在.NET开发中的单元测试工具之(1)——NUnit

NUnit介绍

　　NUnit是一个专门针对于.NET来写的单元测试框架，它是xUnit体系中的一员，在xUnit体系中还有针对Java的JUnit和针对C++的CPPUnit，在开始的时候NUnit和xUnit体系中的大多数的做法一样，仅仅是将Smalltalk或者Java版本转换而来，但是在.NET2.0之后它加入了一些特有的做法。NUnit的官方网站是：http://www.nunit.org/，目前的最新版本是：2.6.2。

NUnit下载与安装

　　NUnit的每个版本都提供了两种形式的下载：安装文件和免安装方式，分别是*.msi格式和*.zip格式。前者需要安装才能使用，并且会在安装过程中创建一些快捷方式和注册NUnit的dll到GAC，这样以后编写NUnit测试类的时候添加NUnit的dll就像添加.Net Framework的dll一样。如果是下载的zip格式的文件，则不会创建快捷方式和注册dll，在编写单元测试类时需要手动指定NUnit的dll的路径。
　　NUnit的运行有三种方式：命令行和图形用户界面。以周公当前电脑上安装的NUnit2.5.10为例，安装路径为：C:\Program Files (x86)\NUnit 2.5.10，其下有三个目录：bin、doc和samples。在doc目录下是软件的文档（英文），在samples目录下则是一些样例代码。如果是采用免安装模式的话，运行NUnit就需要运行bin目录下的文件，在bin目录下有net-1.1和net-2.0两个文件夹，分别对应.net的不同版本。
　　下面介绍如何以不同的方式启动NUnit：
　　命令行模式：运行nunit-console.exe。
　　图形用户界面模式：运行nunit.exe。
　　并行(parallel)模式：运行pnunit-launcher.exe。
　　注意：.Net2.0版本的NUnit是使用/platform:anycpu参数来编译的，我们知道这样的结果是运行在x86的系统上会被JIT编译成32位的程序，而在x64的系统上会被JIT编译成64位的程序。如果使用NUnit在x64系统上测试32位的程序就会带来问题。为了避免这个问题，可以使用nunit-agent-x86.exe/nunit-x86.exe来测试，因为在编译的时候使用了/platform:x86作为编译参数。
　　下图是运行NUnit的GUI界面：
　　
　　

NUnit的常用Attribute标记

　　这些都是可以用来作为类或者方法的属性，它们都是System.Attribute类的直接或间接子类，有如下：
　　Category：用来将测试分类。这个在主界面可以看到Tests/Categories两个选项卡，如果给方法标记了Category属性就会在Categories选项卡中看得到。

　　Combinatorial：用来将来测试时需要测试各种可能的组合，比如如下代码：

1. [Test, Combinatorial]
2. 　　public void MyTest(
3. 　　[Values(1, 2, 3)] int x,
4. 　　[Values("A", "B")] string s)
5. 　　{
6. 　　    string value = x + s;
7. 　　    Assert.Greater(2, value.Length);
8. 　　}

测试时实际会测试6种情况：MyTest(1, "A")/MyTest(1, "B")/MyTest(2, "A")/MyTest(2, "B")/MyTest(3, "A")/MyTest(3, "B")。
　　Culture：设置测试时的语言环境，这对我们测试一些语言敏感的场景下有用，比如DateTime.ToString()在不同语言环境下得到的字符串并不相同。
　　Description：用于指定测试对应的描述，如果选择将测试结果生成XML文件，那么就会在XML文件中看到这些描述。
　　ExpectedException：指出执行测试时将会抛出Exception。
　　Explicit：如果测试的类或者方法使用此Attribute，那么在使用带GUI的NUnit测试时这个类或者方法必须在界面上选定才会被执行。
　　Explicit：忽略某个测试类或者方法。
　　Maxtime：测试方法最大执行的毫秒数，如果程序的执行时间超过指定数值，那么就会被认为测试失败。
　　Random：用于指定如何随机生成参数来测试方法。如下面的代码：

1. [Test]
2. 　　public void TestDemo1(
3. 　　[Values(1, 2, 3)] int x,
4. 　　[Random(-10,10,2)] int y)
5. 　　{
6. 　　    Assert.Greater(x + y, 0);
7. 　　}

