如何在单元测试中轻松模拟graphql-dotnet的GraphQLHttpClient？

当然可以，最简洁可靠的方式是依赖IGraphQLClient抽象接口并结合模拟框架（比如Moq）来实现，避免直接耦合具体的GraphQLHttpClient类，以下是具体步骤和示例：

1. 依赖抽象而非具体类 #

重构你的业务代码，让服务类依赖IGraphQLClient接口而非GraphQLHttpClient具体实现，这是实现可测试性的基础：

public class MyGraphQlService
{
    private readonly IGraphQLClient _graphQlClient;

    public MyGraphQlService(IGraphQLClient graphQlClient)
    {
        _graphQlClient = graphQlClient;
    }

    public async Task<MyResponse> FetchTargetDataAsync(string query)
    {
        var request = new GraphQLRequest { Query = query };
        var response = await _graphQlClient.SendQueryAsync<MyResponse>(request);
        return response.Data;
    }
}

// 示例返回模型
public class MyResponse
{
    public int Id { get; set; }
    public string Name { get; set; }
}

2. 用Moq模拟IGraphQLClient #

在单元测试中，使用Moq框架创建IGraphQLClient的模拟实例，预设它的方法返回值，以此控制测试流程：

[TestClass]
public class MyGraphQlServiceTests
{
    [TestMethod]
    public async Task FetchTargetDataAsync_ReturnsExpectedData()
    {
        // 准备模拟数据
        var expectedResponse = new MyResponse { Id = 123, Name = "Mocked Data" };
        var mockGraphQlClient = new Mock<IGraphQLClient>();

        // 预设SendQueryAsync方法的返回结果
        mockGraphQlClient.Setup(client => client.SendQueryAsync<MyResponse>(
                It.IsAny<GraphQLRequest>(), 
                It.IsAny<CancellationToken>()))
            .ReturnsAsync(new GraphQLResponse<MyResponse> { Data = expectedResponse });

        // 初始化待测试的服务
        var serviceUnderTest = new MyGraphQlService(mockGraphQlClient.Object);

        // 执行测试方法
        var result = await serviceUnderTest.FetchTargetDataAsync("{ getTargetData { id name } }");

        // 验证结果是否符合预期
        Assert.AreEqual(expectedResponse.Id, result.Id);
        Assert.AreEqual(expectedResponse.Name, result.Name);
        // 验证方法是否被调用了一次
        mockGraphQlClient.Verify(client => client.SendQueryAsync<MyResponse>(
                It.IsAny<GraphQLRequest>(), 
                It.IsAny<CancellationToken>()), Times.Once);
    }

    [TestMethod]
    public async Task FetchTargetDataAsync_HandlesGraphQLErrors()
    {
        var mockGraphQlClient = new Mock<IGraphQLClient>();
        var testError = new GraphQLError("Failed to fetch data: Invalid query");

        // 预设返回错误的场景
        mockGraphQlClient.Setup(client => client.SendQueryAsync<MyResponse>(
                It.IsAny<GraphQLRequest>(), 
                It.IsAny<CancellationToken>()))
            .ReturnsAsync(new GraphQLResponse<MyResponse> 
            { 
                Errors = new List<GraphQLError> { testError } 
            });

        var serviceUnderTest = new MyGraphQlService(mockGraphQlClient.Object);

        // 执行测试并验证错误处理逻辑（此处根据你的实际处理逻辑调整断言）
        var result = await serviceUnderTest.FetchTargetDataAsync("{ invalidQuery { id } }");
        Assert.IsNull(result);
    }
}

关键注意事项 #

• 不要直接模拟GraphQLHttpClient：它的方法大多不是虚方法，模拟起来非常麻烦，依赖IGraphQLClient接口是官方推荐的可测试性实践。
• 按需扩展模拟场景：除了成功返回数据，还可以模拟超时、网络错误（通过抛出HttpRequestException）、GraphQL校验错误等场景，覆盖更多测试用例。

内容的提问来源于stack exchange，提问作者Dawid Rutkowski