ASP.NET Core中使用xUnit進行單元測試

單元測試的功能自從MVC的第一個版本誕生的時候，就是作為一個重要的賣點來介紹的，通常在拿MVC與webform比較的時候，單元測試就是必殺底牌，把webform碾壓得一無是處。

單元測試的重要性不用多說了，有單元測試的做兜底的項目，好比給開發人員買了份保險，當然這個保險的質量取決於單元測試的質量，那些一路Mock的單元測試，看起來很美，但是什么都cover不到。目前工作中的一個老項目，有2萬多個單元測試用例，其中不少是用心之作，真正落實到了業務邏輯，開發人員可以放心的去修改代碼，當然一切都必須按照TDD的原則來進行，具體就不詳細說了。

接下來進入正題，單元測試這個重要的基礎功能，在.NET Core中當然不能少，相關的API和組件提供的功能跟之前的版本沒什么大的區別，主要在於需要對.NET Core的支持，說白了就是之前在.NET Framework平台下的代碼，得重新生成支持.NET Core。比如本文要說到的xUnit，xUnit已經提供了對.NET Core的支持版本，下面我們來看看如何在ASP.NET Core中使用xUnit進行單元測試。

准備項目代碼：

1.創建一個空白的ASP.NET Core web項目，命名為UseXunit。

2.然后修改project.json的內容如下，在dependencies的最后一行加入對MVC組件的依賴

   "Microsoft.AspNetCore.Mvc": "1.0.1"

3.修改Startup.cs文件

   在ConfigureServices方法加入services.AddMvc();

   在Configure方法加入app.UseMvcWithDefaultRoute();

3.然后在項目根目錄新建一個Controllers目錄，並添加一個HomeController，代碼如下

public class HomeController : Controller
    {
        public IActionResult Index()
        {
            return Content("Hello test");
        }
    }

4.到這里項目應該能跑起來了，運行后能看到輸出Hello test，說明一個簡單的項目已具備了。

 

加入單元測試項目

接下來加入單元測試項目，獨立一個測試項目方便管理。

1.右鍵解決方案文件，然后選擇新建一個解決方案文件夾，然后命名為test

2.在test目錄下新建一個.NET Core項目，這里選擇的項目類型是Class Library(.NET Core)，命名項目名為UseXunit.Tests

3.然后修改Tests項目的project.json內容為如下

{
  "version": "1.0.0-*",
  "testRunner": "xunit",
  "dependencies": {
    "Microsoft.NETCore.App": {
      "type": "platform",
      "version": "1.0.0"
    },
    "xunit": "2.1.0",
    "dotnet-test-xunit": "2.2.0-preview2-build1029",
    "UseXunit": "1.0.0",

    "Microsoft.AspNetCore.Mvc": "1.0.1"
  },
  "frameworks": {
    "netcoreapp1.0": {
      "imports": [ "dotnet5.6", "portable-net45+win8" ]
    }
  }
}

這里的改動幾乎重寫了系統默認生成的配置，系統默認的配置幾乎跑不起來，需要重新設置。

dependencies引入了xunit，以及dotnet-test-xunit的運行支持package，當然也加入了對待測試項目的依賴(UseXunit)。

另外一個關鍵配置是指定了testrunner為xunit

保存之后會自動restore相關的packages。

4.現在可以開始創建TestCase

新建一個HomeControllerTest類，內容如下

public class HomeControllerTest
    {
        [Fact]
        public void ShouldGetIndexResult()
        {
            var homeController = new HomeController();
            var contentResult = homeController.Index() as ContentResult;
            Assert.NotNull(contentResult);
            Assert.Equal("Hello test", contentResult.Content);
        }
    }

這里就創建了一個基本的測試用例，然后使用你熟悉的快捷鍵Ctrl+U+R(Reshaper)就可以將test愉快地運行起來了

 

完整代碼請參考 https://github.com/shenba2014/AspDotNetCoreMvcExamples/tree/master/UseXunit