ASP.NET Core中使用xUnit进行单元测试

2019-11-29,,,

单元测试的功能自从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进行单元测试。

xUnit.Net介绍

xUnit.net的创造者的创造者是Jim Newkirk和Brad Wilson从包括NUnit及其它单元测试框架的使用经验中总结出来的一个新框架,相比于NUnit,xUnit.net有如下特点:

  1. 为每个测试方法产生一个对象实例
  2. 取消了[SetUp]和[TearDown]
  3. 取消了[ExpectedException]
  4. 类似于Aspect的功能
  5. 减少了自定义属性(Attribute)的数目
  6. 采用泛型
  7. 匿名委托
  8. 可扩展的断言
  9. 可扩展的测试方法
  10. 可扩展的测试类

xUnit.net的官方网站是:http://xunit.codeplex.com,下面是xUnit.net的运行界面:

注意在下载的xUnit.net压缩包内有4个支持GUI方式运行的exe文件,分别是:

  1. xunit.gui.clr4.exe:用于在x64及.Net4.0下运行xUnit.net。
  2. xunit.gui.clr4.x86.exe:用于在x86及.Net4.0下运行xUnit.net。
  3. Xunit.gui.exe:用于在x64及.Net4.0以下版本运行xUnit.net。
  4. xunit.gui.x86.exe:用于在x86及.Net4.0以下版本运行xUnit.net。

准备项目代码:

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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持北冥有鱼。

《ASP.NET Core中使用xUnit进行单元测试.doc》

下载本文的Word格式文档,以方便收藏与打印。