FakeXrmEasy 中的假插件行为？

Question

过去一周左右，我一直在使用 FakeXrmEasy 编写单元测试，我对它的工作方式总体上很满意。但是有一个区域我无法让模拟按我想要的方式工作。

在 Dynamics CRM 安装中，有一个插件运行，可以在销售订单上设置订单号。没有这个，返回的订单号的值总是空的。

我如何告诉 FakeXrmEasy 模拟设置 ordernumber 值？理想情况下，我希望或多或少像这样进入请求管道：

    var context = new FakeXrmEasy.XrmFakedContext();
    context.Initialize(TestEntities);    

    context.TamperWithResults<RetrieveRequest>( x => { 
           return SetOrderNumber(x); 
        });

   context.GetFakedOrganizationService();

   var result = context.Retrieve(...);

我可以尝试使用 .AddExecutionMock 模拟整个结果，但有问题的响应用于验证销售订单确实保存了正确的值。

更新 - 更详细的信息 也许我应该在问这个问题时更详细一点。我刚刚加入了一个现有项目，正在为现有代码编写测试。失败的测试是运行执行此操作的函数：

验证输入
创建销售订单
检索该销售订单
为每个订单行创建 SalesOrderDetails
Returns 包含订单号的结果对象

现在，由于该函数尝试保存订单，我无法将其添加到设置中的上下文中，除非我可以指定将由 Create() 调用返回的 Guid。

Answer 1

假设您正在编写一个单元测试来测试在该插件（填充订单号的插件）之后发生的任何事情，最简单的解决方案是初始化一个包含订单号的销售订单，它将用作前提。默认情况下会自动模拟查询，因此应该返回该值。因此无需在管道中注入任何东西。

示例：

[Fact]
public void Example_test()
{
var context = new XrmFakedContext();
var service = context.GetFakedOrganizationService();
var salesOrder = new SalesOrder() { Id = Guid.NewGuid(), OrderNumber = 69 }; 
context.Initialize(new List<Entity>() { salesOrder });

//some stuff
//....

//Queries are automatically mocked so any LINQ,FetchXml, 
//QueryExpression or QueryByAttrubute should return the values you had in 
//the context initialisation or as a result of updates / creates during the test execution


var result = context.CreateQuery<SalesOrder>().FirstOrDefault();
Assert.Equal(result.OrderNumber, 69);

}

[编辑]: 如果您想在创建之后注入 guid，您可以为此使用 OutputParameters 属性。 Here's an example with the FollowupPlugin。

插件执行有几个重载，那个例子曾经是 "old" 一个。有一种新的通用方法，您可以在其中传递自定义插件上下文，您可以在其中注入许多属性，包括输出参数（查找 GetDefaultPluginContext here）。

但总的来说，回到你原来的问题，如果你有很多这样的步骤：

验证输入
创建销售订单
检索该销售订单
创建销售订单详细信息
Returns 包含订单号的结果对象

可以有很多方法来对这些东西进行单元测试，但我个人的建议是，这些步骤太多了，无法包含在单个单元测试中。我宁愿重构该逻辑，以便可以更轻松地对其进行单独的单元测试。

我将把它恢复到只有 3 个步骤以使其更简单：

创建逻辑：你创建一个销售订单记录，传入一些属性。
创建插件：在创建填充订单号的销售订单时触发插件。
其他内容：之后您有一些逻辑可以检索销售订单并根据 OrderNumber（或其他属性）执行某些操作。

我会首先重构该代码，以便我可以更轻松地以小块的形式对其进行测试。这样做可以使测试更易于实施、理解和审查。

我会为每个（至少！）创建 3 个不同的单元测试：

创建逻辑：单元测试不需要任何输入实体（因此不需要 .Initialize()）并且只创建销售订单实体记录。然后断言它已经创建了您期望的任何属性。
创建插件：一个单元测试来执行插件并确保它做任何它应该做的事情
如果您之后有任何逻辑运行，请确保它已重构，以便您可以注入任何属性/值，然后通过 .Initialize() 方法传递它们（如 .OrderNumber）在随后的单元测试中。

希望这对您有所帮助（现在 :P ）！

Answer 2

我无法反驳 Jordi 的回答，它与我为基于 XrmUnitTest 的单元测试提供的基本答案相同。我还将提供两个我制定的约定，以使此类更改更多 "automagic"。这些将是 XrmUnitTest 示例，但您（或@Jordi）可以在 FakeXrmEasy 框架中实现它们。

选项 #1 Entity Fluent Builder

