# .NET Aspire 测试集成测试框架 ## 前置需求 * .NET 8 SDK 或更高版本 * Docker 桌面（WSL 2 或 Hyper-V） * AppHost专案（.NET Aspire应用编排） ## 核心概念 ### .NET Aspire 测试定位 **.NET Aspire Test是封闭式集成测试框架**，专为分散式应用设计： * 在测试中重新设置与正式环境相同的服务架构 * 使用真实容器模拟服务 * 自动管理容器生命周期 ### AppHost 专案的必要性使用 .NET Aspire 测试必须建立 AppHost 专案： *定义完整的应用架构和容器编排 * 重新测试使用 AppHost 配置建立的环境 * 没有AppHost就无法使用Aspire Test ### 与 Testcontainers 的差异特性 | .NET Aspire 测试 |测试容器 ---|---|--- 设计目标 | 云原生分散式应用| 通用容器测试配置方式 | AppHost 定义式定义 | 程序码手动配置服务编排 | 自动处理 | 手动管理学习圆形| 上面 | 中等适用场景 | 已用 Aspire 的专案 | 传统Web API ## 专案结构我的应用程序/ ├── src/ │ ├── MyApp.Api/ # WebApi 层 │ ├── MyApp.Application/ #应用服务层 │ ├── MyApp.Domain/ # 领域模型 │ └── MyApp.Infrastruct/ # 基础设施层 ├── MyApp.AppHost/ # Aspire 编排专案 ⭐ │ ├── MyApp.AppHost.csproj │ └── 程序.cs └── 测试/ └── MyApp.Tests.Integration/ # Aspire 测试集成测试 ├── MyApp.Tests.Integration.csproj ├── 基础设施/ │ ├── AspireAppFixture.cs │ ├── IntegrationTestCollection.cs │ ├── IntegrationTestBase.cs │ └── 数据库管理器.cs └── 控制器/ └── MyControllerTests.cs ## 必要套件 ### AppHost 专案 <项目Sdk =“Microsoft.NET.Sdk”> <属性组> <输出类型>Exe net9.0 true <项目组> <项目组> ### 测试专案 <项目Sdk =“Microsoft.NET.Sdk”> <属性组> net9.0 true <项目组> <项目组> ## 容器生命周期管理使用 `ContainerLifetime.Session` 确保测试资源自动清理： var postgres = builder.AddPostgres("postgres") .WithLifetime(ContainerLifetime.Session); var redis = builder.AddRedis("redis") .WithLifetime(ContainerLifetime.Session); * **Session** ：测试会话结束后自动清理（推荐） * **持久** ：容器持续运行，需手动清理 ## 等待服务就绪容器启动与服务就绪是两个阶段，需要等待机制：私有异步任务 WaitForPostgreSqlReadyAsync() { 常量 int 最大重试次数 = 30; const int 延迟Ms = 1000; for (int i = 0; i < maxRetries; i++) { 尝试 { var 连接字符串 = 等待 GetConnectionStringAsync(); 等待使用 var 连接 = new NpgsqlConnection(connectionString); 等待连接.OpenAsync(); 返回; } 当 (i < maxRetries - 1) 时捕获（异常 ex） { 等待任务.Delay(delayMs); } } throw new InvalidOperationException("PostgreSQL 服务失败"); } ## 资料库初始化 Aspire启动容器但不自动建立资料库：私有异步任务 EnsureDatabaseExistsAsync(string connectionString) { var builder = new NpgsqlConnectionStringBuilder(connectionString); var 数据库名称 = builder.Database; 数据库=“postgres”; // 连接到预设资料库等待使用 var 连接 = new NpgsqlConnection(builder.ToString()); 等待连接.OpenAsync(); var checkDbQuery = $"从 pg_database 中选择 1，其中 datname = '{databaseName}'"; var dbExists = 等待新的 NpgsqlCommand(checkDbQuery, 连接).ExecuteScalarAsync(); if (dbExists == null) { 等待新的 NpgsqlCommand($"CREATE DATABASE \"{databaseName}\"", 连接) .ExecuteNonQueryAsync(); } } ## 重生配置使用 PostgreSQL 时必须指定设备： _respawner =等待Respawner.CreateAsync（连接，新的RespawnerOptions { TablesToIgnore = new Table[] { "__EFMigrationsHistory" }, SchemasToInclude = new[] { "public" }, DbAdapter = DbAdapter.Postgres // 关键！ }); ## 采集夹具最佳实践避免每个测试类别重复启动容器： [集合定义（“集成测试”）] 公共类 IntegrationTestCollection ： ICollectionFixture { } [集合（“集成测试”）] 公共类 MyControllerTests ：IntegrationTestBase { 公共 MyControllerTests(AspireAppFixture 固定装置) : 基础(固定装置) { } } ## 可测试性时间使用 `TimeProvider` 抽象化时间依赖： // 服务实作公共产品服务类 { 私有只读TimeProvider _timeProvider；公共 ProductService(TimeProvider timeProvider) { _timeProvider = 时间提供者； } 公共异步任务<产品> CreateAsync（ProductCreateRequest请求） { var now = _timeProvider.GetUtcNow(); var 产品 = 新产品 { 创建时间 = 现在，更新时间 = 现在 }; // ... } } // DI 注册 builder.Services.AddSingleton(TimeProvider.System); ## 选择建议 ### 选择.NET Aspire 测试 * 专案已使用 .NET Aspire * 需要测试多服务互动 * 重视统一的开发体验 * 云应用架构 ### 选择测试容器 * 传统.NET专案 *需要精细的容器控制 * 与非 .NET 服务集成 * 团队对Aspire不熟悉 ## 常见问题 ### 端点配置冲突不要手动配置已由 Aspire 自动处理的端点： // ❌ 错误：会造成冲突 builder.AddProject("my-api") .WithHttpEndpoint(端口：8080，名称：“http”); // ✅ 正确：让 Aspire 自动处理 builder.AddProject("my-api") .WithReference(postgresDb) .WithReference(redis); ### Dapper 栏位映射 PostgreSQL Snake_case 与 C# PascalCase 的映射： // 在 Program.cs 初始化 DapperTypeMapping.Initialize(); // 或使用 SQL 别名常量字符串 sql = @" 选择 ID、名称、价格、创建时间 AS 创建时间，更新时间 AS 更新时间来自产品”； ## 输出格式 * 产生AppHost专案的`Program.cs`，定义容器编排与服务参考 * 产生测试基础设施文件：`AspireAppFixture.cs`、`IntegrationTestCollection.cs`、`IntegrationTestBase.cs` * 产生 `DatabaseManager.cs` 处理资料库初始化与 Respawn 清理 * 产生控制器测试类别（`*ControllerTests.cs`），继承`IntegrationTestBase` * 修改测试专案 `.csproj`，加入 Aspire.Hosting.Testing 及相关套件参考 ## 参考资源 ### 原始文章本技能内容提炼自「老派软体工程师的测试修练 - 30天挑战」系列文章： * **第 24 天 - .NET Aspire 测试入门基础介绍** * 铁人赛文章： * 示例程序代码： * **第 25 天 - .NET Aspire 集成测试实战：从 Testcontainers 到 .NET Aspire 测试** * 铁人赛文章： * 示例程序代码： ### 官方文件 * [.NET Aspire 官方文件]() * [Aspire 测试文件]() ### 范例文件请参考同目录下的样本档案： * `templates/apphost-program.cs` \- AppHost 编排定义 * `templates/aspire-app-fixture.cs` \- 测试基础设施 * `templates/integration-test-collection.cs` \- Collection Fixture 设置 * `templates/integration-test-base.cs` \- 测试参数类别 * `templates/database-manager.cs` \- 资料库管理员 * `templates/controller-tests.cs` \- 控制器测试示例 * `templates/test-project.csproj` \- 测试专案设置 * `templates/apphost-project.csproj` \- AppHost 专案设置 ### 相关技能 * `dotnet-testing-advanced-testcontainers-database` \- Testcontainers 资料库测试 * `dotnet-testing-advanced-testcontainers-nosql` \- Testcontainers NoSQL 测试 * `dotnet-testing-advanced-webapi-integration-testing` \- 完整的 WebAPI 集成测试

Dotnet 测试高级 Aspire 测试

包含技能