表示方法TestDemo1会生成6个测试，1,2,3分别作为参数x的值与两次从-10到10之间的随机数y组成6次测试。
　　Range：指定参数的方法，如下面的方法：
[Test]
　　public void TestDemo2(
　　[Range(0, 11, 4)] int x)
　　{
　　    Assert.AreEqual(x%3,0);
　　}
　　表示从0开始递增，步长为4,且不大于11。
　　Repeat：将重复测试的次数。
　　RequiresMTA：表示测试时需要多线程单元（multi-threaded apartment）。
　　RequiresSTA：表示测试时需要单线程单元（single-threaded apartment）。
　　SetUp：在每个测试方法开始之前执行的初始化操作。在NUnit 2.5之前要求每个类只能有一个带SetUp属性的实例方法，但在NUnit 2.5之后则没有次数和必须是实例方法的限制。
　　TearDown：与SetUp的作用相反，是在每个测试方法执行结束之后执行的方法。在NUnit 2.5之前要求每个类只能有一个带SetUp属性的实例方法，但在NUnit 2.5之后则没有次数和必须是实例方法的限制。
　　Test：用来标记需要测试的方法，在NUnit 2.5之前只能用于标记实例方法，在NUnit 2.5之后则可以用于标记静态方法。
　　TestCase：标记方法具有参数并且提供了在测试时需要的参数。如下面的代码：
　　[TestCase(12, 3, 4)]
　　[TestCase(12, 2, 6)]
　　[TestCase(12, 4, 3)]
　　public void DivideTest(int n, int d, int q)
　　{
　　    Assert.AreEqual(q, n / d);
　　}
　　将会执行三次测试，相当于：
　　[Test]
　　public void DivideTest()
　　{
　　    Assert.AreEqual(4,12/3);
　　}
　　
　　[Test]
　　public void DivideTest()
　　{
　　    Assert.AreEqual(6,12/2);
　　}
　　
　　[Test]
　　public void DivideTest()
　　{
　　    Assert.AreEqual(3,12/4);
　　}
　　TestFixture：标记一个类可能具有[Test]/[SetUp]/[TearDown]方法，但这个类不能是抽象类。
　　TestFixtureSetUp：标记在类中所有测试方法执行之前执行的方法。在NUnit 2.5之前只能在类中将此标记最多使用于一个实例方法，在NUnit 2.5之后则可以标记多个方法，而且不限于实例方法还可以用于静态方法。
　　TestFixtureTearDown：标记在类中所有测试方法执行之后再执行的方法。在NUnit 2.5之前只能在类中将此标记最多使用于一个实例方法，在NUnit 2.5之后则可以标记多个方法，而且不限于实例方法还可以用于静态方法。
　　Timeout：标记被测试的方法最大的执行时间，如果超出标记的时间，则会被取消执行并且被标记为测试失败。
　　Values：标记作为测试方法的一系列的参数。前面的代码实例中就有用法实例。

NUnit的断言（Assertions）

　　断言是所有基于xUnit单元测试系列的核心，NUnit通过NUnit.Framework.Assert类提供了丰富的断言。具体说来，NUnit总共提供了11个类别的断言，它们是：
　　Equality Asserts：用于断言对象是否相等方面的断言，主要表现为两个方法的重载：Assert.AreEqual()和Assert.AreNotEqual()两种形式的重载，重载参数包括了常见的基本数值类型（int/float/double等）和引用类型（表现为使用object作为参数）.
　　Identity Asserts：用于判断引用类型的对象是否是同一个引用的断言及断言对象是否存在于某个集合中，如Assert.AreSame、Assert.AreNotSame及Assert.Contains。
　　Condition Asserts：用于某些条件的断言，如：Assert.IsTrue、Assert.True、Assert.IsFalse、Assert.False、Assert.IsNull、Assert.Null、Assert.IsNotNull、Assert.NotNull、Assert.IsNaN、Assert.IsEmpty及Assert.IsNotEmpty。
　　Comparisons Asserts：用于数值及实现了IComparable接口的类型之间的断言，如Assert.Greater（大于）、Assert.GreaterOrEqual（大于或等于）、Assert.Less（小于）、Assert.LessOrEqual（小于或等于）。
　　Type Asserts：用于类型之间的判断，比如判断某个实例是否是某一类型或者是从某个类型继承，如：Assert.IsInstanceOfType、Assert.IsNotInstanceOfType、Assert.IsAssignableFrom、Assert.IsNotAssignableFrom。在NUnit 2.5之后就增加了泛型方法，如Assert.IsInstanceOf<T>、Assert.IsNotInstanceOf<T>、Assert.IsAssignableFrom<T>、Assert.IsNotAssignableFrom<T>。。
　　Exception Asserts：有关异常方面的断言，如Assert.Throws/Assert.Throws<T>、Assert.DoesNotThrow、Assert.Catch/Assert.Catch<T>。
　　Utility Methods：用于精确控制测试过程，总共有四个方法，分别是：Assert.Pass、Assert.Fail、Assert.Ignore、Assert.Inconclusive。Assert.Pass和Assert.Fail是相反的，前者是表示将立即终止测试并将测试结果标识为成功通过测试，后者是立即终止测试并将测试结果标识为测试失败。Assert.Ignore表示忽略测试，这个标记可以用于标识测试方法或者测试的类。
　　StringAssert：用于字符串方面的断言，提供的方法有StringAssert.Contains、StringAssert.StartsWith、StringAssert.EndsWith、StringAssert.AreEqualIgnoringCase及StringAssert.IsMatch。
　　CollectionAssert：关于集合方面的断言，提供的方法有CollectionAssert.AllItemsAreInstancesOfType、CollectionAssert.AllItemsAreNotNull、CollectionAssert.AllItemsAreUnique、CollectionAssert.AreEqual、CollectionAssert.AreEquivalent、CollectionAssert.AreNotEqual、CollectionAssert.AreNotEquivalent、CollectionAssert.Contains、CollectionAssert.DoesNotContain、CollectionAssert.IsSubsetOf、CollectionAssert.IsNotSubsetOf、CollectionAssert.IsEmpty、CollectionAssert.IsNotEmpty和CollectionAssert.IsOrdered。
　　FileAssert：用于文件相关的断言，主要提供两个方法：FileAssert.AreEqual和FileAssert.AreNotEqual。
　　DirectoryAssert：用于文件夹的断言，提供的方法有：DirectoryAssert.AreEqual、DirectoryAssert.AreNotEqual、DirectoryAssert.IsEmpty、DirectoryAssert.IsNotEmpty、DirectoryAssert.IsWithin和DirectoryAssert.IsNotWithin。

