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

Question

我正在测试一种调用Web API的服务方法。如果我在本地运行Web服务(位于解决方案中的另一个项目中)，那么使用普通的HttpClient进行单元测试也是可行的。

但是，当我提交更改后，构建服务器将无法访问Web服务，因此测试将失败。

我已经针对我的单元测试设计了一种解决方法，即创建一个IHttpClient接口并实现一个版本，我在我的应用程序中使用该版本。对于单元测试，我制作了一个模拟版本，包括模拟的异步post方法。这就是我的问题所在。我想为这个特定的测试返回一个OK HttpStatusResult。对于另一个类似的测试，我将返回一个坏结果。

测试将运行，但永远不会完成。它停留在等待await时。我还不熟悉异步编程、委托和Moq本身，并且我已经在Stack Overflow和谷歌上搜索了一段时间，学到了新的东西，但仍然无法解决这个问题。

以下是我正在尝试测试的方法：

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 = "[e-mail]",
        ToAddress = "[e-mail]",
        CCAddress = "[e-mail]",
        BCCAddress = "[e-mail]",
        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.");
}

我做错了什么？

谢谢你的帮助。

- mvanella

Answer 1

你正在创建一个任务，但从未启动它，因此它永远不会完成。然而，不要仅仅启动任务-改用Task.FromResult<TResult>，这将给你一个已经完成的任务：

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

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

您可能还希望考虑使用IHttpClient的伪造对象而不是模拟所有内容 - 这确实取决于您需要使用它的频率。

- Jon Skeet

---

非常感谢。那很好地解决了问题。我想这可能是我没有理解的简单问题。 - mvanella

关于：伪造 IHttpClient，我考虑过这个方法，但是我需要能够根据来自 Web API 的预期行为返回不同的 HttpStatusCodes 以便进行不同的测试，而这种方法似乎给了我更多的控制权。 - mvanella

是的，所以你可以创建一个假对象，使其返回任何你想要的内容。这只是一个需要考虑的问题。 - Jon Skeet

对于现在发现这个帖子的任何人，Moq 4.2有一个名为ReturnsAsync的扩展，可以完全做到这一点。 - Stuart Grassie

@legacybass 我找不到任何关于它的文档链接，尽管API文档说它们是针对v4.2.1312.1622构建的，该版本是在大约一年前发布的。请查看此提交，该提交是在该版本发布前几天进行的。至于为什么API文档没有更新... - Stuart Grassie

Answer 2

推荐使用@Stuart Grassie的评论。使用Moq的ReturnsAsync。

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

- DineshNS

---

不再支持：https://github.com/moq/moq4/wiki/Quickstart#async-methods - General Grievance

Answer 3

尝试使用 ReturnsAsync。

在异步方法中，这个方法能够正常工作，我相信这应该是解决您的问题的基础。

_mocker.GetMock<IMyRepository>()
     .Setup(x => x.GetAll())
     .ReturnsAsync(_myFakeListRepository.GetAll());

- Cleber Spirlandeli

Answer 4

使用Mock.Of<...>(...)来进行异步方法的单元测试时，您可以使用Task.FromResult(...)：

var client = Mock.Of<IHttpClient>(c => 
    c.PostAsync(It.IsAny<Uri>(), It.IsAny<HttpContent>()) == Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK))
);

- bside