还记得 .NET Framework 的 ASP.NET WebForm 吗?那个年代如果要在 Web 层做单元测试简直就是灾难啊。.NET Core 吸取教训,在设计上考虑到了可测试性,就连 ASP.NET Core 这种 Web 或 API 应用要做单元测试也是很方便的。其中面向接口和依赖注入在这方面起到了非常重要的作用。

本文就来手把手教你如何用 xUnit 对 ASP.NET Core 应用做单元测试。.NET Core 常用的测试工具还有 NUnit 和 MSTest,我本人习惯用 xUnit 作为测试工具,所以本文用的是 xUnit。

创建示例项目

先用 ASP.NET Core API 模板建一个应用。

模板为我们自动创建了一个 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 应用还需要添加两个 NuGet 包:

Install-Package Microsoft.AspNetCore.App
Install-Package Microsoft.AspNetCore.TestHost

当然还要引入目标项目。最后的引用是这样的:

<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>

添加完引用后编译一下,确认引用没有问题。

编写单元测试

写单元测试一般有三个步骤:Arrange,Act 和 Assert。

  • Arrange 是准备阶段,这个阶段是准备工作,比如模拟数据、初始化对象等;
  • Act 是行为阶段,这个阶段是用准备好的数据去调用要测试的方法;
  • Assert 是断定阶段,就是把调用目标方法返回的值和预期的值进行比较,如果和预期一致说明测试通过,否则为失败。

按照这个步骤我们来编写一个单元测试方法,以 ValuesController 中的 Get 方法作为要测试的目标。一般一个单元测试方法就是一个测试用例。

我们在测试工程添加一个 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 三个步骤。

建议单元测试的方法名使用“什么应该是什么”的模式。比如上面的 GetById_ShouldBe_Ok,表示调用 GetById 这个 API 返回的结果应该是 OK 的,这样一看就知道你这个测试用例是干吗的,不需要过多的注释。

运行单元测试

单元测试用例写好后,打开“Test Explore”(中文版 VS 看到的是中文),在测试方法上右击,选择“Run Seleted Tests”,也可以在方法代码块内鼠标右击选择“Run Tests”:

注意看测试方法前面图标的颜色,目前是蓝色的,表示测试用例还没有运行过。

测试用例执行结束后如果结果和预期一致就是绿色的图标:

如果运行结果和预期不一致就会是红色图标,然后你需要修改代码直到出现绿色图标。你可以在“Test Explore”的下方看到执行消耗的时间,也可以在 Output 窗口看到执行的细节。

以上图标颜色的变化过程是:蓝色,红色,再绿色,有可能蓝色经过一次运行就直接变成绿色,也有可能经过很多次红色才变成绿色。测试驱动开发中的 BRG(蓝红绿)术语就是这么来的。

调试单元测试

你可以通过添加断点的方式在单元测试中调试。方法很简单,在需要调试的方法上右键选择“Debug Seleted Tests”即可,和平时的调试是一样的。

如果我们要查看 API 具体返回了什么,可以通过加断点调试来查看返回结果的变量字符串值,但这种方式不是最好的选择。比如对于同一个 API,我要看看 10 种参数返回的结果是什么样的,每次都通过断点调试来查看就很麻烦。

除了添加断点来调试,还有一种打印日志的方法来快速调试,xUnit 可以很方便地做到这一点。为此我们来修改一下 ValuesTests:

public ValuesTests(ITestOutputHelper outputHelper)
{
var server = new TestServer(WebHost.CreateDefaultBuilder()
.UseStartup<Startup>());
Client = server.CreateClient();
Output = outputHelper;
} public ITestOutputHelper Output{ get; } // ... (省略其它代码)

这里我们在构造函数中添加了 ITestOutputHelper 参数,xUnit 会将一个实现此接口的实例注入进来。拿到这个实例后,我们就可以用它来输出日志了:

[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)此方法,运行结束后,在“Test Explore”的下方可以可以看到“Output”字样,点击它就可以看到输出的结果,如图:

通过这种方式,每次运行测试我们就可以很方便的查看输出结果了。

其它

上面我们是通过模拟 Http 请求的方式来调用 API 测试的,还有一种就是 new 一个 Controller 来直接调用它的 Action 方法来测试。比如这样:

// Arrange
var id = 1;
var controller = new ValuesController();
// Act
var result = controller.Get(id);

如果 Controller 没有其它依赖,这种方式当然是最方便的。但通常 Controller 是会有一个或多个依赖的,比如这样:

public class ValuesController : Controller
{
private readonly ISessionRepository _sessionRepository; public ValuesController(ISessionRepository sessionRepository)
{
_sessionRepository = sessionRepository;
} // ...
}

我们就要模拟实例化这个 Controller 的所有依赖,当然手动模拟是不现实的,因为一个依赖类还可能会依赖其它的类或接口,依赖链可能很长,你不可能每个依赖都手动去实例化它们。有一个叫 Moq 的工具可以自动来模拟实例化依赖,它的用法是这样的:

// ..
// Arrange
var mockRepo = new Mock<ISessionRepository>();
mockRepo.Setup(...);
var controller = new HomeController(mockRepo.Object); // Act
var result = await controller.Index();

这种方式我是不推荐的,因为抛开 Moq 的学习成本不说,重要的是它不如模拟 Http 请求那样接近真实的调用场景,所以本文对它不作过多的介绍,大家知道有这么回事就行。