NUnit的使用

　　第一次打开NUnit时会是一个空白界面，如下图所示：
　　
　　首先我们需要创建一个NUnit项目，点击[File]->[New Project]会弹出一个保存NUnit项目的对话框，选择合适的路径并输入合适的名称（注意文件后缀名为.nunit），然后点击保存按钮，这样就创建了一个NUnit测试项目。以后我们就可以再次打开这个项目了。
　　此时这个NUnit项目中还不包含任何单元测试用例，我们需要创建包含测试用例的项目。打开Visual Studio创建一个类库项目（在真实项目中通常做法是向当前解决方案中添加类库项目，这样便于解决dll引用问题），接着我们需要添加NUnit的引用，这取决于我们是采用安装方式还是免安装方式，通常情况下我们只需要添加对nunit.framework（对应的dll是unit.framework.dll）的引用就够了。
　　这里周公采用的示例代码如下：

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Text;
5. using NUnit.Framework;
6. namespace UnitTestDemo
7. {
8. [TestFixture]
9. public class NUnitTestDemo
10. {
11. private IList<int> intList = new List<int>();
12. [SetUp]
13. [Category("NA")]
14. public void BeforeTest()
15. { Console.WriteLine("BeforeTest"); }
16. [TestFixtureSetUp]
17. [Category("NA")]
18. public void BeforeAllTests()
19. { Console.WriteLine("BeforeAllTests"); }
20. [TearDown]
21. [Category("NA")]
22. public void AfterTest()
23. { Console.WriteLine("AfterTest"); }
24. [TestFixtureTearDown]
25. [Category("NA")]
26. public void AfterAllTests()
27. { Console.WriteLine("AfterAllTests"); }
28. [Test]
29. [Category("NA")]
30. public void Test1()
31. { Console.WriteLine("Test1"); }
32. [Test]
33. [Category("NA")]
34. public void Test2()
35. { Console.WriteLine("Test2"); }
36. [Test]
37. public void TestFloat()
38. {
39. float value = 0.9999999999999999999999999999f;
40. //value = 0.9999999999999999999999999999;
41. Console.WriteLine("float value:" + value);
42. Assert.AreEqual(value, 1f);
43. Console.WriteLine("TestFloat");
44. }
45. [Test]
46. public void TestDouble()
47. {
48. double value = 0.9999999999999999999999999999d;
49. Console.WriteLine("double value:" + value);
50. Assert.AreEqual(value, 1d);
51. Console.WriteLine("Test2");
52. }
53. [Test]
54. public void TestDecimal()
55. {
56. decimal value = 0.9999999999999999999999999999M;
57. Console.WriteLine("decimal value:" + value);
58. Assert.AreEqual(value, 1M);
59. Console.WriteLine("Test2");
60. }
61. [Test,Repeat(3)]
62. public void TestIntList2()
63. {
64. Assert.AreEqual(0, intList.Count);
65. }
66. [Test]
67. public void TestIntList1()
68. {
69. intList.Add(1);
70. Assert.AreEqual(1, intList.Count);
71. }
72. [TestCase(12, 3, 4)]
73. [TestCase(12, 2, 6)]
74. [TestCase(12, 4, 3)]
75. public void DivideTest(int n, int d, int q)
76. {
77. Assert.AreEqual(q, n / d);
78. }
79. [Test, Combinatorial,Description("This is used for show Combinatorial")]
80. public void MyTest(
81. [Values(1, 2, 3)] int x,
82. [Values("A", "B")] string s)
83. {
84. string value = x + s;
85. Assert.Greater(2, value.Length);
86. }
87. [Test]
88. public void TestDemo1(
89. [Values(1, 2, 3)] int x,
90. [Random(-10,10,2)] int y)
91. {
92. Assert.Greater(x + y, 0);
93. }
94. [Test]
95. public void TestDemo2(
96. [Range(0, 11, 4)] int x)
97. {
98. Assert.AreEqual(x%3,0);
99. }
100. }
101. }

