本篇內(nèi)容主要講解“xUnit 如何編寫 ASP.NET Core 單元測試”,感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷,實用性強。下面就讓小編來帶大家學(xué)習(xí)“xUnit 如何編寫 ASP.NET Core 單元測試”吧!
還記得 .NET Framework 的 ASP.NET WebForm 嗎?那個年代如果要在 Web 層做單元測試簡直就是災(zāi)難啊。.NET Core 吸取教訓(xùn),在設(shè)計上考慮到了可測試性,就連 ASP.NET Core 這種 Web 或 API 應(yīng)用要做單元測試也是很方便的。其中面向接口和依賴注入在這方面起到了非常重要的作用。
本文就來手把手教你如何用 xUnit 對 ASP.NET Core 應(yīng)用做單元測試。.NET Core 常用的測試工具還有 NUnit 和 MSTest,我本人習(xí)慣用 xUnit 作為測試工具,所以本文用的是 xUnit。
創(chuàng)建示例項目
先用 ASP.NET Core API 模板建一個應(yīng)用。
模板為我們自動創(chuàng)建了一個 ValuesController,為了方便演示,我們只留其中一個 Get 方法:
public class ValuesController : ControllerBase { // GET api/values/5 [HttpGet("{id}")] public ActionResult<string> Get(int id) { return "value"; } }
然后再添加一個 xUnit 單元測試項目:
模板自動為我們添加好了 xUnit 引用:
<ItemGroup> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.9.0" /> <PackageReference Include="xunit" Version="2.4.0" /> <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" /> </ItemGroup>
但要測試 ASP.NET Core 應(yīng)用還需要添加兩個 NuGet 包:
Install-Package Microsoft.AspNetCore.App
Install-Package Microsoft.AspNetCore.TestHost
當(dāng)然還要引入目標(biāo)項目。最后的引用是這樣的:
<ItemGroup> <PackageReference Include="Microsoft.AspNetCore.App" Version="2.1.5" /> <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="2.1.1" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.9.0" /> <PackageReference Include="xunit" Version="2.4.0" /> <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" /> </ItemGroup> <ItemGroup> <ProjectReference Include="..\WebApplication1\WebApplication1.csproj" /> </ItemGroup>
添加完引用后編譯一下,確認(rèn)引用沒有問題。
編寫單元測試
寫單元測試一般有三個步驟:Arrange,Act 和 Assert。
Arrange 是準(zhǔn)備階段,這個階段是準(zhǔn)備工作,比如模擬數(shù)據(jù)、初始化對象等;
Act 是行為階段,這個階段是用準(zhǔn)備好的數(shù)據(jù)去調(diào)用要測試的方法;
Assert 是斷定階段,就是把調(diào)用目標(biāo)方法返回的值和預(yù)期的值進(jìn)行比較,如果和預(yù)期一致說明測試通過,否則為失敗。
按照這個步驟我們來編寫一個單元測試方法,以 ValuesController 中的 Get 方法作為要測試的目標(biāo)。一般一個單元測試方法就是一個測試用例。
我們在測試工程添加一個 ValuesTests 單元測試類,然后編寫一個單元測試方法,代碼如下:
public class ValuesTests { public ValuesTests() { var server = new TestServer(WebHost.CreateDefaultBuilder() .UseStartup<Startup>()); Client = server.CreateClient(); } public HttpClient Client { get; } [Fact] public async Task GetById_ShouldBe_Ok() { // Arrange var id = 1; // Act var response = await Client.GetAsync($"/api/values/{id}"); // Assert Assert.Equal(HttpStatusCode.OK, response.StatusCode); } }
這里我們通過 TestServer 拿到一個 HttpClient 對象,用它我們可以模擬 Http 請求。我們寫了一個非常簡單的測試用例,完整演示了單元測試的 Arrange,Act 和 Assert 三個步驟。
建議單元測試的方法名使用“什么應(yīng)該是什么”的模式。比如上面的 GetById_ShouldBe_Ok,表示調(diào)用 GetById 這個 API 返回的結(jié)果應(yīng)該是 OK 的,這樣一看就知道你這個測試用例是干嗎的,不需要過多的注釋。
運行單元測試
單元測試用例寫好后,打開“Test Explore”(中文版 VS 看到的是中文),在測試方法上右擊,選擇“Run Seleted Tests”,也可以在方法代碼塊內(nèi)鼠標(biāo)右擊選擇“Run Tests”:
注意看測試方法前面圖標(biāo)的顏色,目前是藍(lán)色的,表示測試用例還沒有運行過。
測試用例執(zhí)行結(jié)束后如果結(jié)果和預(yù)期一致就是綠色的圖標(biāo):
如果運行結(jié)果和預(yù)期不一致就會是紅色圖標(biāo),然后你需要修改代碼直到出現(xiàn)綠色圖標(biāo)。你可以在“Test Explore”的下方看到執(zhí)行消耗的時間,也可以在 Output 窗口看到執(zhí)行的細(xì)節(jié)。
以上圖標(biāo)顏色的變化過程是:藍(lán)色,紅色,再綠色,有可能藍(lán)色經(jīng)過一次運行就直接變成綠色,也有可能經(jīng)過很多次紅色才變成綠色。測試驅(qū)動開發(fā)中的 BRG(藍(lán)紅綠)術(shù)語就是這么來的。
調(diào)試單元測試
你可以通過添加斷點的方式在單元測試中調(diào)試。方法很簡單,在需要調(diào)試的方法上右鍵選擇“Debug Seleted Tests”即可,和平時的調(diào)試是一樣的。
如果我們要查看 API 具體返回了什么,可以通過加斷點調(diào)試來查看返回結(jié)果的變量字符串值,但這種方式不是好的選擇。比如對于同一個 API,我要看看 10 種參數(shù)返回的結(jié)果是什么樣的,每次都通過斷點調(diào)試來查看就很麻煩。
除了添加斷點來調(diào)試,還有一種打印日志的方法來快速調(diào)試,xUnit 可以很方便地做到這一點。為此我們來修改一ValuesTests:
public ValuesTests(ITestOutputHelper outputHelper) { var server = new TestServer(WebHost.CreateDefaultBuilder() .UseStartup<Startup>()); Client = server.CreateClient(); Output = outputHelper; } public ITestOutputHelper Output{ get; } // ... (省略其它代碼)
這里我們在構(gòu)造函數(shù)中添加了 ITestOutputHelper 參數(shù),xUnit 會將一個實現(xiàn)此接口的實例注入進(jìn)來。拿到這個實例后,我們就可以用它來輸出日志了:
[Fact] public async Task GetById_ShouldBe_Ok() { // Arrange var id = 1; // Act var response = await Client.GetAsync($"/api/values/{id}"); // Output var responseText = await response.Content.ReadAsStringAsync(); Output.WriteLine(responseText); // Assert Assert.Equal(HttpStatusCode.OK, response.StatusCode); }
運行(注意不是 Debug)此方法,運行結(jié)束后,在“Test Explore”的下方可以可以看到“Output”字樣,點擊它就可以看到輸出的結(jié)果,如圖:
通過這種方式,每次運行測試我們就可以很方便的查看輸出結(jié)果了。
其它
上面我們是通過模擬 Http 請求的方式來調(diào)用 API 測試的,還有一種就是 new 一個 Controller 來直接調(diào)用它的 Action 方法來測試。比如這樣:
// Arrange var id = 1; var controller = new ValuesController(); // Act var result = controller.Get(id);
如果 Controller 沒有其它依賴,這種方式當(dāng)然是最方便的。但通常 Controller 是會有一個或多個依賴的,比如這樣:
public class ValuesController : Controller { private readonly ISessionRepository _sessionRepository; public ValuesController(ISessionRepository sessionRepository) { _sessionRepository = sessionRepository; } // ... }
我們就要模擬實例化這個 Controller 的所有依賴,當(dāng)然手動模擬是不現(xiàn)實的,因為一個依賴類還可能會依賴其它的類或接口,依賴鏈可能很長,你不可能每個依賴都手動去實例化它們。有一個叫 Moq 的工具可以自動來模擬實例化依賴,它的用法是這樣的:
// .. // Arrange var mockRepo = new Mock<ISessionRepository>(); mockRepo.Setup(...); var controller = new HomeController(mockRepo.Object); // Act var result = await controller.Index();
這種方式我是不推薦的,因為拋開 Moq 的學(xué)習(xí)成本不說,重要的是它不如模擬 Http 請求那樣接近真實的調(diào)用場景,所以本文對它不作過多的介紹,大家知道有這么回事就行。
到此,相信大家對“xUnit 如何編寫 ASP.NET Core 單元測試”有了更深的了解,不妨來實際操作一番吧!這里是創(chuàng)新互聯(lián)建站,更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢,關(guān)注我們,繼續(xù)學(xué)習(xí)!
本文名稱:xUnit如何編寫ASP.NETCore單元測試-創(chuàng)新互聯(lián)
分享網(wǎng)址:http://chinadenli.net/article30/dhpepo.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供面包屑導(dǎo)航、品牌網(wǎng)站建設(shè)、關(guān)鍵詞優(yōu)化、外貿(mào)建站、建站公司、微信公眾號
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容