创建流畅的 OrderNumber Builder。默认情况下，将订单号默认为特定数字，或者甚至接受一个值：

public class SalesOrderBuilder : EntityBuilder<SalesOrder>
{
    public SalesOrder SalesOrder { get; set; }

    public SalesOrderBuilder()
    {
        SalesOrder = new SalesOrder();
        WithOrderNumber();
    }

    public SalesOrderBuilder(Id id)
        : this() { Id = id; }

    #region Fluent Methods

    public SalesOrderBuilder WithOrderNumber(string orderNumber = null)
    {
        orderNumber = orderNumber ?? "2";
        SalesOrder.OrderNumber = orderNumber;

        return this;
    }

    #endregion // Fluent Methods

    protected override SalesOrder BuildInternal() { return SalesOrder; }
}

然后你会在初始化测试数据时调用它：

private class Example : TestMethodClassBase
{
    // Ids struct is used by the TestMethodClassBase to clean up any entities defined
    private struct Ids
    {
        public static readonly Id<SalesOrder> SalesOrder = new Id<SalesOrder>("7CF2BB0D-85D4-4B8C-A7B6-371D3C6EA37C");
    }

    protected override void InitializeTestData(IOrganizationService service)
    {
        new SalesOrderBuilder(Ids.SalesOrder).Create(service);
    }

    protected override void Test(IOrganizationService service)
    {
        // Run test
        Assert.IsNotNull(service.GetFirst<SalesOrder>().OrderNumber);

    }
}

选项 #2 Fluent Organization Service Builder

创建 Fluent OrganizationServiceBuilder。将其默认为添加订单号：

public class OrganizationServiceBuilder : DLaB.Xrm.Test.Builders.OrganizationServiceBuilderBase<OrganizationServiceBuilder>
{
    protected override OrganizationServiceBuilder This
    {
        get { return this; }
    }

    #region Constructors


    public OrganizationServiceBuilder() : this(TestBase.GetOrganizationService()) {}

    public OrganizationServiceBuilder(IOrganizationService service) : base(service) { WithSalesOrderNumbersDefaulted(); }

    #endregion Constructors

    #region Fluent Methods

    private static int _salesNumber = 1;
    public OrganizationServiceBuilder WithSalesOrderNumbersDefaulted() {
        WithFakeCreate((s, e) =>
        {
            if (e.LogicalName == SalesOrder.EntityLogicalName && e.GetAttributeValue<string>(SalesOrder.Fields.OrderNumber) == null)
            {
                _salesNumber++; //Use Interlocking if thread safe is required 
                e[SalesOrder.Fields.OrderNumber] = _salesNumber;
            }
            return s.Create(e);
        });
        return this;
    }

    #endregion Fluent Methods
}

然后您的测试将在您创建它时包装它：

private class Example : TestMethodClassBase
{
    // Ids struct is used by the TestMethodClassBase to clean up any entities defined
    private struct Ids
    {
        public static readonly Id<SalesOrder> SalesOrder = new Id<SalesOrder>("7CF2BB0D-85D4-4B8C-A7B6-371D3C6EA37C");
    }

    protected override void InitializeTestData(IOrganizationService service)
    {
        service = new OrganizationServiceBuilder(service).WithSalesOrderNumbersDefaulted().Build();
        service.Create(new SalesOrder());
    }

    protected override void Test(IOrganizationService service)
    {
        // Run test
        Assert.IsNotNull(service.GetFirst<SalesOrder>().OrderNumber);

    }
}

使用这些选项中的任何一个都可以让您轻松地指定您希望默认的自动订单号，而不必在每个测试中都默认它。如果你将它添加到你的测试基础 class，你会自动设置它。

更新 1

响应 OP 的更新，对创建实体的方法进行单元测试。

像这样使用 Fluen tOrganization Builder：

private class Example : TestMethodClassBase
{
    protected override void Test(IOrganizationService service)
    {
        service = new OrganizationServiceBuilder(service)
                          .WithSalesOrderNumbersDefaulted()
                          .Build();
        // Execute Function for test
        var id = Example.ValidateAndCreateOrderAndDetail(service);
        Assert.IsNotNull(service.GetEntity<SalesOrder>(id).OrderNumber);
    }
}

当您的 ValidateAndCreateOrderDetail 方法运行时，创建的任何 SalesOrder 都将填充一个 SalesOrder Number。

FakeXrmEasy 中的假插件行为？

Fake plugin behavior in FakeXrmEasy?

c#

mocking

dynamics-crm

dynamics-crm-2013

选项 #1 Entity Fluent Builder

选项 #2 Fluent Organization Service Builder

更新 1