使用 xUnit 编写 ASP.NET Core 单元测试的更多相关文章

  1. 使用 xUnit 编写 ASP.NET Core WebAPI单元测试

    本文使用xUnit对ASP.NET Core WebAPI做单元测试,使用HttpClient的同步和异步请求,下面详细介绍xUnit的使用过程: 一.创建示例项目 模板为我们自动创建了一个Value ...

  2. 【转】.NET(C#):浅谈程序集清单资源和RESX资源 关于单元测试的思考--Asp.Net Core单元测试最佳实践 封装自己的dapper lambda扩展-设计篇 编写自己的dapper lambda扩展-使用篇 正确理解CAP定理 Quartz.NET的使用(附源码) 整理自己的.net工具库 GC的前世与今生 Visual Studio Package 插件开发之自动生

    [转].NET(C#):浅谈程序集清单资源和RESX资源   目录 程序集清单资源 RESX资源文件 使用ResourceReader和ResourceSet解析二进制资源文件 使用ResourceM ...

  3. Asp.Net Core 单元测试正确姿势

    背景 ASP.NET Core 支持依赖关系注入 (DI) 软件设计模式,并且默认注入了很多服务,具体可以参考 官方文档, 相信只要使用过依赖注入框架的同学,都会对此有不同深入的理解,在此无需赘言. ...

  4. 在 Mac OS 上使用 TypeScript 编写 ASP.NET Core 1.0 应用

    var appInsights=window.appInsights||function(config){ function r(config){t[config]=function(){var i= ...

  5. 从头编写asp.net core 2.0 web api 基础框架 (5) + 使用Identity Server 4建立Authorization Server (7) 可运行前后台源码

    前台使用angular 5, 后台是asp.net core 2.0 web api + identity server 4. 从头编写asp.net core 2.0 web api 基础框架: 第 ...

  6. 使用xunit对asp.net core webapi进行集成测试

    新项目我们采用前后端分离,后端采用asp.net core webapi, 如何对后端代码进行自动化测试呢,有以下几种方案: 1. 单元测试,目前这个方案对我们来说难度很大,抛开时间的问题,单元测试对 ...

  7. 从头编写 asp.net core 2.0 web api 基础框架 (1)

    工具: 1.Visual Studio 2017 V15.3.5+ 2.Postman (Chrome的App) 3.Chrome (最好是) 关于.net core或者.net core 2.0的相 ...

  8. 从头编写 asp.net core 2.0 web api 基础框架 (2)

    上一篇是: http://www.cnblogs.com/cgzl/p/7637250.html Github源码地址是: https://github.com/solenovex/Building- ...

  9. 从头编写 asp.net core 2.0 web api 基础框架 (3)

    第一部分:http://www.cnblogs.com/cgzl/p/7637250.html 第二部分:http://www.cnblogs.com/cgzl/p/7640077.html 之前我介 ...

随机推荐

  1. .NET Http请求

    声明:本代码只是我使用的网络请求方式的封装,大家如果有其他的可以一起讨论讨论.    本代码可以在.NET 与.NET CORE的平台下无须做任何改动(除非手动加一些必要的引用,resharper会有 ...

  2. 基于MVC的网站和在线教育系统

    最近老表说要创业,想要做一个网站做宣传,还想要一个在线教育系统. 学习了一部分 Java,  决定用.Net MVC做官网或直接做成静态HTML网站,主要是因为.Net MVC 技术简单,效率高,需求 ...

  3. 从零开始学安全(三十八)●cobaltstrike生成木马抓肉鸡

    链接:https://pan.baidu.com/s/1qstCSM9nO95tFGBsnYFYZw 提取码:w6ih  上面是工具 需要java jdk 在1.8.5 以上  实验环境windows ...

  4. JAVA程序员面试30问(附带答案)

    第一,谈谈final, finally, finalize的区别. 最常被问到.final修饰符(关键字)如果一个类被声明为final,意味着它不能再派生出新的子类,不能作为父类被继承.因此一个类不能 ...

  5. Maven(十)通过Maven缺失servlet.api的解决方式看provide(依赖范围)

    1. Eclipse解决servlet.api缺失的方法参考此处 2. 通过配置pom.xml里依赖来添加servlet.api 在里面添加如下代码保存后错误立刻消失 <dependencies ...

  6. 轨迹系列6——车载GPS对接方案汇总小结(809、自定义协议、前置库、WS)

    文章版权由作者李晓晖和博客园共有,若转载请于明显处标明出处:http://www.cnblogs.com/naaoveGIS/ 1.背景 最近在不同项目中对接了多个车载GPS厂商服务终端,绝大多数厂商 ...

  7. 解决注册并发问题并提高QPS

    前言:前面在本地的windows通过apache的ab工具测试了600并发下“查询指定手机是否存在再提交数据”的注册功能会出现重复提交的情况,并且在注册完成时还需要对邀请人进行奖励,记录邀请记录,对该 ...

  8. nodejs+express+mongodb写api接口的简单尝试

    1:启动mongodb服务 我的mongoDB的安装目录:E:\mongoDB\bin,版本:3.4.9 打开cmd  -> e:(进入e盘) -> cd mongoDB/bin(进入mo ...

  9. SpringBoot 配置定时任务

    SpringBoot启用定时任务,其内部集成了成熟的框架,因此我们可以很简单的使用它. 开启定时任务 @SpringBootApplication //设置扫描的组件的包 @ComponentScan ...

  10. Greenplum扩容

    Greenplum支持原有主机扩展Segment个数.新增主机.和混合扩展 本文以在已有机器上扩展节点为例 1.可按照hostname:address:port:fselocation:dbid:co ...