精通中介軟體測試：Asp.Net Core實戰指南，提升套用穩定性和可靠性

引言

在上一章節我們實戰了在 Asp.Net Core 中的計畫實戰，這一章節講解一下如何測試 Asp.Net Core 的中介軟體。

TestServer

還記得我們在整合測試中提供的 TestServer 嗎？ TestServer 是由 Microsoft.AspNetCore.TestHost 包提供的。包含了用於在測試環境中模擬 ASP.NET Core 應用程式的類和方法。透過使用 TestServer ，開發人員可以在測試中模擬整個應用程式的執行環境，包括中介軟體的執行，從而進行整合測試和端到端測試。

中介軟體可以使用 TestServer 單獨測試。這樣便可以：

優點：

實戰

VS 新建測試計畫 dotNetParadise.MiddlerWareTest

Nuget 安裝 Microsoft.AspNetCore.TestHost

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


既然我們是要測試中介軟體 那首先得先在我們的 Sample.Api 中建立一個中介軟體

定義 MyMiddleware 中介軟體

public class MyMiddleware(RequestDelegate next)
{
publicasync Task InvokeAsync(HttpContext context)
{
// 在請求處理前執行的邏輯
context.Response.ContentType = "text/plain";
context.Response.Headers.TryAdd("X-Custom-Header", "CustomValue");
await context.Response.WriteAsync("Test My Middleware");
// 呼叫下一個中介軟體
await next(context);
// 在請求處理後執行的邏輯
await context.Response.WriteAsync("Middleware Test Completed");
}
}

定義測試類

// Arrange
usingvar host = awaitnew HostBuilder()
.ConfigureWebHost(webBuilder =>
{
webBuilder
.UseTestServer()
.ConfigureServices(services =>
{
// 在這裏可以註入服務
})
.Configure(app =>
{
app.UseMiddleware<MyMiddleware>();
});
})
.StartAsync();
// Act
var response = await host.GetTestClient().GetAsync("/");
// Assert
response.EnsureSuccessStatusCode(); // 確保請求成功
var responseContent = await response.Content.ReadAsStringAsync();
Assert.Contains("Test My Middleware", responseContent);
Assert.Contains("Middleware Test Completed", responseContent);


Run Test

使用 HttpContext 發送請求

可以使用 TestServer 來設定測試環境，並建立一個模擬的 HttpContext 物件來代表一個請求

[Fact]
publicasync Task TestMiddleware_ExpectedResponse()
{
usingvar host = awaitnew HostBuilder()
.ConfigureWebHost(webBuilder =>
{
webBuilder
.UseTestServer()
.ConfigureServices(services =>
{
})
.Configure(app =>
{
app.UseMiddleware<MyMiddleware>();
});
})
.StartAsync();
var server = host.GetTestServer();
server.BaseAddress = new Uri("http://localhost");
var context = await server.SendAsync(c =>
{
c.Request.Method = HttpMethods.Get;
c.Request.Path = "/";
c.Request.Host = new HostString("localhost");
c.Request.Scheme = "http";
});
//act
Assert.True(context.RequestAborted.CanBeCanceled);
Assert.Equal(HttpProtocol.Http11, context.Request.Protocol);
// 驗證響應
Assert.Equal(StatusCodes.Status200OK, context.Response.StatusCode);
var customHeader = context.Response.Headers["X-Custom-Header"].ToString();
Assert.Equal("CustomValue", customHeader);
}


使用 SendAsync 的好處包括： 透過設定 HttpContext 的任何內容，從而精確控制請求的各個方面。相比於使用 HttpClient ， SendAsync 通常更快，因為它繞過了網路層。整合測試：這是測試整個請求處理管道（包括所有中介軟體）的好方法。然而，它也有一些限制：

局限性 ： SendAsync 主要用於整合測試，而不是單元測試。它測試的是整個請求處理流程，而不是單個元件。模擬限制：雖然你可以設定 HttpContext 的許多內容來模擬請求，但某些方面（如使用者認證狀態或外部依賴項）可能難以完全模擬。

添加請求路由

這個比較好理解，就是在 TestServer 中添加路由的功能和 Asp.Net Core 中添加路由基本一致

[Fact]
publicasync Task TestWithEndpoint_ExpectedResponse()
{
usingvar host = awaitnew HostBuilder()
.ConfigureWebHost(webBuilder =>
{
webBuilder
.UseTestServer()
.ConfigureServices(services =>
{
services.AddRouting();
})
.Configure(app =>
{
app.UseRouting();
//app.UseMiddleware<MyMiddleware>();
app.UseEndpoints(endpoints =>
{
endpoints.MapGet("/hello", () =>
TypedResults.Text("Hello Tests"));
});
});
})
.StartAsync();
var client = host.GetTestClient();
var response = await client.GetAsync("/hello");
Assert.True(response.IsSuccessStatusCode);
var responseBody = await response.Content.ReadAsStringAsync();
Assert.Equal("Hello Tests", responseBody);
}




在測試場景中，添加請求路由的好處主要體現在以下幾個方面：

最後

本章我們探討了如何在 Asp.Net Core 計畫中測試中介軟體的方法和技巧。透過使用 TestServer 和 HttpContext 發送請求，我們可以模擬整個應用程式的執行環境，從而進行整合測試和端到端測試。同時，我們也介紹了如何添加請求路由來模擬不同的場景，並對中介軟體的行為進行驗證。

透過測試中介軟體，我們可以確保其在處理請求時的行為符合預期，提高應用程式的穩定性和可靠性。測試不僅可以幫助發現潛在的問題，還可以在開發過程中及早發現和解決 bug，提高程式碼品質和開發效率。

參考資料

[1]

測試中介軟體: https://learn.microsoft.com/zh-cn/aspnet/core/test/middleware?view=aspnetcore-8.0#send-requests-with-httpcontext