# ASP.NET Core 集成测试指南 ## 核心概念 ### 集成测试的两种定义 **定义一：多物品协作测试** > 将两个以上的类别做整合，并且测试它们之间的兼容性是不正确的，测试案例一定是跨类别对象的 **定义二：外部资源整合测试** > 会使用到外部资源，例如数据库、外部服务、档案、需要对测试环境进行特殊处理等 ###为什么需要集成测试？ * **确保多个模组在整合后兼容，能够正确工作** * ** 单元测试能够底层的整合点** ：路由、中间件、请求/响应管道 * **WebApplication 做了太多的整合和设置，单元测试无法确认全部** * **确认是否完善异常处理，减少更多问题的发生** ### 测试金字塔定位测试类型 | 测试范围 | 执行速度 | 维护成本 | 建议比例 ---|---|---|---|--- 单元 |测试单一类别/方法 | 很快 | 低| 70% 整合测试元件多个 | 地中海 | 地中海 | 20% 端对端测试 | 完整流程 | 慢| 高| 10% ** ** ## 原则一：利用WebApplicationFactory建立测试环境 ###基本使用方式公共类 BasicIntegrationTest ： IClassFixture> { 私有只读 WebApplicationFactory _factory; 公共BasicIntegrationTest（WebApplicationFactory<程序>工厂） { _工厂=工厂； } [事实] 公共异步任务 Get_首页_应回传成功() { // 排列 var client = _factory.CreateClient(); // 行动 var response = wait client.GetAsync("/"); // 断言响应.EnsureSuccessStatusCode(); } } ### 自订WebApplicationFactory 公共类 CustomWebApplicationFactory : WebApplicationFactory 其中 TProgram ：类 { 受保护的覆盖无效ConfigureWebHost（IWebHostBuilder构建器） { 构建器.ConfigureServices（服务=> { // 删除具体的数据库设置 services.RemoveAll(typeof(DbContextOptions)); // 记忆加入体资料库 services.AddDbContext(选项=> { 选项.UseInMemoryDatabase("TestDatabase"); }); // 替换外部服务为测试版本 services.Replace(ServiceDescriptor.Scoped()); }); // 设置测试环境 builder.UseEnvironment(“测试”); } } ** ** ## 原则二：使用 AwesomeAssertions.Web 验证 HTTP 响应 ### HTTP 状态码断言响应.Should().Be200Ok(); // HTTP 200 响应.Should().Be201Created(); // HTTP 201 响应.Should().Be204NoContent(); // HTTP 204 响应.Should().Be400BadRequest(); // HTTP 400 响应.Should().Be404NotFound(); // HTTP 404 响应.Should().Be500InternalServerError(); // HTTP 500 ### 满足强型别验证 [事实] public async Task GetShipper_当货运商存在_应回传成功结果() { // 排列等待 CleanupDatabaseAsync(); var ShipperId = wait SeedShipperAsync("顺丰速运", "02-2345-6789"); // 行动 var response = wait Client.GetAsync($"/api/shippers/{shipperId}"); // 断言响应.Should().Be200Ok() .并且 .满足>(结果=> { result.Status.Should().Be("成功"); result.Data.Should().NotBeNull(); result.Data!.ShipperId.Should().Be(shipperId); result.Data.CompanyName.Should().Be("顺丰速运"); 结果.Data.Phone.Should().Be("02-2345-6789"); }); } ### 与传统方式的比较 // ❌传统方式 - 冗长且容易出错 response.IsSuccessStatusCode.Should().BeTrue(); var content =等待response.Content.ReadAsStringAsync(); var 结果 = JsonSerializer.Deserialize>(内容，新 JsonSerializerOptions { PropertyNameCaseInsensitive = true }); 结果.Should().NotBeNull(); 结果！.Status.Should().Be("成功"); // ✅ 使用 Satisfy - 简洁且绘图响应.Should().Be200Ok() .并且 .满足>(结果=> { result.Status.Should().Be("成功"); result.Data!.CompanyName.Should().Be("测试公司"); }); ** ** ## 原则三：使用 System.Net.Http.Json 简化 JSON 操作 ### PostAsJsonAsync 简化 POST 请求 // ❌传统方式 var createParameter = new ShipperCreateParameter { CompanyName = "测试公司", Phone = "02-1234-5678" }; var jsonContent = JsonSerializer.Serialize(createParameter); var content = new StringContent(jsonContent, Encoding.UTF8, "application/json"); var response = wait client.PostAsync("/api/shippers", content); // ✅ 现代化方式 var createParameter = new ShipperCreateParameter { CompanyName = "测试公司", Phone = "02-1234-5678" }; var response = wait client.PostAsJsonAsync("/api/shippers", createParameter); ### ReadFromJsonAsync 简化响应读取 // ❌传统方式 var responseContent =等待response.Content.ReadAsStringAsync(); var 结果 = JsonSerializer.Deserialize>(responseContent, 新 JsonSerializerOptions { PropertyNameCaseInsensitive = true }); // ✅ 现代化方式 var result =等待response.Content.ReadFromJsonAsync>(); ** ** ## 三个体系的整合测试策略 ### Level 1：简单的WebApi专案 **特色** ： * 没有资料库、服务与 Repository 依赖 * 最简单、基本的WebApi网站专案 * 直接使用 `WebApplicationFactory` 进行测试 **测试重点**： * 各个API的输入输出验证 * HTTP 动作和路由正确性 * 模型绑定和序列化 * 状态码和响应格式验证公共类 BasicApiControllerTests ： IClassFixture> { 私有只读 HttpClient _client；公共BasicApiControllerTests（WebApplicationFactory<程序>工厂） { _client = 工厂.CreateClient(); } [事实] 公共异步任务 GetStatus_应回传OK() { // 行动 var response = wait _client.GetAsync("/api/status"); // 断言响应.Should().Be200Ok(); } } ### Level 2：相依服务的WebApi专案 **特色** ： * 没有资料库，但有服务依赖 * 使用NSubstitute建立服务存根 * 在测试中配置依赖注入公共类 ServiceStubWebApplicationFactory : WebApplicationFactory { 私有只读IExampleService _serviceStub; 公共 ServiceStubWebApplicationFactory(IExampleService serviceStub) { _serviceStub = serviceStub; } 受保护的覆盖无效ConfigureWebHost（IWebHostBuilder构建器） { 构建器.ConfigureTestServices（服务=> { services.RemoveAll(); services.AddScoped(_ => _serviceStub); }); } } 公共类 ServiceDependentControllerTests { [事实] 公共异步任务 GetData_应回传服务资料() { // 排列 var serviceStub = Substitute.For(); serviceStub.GetDataAsync().Returns("测试数据"); var 工厂 = new ServiceStubWebApplicationFactory(serviceStub); var client = factory.CreateClient(); // 行动 var response = wait client.GetAsync("/api/data"); // 断言响应.Should().Be200Ok(); } } ### Level 3：完整的WebApi专案 **特色** ： * 完整的解决方案架构 * 包含真实的数据库操作 * 使用InMemory或真实测试资料库公共类 FullDatabaseWebApplicationFactory : WebApplicationFactory { 受保护的覆盖无效ConfigureWebHost（IWebHostBuilder构建器） { 构建器.ConfigureServices（服务=> { // 删除具体的数据库设置 var 描述符 = services.SingleOrDefault( d => d.ServiceType == typeof(DbContextOptions)); if（描述符！= null） { services.Remove(描述符); } // 记忆加入体资料库 services.AddDbContext(选项=> { 选项.UseInMemoryDatabase("TestDatabase"); }); // 建立资料库并加入测试资料 var serviceProvider = services.BuildServiceProvider(); 使用 varscope = serviceProvider.CreateScope(); var context =scope.ServiceProvider.GetRequiredService(); context.Database.EnsureCreated(); }); } } ** ** ## 测试类别模式 ### 建立可重用的测试主题类别公共抽象类 IntegrationTestBase ：IDisposable { 受保护的只读 CustomWebApplicationFactory 工厂；受保护的只读 HttpClient 客户端；受保护的集成测试库() { 工厂=新的CustomWebApplicationFactory(); 客户端 = Factory.CreateClient(); } 受保护的异步任务 SeedShipperAsync（字符串公司名称，字符串电话 =“02-12345678”） { 使用 varscope = Factory.Services.CreateScope(); var context =scope.ServiceProvider.GetRequiredService(); var 发货人 = 新发货人 { 公司名称 = 公司名称, 电话=电话，创建时间 = DateTime.UtcNow }; context.Shippers.Add(发货人); 等待 context.SaveChangesAsync(); 返回托运人.ShipperId; } 受保护的异步任务 CleanupDatabaseAsync() { 使用 varscope = Factory.Services.CreateScope(); var context =scope.ServiceProvider.GetRequiredService(); context.Shippers.RemoveRange(context.Shippers); 等待 context.SaveChangesAsync(); } 公共无效处置（） { 客户端？.Dispose(); 工厂？.Dispose(); } } ** ** ## CRUD 操作测试示例完整的 CRUD 操作测试代码（GET、POST、验证错误、集合查询）请参考 **[CRUD 操作测试完整示例]()** ** ** ## 专案结构建议测试/ ├── Sample.WebApplication.UnitTests/ # 单元测试 ├── Sample.WebApplication.Integration.Tests/ # 集成测试 │ ├── Controllers/ # 控制器集成测试 │ │ └── ShippersControllerTests.cs │ ├── 基础设施/ # 测试基础设施 │ │ └── CustomWebApplicationFactory.cs │ ├── IntegrationTestBase.cs # 测试焦点类别 │ └── GlobalUsings.cs └── Sample.WebApplication.E2ETests/ # 端对端测试 ** ** ## 套件相关故障排除 ### 常见错误 error CS1061: 'ObjectAssertions' 未包含 'Be200Ok' 的定义 ### 解决方案基础断言库 | 正确的套件 ---|--- FluentAssertions < 8.0.0 | FluentAssertions.Web FluentAssertions >= 8.0.0 | FluentAssertions.Web.v8 AwesomeAssertions >= 8.0.0 | AwesomeAsserts.Web ** ** ## 最佳实践 ### 要做的 1. **独立测试专案**：集成测试专案应与单元测试分离 2. **測試資料隔離** ：每個測試案例有獨立的資料準備和清理 3. **使用基底類別** ：共用的設定和輔助方法放在基底類別 4. **明確的命名** ：使用三段式命名法（方法_情境_預期） 5. **適當的測試範圍** ：專注於整合點，不要過度測試 ### 應該避免的 1. **混合測試類型** ：不要將單元測試和整合測試放在同一專案 2. **測試相依性** ：每個測試應該獨立，不依賴其他測試的執行順序 3. **過度模擬** ：整合測試應該盡量使用真實的元件 4. **忽略清理** ：測試完成後要清理測試資料 5. **硬編碼資料** ：使用工廠方法或 Builder 模式建立測試資料 * * * ## 相關技能 * `unit-test-fundamentals` \- 單元測試基礎 * `nsubstitute-mocking` \- 使用 NSubstitute 進行模擬 * `awesome-assertions-guide` \- AwesomeAssertions 流暢斷言 * `testcontainers-database` \- 使用 Testcontainers 進行容器化資料庫測試 * * * ## 輸出格式 * 產生 `CustomWebApplicationFactory.cs`，配置測試用 DI 容器與資料庫替換 * 產生 `IntegrationTestBase.cs` 測試基底類別，包含資料準備與清理方法 * 產生控制器測試類別（`*ControllerTests.cs`），涵蓋 CRUD 操作驗證 * 修改測試專案 `.csproj`，加入 `Microsoft.AspNetCore.Mvc.Testing` 與 `AwesomeAssertions.Web` * 確保主專案 `Program.cs` 包含 `public partial class Program { }` 以支援測試存取 ## 參考資源 ### 原始文章本技能內容提煉自「老派軟體工程師的測試修練 - 30 天挑戰」系列文章： * **Day 19 - 整合測試入門：基礎架構與應用場景** * 鐵人賽文章： * 範例程式碼： ### 官方文件 * [ASP.NET Core 整合測試文件]() * [WebApplicationFactory 使用指南]() * [AwesomeAssertions.Web GitHub]() * [AwesomeAssertions.Web NuGet]()

Dotnet 测试 高级 Aspnet 集成测试

包含技能

Dotnet 测试高级 Aspnet 集成测试