FakeXrmEasy中的假插件行为?

时间:2016-08-22 08:40:33

标签: c# mocking dynamics-crm dynamics-crm-2013

过去一周左右我一直在使用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
  • 返回包含订单号
  • 的结果对象

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

2 个答案:

答案 0 :(得分:2)

假设您正在编写单元测试以测试该插件之后发生的任何事情(填充订单号的插件),最简单的解决方案是初始化其中包含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属性。 Here's an example with the FollowupPlugin

插件执行有几个重载,这个例子曾经是一个&#34; old&#34;一。有一种新的通用方法,您可以在其中传递自定义插件上下文,您可以在其中注入许多属性,包括Outputparameters(查找GetDefaultPluginContext here)。

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

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

可能有很多方法对这些东西进行单元测试,但我个人的建议是,这些步骤太多,无法包含在单个单元测试中。我宁愿重构那个逻辑,以便它可以更容易地单独进行单元测试。

我将恢复到只有3个步骤,以使其更简单:

  • 创建逻辑:您创建销售订单记录,并传入一些属性。
  • 创建插件:在创建销售订单时触发插件,该销售订单会填充订单号。
  • 其他东西:之后你有一些逻辑检索销售订单,并根据OrderNumber(或其他属性)做了什么。

我首先会重构该代码,以便我可以更轻松地以小块的形式测试它。这样做可以使测试更容易实现和理解。审查。

我会为每个(至少!)创建3个不同的单元测试:

  • 创建逻辑:不需要任何输入实体的单元测试(因此不需要.Initialize())并且只创建销售订单实体记录。然后断言它创建了你期望的任何属性。
  • 创建插件:执行插件的单元测试,并确保它执行任何应该执行的操作
  • 如果之后有任何逻辑运行,请确保它已被重构,以便您可以注入任何属性/值,然后在后续单元测试中通过.Initialize()方法传递它们(如.OrderNumber)。 / LI>

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

答案 1 :(得分:1)

我无法与Jordi的答案争论,这与我为基于XrmUnitTest的单元测试提供的基本答案相同。我还提供了两个我已经开发的约定,以使这种类型的更改更加自动化#34;。这些将是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流利组织服务构建器

创建一个流畅的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编号。