在 Thread 的上下文中使用 Moq 模拟 HttpClient

Question

我正在使用moq 创建单元测试，但我无法弄清楚如何将此框架应用到我的程序中处理使用HttpClient 的部分。我发现有各种资源可以演示如何直接模拟 HttpClient 响应，但我的应用程序使用 HttpClient 的方式与使用 Threads 的方式略有不同。

测试的骨架：

public class MyTestClass
{
    public void myTest()
    {
        ClassA classObj = new ClassA();
        classObj.Start();
        // I'd like to use moq somewhere here to mock the response that occurs in DoThreadStuff() below
    }
}

正在测试的类：

public class ClassA
{
    private readonly Thread _myThread; 
    private HttpClient _client;
    
    public ClassA()
    {
        // initialize some values
        _myThread = new Thread(DoThreadStuff);
    }
        
    public void Start()
    {
        _myThread.Start(); // starts DoThreadStuff()
    }
    
    private void DoThreadStuff()
    {
        var newClient = getNewHttpClient(); // utility function returns a HttpClient
        var response = newClient.GetAsync("/my/api/status/endpoint");
    }       
}

如您所见，当ClassA.Start() 被调用时，一个新的HttpClient 被创建并通过GetAsync 使用。为这个构建测试的正确方法是什么？我是否必须更改现有课程的实施以适应最小起订量？有没有人有类似的经验，我可以看看？

Answer 1

假设您的ClassA 如下所示：

public class ClassA
{
    private readonly Thread _myThread;

    public ClassA()
    {
        _myThread = new Thread(DoThreadStuff);
    }

    public void Start()
    {
        _myThread.Start();
    }

    private void DoThreadStuff()
    {
        var newClient = getNewHttpClient();

        var response = newClient.GetAsync("https://httpstat.us//200").GetAwaiter().GetResult();
        if(response.StatusCode == HttpStatusCode.OK)
            Console.WriteLine("OK");
        else if(response.StatusCode == HttpStatusCode.InternalServerError)
            Console.WriteLine("Not good");
    }

    protected virtual HttpClient getNewHttpClient()
    {
        return new HttpClient();
    }
}

• 为了可测试性，我在getNewHttpClient 调用之后添加了一些虚拟代码
  • 请注意，以同步方式 (.GetAwaiter().GetResult()) 调用异步方法并不是一个好主意
• 我还将 getNewHttpClient 添加到您的课程中作为 protected virtual 以便能够轻松覆盖它

---

现在让我们创建一个辅助方法来模拟 HttpClient：

public static HttpClient SetupMockClient(HttpResponseMessage response)
{
    var mockMessageHandler = new Mock<HttpMessageHandler>();
    mockMessageHandler.Protected()
        .Setup<Task<HttpResponseMessage>>("SendAsync", ItExpr.IsAny<HttpRequestMessage>(), ItExpr.IsAny<CancellationToken>())
        .ReturnsAsync(response);
    return new HttpClient(mockMessageHandler.Object);
}

让我们从ClassA 派生来覆盖getNewHttpClient 方法

internal class VerifiableClassA : ClassA
{
    private HttpClient mockedHttpClient;
    public VerifiableClassA(HttpClient mockedHttpClient)
    {
        this.mockedHttpClient = mockedHttpClient;
    }

    protected override HttpClient getNewHttpClient()
    {
        return this.mockedHttpClient;
    }
}

请注意，您可以使用this with moq as well，这样您就不需要仅仅为了测试而引入一个新类。但在这种情况下，getNewHttpClient 应该是 public。

---

现在您可以像这样执行单元测试：

var mockedClient = SetupMockClient(new HttpResponseMessage
{
    StatusCode = HttpStatusCode.InternalServerError,
    Content = new StringContent("Failure")
});

var sut = new VerifiableClassA(mockedClient);
sut.Start();

Answer 2

您应该考虑使用工厂/存储库模式。它们使测试您的方法变得更容易，因为您可以只注入像 HttpClient 这样的对象的模拟。 Peter Csala 建议的答案非常肮脏，因为您创建了一个仅用于测试的类。