NUnit使用方法

NUnit2.0详细使用方法

注：NUnit中文文档可以参看我的另一个站点:http://www.36sign.com/nunit

前一段时间,有人问我在.NET里如何进行TDD开发.这个问题促使我想对NUnit做一个详细的介绍.因为我们大家都知道NUnit是在.NET进行TDD的利器.
如果你已经知道很多关于NUnit的应用,请指出我的不对之处和提出一些建议，使本文更加完善.如果你对NUnit还不是很了解的话,我建议你还是阅读一下.

本文分为以下部分:

1. TDD的简介

首先什么是TDD呢?Kent Beck在他的<<测试驱动开发 >>(Addison-Wesley Professional,2003)一书中,使用下面2个原则来定义TDD:

·除非你有一个失败的自动测试,永远不要写一单行代码.

·阻止重复

我想第一个原则是显而易见的.在没有失败的自动测试下就不要写代码.因为测试是嵌入在代码必须满足的需求中.如果没有需求,就没有必要实现任何东西.所以这个原则阻止我们去实现那些没有测试和在解决方案中不需要的功能.

第二个原则说明了在一个程序中,不应该包含重复的代码.如果代码重复,我想这就是不好的软件设计的象征.随着时间的流逝,它会对程序造成不一致的问题,并且使代码变非常混乱 ,因为我们时常不会记得重复代码的位置.如果发现代码重复,我想我们应该立即删除代码重复.其实这就涉及到重构了.在这里我就不多讲了.

一般来说,测试分为2种类型,一是程序员自己的测试,另外一种是客户的测试.关于客户测试，我推荐一个FIT的框架，非常不错。在这里，我们讲的TDD就是程序员测试.那么什么是程序员测试呢?我认为就是我们常说的单元测试.既然是单元测试,在.NET里势必会用到某些工具,目前最著名恐怕就是我即将介绍的NUnit了,

2.NUnit的介绍

NUnit是一个单元测试框架,专门针对于.NET来写的.其实在前面有JUnit(Java),CPPUnit(C++),他们都是xUnit的一员.最初,它是从JUnit而来.现在的版本是2.2.接下来我所用的都是基于这个版本.

NUnit最初是由James W. Newkirk, Alexei A. Vorontsov 和Philip A. Craig, 后来开发团队逐渐庞大起来.在开发过程中, Kent Beck 和Erich Gamma2位牛人也提供了许多帮助.看来对于NUnit还真是下了一番力气了.J

NUnit是xUnit家族种的第4个主打产品,完全由C#语言来编写,并且编写时充分利用了许多.NET的特性,比如反射,客户属性等等.

最重要的一点是它适合于所有.NET语言.

如果你还没有下载,可以到http://www.nunit.org/去下载.

2.1 NUnit的介绍

   Ok,下面正式讲解NUnit.在讲解之前,看看几张图片:

     

图1  NUnit运行的效果

                     图2   NUnit运行的另外一个效果

 从中我们可以非常容易发现,右边是个状态条,图1是红色的,图2是绿色的.为什么会这样呢?因为如果所有测试案例运行成功,就为绿色,反之如果有一个不成功,则为红色,但也有黄色的.左面的工作域内则是我们写的每一个单元测试.

通过上面的图片,我想你对NUnit有个总的了解了.

接下来还是分为2个部分,一是NUnit的布局,另外一部分就是它的核心概念.

首先熟悉一下NUnit GUI的布局.

让我们更进一步看一下测试运行器窗口的布局。在右边面板的中间，可以看到测试进度条。进度条的颜色反映了测试执行的状态：

• 绿色 描述目前所执行的测试都通过
• 黄色 意味某些测试忽略，但是这里没有失败
• 红色 表示有失败

底部的状态条表示下面的状态：

