實戰指南：使用 xUnit 和 ASP.NET Core 進行集成測試【完整教程】

引言集成測試可在包含應用支持基礎結構（如資料庫、文件系統和網路）的級別上確保應用組件功能正常。 ASP.NET Core 通過將單元測試框架與測試 Web 主機和記憶體中測試伺服器結合使用來支持集成測試。簡介集成測試與單元測試相比，能夠在更廣泛的級別上評估應用的組件，確認多個組件一起工作以生成預 ...

引言

集成測試可在包含應用支持基礎結構（如資料庫、文件系統和網路）的級別上確保應用組件功能正常。 ASP.NET Core 通過將單元測試框架與測試 Web 主機和記憶體中測試伺服器結合使用來支持集成測試。

簡介

集成測試與單元測試相比，能夠在更廣泛的級別上評估應用的組件，確認多個組件一起工作以生成預期結果，包括資料庫、文件系統、網路設備等組件。單元測試主要用於測試獨立軟體組件，如類方法，通常使用 fake 或 mock 對象。集成測試使用實際組件，需要更多代碼和數據處理，運行時間更長。建議將集成測試限制在重要的基礎結構方案上，若可用單元測試或集成測試測試行為，優先選擇單元測試。集成測試中被測試的項目通常稱為"SUT"，用於指代要測試的應用。避免為每種資料庫和文件系統交互排列編寫集成測試，而是通過一組集中式讀取、寫入、更新和刪除集成測試充分測試這些組件，使用單元測試測試與這些組件交互的方法邏輯，使用 fake 或 mock 對象可加快測試速度。

集成測試實戰

我們在之前的章節中創建了Sample.Api和Sample.Repository的項目，現在我們對這個項目進行整體的集成測試，帶大家來感受一下。

ASP.NET Core 中的集成測試需要以下內容：

測試項目用於包含和執行測試。測試項目具有對 SUT 的引用。
測試項目為 SUT 創建測試Web主機，並使用測試伺服器客戶端處理 SUT 的請求和響應。
測試運行程式用於執行測試並報告測試結果。

集成測試後跟一系列事件，包括常規“排列”、“操作”和“斷言”測試步驟：

