.NET 8中如何用WebApplicationFactory编写ASP.NET Core gRPC功能测试？

1. 确保主项目的Program类可访问 #

默认情况下，.NET 6+的Program类是内部（internal）的，测试项目无法直接引用。在主项目的Program.cs末尾添加以下代码，将其改为公开（public）的部分类：

public partial class Program { }

2. 创建自定义WebApplicationFactory #

继承WebApplicationFactory<Program>，在这里可以自定义测试环境的配置、替换依赖服务等：

public class GrpcWebApplicationFactory : WebApplicationFactory<Program>
{
    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        // 配置测试环境，比如替换数据库为内存版本、修改配置项
        builder.ConfigureServices(services =>
        {
            // 示例：移除默认数据库上下文并添加内存版本
            // var dbDescriptor = services.SingleOrDefault(d => d.ServiceType == typeof(DbContextOptions<AppDbContext>));
            // if (dbDescriptor != null) services.Remove(dbDescriptor);
            // services.AddDbContext<AppDbContext>(options => options.UseInMemoryDatabase("GrpcTestDb"));
        });

        // 指定测试环境
        builder.UseEnvironment("Testing");
    }
}

3. 编写gRPC测试用例 #

在测试类中，通过GrpcWebApplicationFactory创建gRPC客户端，连接到测试服务器执行测试：

public class GrpcServiceTests : IClassFixture<GrpcWebApplicationFactory>
{
    private readonly GrpcWebApplicationFactory _factory;

    public GrpcServiceTests(GrpcWebApplicationFactory factory)
    {
        _factory = factory;
    }

    [Fact]
    public async Task SayHello_ReturnsGreetingMessage()
    {
        // 创建gRPC通道
        var channel = GrpcChannel.ForAddress(_factory.Server.BaseAddress, new GrpcChannelOptions
        {
            HttpClient = _factory.CreateClient()
        });

        // 实例化你的gRPC客户端（替换为实际生成的客户端类）
        var client = new Greeter.GreeterClient(channel);

        // 调用gRPC方法
        var response = await client.SayHelloAsync(new HelloRequest { Name = "TestUser" });

        // 断言结果符合预期
        Assert.Equal("Hello TestUser", response.Message);
    }
}

所需NuGet包 #

确保测试项目安装以下依赖包：

• Microsoft.AspNetCore.Mvc.Testing：提供WebApplicationFactory核心功能
• Grpc.Net.Client：gRPC客户端通信库
• Google.Protobuf：Protobuf序列化/反序列化支持
• Grpc.AspNetCore：ASP.NET Core gRPC集成支持

关键说明 #

• 该方案完全适配.NET 8的WebApplication.CreateBuilder范式，无需依赖已弃用的Startup类。
• WebApplicationFactory会启动真实的测试服务器，模拟生产环境的请求流程，保证测试的真实性。
• 通过ConfigureWebHost方法可以灵活隔离测试环境，比如替换第三方依赖、修改配置，避免测试污染生产数据。

内容的提问来源于stack exchange，提问作者Jonathan Websdale