• 状态.说明了现在运行测试的状态。当所有测试完成时，状态变为Completed.运行测试中，状态是Running: <test-name> (<test-name>是正在运行的测试名称)。
• Test Cases说明加载的程序集中测试案例的总个数。这也是测试树里叶子节点的个数。
• Tests Run 已经完成的测试个数。
• Failures  到目前为止，所有测试中失败的个数.
• Time  显示运行测试时间（以秒计）

File主菜单有以下内容：

• New Project允许你创建一个新工程。工程是一个测试程序集的集合。这种机制让你组织多个测试程序集，并把他们作为一个组对待。
• Open 加载一个新的测试程序集，或一个以前保存的NUnit工程文件。
• Close关闭现在加载的测试程序集或现在加载的NUnit工程。
• Save 保存现在的Nunit工程到一个文件。如果正工作单个程序集，本菜单项允许你创建一个新的NUnit工程，并把它保存在文件里。
• Save As允许你将现有NUnit工程作为一个文件保存。
• Reload 强制重载现有测试程序集或NUnit工程。NUnit-Gui自动监测现加载的测试程序集的变化。

当程序集变化时，测试运行器重新加载测试程序集。（当测试正运行时，现在加载的测试程序集不会重新加载。在测试运行之间测试程序集仅可以重新加载。一个忠告：如果测试程序集依赖另外一个程序集，测试运行器不会观察任何依赖的程序集。对测试运行器来说，强制一个重载使全部依赖的程序集变化可见。

• Recent Files  说明5个最近在NUnit中加载的测试程序集或NUnit工程（这个列表在Windows注册表，由每个用户维护，因此如果你共享你的PC，你仅看到你的测试）。最近程序集的数量可以使用Options菜单项修改，可以访问Tool主菜单。
• Exit退出。
•  View菜单有以下内容：
• Expand一层层扩展现在树中所选节点
• Collapse 折叠现在树中选择的节点
• Expand All递归扩展树中所选节点后的所有节点
• Collapse All递归折叠树中所选节点后的所有节点
• Expand Fixtures扩展树中所有代表测试fixture的节点。
• Collapse Fixtures 折叠树中所有代表测试fixture的节点。
• Properties 显示树中现所选节点的属性。
• Tools 菜单由这些项:
• Save Results as XML作为一XML文件保存运行测试的结果。
• Options让你定制NUnit的行为。

现在看看右边，你已经熟悉Run按钮和进度条。这里还有一个紧跟Run按钮的Stop按钮：点击这个按钮会终止执行正运行的测试。进度条下面是一个文本窗口，在它上方，由以下4个标签：

• Errors and Failures 窗口显示失败的测试。在我们的例子里，这个窗口是空。
• Tests Not Run 窗口显示没有得到执行的测试。
• Console.Error 窗口显示运行测试产生的错误消息。这些此消息是应用程序代码使用Console.Error输出流可以输出的。
• Console.Out窗口显示运行测试打印到Console.Error输出流的文本消息。

2.2 一些常用属性

 接下来,我将讲述这个框架如何使用.同时也涉及到一些非常重要的概念,我想其客户属性是非常重要的.在NUnit里,有以下几种属性:

• Test Fixture
• Test

下面我将对每种属性一一讲解.

TestFixtureAttribute

    本属性标记一个类包含测试,当然setup和teardown方法可有可无.(关于setup 和teardown方法在后面介绍)

    做为一个测试的类,这个类还有一些限制

• 必须是Public,否则NUnit看不到它的存在.
• 它必须有一个缺省的构造函数,否则是NUnit不会构造它.
• 构造函数应该没有任何副作用,因为NUnit在运行时经常会构造这个类多次,如果要是构造函数要什么副作用的话,那不是乱了.

举个例子

using System;
using NUnit.Framework;
namespace MyTest.Tests
{
 [TestFixture]
 public class PriceFixture
 {
  // 
 }
}

  

