DataverseFakes.Community 1.1.5

DataverseFakes

A modern, open-source unit testing framework for Dynamics 365 / Dataverse that mocks IOrganizationService with an in-memory context for fast plugin, workflow, and custom code testing.

Features

• Unit test plugins without deploying to a real environment
• Test workflow activities with in-memory execution
• Fast execution - run 1000+ tests in seconds
• No server required - test offline, no Dynamics 365 connection needed
• Early and late bound - works with generated entities or dynamic Entity objects
• 62+ SDK messages supported out of the box
• Pipeline simulation - register plugin steps with filtering attributes, stages, and rank ordering
• FetchXML and QueryExpression - full query translation with aggregates, joins, and date operators

Getting Started

Installation

dotnet add package DataverseFakes.Community

Or via Package Manager:

Install-Package DataverseFakes.Community

Quick Example

using DataverseFakes;
using Microsoft.Xrm.Sdk;
using Xunit;

public class AccountPluginTests
{
    [Fact]
    public void When_Account_Created_Should_Set_AccountNumber()
    {
        // Arrange
        var context = new XrmFakedContext();
        var target = new Entity("account")
        {
            ["name"] = "Contoso"
        };

        // Act
        context.ExecutePluginWithTarget<AccountNumberPlugin>(target);

        // Assert
        Assert.True(target.Contains("accountnumber"));
        Assert.NotNull(target["accountnumber"]);
    }
}

Early-Bound Entities

var context = new XrmFakedContext();
context.ProxyTypesAssembly = Assembly.GetExecutingAssembly();

var account = new Account
{
    Id = Guid.NewGuid(),
    Name = "Test Account"
};

context.Initialize(new List<Entity> { account });
var service = context.GetOrganizationService();

Testing Workflow Activities

var context = new XrmFakedContext();
var inputs = new Dictionary<string, object>
{
    { "Target", new EntityReference("account", Guid.NewGuid()) },
    { "InputText", "Hello" }
};

var outputs = context.ExecuteCodeActivity<MyCustomActivity>(inputs);
Assert.Equal("Hello World", outputs["OutputText"]);

Plugin Pipeline Simulation

var context = new XrmFakedContext();
context.UsePipelineSimulation = true;

// Register plugin steps with filtering attributes
context.RegisterPluginStep<AccountPlugin, Account>(
    message: "Create",
    stage: ProcessingStepStage.Preoperation,
    mode: ProcessingStepMode.Synchronous,
    rank: 1,
    filteringAttributes: new[] { "name", "revenue" }
);

// Entity images auto-populated from context
context.ExecutePluginWithTarget<MyPlugin>(target,
    messageName: "Update",
    stage: 40,
    preImageColumns: new ColumnSet(true),
    postImageColumns: new ColumnSet(true));

Supported SDK Messages

DataverseFakes supports 62+ standard CRM messages:

Query Support

Result Ordering

DataverseFakes matches Dataverse behavior: result ordering is not guaranteed unless you explicitly specify an OrderExpression or <order /> clause. Use set/membership assertions instead of index-based assertions:

var results = service.RetrieveMultiple(query);
var ids = results.Entities.Select(e => e.Id).ToList();
Assert.Contains(expectedId, ids);

Condition Operators

FetchXML Aggregates

var fetchXml = @"<fetch aggregate='true'>
  <entity name='contact'>
    <attribute name='contactid' alias='count' aggregate='count' />
    <attribute name='lastname' alias='group' groupby='true' />
  </entity>
</fetch>";

var results = service.RetrieveMultiple(new FetchExpression(fetchXml));

Alternate Keys

// Define alternate keys
context.AddAlternateKey("account", "accountnumber", "Account Number Key");
context.AddAlternateKey("product", new[] { "productnumber", "productcategoryid" }, "Composite Key");

// Retrieve by alternate key
var entity = new Entity("account");
entity.KeyAttributes["accountnumber"] = "ACC-001";
var result = service.Retrieve("account", entity.KeyAttributes, new ColumnSet(true));

// Upsert by alternate key
var upsert = new Entity("account");
upsert.KeyAttributes["accountnumber"] = "ACC-002";
upsert["name"] = "New or Updated";
service.Execute(new UpsertRequest { Target = upsert });

Known Limitations

Building from Source

build.bat              # Restore, build, and test
build.bat test         # Run tests only
build.bat pack         # Create NuGet package

Target Platform: Dynamics 365 v9.x and later (.NET Framework 4.6.2)

Contributing

1. Fork the repository
2. Create a feature branch
3. Write tests for your changes
4. Open a Pull Request

All new features and bug fixes must include unit tests.

License

MIT License - see LICENSE.md for details.

Attribution

This project is derived from FakeXrmEasy, originally created by Jordi Montana and contributors.

FakeXrmEasy is a registered trademark of Jordi Montana. This project is not affiliated with or endorsed by the trademark holder.

See CHANGELOG.md for version history.