xUnit 编写 ASP.NET Core 单元测试的方法
还记得 .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 单元测试的方法的详细内容,更多关于xunit 编写 asp.net core 单元测试的资料请关注其它相关文章!
上一篇: JavaScript中的几种继承方法示例
推荐阅读
-
ASP.NET Core2读写InfluxDB时序数据库的方法教程
-
ASP.NET Core Mvc中空返回值的处理方法详解
-
ASP.NET Core2读写InfluxDB时序数据库的方法教程
-
ASP.NET core Web中使用appsettings.json配置文件的方法
-
ASP.NET Core 中使用EF Core 将实体映射到数据库表的方法(SQL Server)
-
使用ASP.NET Core支持GraphQL -- 较为原始的方法
-
ASP.NET Core Middleware的实现方法详解
-
asp.net core下给网站做安全设置的方法详解
-
ASP.NET Core MVC 过滤器的使用方法介绍
-
Hangfire在ASP.NET CORE中的简单实现方法