已配置 SUT 的 Web 主機。
創建測試伺服器客戶端以嚮應用提交請求。
執行“排列”測試步驟：測試應用會準備請求。
執行“操作”`測試步驟：客戶端提交請求並接收響應。
執行“斷言”測試步驟：實際響應基於預期響應驗證為通過或失敗。
該過程會一直繼續，直到執行了所有測試。
報告測試結果。

上面解釋到了集成測試中被測試的項目通常稱為SUT。我們要測試的項目Sample.Api既是我們的SUT。

好了我們開始創建xUnit的單元測試項目,並添加Sample.Api的項目引用.

集成測試第一步

在我們的單元測試項目中安裝Nuget依賴

PM> NuGet\Install-Package Microsoft.AspNetCore.Mvc.Testing -Version 8.0.4

基礎結構組件（如測試 Web 主機和記憶體中測試伺服器 (TestServer)）由 Microsoft.AspNetCore.Mvc.Testing 包提供或管理。使用此包可簡化測試創建和執行。

Microsoft.AspNetCore.Mvc.Testing 包處理以下任務：

將依賴項文件 (.deps) 從 SUT 複製到測試項目的 bin目錄中。
將內容根目錄設置為 SUT 的項目根目錄，以便可在執行測試時找到靜態文件和頁面/視圖。
提供 WebApplicationFactory 類，以簡化 SUT 在 TestServer 中的啟動過程。

概念有點多，後續裡面的概念會慢慢講到。

我們知道Asp.Net Core的Web項目項目是藉助Kestrel啟動,用集成測試的TestServer正是代替了Kestrel托管服務的啟動，那我們要測試的項目就不需要單獨被啟動了。

什麼是TestServer?

TestServer 用於在集成測試中模擬和啟動應用程式的主機環境。通過創建 TestServer 實例，可以在測試中模擬出一個運行中的應用程式實例，以便進行端到端的集成測試。

在Microsoft.AspNetCore.Mvc.Testing中已經預設集成了對TestServer的支持所以，不需要額外進行配置。

SUT 環境?

如果未設置 SUT 的環境，則環境會預設為開發環境即 Development。

向測試項目公開啟動類`Program`

使用 WebApplicationFactory<TEntryPoint> 創建 TestServer以進行集成測試。 TEntryPoint 是 SUT 的入口點類，通常是 Program.cs。

有兩種向測試項目公開 Program 的方法

在Program.cs添加部分類

  var builder = WebApplication.CreateBuilder(args);
  // ... Configure services, routes, etc.
  app.Run();
  + public partial class Program { }

配置MSBuild
在SUT的csproj文件下添加

	<ItemGroup>
		<Using Include="Sample.Api" />
		<InternalsVisibleTo Include="dotNetParadise.IntegrationTest" />
	</ItemGroup>

<Using Include="Sample.Api" />：這個子元素指定了要在項目中使用的命名空間或程式集。在這裡，Sample.Api 被包含在項目中，以便項目可以訪問和使用該命名空間或程式集中的內容。
<InternalsVisibleTo Include="dotNetParadise.IntegrationTest" />：這個子元素用於將內部可見性（InternalsVisibleTo）屬性應用於項目，允許指定的程式集（在這裡是 dotNetParadise.IntegrationTest）訪問項目中的內部成員。這在單元測試或集成測試中非常有用，因為測試項目通常需要訪問被測試項目的內部成員以進行更全面的測試。

相對來說更推薦使用第一種部分類的形式來對測試項目公開。

`WebApplicationFactory`

可以使用預設的WebApplicationFactory和自定義的WebApplicationFactory來進行集成測試

測試類實現一個類固定常式介面 (IClassFixture)，以指示類包含測試，併在類中的所有測試間提供共用對象實例。

來感受一下

使用預設 WebApplicationFactory 的基本測試

看一下如何使用

public class DefaultWebApplicationFactoryTest : IClassFixture<WebApplicationFactory<Program>>
{
    private readonly WebApplicationFactory<Program> _factory;

    public DefaultWebApplicationFactoryTest(WebApplicationFactory<Program> factory)
    {
        _factory = factory;
    }

    [Fact]
    public async Task GetAll_Query_ReturnOkAndListStaff()
    {
        //Arrange
        var httpClient = _factory.CreateClient();
        //act
        var response = await httpClient.GetAsync("/api/Staff");
        //Assert
        //校驗狀態碼
        Assert.Equal(HttpStatusCode.OK, response.StatusCode);
        //校驗用戶
        var users = await response.Content.ReadFromJsonAsync<List<Staff>>();
        Assert.NotNull(users);
    }

    [Fact]
    public async Task GetConfig_WhenCalled_ReturnOk() {
        //Arrange
        var httpClient = _factory.CreateClient();
        //act
        var response = await httpClient.GetAsync("/GetConfig");
        //Assert
        //校驗狀態碼
        Assert.Equal(HttpStatusCode.OK, response.StatusCode);
        //校驗用戶
        var config = await response.Content.ReadFromJsonAsync<string>();
        Assert.NotNull(config);
    }
}

看到我們的測試類繼承了IClassFixture來共用實例對象，並且泛型類型是預設的WebApplicationFactory<Program>

接下來在我們的SUT即Sample.Api的program中打個斷點來驗證一下

看到了我們測試時預設的 WebApplicationFactory 使用預設配置啟動應用程式主機，包括載入 appsettings.json 等配置文件。

在我們的appsettings.Development.json中加了一個配置

{
  "Config": "這裡是appsettings.Development.json"
}

GetConfig_WhenCalled_ReturnOk 測試方法看下結果

正確的讀到appsettings.Development.json的內容了，從而可以得出我們上面的結論，如果未設置 SUT 的環境，則環境會預設為開發環境即 Development。

從上面我們看到我們向SUT發請求是調用的CreateClient()：
CreateClient() 方法用於創建一個 HttpClient 實例，用於模擬客戶端與 SUT 進行交互。通過這個 HttpClient，測試代碼可以發送 HTTP 請求到應用程式，並驗證應用程式的響應。

總的來說預設的 WebApplicationFactory 提供了一種快速啟動應用程式主機進行集成測試的方式，適用於簡單的測試場景。

自定義 WebApplicationFactory

通過從 WebApplicationFactory<TEntryPoint> 來創建一個或多個自定義工廠，可以獨立於測試類創建 Web 主機配置

我們來創建一個SampleApiWebAppFactory的類，然後繼承WebApplicationFactory<Program>

public class SampleApiWebAppFactory : WebApplicationFactory<Program>
{
    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {

        builder.ConfigureServices((context, services) =>
        {

        });
        builder.UseEnvironment("Production");
        base.ConfigureWebHost(builder);
    }

    public HttpClient Client()
    {
        return CreateDefaultClient();
    }
}

裡面有Asp.Net Core 啟動項配置，我們都可以在自定義的SampleApiWebAppFactory進行重寫，自定義的 WebApplicationFactory 提供了一種靈活的方式來定製化應用程式主機的配置，並擴展功能以滿足特定的測試需求。通過繼承並重寫 ConfigureWebHost 方法等，開發人員可以對應用程式主機進行自定義配置，包括添加新的服務、中間件或修改預設配置，從而在測試環境中模擬特定的場景或功能。

優勢和功能擴展：

定製化配置： 自定義的 WebApplicationFactory 允許開發人員根據測試需求添加自定義配置，比如測試環境特定的服務、中間件或其他設置，以確保測試環境與實際生產環境保持一致或滿足特定測試需求。
功能擴展： 通過重寫 ConfigureWebHost 方法，開發人員可以擴展應用程式主機的功能，例如註冊額外的服務、修改中間件管道、添加測試專用的配置等，從而更好地適應測試場景。

複雜性和維護：

定製化代碼量增加： 自定義的 WebApplicationFactory 可能會包含更多的定製化代碼，需要更多的理解和維護，但這樣可以更好地控制應用程式主機的配置和功能。
更高的靈活性： 雖然需要更多的理解和維護，但自定義的 WebApplicationFactory 提供了更大的靈活性和定製性，可以滿足更複雜的測試需求，並確保測試環境的準確性和一致性。

總的來說，通過自定義的 WebApplicationFactory，開發人員可以根據具體的測試場景和需求定製化配置和功能，以確保在集成測試中能夠模擬真實的應用程式環境，併進行更全面和準確的測試。這種方式允許開發人員更好地控制應用程式主機的設置，以適應不同的測試需求和場景。

SUT 的資料庫上下文在 Program.cs 中註冊。測試應用的 builder.ConfigureServices 回調在執行應用的 Program.cs 代碼之後執行。若要將與應用資料庫不同的資料庫用於測試，必須在 builder.ConfigureServices 中替換應用的資料庫上下文。

builder.ConfigureServices((context, services) =>
{
    var descriptor = new ServiceDescriptor(
        typeof(DbContextOptions<SampleDbContext>),
        serviceProvider => DbContextFactory<SampleDbContext>(serviceProvider, (sp, o) =>
        {
            o.UseInMemoryDatabase("TestDB");
        }),
         ServiceLifetime.Scoped);

    services.Replace(descriptor);
});

上面用到的DbContextFactory方法

    private static DbContextOptions<TContext> DbContextFactory<TContext>(IServiceProvider applicationServiceProvider,
      Action<IServiceProvider, DbContextOptionsBuilder> optionsAction)
      where TContext : DbContext
    {
        var builder = new DbContextOptionsBuilder<TContext>(
            new DbContextOptions<TContext>(new Dictionary<Type, IDbContextOptionsExtension>()));

        builder.UseApplicationServiceProvider(applicationServiceProvider);

        optionsAction?.Invoke(applicationServiceProvider, builder);

        return builder.Options;
    }

來寫個集成測試

public class SampleApiTest(SampleApiWebAppFactory factory) : IClassFixture<SampleApiWebAppFactory>
{

    [Fact]
    public async Task GetAll_Query_ReturnOkAndListStaff()
    {
        //Arrange
        var httpClient = factory.CreateClient();
        //act
        var response = await httpClient.GetAsync("/api/Staff");
        //Assert
        //校驗狀態碼
        Assert.Equal(HttpStatusCode.OK, response.StatusCode);
        //校驗用戶
        var users = await response.Content.ReadFromJsonAsync<List<Staff>>();
        Assert.NotNull(users);
    }

    [Fact]
    public async Task GetConfig_WhenCalled_ReturnOk()
    {
        //Arrange
        var httpClient = factory.CreateClient();
        //act
        var response = await httpClient.GetAsync("/GetConfig");
        //Assert
        //校驗狀態碼
        Assert.Equal(HttpStatusCode.OK, response.StatusCode);
        //校驗用戶
        var config = await response.Content.ReadFromJsonAsync<string>();
        Assert.NotNull(config);
    }

    // 後面測試省略。。。。
}

最後

集成測試是確保應用組件在包含資料庫、文件系統和網路等基礎結構的級別上正常運行的重要方式。ASP.NET Core通過結合單元測試框架、測試Web主機和記憶體中測試伺服器來支持集成測試。

在集成測試中，我們評估應用組件在更廣泛的級別上的功能，驗證多個組件一起工作以生成預期結果，包括資料庫、文件系統、網路設備等。單元測試主要用於測試獨立的軟體組件，而集成測試需要使用實際組件，涉及更多的代碼和數據處理，以及更長的運行時間。建議將集成測試限制在重要的基礎結構方案上，優先選擇單元測試或集成測試來測試行為。

在集成測試中，被測試的項目通常稱為SUT（System Under Test），用於指代要測試的應用。避免為每種資料庫和文件系統交互編寫獨立的集成測試，而是通過一組集中式的測試來全面測試這些組件，並使用單元測試來測試與這些組件交互的方法邏輯。

通過自定義的WebApplicationFactory，可以根據測試需求定製化配置和功能，模擬真實的應用程式環境進行全面和準確的測試。自定義的WebApplicationFactory提供了靈活性和定製性，滿足複雜的測試需求，並確保測試環境的準確性。雖然自定義的WebApplicationFactory可能需要更多的理解和維護，但能更好地適應不同的測試場景。

集成測試是確保應用程式正常運行的關鍵步驟，通過綜合不同組件的功能來驗證應用的整體表現，提高應用程式的質量和穩定性。

本文來自博客園，作者：董瑞鵬，轉載請註明原文鏈接：https://www.cnblogs.com/ruipeng/p/18141877