FastEndpoints项目中使用TestContainers进行集成测试的最佳实践

在FastEndpoints框架中进行集成测试时，TestContainers是一个非常实用的工具，它允许我们在测试环境中使用真实的数据库引擎。本文将详细介绍如何在FastEndpoints项目中结合TestContainers进行高效的集成测试。

为什么选择TestContainers

TestContainers是一个支持多种数据库容器的测试库，它能够在测试期间启动和管理Docker容器。与内存数据库相比，使用真实数据库引擎进行测试有以下优势：

1. 测试环境更接近生产环境
2. 可以测试特定数据库的特性
3. 避免内存数据库与实际数据库行为不一致的问题

实现方案

在FastEndpoints的AppFixture中使用TestContainers需要特别注意初始化顺序。以下是实现的关键步骤：

1. 容器初始化

在PreSetupAsync方法中初始化数据库容器是最佳选择，因为这个阶段服务集合尚未构建，可以安全地进行容器启动和数据库准备：

protected override async Task PreSetupAsync()
{
    postgreSqlContainer = new PostgreSqlBuilder()
        .WithImage("postgres:16")
        .WithDatabase("mydb")
        .WithUsername("user")
        .WithPassword("password")
        .Build();

    await postgreSqlContainer.StartAsync();
}

2. 数据库迁移

由于在PreSetupAsync阶段服务集合尚未构建，我们需要创建一个临时的服务提供者来执行数据库迁移：

var serviceCollection = new ServiceCollection();
serviceCollection.AddMyDbContext(); // 自定义的DbContext注册方法

using (var serviceProvider = serviceCollection.BuildServiceProvider())
{
    using (var dbContext = serviceProvider.GetRequiredService<MyDbContext>())
    {
        await tenantDbContext.Database.MigrateAsync();
        // 可在此处添加测试数据
    }
}

3. 配置应用

在ConfigureApp方法中，我们可以配置应用程序使用TestContainer提供的数据库连接：

protected override void ConfigureApp(IWebHostBuilder app)
{
    app.ConfigureTestServices(services => 
    {
        services.RemoveDbContext<MyDbContext>();
        services.AddDbContext<MyDbContext>(options => 
            options.UseSqlServer(connectionString));
    });
}

最佳实践建议

1. 环境变量配置：将连接字符串存储在环境变量中，便于在不同环境间保持一致
2. 并行测试：确保数据库名称唯一，避免并行测试时的冲突
3. 资源清理：在TearDownAsync中正确释放容器资源
4. 数据隔离：考虑为每个测试用例使用独立的数据集或事务

完整示例

以下是PostgreSQL的完整实现示例：

public class TestFixture : AppFixture<Program>
{
    private PostgreSqlContainer? postgreSqlContainer;

    protected override async Task PreSetupAsync()
    {
        postgreSqlContainer = new PostgreSqlBuilder()
            .WithImage("postgres:16")
            .WithDatabase(Guid.NewGuid().ToString()) // 确保唯一性
            .WithUsername("user")
            .WithPassword("password")
            .Build();

        await postgreSqlContainer.StartAsync();
        
        Environment.SetEnvironmentVariable("DB_CONNECTION_STRING", 
            postgreSqlContainer.GetConnectionString());

        var services = new ServiceCollection();
        services.AddMyDbContext();
        
        using var provider = services.BuildServiceProvider();
        using var context = provider.GetRequiredService<MyDbContext>();
        await context.Database.MigrateAsync();
    }

    protected override async Task TearDownAsync()
    {
        if (postgreSqlContainer != null)
            await postgreSqlContainer.DisposeAsync();
    }
}

通过这种方式，我们可以在FastEndpoints项目中实现高效、可靠的集成测试，确保测试环境与生产环境高度一致，提高测试的可靠性和价值。