使用 Moq 在 Silverlight WCF 代理中模拟异步调用

Question

我有一个带有 WCF 服务的典型 Silverlight 应用程序，并且我使用 slsvcutil.exe 生成标准客户端代理以与 Web 服务进行通信。我正在尝试编写单元测试，并尝试使用 Silverlight 单元测试框架和 Moq 来模拟代理并删除测试的服务依赖项。

我对 Moq 很陌生，当进行服务调用来模拟异步调用时，在模拟代理上自动引发各种 Completed 事件时遇到很多麻烦。

为了使代理“可模拟”，我为生成的代理调用及其完成的事件创建了自己的简单接口：

public interface IServiceProxy
{
    void TestAsync(TestRequest request);
    void TestAsync(TestRequest request, object userState);
    event EventHandler<TestCompletedEventArgs> TestCompleted;
}

我还对生成的代理对象进行子类化以实现该接口：

public class MyServiceProxy : GeneratedServiceClient, IServiceProxy, ICommunicationObject
{
    // ... overloaded proxy constructors
}

查看 Moq 文档后，这就是我的方式我正在尝试设置模拟以期望 TestAsync() 调用并立即引发 TestCompleted 事件，结果在 EventArgs 中：

[TestMethod]
public void Test_Returns_Expected()
{
    var mockProxy = new Mock<IServiceProxy>();
    var result = new TestResponse() { Value = true };

    this.mockProxy.Setup(
        p => p.TestAsync(It.IsAny<TestRequest>()))
        .Raises(p => p.TestCompleted += null, new TestCompletedEventArgs(new object[] { result }, null, false, null));

    // rest of the test to actually use the mock and assert things
}

一切都构建良好，但是当我尝试使用模拟运行任何类型的测试并设置断点时，TestCompleted当我调用 TestAsync() 时，事件永远不会被引发。

关于在 Silverlight 中模拟这些类型的异步服务代理，我是否遗漏了任何明显的内容或任何更好的想法？

谢谢！

编辑：

更清楚地说，我实际上想要测试的是我制作的一个辅助类，它采用 IServiceProxy 实例并为我的 ViewModel 使用提供更清晰的服务接口通过接受 Action 回调参数而不是处理 ViewModel 中的回调事件。我知道如何模拟它来直接测试我的 ViewModel，但我认为首先测试助手类本身会很好。

这是我正在谈论的一个示例：

public class HelperClient : IServiceHelper
{
    private IServiceProxy proxy;

    public HelperClient(IServiceProxy proxy)
    {
        this.proxy = proxy;

        // register to handle all async callback events
        this.proxy.TestCompleted += new EventHandler<TestCompletedEventArgs>(TestCompleted);
    }

    public void Test(TestRequest request, Action<TestResponse, Exception> response)
    {
        this.proxy.TestAsync(request, response);
    }

    private void TestCompleted(object sender, TestCompletedEventArgs e)
    {
        var response = e.UserState as Action<TestResponse, Exception>;

        if (response != null)
        {
            var ex = GetServiceException(e);

            if (ex == null)
            {
                response(e.Result, null);
            }
            else
            {
                response(null, ex);
            }
        }
    }
}

因此，在我的测试中，我真正做的是模拟 ISerivceProxy 并将其传递进去，然后尝试测试服务调用以确保包装器正确调用操作：

[TestMethod]
[Asynchronous]
public void Test_Returns_Expected()
{
    var mockProxy = new Mock<IServiceProxy>();
    var helper = new HelperClient(mockProxy.Object);
    bool expectedResult = true;
    var result = new TestResponse() { Value = expectedResult };

    this.mockProxy.Setup(
        p => p.TestAsync(It.IsAny<TestRequest>()))
        .Raises(p => p.TestCompleted += null, new TestCompletedEventArgs(new object[] { result }, null, false, null));

    helper.Test(new TestRequest(), (response, ex) =>
    {
        Assert.AreEqual(expectedResult, response.Value);
        EnqueueTestComplete();
    });
}

问题是模拟的代理对象永远不会引发 TestCompleted 事件，因此我的响应操作永远不会被调用来完成测试（即使测试似乎成功完成，但 Assert 从未真正运行）。抱歉，这篇文章很长，只是想向您展示尽可能多的代码。

编辑2

添加了[Asynchronous]并调用EnqueueTestComplete()，我意识到我可能需要让测试等待事件引发。这并没有真正帮助，该事件仍然从未引发，因此测试只是挂起并且永远不会完成。

编辑3

阿利斯塔德的答案是正确的，我的设置期望的签名与实际的 Test() 签名不匹配，允许我传递响应操作作为第二个参数。愚蠢的错误，但这就是阻止 Moq 引发 Completed 事件的原因。我还忘记将 Action 作为 TestCompletedEventArgs 中的 userState 对象传递，以便在引发 Completed 事件时实际调用它。此外，在这种情况下，[Asynchronous] 和 EnqueueTestCompleted 似乎没有必要。

这是更新的测试代码，供感兴趣的人使用：

[TestMethod]
public void Test_Returns_Expected()
{
    var mockProxy = new Mock<IServiceProxy>();
    var helper = new HelperClient(mockProxy.Object);
    bool expectedResult = true;
    var result = new TestResponse() { Value = expectedResult };

    Action<TestResponse, Exception> responseAction = (response, ex) =>
    {
        Assert.AreEqual(expectedResult, response.Value);
    };

    this.mockProxy.Setup(
        p => p.TestAsync(It.IsAny<TestRequest>(), It.IsAny<Action<TestResponse, Exception>>()))
        .Raises(p => p.TestCompleted += null, new TestCompletedEventArgs(new object[] { result }, null, false, responseAction));

    helper.Test(new TestRequest(), responseAction);
}

Answer 1

模拟事件非常痛苦，单元测试变得脆弱。但正如你所说，没有办法解决这个问题。但通常您会进行尝试测试的调用并阻止当前线程（使用 Sleep 或其他方法），直到引发事件（或超时）。

实际上并不清楚你在测试什么。我可以看到模拟和响应，实际的真实对象在哪里？

我会相应地更新我的答案。

更新

我可以在这里看到一个问题：

helper.Test(new TestRequest(), (response, ex) =>
{
    Assert.AreEqual(expectedResult, response.Value);
    EnqueueTestComplete();
});

在最后一个语句中，您将 EnqueueTestComplete();并且您断言但此操作永远不会被使用，因为它被传递到最小起订量对象。

此外，当您在 HelperClient (< code>this.proxy.TestAsync(request, response);) 这就是为什么它永远不会被触发，因为没有满足期望。

Answer 2

刚刚搜索模拟异步WCF客户端并发现了这个问题。

为了防止这种情况，Moq 可以 .Verify() p.TestAsync() 已被调用。

//will throw MockException if p.TestAsync() has never been called.
this.mockProxy.Verify(p => p.TestAsync(It.IsAny<TestRequest>()), Times.Once());