编译项目生成dll。我们就可以在NUnit主界面上点击[Project]->[Add Assembly...]来添加刚才编译生成的dll，加载成功后界面如下所示：
　　
　　点击界面上的[Run]按钮就可以开始测试了。注意这种方式下是测试所有的测试方法，如果我们只想测试某几个方法，可以勾选方面前面的复选框（默认情况下复选框不出现，需要按照点击[Tools]->[Setting]打开设置界面，然后点击在[GUI]下面找到[Tree Display]，勾选上“Show CheckBoxes”即可）。
　　如果我们只是想单独测试某个方法，那就更简单了——直接双击那个测试方法即可。
　　有时候我们进行测试时还会用到一些config文件里面的配置信息，如在app.config/web.config中保存数据库连接字符串信息及其他的配置信息，为了能让NUnit测试时能读取app.config/web.config中保存的配置信息，我们需要对NUnit进行配置。
　　为了演示，我们制定以下信息：
　　项目名称：UnitTestDemo
　　项目位置：D:\BlogCode\UnitTestDemo\
　　项目编译模式（Debug/Release)：Debug
　　为了演示刚才的如何对config文件中保存的数据进行测试，我们在刚才的代码基础上编写了三个测试用例，代码如下：

1. [Test]
2. public void Test0_51CTOBlog()
3. {
4. StringAssert.AreEqualIgnoringCase(ConfigurationManager.AppSettings["51ctoBlog"], "http://zhoufoxcn.blog.51cto.com");
5. }
6. [Test]
7. public void Test0_CSDNBlog()
8. {
9. StringAssert.AreEqualIgnoringCase(ConfigurationManager.AppSettings["CSDNBlog"], "http://blog.csdn.net/zhoufoxcn");
10. }
11. [Test]
12. public void Test0_SinaWeiBo()
13. {
14. StringAssert.AreEqualIgnoringCase(ConfigurationManager.AppSettings["SinaWeiBo"], "http://weibo.com/zhoufoxcn");
15. }

　　同时在app.config文件的appSettings节点增加以下数据：

1. <appSettings>
2. <add key="51ctoBlog" value="http://zhoufoxcn.blog.51cto.com"/>
3. <add key="CSDNBlog" value="http://blog.csdn.net/zhoufoxcn"/>
4. <add key="SinaWeiBo" value="http://weibo.com/zhoufoxcn"/>
5. </appSettings>

　　如果不在NUnit上做任何设置，我们会得到错误的结果，如下图所示：
　　
　　这时，我们可以按照如下步骤配置，点击[Project]-[Edit...]打开如下界面：
　　
　　在上图的界面中设置ApplicationBase为当前要测试的dll所在的路径，本例中为：D:\BlogCode\UnitTestDemo\bin\Debug（注意如果复制全路径到文本框中NUnit会自动更改为相对路径），因为当前项目是名为UnitTestDemo的类库项目，所以对应config文件名称为UnitTestDemo.dll.config，将其填入Configuration File Name后面的文本框中，然后我们再次点击[Run]按钮就会看到测试通过。
总结
　　作为xUnit体系中的一员，NUnit确实给.Net开发人员进行单元测试带来了不少方便，在早期我们一直都是使用NUnit进行单元测试的。但是也存在着一些不足之处，比如：1.在xUnit体系中的JUnit是在测试每个方法时都是新生成一个实例，而在NUnit中确实一个TestFixture只会生成一个实例，这样一来如果对要包含单元测试类中的实例数据进行更改会可能会影响到其它的测试方法（像JUnit那样每次都生成一个实例则不会产生这种情况）。2.早期大多数人以为像JUnit中一样，[SetUp]、[TearDown]只会在所有测试前、后分别执行一次，实际情况是在每个测试前、后都会执行一次，为了达到JUnit中[SetUp]、[TearDown]这样的效果，只能新增TestFixtureSetUp、TestFixtureTearDown属性。除此之外，还存在一些缺点和不足。
　　所以本篇只是简单介绍了NUnit的一些用法，虽然NUnit提供了相当多的断言及Attribute，但实际用到的并不多，在这里介绍它是为介绍另一个.NET单元测试工具作铺垫。
　　
　　周金桥
　　2013-01-03