使用Moq模拟单元测试的异步方法


178

我正在测试用于进行Web API调用的服务的方法。HttpClient如果我还本地运行Web服务(位于解决方案中的另一个项目中),则对单元测试使用正常工作就可以了。

但是,当我签入更改时,构建服务器将无法访问Web服务,因此测试将失败。

我为单元测试设计了一种解决方法,方法是创建一个IHttpClient接口并实现一个在应用程序中使用的版本。对于单元测试,我制作了一个模拟版本,其中包含一个模拟的异步post方法。这是我遇到问题的地方。我想HttpStatusResult为此特定测试返回确定。对于另一个类似的测试,我将返回不好的结果。

测试将运行,但永远不会完成。它挂在等待。我是异步编程,委托和Moq本身的新手,我一直在搜索SO和Google一段时间以学习新事物,但我似乎仍然无法克服这个问题。

这是我要测试的方法:

public async Task<bool> QueueNotificationAsync(IHttpClient client, Email email)
{
    // do stuff
    try
    {
        // The test hangs here, never returning
        HttpResponseMessage response = await client.PostAsync(uri, content);

        // more logic here
    }
    // more stuff
}

这是我的单元测试方法:

[TestMethod]
public async Task QueueNotificationAsync_Completes_With_ValidEmail()
{
    Email email = new Email()
    {
        FromAddress = "bob@example.com",
        ToAddress = "bill@example.com",
        CCAddress = "brian@example.com",
        BCCAddress = "ben@example.com",
        Subject = "Hello",
        Body = "Hello World."
    };
    var mockClient = new Mock<IHttpClient>();
    mockClient.Setup(c => c.PostAsync(
        It.IsAny<Uri>(),
        It.IsAny<HttpContent>()
        )).Returns(() => new Task<HttpResponseMessage>(() => new HttpResponseMessage(System.Net.HttpStatusCode.OK)));

    bool result = await _notificationRequestService.QueueNotificationAsync(mockClient.Object, email);

    Assert.IsTrue(result, "Queue failed.");
}

我究竟做错了什么?

谢谢您的帮助。

Answers:


348

您正在创建任务,但从未启动它,因此它从未完成。但是,不要只是开始任务-而是改为使用using Task.FromResult<TResult>将为您提供已经完成的任务:

...
.Returns(Task.FromResult(new HttpResponseMessage(System.Net.HttpStatusCode.OK)));

请注意,您将不会以这种方式测试实际的异步-如果您想要这样做,则需要做更多的工作来创建Task<T>可以以更细粒度的方式进行控制的...另一天。

您可能还想考虑使用假冒产品,IHttpClient而不是嘲笑所有内容,这实际上取决于您需要使用它的频率。


2
非常感谢你。效果很好。我认为这可能是我不了解的简单事情。
mvanella

2
回复:假的IHttpClient,我认为是这样,但是我需要能够基于Web API返回的预期行为,针对不同的测试返回不同的HttpStatusCodes,这似乎给了我更多的控制权。
mvanella

3
@mvanella:是的,所以您将创建一个假货,该假货可以返回您想要的任何东西。只是要考虑的事情。
乔恩·斯基特

133
对于现在发现此问题的任何人,Moq 4.2都有一个扩展名为ReturnsAysnc,可以完全做到这一点。
Stuart Grassie 2014年

3
@legacybass尽管API文档说它们是针对将近一年前发布的 v4.2.1312.1622构建的,但我找不到指向它的任何文档的链接。请参阅在该版本发布前几天进行的提交。至于为什么API文档没有更新……
Stuart Grassie 2014年

16

在上面推荐@Stuart Grassie的答案。

var moqCredentialMananger = new Mock<ICredentialManager>();
moqCredentialMananger
                    .Setup(x => x.GetCredentialsAsync(It.IsAny<string>()))
                    .ReturnsAsync(new Credentials() { .. .. .. });

1

使用Mock.Of<...>(...)for async方法,您可以使用Task.FromResult(...)

var client = Mock.Of<IHttpClient>(c => 
    c.PostAsync(It.IsAny<Uri>(), It.IsAny<HttpContent>()) == Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK))
);
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.