ChatGPT解决这个技术问题 Extra ChatGPT

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

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

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

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

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

这是我要测试的方法:

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.");
}

我究竟做错了什么?

谢谢您的帮助。


J
Jon Skeet

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

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

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

您可能还想考虑使用假的 IHttpClient 而不是模拟所有内容 - 这实际上取决于您需要它的频率。


非常感谢。那效果很好。我想这可能是我不理解的简单事情。
回复:假 IHttpClient,我考虑过,但我需要能够根据从 Web API 返回的预期行为为不同的测试返回不同的 HttpStatusCode,这似乎给了我更多的控制权。
@mvanella:是的,所以你会创建一个可以返回任何你想要它的假货。只是想一想。
对于现在发现此内容的任何人,Moq 4.2 都有一个名为 ReturnsAysnc 的扩展,它正是这样做的。
@legacybass 我找不到任何文档的链接,尽管 API 文档说它们是针对 v4.2.1312.1622 构建的,而 v4.2.1312.1622 几乎是一年前的 released。请参阅该版本前几天制作的this commit。至于为什么API文档没有更新......
D
DineshNS

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

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

b
bside

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

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

K
Kurt Van den Branden

尝试使用 ReturnsAsync。在异步方法中它起作用,我相信解决您的问题的基础应该是相似的。

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