如何使依赖扩展方法的方法可测试？

Question

我有一个具有以下签名的扩展方法（在 BuildServerExtensions 类中）::

public static IEnumerable<BuildAgent> GetEnabledBuildAgents(
                                          this IBuildServer buildServer,
                                          string teamProjectName)
{
    // omitted agrument validation and irrelevant code
    var buildAgentSpec = buildServer.CreateBuildAgentSpec(teamProjectName);
}

另一个方法调用第一个方法（在 BuildAgentSelector 类中）：

public BuildAgent Select(IBuildServer buildServer, string teamProjectName)
{
    // omitted argument validation
    IEnumerable<BuildAgent> serverBuildAgents = 
        buildServer.GetEnabledBuildAgents(teamProjectName);

    // omitted - test doesn't get this far
}

我正在尝试使用 MSTest 和 Rhino.Mocks (v3.4) 来测试它

[TestMethod]
public void SelectReturnsNullOnNullBuildAgents()
{
    Mocks = new MockRepository();
    IBuildServer buildServer = Mocks.CreateMock<IBuildServer>();

    BuildAgentSelector buildAgentSelector = new BuildAgentSelector();
    using (Mocks.Record())
    {
        Expect.Call(buildServer.GetEnabledBuildAgents(TeamProjectName)).Return(null);
    }

    using (Mocks.Playback())
    {
        BuildAgent buildAgent = buildAgentSelector.Select(buildServer, TeamProjectName);

        Assert.IsNull(buildAgent);
    }
}

：我运行这个测试我得到：

System.InvalidOperationException：

之前的方法 IBuildServer.CreateBuildAgentSpec("TeamProjectName"); 需要返回值或抛出异常。

这显然是调用真正的扩展方法而不是测试实现。 我的下一个倾向是尝试：

Expect.Call(BuildServerExtensions.GetEnabledBuildAgents(buildServer, TeamProjectName))
      .Return(null);

然后我注意到我对 Rhino.Mocks 拦截此行为的期望可能是错误的。

问题是：如何消除这种依赖性并使 Select 方法可测试？

请注意，扩展方法和 BuildAgentSelector 类位于同一个程序集中，我希望避免更改此方法或必须转向扩展方法之外的其他方法，尽管如果我知道另一个模拟框架可以处理这种情况，我会考虑它。

Answer 1

您的扩展方法实际上写得相当好。 它是一种无副作用的方法，并且扩展一个接口，而不是一个具体的类。 你已经快到了，但你只需要走得更远一点。 您正在尝试模拟 .GetEnabledBuildAgents(...) 扩展方法...但是这实际上并不是可模拟的（除了 TypeMock Isolator 之外的任何东西，这是目前唯一可以实际模拟静态的东西...但是它相当昂贵.)

您实际上有兴趣模拟扩展方法在内部调用的 IBuildAgent 上的方法：.CreateBuildAgentSpec(...)。 如果您仔细考虑，模拟 CreateBuildAgentSpec 方法将解决您的问题。 扩展方法是“纯粹的”，所以真的不需要被嘲笑。 它没有状态，也不会产生副作用。 它调用 IBuildAgent 接口上的单个方法...这是引导您真正需要模拟的内容的第一个线索。

尝试以下操作：

[TestMethod]
public void SelectReturnsNullOnNullBuildAgents()
{
    Mocks = new MockRepository();
    IBuildServer buildServer = Mocks.CreateMock<IBuildServer>();

    BuildAgent agent = new BuildAgent { ... }; // Create an agent
    BuildAgentSelector buildAgentSelector = new BuildAgentSelector();
    using (Mocks.Record())
    {
        Expect.Call(buildServer.CreateBuildAgentSpec(TeamProjectName)).Return(new List<BuildAgent> { agent });
    }

    using (Mocks.Playback())
    {
        BuildAgent buildAgent = buildAgentSelector.Select(buildServer, TeamProjectName);

        Assert.IsNull(buildAgent);
    }
}

通过创建 BuildAgent 实例并将其返回到 List中，您可以有效地返回 IEnumerable实例。 您的 Select 方法可以对其进行操作。 这应该能让你继续前进。 如果仅返回一个基本的 BuildAgent 实例还不够，或者您需要多个实例，您可能需要进行一些额外的模拟。 当涉及到要返回的模拟结果时，Rhino.Mocks 可能是一个真正的麻烦。 如果您遇到麻烦（根据我的经验，您很可能会遇到麻烦），我建议您尝试一下 Moq，因为它是一个更好、更适合测试人员使用的框架。 它不需要存储库，并且消除了 Rhino.Mocks 所需的记录/回放和 using() 语句繁重符号。 Moq 还提供其他框架尚未提供的附加功能，一旦您进入较重的模拟场景，您就会爱上（即 It.* 方法）。

希望这会有所帮助。

Answer 2

休息一下并带着全新的头脑回来后，我意识到我实际上在 BuildAgentSelector 类中混合了一些关注点。 我正在获取代理并选择他们。 通过分离这两个问题并将代理直接传递给 BuildAgentSelector 构造函数（或委托/接口来执行此操作），我能够分离问题，删除对 buildServer 和 teamProjectName 参数的依赖项，并简化接口正在进行中。 它还实现了我在 BuildAgentSelector 类上寻找的可测试性结果。 我也可以很好地单独测试扩展方法。

但最终，只是将测试问题转移到了别处。 更好是因为关注点放在了更好的位置，但无论关注点放在哪里，jrista 的答案都解决了问题。

必须模拟被测代码下面的第二层仍然有点难看。 我本质上必须从我的扩展方法测试中模拟成功路径，并在我的其他测试中重用此代码 - 并不困难，但有点烦人。

我会尝试最小起订量，并小心不要对编写扩展方法过于满意。

Answer 3

该测试调用真正的扩展方法，因为这是唯一的方法。 当您模拟 IBuildServer 时，不会创建任何测试实现，因为该方法不是 IBuildServer 的成员。

使用您现在的设置，没有干净的解决方案。

理论上，TypeMock 将模拟静态类，但重构扩展方法将提供更好的可测试性。