net core WebApi——使用xUnits來實現單元測試

  • 2019 年 11 月 6 日
  • 筆記

前言

從開始敲代碼到現在,不停地都是在喊着記得做測試,記得自測,測試人員打回來扣你money之類的,剛開始因為心疼錢(當然還是為了代碼質量),就老老實實自己寫完自己跑一遍,沒有流程沒有規劃沒有測試文檔,就是自己整理一組數據跑一遍,最後依然還是讓測試人員老老實實把一大堆測試問題扔給你。

單元測試

首先,還是來聊聊為啥要搞測試吧。

  1. 測試有助於代碼整體健壯性,覆蓋測試、壓力測試都是為了全方位多角度更快更好為用戶服務。
  2. 測試有助於提高程序猿的積極性以及引起自身的重視,畢竟一個坑栽一遍就夠了,兩次也能容忍,再三再四再五怕是要被搞,同時這也是自我提高的一種手段吧。
  3. 軟件開發流程收尾的工作就是測試,繞不過,畢竟驗收才是最終目標,達到效果才能獲得應有的。

好了,聊完這些,當然我也不是專業測試人員,肯定不會給個測試文檔模板,喏,照着這個規範起來,我主要是要鼓搗下我之前一直想試試的單元測試,這個自動化測試的手段之一,一直想試試但是一直都放着。

MSTestNUnitxUint這三個中讓我稍微猶豫了下,不過三七二十八管他呢,隨便來個吧,就選了xUnit,當然MSTest是官方的,支持度應該高點兒,但是這不是我們該猶豫抉擇的地方。

xUnit

首先,我們新建一個項目April.Test
新建

Fact

新建之後,我們看到有個默認的 [Fact]

這個就是測試的標準格式了,如果我們不需要測試數據的話,就是在這個標籤下的方法做斷言,簡單舉個例子吧。

        [Fact]          public void TestEqual()          {              int a = 10, b = 20;              Assert.Equal(30, Add(a, b));          }            private int Add(int a, int b)          {              return a + b;          }

敲下Assert之後,發現斷言好多方法,這裡也就不一一說明了,感覺方法名起的都挺明白的,這裡就不過多描述了,代碼中也有些測試示例,地址在文末給出。

Theory

我們在上面的代碼可以看到,所有的數據都是自己定好的,如果我想自己做參數傳入測試怎麼搞呢,這時候就要用到 [Theory] 這個標籤以及 [InlineData] 了,標籤是為了更好的區分方法的類型(個人理解),來看下這種參數傳遞的測試怎麼搞吧。

        [Theory]          [InlineData(new object[] { 1, 2, 3, 4 },1)]          [InlineData(new object[] { "t", "e", "s", "t" }, "t")]          public void TestContains(object[] objs,object obj)          {              Assert.Contains(obj, objs);          }

當然我們也可以使用自定義數組來做測試數據源,這裡我起初以為可以傳任意類型參數,但是MemberData只支持object[]。

        [Theory]          [MemberData(nameof(tempDatas))]          public void TestData(int a, int b)          {              int result = a + b;              Assert.True(result == Add(a, b));          }            public static IEnumerable<object[]> tempDatas          {              get              {                  yield return new object[] { 1, 2 };                  yield return new object[] { 5, 7 };                  yield return new object[] { 12, 12 };              }          }

控制器

在之前鼓搗單元測試的時候,我一直想一個問題,如果只是這種操作的話,那測試有何意義,但是後來發現,原來單元測試比我以為能做的多得多,所以,學習是個不停的行程,走的多了,風景也就多了。

這裡可以引入一個流程,在我們測試自己的工程的時候,我們需要三步來做完單個的測試。

  • Arrange(準備工作)
  • Act(實現方法)
  • Assert(斷言結果)

在測試之前,我們需要在當前工程引入一個Moq,至於為什麼用這個呢,就跟vue一樣我們需要模擬(雖說mock跟Moq還不是那麼類似),總不可能我們單元測試引入了orm來實際操作數據庫吧(當然測試庫這個也是可行的),所以我們需要模擬接口的實現類及方法。

引入

引入完,我們將April.WebApi引入到當前工程,之後我們創建一個Values的接口測試類ValuesControllerTest,然後測試方法如下:

        [Fact]          public void TestGet()          {              // Arrange              var mockRepo = new Mock<IStudentService>();              var controller = new ValuesController(mockRepo.Object);              // Act              var result = controller.Get();              // Assert              Assert.Equal(new string[] { "value1", "" }, result.Value);          }

這裡注意下,對應接口的方法我是都注釋的,最終只有返回了字符串數組,因為對應接口中的方法都需要初始化,那麼我們來測試下獲取數據的接口,看下這個Moq的用法吧,首先我們需要初始化Mock來實現對應接口,然後我們通過實現對應方法來模擬獲取數據。

        [Theory]          [InlineData(1)]          public void TestGetByID(int id)          {              var mockRepo = new Mock<IStudentService>();              mockRepo.Setup(repo => repo.GetList(s => s.ID == 38).ToList())                  .Returns(GetList());                var controller = new ValuesController(mockRepo.Object);                var result = controller.Get(id);                Assert.NotNull(result);              Assert.Contains("大洛陽", result.Value);          }            private List<StudentEntity> GetList()          {              List<StudentEntity> entities = new List<StudentEntity>();                entities.Add(new StudentEntity()              {                  ID = 1,                  Name = "小明",                  Number = "123456",                  Age = 19,                  Sex = 1,                  Address = "大洛陽"              });              entities.Add(new StudentEntity()              {                  ID = 2,                  Name = "小紅",                  Number = "456789",                  Age = 18,                  Sex = 0,                  Address = "大洛陽"              });                return entities;          }

寫到這我發現,我在引入WebApi的時候,好像已經把幾個工程都已經引入進來,這個不知道合適不合適。

小結

寫到這裡,基本上單元測試這塊兒也簡單了走了一遍,至於具體在業務中如何實現,還是想着需要結合個小項目來實踐下,東西走通個demo只能說明可行,走通不同體量的工程才能說明可用,包括後續的集成測試,壓力測試,自動化測試也會一點點兒的開始鼓搗,路漫漫啊。

附錄

代碼地址:April.WebApi