TestContainers-DotNet 在 ASP.NET Core 集成测试中的实践指南-优快云博客

TestContainers-DotNet 在 ASP.NET Core 集成测试中的实践指南

testcontainers-dotnet A library to support tests with throwaway instances of Docker containers for all compatible .NET Standard versions. 项目地址: https://gitcode.com/gh_mirrors/te/testcontainers-dotnet

前言

在现代软件开发中，集成测试是确保系统各组件协同工作的重要环节。对于 ASP.NET Core 应用程序来说，测试常常需要依赖数据库、消息队列等外部服务。TestContainers-DotNet 提供了一种优雅的解决方案，它允许我们在 Docker 容器中运行这些依赖服务，使测试环境更加接近生产环境。

TestContainers-DotNet 简介

TestContainers-DotNet 是一个 .NET 库，它基于 Docker 容器技术，能够在测试过程中轻松启动和管理各种依赖服务。主要优势包括：

测试环境一致性：所有依赖都在容器中运行，确保测试环境一致
快速启动：容器启动速度快，适合频繁运行的测试
隔离性：每个测试可以拥有独立的容器实例，避免测试间相互影响
资源管理：测试完成后自动清理容器资源

与 ASP.NET Core 测试框架集成

使用 WebApplicationFactory

ASP.NET Core 提供了 WebApplicationFactory<TEntryPoint> 类，专门用于集成测试。我们可以通过多种方式将 TestContainers 与它结合使用。

基础配置方式

最简单的集成方式是在创建 TestServer 前覆盖应用程序的配置部分：

private sealed class CustomWebApplicationFactory : WebApplicationFactory<Program>
{
  protected override void ConfigureWebHost(IWebHostBuilder builder)
  {
    builder.UseSetting("ConnectionStrings:RedisCache", _redisContainer.GetConnectionString());
  }
}

这种方式需要手动预先启动依赖服务，适合简单的测试场景。

高级配置方式

更复杂的场景可以实现 IConfigurationSource 接口，自动管理依赖服务的生命周期：

private sealed class CustomWebApplicationFactory : WebApplicationFactory<Program>
{
  protected override void ConfigureWebHost(IWebHostBuilder builder)
  {
    builder.ConfigureAppConfiguration(configure =>
    {
      configure.Add(new RedisConfigurationSource());
    });
  }
}

这种方式会自动启动依赖服务，并在配置加载时设置连接字符串，适合需要自动管理依赖的场景。

实战案例：天气预报应用测试

让我们通过一个天气预报应用的测试案例，展示 TestContainers-DotNet 的实际应用。

环境准备

首先添加必要的 NuGet 包：

dotnet add package Testcontainers.MsSql --version 3.0.0

注意：在 Apple Silicon 芯片的 Mac 上运行时，需要确保使用 Docker Desktop for macOS 4.16 或更高版本，并启用 Virtualization Framework 和 Rosetta 2 支持。

容器配置

以下是配置天气预报应用及其依赖的代码：

const string weatherForecastStorage = "weatherForecastStorage";
const string connectionString = $"server={weatherForecastStorage};user id={MsSqlBuilder.DefaultUsername};password={MsSqlBuilder.DefaultPassword};database={MsSqlBuilder.DefaultDatabase}";

_weatherForecastNetwork = new NetworkBuilder().Build();

_msSqlContainer = new MsSqlBuilder()
  .WithNetwork(_weatherForecastNetwork)
  .WithNetworkAliases(weatherForecastStorage)
  .Build();

_weatherForecastContainer = new ContainerBuilder()
  .WithImage(Image)
  .WithNetwork(_weatherForecastNetwork)
  .WithPortBinding(WeatherForecastImage.HttpsPort, true)
  .WithEnvironment("ASPNETCORE_URLS", "https://+")
  .WithEnvironment("ASPNETCORE_Kestrel__Certificates__Default__Path", WeatherForecastImage.CertificateFilePath)
  .WithEnvironment("ASPNETCORE_Kestrel__Certificates__Default__Password", WeatherForecastImage.CertificatePassword)
  .WithEnvironment("ConnectionStrings__DefaultConnection", connectionString)
  .WithWaitStrategy(Wait.ForUnixContainer().UntilPortIsAvailable(WeatherForecastImage.HttpsPort))
  .Build();

这段代码完成了以下工作：

创建专用 Docker 网络
配置 SQL Server 容器
配置应用容器，包括端口绑定、环境变量等

测试生命周期管理

使用 xUnit 的 IAsyncLifetime 接口管理容器生命周期：

await Image.InitializeAsync();
await _weatherForecastNetwork.CreateAsync();
await _msSqlContainer.StartAsync();
await _weatherForecastContainer.StartAsync();

测试类可以通过构造函数注入容器实例，每个测试集合都会创建独立的容器环境。

测试执行

容器启动后，测试可以发送 HTTP 请求验证应用行为：

[Fact]
public async Task GetWeatherForecastReturnsSuccessStatusCode()
{
    var httpClient = _weatherForecastContainer.GetHttpClient();
    var response = await httpClient.GetAsync("/weatherforecast");
    Assert.Equal(HttpStatusCode.OK, response.StatusCode);
}

测试策略选择

TestContainers-DotNet 支持两种主要测试策略：

进程外测试：完整容器化运行应用，适合端到端测试
进程内测试：使用 WebApplicationFactory 运行应用，TestContainers 只管理依赖服务，适合快速迭代

进程内测试启动更快，适合开发过程中的频繁测试；进程外测试更接近生产环境，适合 CI/CD 流程。

最佳实践

资源复用：对于重量级依赖，考虑使用 xUnit 的集合夹具共享容器实例
网络隔离：为每个测试环境创建独立网络，避免端口冲突
等待策略：配置合理的容器等待策略，确保依赖服务完全启动
资源清理：利用测试框架的生命周期钩子确保资源释放
日志收集：配置容器日志输出，便于调试失败的测试

结语

TestContainers-DotNet 为 ASP.NET Core 应用的集成测试提供了强大而灵活的工具。通过容器化依赖服务，开发者可以构建更加可靠、可重复的测试环境，显著提高软件质量。无论是简单的单元测试还是复杂的端到端测试，TestContainers-DotNet 都能提供合适的解决方案。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考