TestAttribute

 Test属性用来标记一个类(已经标记为TestFixture)的某个方法是可以测试的.为了和先前的版本向后兼容,头4个字符(“test”)忽略大小写.(参看http://nunit.org/test.html)

这个测试方法可以定义为:       

public void MethodName()

从上面可以看出,这个方法没有任何参数,其实测试方法必须没有参数.如果我们定义方法不对的话,这个方法不会出现在测试方法列表中.也就是说在NUnit的界面左边的工作域内,看不到这个方法.还有一点就是这个方法不返回任何参数,并且必须为Public.

例如:

using System;
using NUnit.Framework;
namespace MyTest.Tests
{
  [TestFixture]
  public class SuccessTests
  {
     [Test] public void Test1()
    { /**//*  */ }
  }
}

 

一般来说,有了上面两个属性,你可以做基本的事情了.



另外，我们再对如何进行比较做一个描述。

在NUnit中，用Assert（断言）进行比较，Assert是一个类，它包括以下方法：AreEqual，AreSame，Equals， Fail，Ignore，IsFalse，IsNotNull，具体请参看NUnit的文档。

3.如何在.NET中应用NUnit

我将举个例子,一步一步演示如何去使用NUnit.

第1步.为测试代码创建一个Visual Studio工程。

在Microsoft Visual Studio .NET中，让我们开始创建一个新的工程。选择Visual C#工程作为工程类型，Class Library作为模板。将工程命名为NUnitQuickStart.图4-1是一个描述本步骤的Visual Studio .NET。

 
                            图 4-1: 创建第一个NUnit工程

第2步.增加一个NUnit框架引用

在Microsoft Visual Studio .NET里创建这个例子时，你需要增加一个NUnit.framework.dll引用，如下：

在Solution Explorer右击引用，然后选择增加引用

   NUnit.framework组件，在Add Reference对话框中按Select和OK按钮。

图4-2 描述了这步:

 
图 4-2: 增加一个 NUnit.framework.dll 引用到工程

第3步.为工程加一个类.

为工程加一个NumbersFixture类。这里是这个例子的代码。

using System; 
using NUnit.Framework;   
namespace NUnitQuickStart 
{ 
            [TestFixture] 
            public class NumersFixture 
            { 
                        [Test] 
                        public void AddTwoNumbers() 
                        { 
                                    int a=1; 
                                    int b=2; 
                                    int sum=a+b; 
                                    Assert.AreEqual(sum,3); 
                        } 
            } 
}

第4步.建立你的Visual Studio 工程，使用NUnit-Gui测试

从程序->NUnit2.2打开NUnit-gui,加载本本工程编译的程序集.

为了在Visual Studio .NET中自动运行NUnit-Gui，你需要建立NUnit-Gui作为你的启动程序：

在 Solution Explorer里右击你的NunitQuickStart工程。

在弹出菜单中选择属性。

在显示的对话框的左面，点击Configuration Properties夹

选择出现在Configuration Properties夹下的Debugging。

在属性框右边的Start Action部分，选择下拉框的Program作为Debug Mode值。

按Apply按钮

设置NUnit-gui.exe 作为Start Application。，你既可以键入nunit-gui.exe的全路径，也可使用浏览按钮来指向它。

图4-3 帮助描述本步骤:
  

图 4-3:将NUnit-Gui 作为工程的测试运行器

第5步.编译运行测试.

 现在编译solution。成功编译后，开始应用程序。NUnit-Gui测试运行器出现。当你第一次开始NUnit-Gui，它打开时没有测试加载。从File菜单选择Oprn，浏览NUnitQuickStart.dll的路径。当你加载了测试的程序集，测试运行器为加载的程序集的测试产生一个可见的表现。在例子中，测试程序集仅有一个测试，测试程序集的结构如图4－4所示：

 
 图 4-4: 测试程序集的测试在 NUnit-Gui中的视图

按Run按钮。树的节点变为绿色，而且测试运行器窗口上的进度条变绿，绿色代表成功通过。

 

4.其他的一些核心概念

 上面的例子介绍了基本的NUnit特性和功能. TestFixture, Test, 和 Assert是3个最基本的特征,我们可以用这些特性进行程序员测试了.但是有的时候,你觉得这3个远远不够,比如有的时候打开一个数据库连接多次,有没有只让它打开一次的方法呢?如果我想把测试分类,应该怎样实现呢?如果我想忽略某些测试,又应该如何去完成呢?不用担心,NUnit已经有这样的功能了.

下面我们一一作出回答.

SetUp/TearDown 属性

在早期给的test fixture定义里,我们说test fixture的测试是一组常规运行时资源.在测试完成之后,或是在测试执行种,或是释放或清除之前,这些常规运行时资源在一确定的方式上可能需要获取和初始化.NUnit使用2个额外的属性:SetUp 和TearDown,就支持这种常规的初始化/清除.我们上面的例子来描述这个功能.让我们增加乘法.

using System; 
using NUnit.Framework; 
  
namespace NUnitQuickStart 
{ 
            [TestFixture] 
            public class NumersFixture 
            { 
                        [Test] 
                        public void AddTwoNumbers() 
                        { 
                                    int a=1; 
                                    int b=2; 
                                    int sum=a+b; 
                                    Assert.AreEqual(sum,3); 
                        } 
                        [Test] 
                        public void MultiplyTwoNumbers() 
                        { 
                                    int a = 1; 
                                    int b = 2; 
                                    int product = a * b; 
                                    Assert.AreEqual(2, product); 
                        } 
  
            } 
} 

    我们仔细一看,不对,有重复的代码,如何去除重复的代码呢?我们可以提取这些代码到一个独立的方法,然后标志这个方法为SetUp 属性,这样2个测试方法可以共享对操作数的初始化了,这里是改动后的代码: 

using System; 
using NUnit.Framework; 
  
namespace NUnitQuickStart 
{ 
            [TestFixture] 
            public class NumersFixture 
            { 
                        private int a; 
                        private int b; 
                        [SetUp] 
                        public void InitializeOperands() 
                        { 
                                    a = 1; 
                                    b = 2; 
                        } 
  
                        [Test] 
                        public void AddTwoNumbers() 
                        { 
                                    int sum=a+b; 
                                    Assert.AreEqual(sum,3); 
                        } 
                        [Test] 
                        public void MultiplyTwoNumbers() 
                        { 
                                    int product = a * b; 
                                    Assert.AreEqual(2, product); 
                        } 
  
            } 
} 

 

   这样NUnit将在执行每个测试前执行标记SetUp属性的方法.在本例中就是执行InitializeOperands()方法.记住，这里这个方法必须为public，不然就会有以下错误：Invalid Setup or TearDown method signature

ExpectedException

这里是一个验证这个假设的测试.有的时候,我们知道某些操作会有异常出现,例如, 在实例中增加除法,某个操作被0除,抛出的异常和.NET文档描述的一样.参看以下源代码.

[Test]
[ExpectedException(typeof(DivideByZeroException))]
public void DivideByZero()
{
   int zero = 0;
   int infinity = a/zero;
   Assert.Fail("Should have gotten an exception");
}

 

   除了[Test]属性之外, DivideByZero方法有另外一个客户属性: ExpectedException.在这个属性里,你可以在执行过程中捕获你期望的异常类型,例如在本例就是DivideByZeroException.如果这个方法在没有抛出期望异常的情况下完成了,这个测试失败.使用这个属性帮助我们写程序员测试验证边界条件(Boundary Conditions).

Ignore 属性

   由于种种原因,有一些测试我们不想运行.当然,这些原因可能包括你认为这个测试还没有完成,这个测试正在重构之中,这个测试的需求不是太明确.但你有不想破坏测试,不然进度条可是红色的哟.怎么办?使用Ignore属性.你可以保持测试,但又不运行它们.让我们标记MultiplyTwoNumbers测试方法为Ignore属性:

[Test]
[Ignore("Multiplication is ignored")]
public void MultiplyTwoNumbers()
{
   int product = a * b;
   Assert.AreEqual(2, product);
}

 

   运行测试,现在产生了下面的输出(在图5-1显示):

 
图 5-1: 在一个程序员测试中使用 Ignore属性

   Ignore属性可以附加到一个独立的测试方法,也可以附加到整个测试类(TestFixture).如果Ignore属性附加到TestFixture,所有在fixture的测试都被忽略.

TestFixtureSetUp/TestFixtureTearDown

   有时,一组测试需要的资源太昂贵.例如,数据库连接可能是一个关键资源,在一个test fixture的每个测试中,打开/关闭数据库连接可能非常慢.这就是我在开始提到的问题.如何解决?NUnit有一对类似于前面讨论的SetUp/TearDown的属性: TestFixtureSetUp/TestFixtureTearDown.正如他们名字表明的一样,这些属性用来标记为整个test fixture初始化/释放资源方法一次的方法.

   例如,如果你想为所有test fixture的测试共享相同的数据库连接对象,我们可以写一个打开数据库连接的方法,标记为TestFixtureSetUp属性,编写另外一个关闭数据库连接的方法,标记为TestFixtureTearDown属性.这里是描述这个的例子.

using NUnit.Framework;

[TestFixture]
public class DatabaseFixture
{
   [TestFixtureSetUp]
   public void OpenConnection()
   {
      //open the connection to the database
   }
 
   [TestFixtureTearDown]
   public void CloseConnection()
   {
      //close the connection to the database
   }
   
   [SetUp]
   public void CreateDatabaseObjects()
   {
      //insert the records into the database table
   }
 
   [TearDown]
   public void DeleteDatabaseObjects()
   {
      //remove the inserted records from the database table
   }
 
   [Test]
   public void ReadOneObject()
   {
      //load one record using the open database connection
   }

   [Test]
   public void ReadManyObjects()
   {
      //load many records using the open database connection
   }
}

 

Test Suite

   Test Suite是test case或其他test suite的集合. 合成(Composite)^,模式描述了test case和test suite之间的关系.

 参考来自NUnit的关于Suite的代码

Suite Attribute

namespace NUnit.Tests
{
using System;
  using NUnit.Framework;
 


  public class AllTests
  {
    [Suite]
    public static TestSuite Suite
    {
      get
      {
        TestSuite suite = new TestSuite("All Tests");
        suite.Add(new OneTestCase());
        suite.Add(new Assemblies.AssemblyTests());
        suite.Add(new AssertionTest());
        return suite;
      }
    }
  }
} 

 

Category属性

 对于测试来说，你有的时候需要将之分类，此属性正好就是用来解决这个问题的。

 你可以选择你需要运行的测试类目录，也可以选择除了这些目录之外的测试都可以运行。在命令行环境里 /include 和/exclude来实现。在GUI环境下，就更简单了，选择左边工作域里的Catagories Tab，选择Add和Remove既可以了。

在上面的例子上做了一些改善，代码如下：

using System; 
using NUnit.Framework; 
  
namespace NUnitQuickStart 
{ 
            [TestFixture] 
            public class NumersFixture 
            { 
                        private int a; 
                        private int b; 
                        [SetUp] 
                        public  void InitializeOperands() 
                        { 
                                    a = 1; 
                                    b = 2; 
                        } 
  
                        [Test] 
                        [Category("Numbers")] 
                        public void AddTwoNumbers() 
                        { 
                                    int sum=a+b; 
                                    Assert.AreEqual(sum,3); 
                        } 
                        
                       [Test] 
                [Category("Exception")] 
                        [ExpectedException(typeof(DivideByZeroException))] 
                        public void DivideByZero() 
                        { 
                                    int zero = 0; 
                                    int infinity = a/zero; 
                                    Assert.Fail("Should have gotten an exception"); 
                        } 
                        [Test] 
                        [Ignore("Multiplication is ignored")] 
                        [Category("Numbers")] 
                        public void MultiplyTwoNumbers() 
                        { 
                                    int product = a * b; 
                                    Assert.AreEqual(2, product); 
                        } 
  
               } 

 
        NUnit-GUI界面如图5-2：

图5-2:使用Catagories属性的界面

Explicit属性

本属性忽略一个test和test fixture，直到它们显式的选择执行。如果test和test fixture在执行的过程中被发现，就忽略他们。所以，这样一来进度条显示为黄色，因为有test或test fixture忽略了。

 例如：

[Test,Explicit] 
[Category("Exception")] 
[ExpectedException(typeof(DivideByZeroException))] 
public void DivideByZero() 
{ 
      int zero = 0; 
      int infinity = a/zero; 
      Assert.Fail("Should have gotten an exception"); 
}

 为什么会设计成这样呢？原因是Ingore属性忽略了某个test或test fixture，那么他们你再想调用执行是不可能的。那么万一有一天我想调用被忽略的test或test fixture怎么办，就用Explicit属性了。我想这就是其中的原因吧。

Expected Exception属性

  期望在运行时抛出一个期望的异常，如果是，则测试通过，否则不通过。

参看下面的例子：

[Test] 
[ExpectedException(typeofInvalidOperationException))] 
public void ExpectAnException() 
 { 
   int zero = 0; 
   int infinity = a/zero; 
   Assert.Fail("Should have gotten an exception"); 
                       
 }

 

  在本测试中，应该抛出DivideByZeroException，但是期望的是InvalidOperationException，所以不能通过。如果我们将[ExpectedException(typeof(InvalidOperationException))]改为[ExpectedException(typeof(DivideByZeroException))]，本测试通过。

5 . 测试生命周期合约

   如果记得test case的定义,其中一个属性是测试的独立性或隔离性.SetUp/TearDown方法提供达到测试隔离性的目的.SetUp确保共享的资源在每个测试运行前正确初始化,TearDown确保没有运行测试产生的遗留副作用. TestFixtureSetUp/TestFixtureTearDown同样提供相同的目的,但是却在test fixture范围里,我们刚才描述的内容组成了测试框架的运行时容器(test runner)和你写的测试之间的生命周期合约(life-cycle contract).

   为了描述这个合约,我们写一个简单的测试来说明什么方法调用了,怎么合适调用的.这里是代码:

using System;
using NUnit.Framework;
[TestFixture]
public class LifeCycleContractFixture
{
   [TestFixtureSetUp]
   public void FixtureSetUp()
   {
     Console.Out.WriteLine("FixtureSetUp");
   }
 
   [TestFixtureTearDown]
   public void FixtureTearDown()
   {
      Console.Out.WriteLine("FixtureTearDown");
   }
   
   [SetUp]
   public void SetUp()
   {
      Console.Out.WriteLine("SetUp");
   }

   [TearDown]
   public void TearDown()
   {
      Console.Out.WriteLine("TearDown");
   }
 
   [Test]
   public void Test1()
   {
      Console.Out.WriteLine("Test 1");
   }

   [Test]
   public void Test2()
   {
      Console.Out.WriteLine("Test 2");
   }

}

 

当编译和运行这个测试,可以在System.Console窗口看到下面的输出:

   FixtureSetUp
SetUp
Test 1
TearDown
SetUp
Test 2
TearDown
FixtureTearDown

 

   可以看到, SetUp/TearDown方法调用在每个测试方法的前后. 整个fixture调用一次TestFixtureSetUp/TestFixtureTearDown方法.

 

 

 

 

参考

1)      http://www.nunit.org

2)      James W. Newkirk and Alexei A. Vorontsov ,Test-Driven Development in Microsoft .NET，Microsoft Press，2003

3)      http://www.testdriven.com

4)      Kent Beck, Test-Driven Development: By Example ，Addison-Wesley Professional, 2003

5)      Andrew Hunt ,David Thomas ,Pragmatic Unit Testing  In   C#  With NUnit
6)      NUnit中文文档:http://www.36sign.com/nunit