asp.net core 使用 TestServer 來做整合測試

大雄45發表於2020-12-07
ASP.NETServer

asp.net core 使用 TestServer 來做整合測試

Intro

之前我的專案裡的整合測試是隨機一個埠，每次都真實的啟動一個 WebServer，之前也有看到過微軟文件上 TestServer 的介紹，當時沒仔細看過以為差不多就沒用，一直是啟動了一個真正的 WebServer 去跑整合測試的，上次分享 Xunit.DependencyInjection 改造測試專案的時候，寫的爛程式碼被大師看到了之後， 大師建議用 TestServer 來做整合測試，使用 TestServer 不會真正的佔用埠號，不會出現許可權問題，於是扒了扒 TestServer 的原始碼，並用 TestServer 改進了整合測試專案，感謝大師[獻花鮮花]~~

Sample

之前的整合測試監聽了一個埠號，使用了一個真實的 WebServer，下面改成使用 TestServer

TestServer 現在是在 Microsoft.AspNetCore.TestHost 這個 Nuget 包中，引用這個包就可以使用了

在服務註冊的時候呼叫 UseTestServer 這一擴充套件方法就可以注入 TestServer 了，整合測試一般會用 HttpClient 來請求伺服器端的 API 地址或頁面，TestServer 提供了一個方便的 CreateClient 的方法可以很方便的建立一個用來請求 TestServer 的 HttpClient，微軟也提供了一些比較方便的擴充套件方法，可以使用 IHost 的 GetTestClient 擴充套件方法來獲取 HttpClient

改成使用 TestServer 很簡單，引用 nuget 包 Microsoft.AspNetCore.TestHost，變更對比如下：

diff

原始碼概覽

TestServer 在啟動的時候並沒有監聽埠，可以參考原始碼 IServer 的 Start

TestServer 通過 CreateClient 方法來建立呼叫 TestServer 介面的 HttpClient

通過上面的程式碼可以看的出來核心程式碼是在 ClientHandler 中定義的，原始碼有點多，詳細可以直接看原始碼 https://github.com/dotnet/aspnetcore/blob/v5.0.0/src/Hosting/TestHost/src/ClientHandler.cs#L58

ClientHandler 重寫了 HttpClientHandler 的 SendAsync 方法，使得請求直接攔截掉，不會真正的發生 Http 請求，實際的請求過程首先將 Http 請求的資訊轉換成 HttpRquestFeature 然後直接交給 TestServer 處理，其實也就是直接交給 asp.net core 的請求管道去處理，請求處理結束之後，獲取 HttpContext 響應，獲取 HttpResponseFeature 然後轉換成 HttpClient 需要的 HttpResponseMessage.

More

TestServer 不僅僅可以支援 HTTP 請求的處理，還支援 WebSocket 的處理，WebSocket 的整合測試也可以使用 TestServer 來處理。

你如果還是比較懷疑是否真的沒有 HTTP 請求，可以用 Fildder 之類的 HTTP 抓包工具監控在跑測試的期間是否真的有 HTTP 請求，如果是真正的 WebServer 會有 HTTP 請求，TestServer 不會有 HTTP 請求。

Reference

相關文章