FakeXrmEasy中的假插件行为？

Question

在过去一周左右的时间里，我一直在使用FakeXrmEasy编写单元测试，而且我通常对它的工作方式感到满意。但有一个地方，我不能让模拟工作，我希望它。

在Dynamics安装中，有一个插件正在运行，它在销售订单上设置订单编号。如果没有此操作，返回的订单号的值始终为空。

如何告诉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
• 返回包含订单号的结果对象。

现在，由于函数试图保存订单，除非我可以指定Create()调用返回的Guid，否则无法将其添加到安装程序中的上下文中。

Answer 1

假设您正在编写一个单元测试，用于测试在插件(填充订单号的插件)之后发生的任何事情，最简单的解决方案是初始化带有OrderNumber的销售订单，这将作为先决条件。查询在默认情况下会自动模拟，因此应该返回值。所以没必要在管道里注射任何东西。

示例：

[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属性。下面是一个关于FollowupPlugin的例子。

插件的执行有几个重载，这个例子曾经是一个“旧”的例子。有一种新的通用方法，可以传递自定义插件上下文，在该方法中可以注入许多属性，包括输出参数(查找GetDefaultPluginContext在这里)。

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

• 验证输入
• 创建销售订单
• 检索销售订单
• 创建SalesOrderDetails
• 返回包含订单号的结果对象。

可以有许多方法来测试这些内容，但我个人的建议是，这些步骤太多了，无法包含在单个单元测试中。我更愿意重构这个逻辑，这样就可以更容易地单独进行单元测试。

我将继续讨论这个问题，只需三个步骤就可以使其更简单：

• 创建逻辑:创建一个salesorder记录，传递一些属性。
• Create :一个插件在salesorder的创建中触发，该命令填充订单号。
• 其他内容:之后有一些逻辑，它检索一个销售订单，并基于OrderNumber (或其他属性)执行一些操作。

首先，重构该代码，这样我就可以更容易地以小块的方式测试它。这样做可以简化测试的实现以及理解和评审。

我将为每个单元创建3个不同的单元测试(至少！)：

• 创建逻辑:一个单元测试，它不需要任何输入实体(所以不需要.Initialize() )，只需要创建一个salesorder实体记录。然后断言它已经创建了您所期望的任何属性。
• 创建插件:一个执行插件的单元测试，并确保它做它应该做的事情。
• 如果在此之后运行了任何逻辑，请确保对其进行重构，以便注入任何属性/值，然后在随后的单元测试中通过.Initialize()方法传递它们(类似于.Initialize)。

希望这有帮助(现在:P )！

Answer 2

我不能反驳若迪的回答，这是相同的基本答案，我会提供一个基于XrmUnitTest的单元测试。我还将给出两个惯例，我已经开发了使这种类型的变化更“自动”。这些将是XrmUnitTest示例，但是您(或@Jordi)可以在FakeXrmEasy框架中实现它们。

选项1实体Fluent Builder

创建一个流利的OrderNumber生成器。默认情况下，它是否将订单号默认为特定数字，或者接受一个值，甚至：

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:流畅的组织服务生成器

创建一个流利的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);

    }
}

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

更新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编号。