.NET 单元测试(一):工具和规范
工欲善其事,必先利其器
单元测试框架为我们写单元测试提供了极大的便利,目前市面上有很多单元测试框架,这么多,怎么选呢?
这个需要视团队情况而定,有这么些规则是需要考虑的:
- 功能满足需求
- 稳定且容易获取
- 上手简单,使用方便(调试、运行、整理单元测试等)
- 部署自动化容易
综上,宇宙最强IDE默认集成的MSTest中标(非必需情况,强烈推荐使用MSTest)。
开始
在VS中右键单击任意公开的类名或方法即可看到创建单元测试项目的选项(也可以在设计解决方案的时候建立好单元测试项目,并引用需要依赖的程序集)。
命名
- 单元测试项目名:[被测项目].Tests
- 类名:[被测类]Tests
- 方法名:[被测方法]_[测试场景]_[预期行为]
举个例子,现在要对Shape.Core.dll中的Line类的Contains方法写单元测试,测试其在传入一个当前直线上的点时,能正确返回true,按照规范应该这样命名:
项目名:Shape.Core.Tests
类名:LineTests
方法名:Contains_PointIsOnLine_ReturnTrue()
当然,注释也是很重要的,一般可以在注释中注明测试条件和预期行为。
分组
在单元测试方法中增加分组,可以更好的管理单元测试,也方便自动化测试,只需要在在测试方法上,使用[TestCategory(name)]特性进行标记。标记分组后,可针对组单独运行或者调试测试用例。
组的命名规则可参考:[模块]_[类名]_[功能]_[额外用途],如:
步骤
一个完整的单元测试用例应该包含如下三个部分
- Arrange:准备当前测试场景的前置条件
- Action:执行被测试方法
- Assert:对被测试方法的执行结果进行断言判断(几乎每种测试框架都提供了Assert库,当然,也可以根据情况丰富我们自己的Assert库)
还是Line类的Contains方法,请看按照标准步骤的代码:
/// <summary>
/// 条件:点point在直线line上
/// 预期:<see cref="Line.Contains"/> 方法判断点在直线上
/// </summary>
[TestMethod]
public void Contains_PointIsOnLine_ReturnsTrue()
{
//// Arrange
var point = new Point(1, 1);
var line = new Line(new Point(0, 2), new Point(2, 0));
//// Act
var contains = line.Contains(point);
//// Assert
Assert.IsTrue(contains);
}
以上命名规则和步骤是业界广泛使用的,每一位开发者务必遵循。
再谈单元测试框架
上面讲的例子是在单元测试框架的基础上写的,那么其中那些是单元测试框架的功劳呢?单元测试框架还可以帮我们做些什么呢?
-
测试方法上的[TestMethod]就是MSTest为我们提供的用于标识一个单元测试方法的特性,在项目或者类名上运行单元测试时,这些方法就会运行起来。
-
Assert也是MSTest为我们提供的类库。
除此之外,测试框架还提供了
- 在测试类的所有方法运行之前和之后执行一个方法
- 在每个测试方法执行之前和之后执行一个方法
- 对测试方法进行归类(比如需要每次Push都运行的测试可以归为一类)
- 自动化单元测试
- ...
代码覆盖率
代码覆盖率指的是运行单元测试时,产品代码的覆盖情况。VS默认执行的是Block(Block指的是对应IL上单一入口和单一出口的代码块,在实际执行代码覆盖率时无需纠结Block的定义和具体划分)级别的代码覆盖率检查。
怎么看代码覆盖率
目前VS只对企业版提供了单元测试代码覆盖率的检查工具(如果不是企业版,也可使用JUST TRACE等工具来辅助检查,但强烈推荐安装企业版)这里以VS2017企业版为例:
image.png也可以通过测试=>窗口=>测试资源管理器
image.png打开测试用例浏览窗口,进行选中的单元测试或者全部单元测试的代码覆盖率检查:
image.png执行完代码覆盖率分析,会得到一个下面这样的窗口:
image.png通过这个窗口可以看到程序集、类和方法的代码覆盖率,双击相应方法可以看到具体的代码覆盖情况,比如:
image.png其中红色部分是未被覆盖的代码,米色部分是未覆盖完全的代码,浅蓝色是完全覆盖的代码。
代码覆盖率要求
正如本节开始所说,约定单元测试Block级别的覆盖,因此,对于明确要求测试的公共方法,该方法的代码覆盖率要求100%。
另外:
覆盖率数据只能代表你测试过哪些代码,不能代表你是否测试好这些代码(测试用例的设计尤为重要哦(_))
2017-3-16 08:02:54