CppUnit测试框架入门(2)

Author: Cpluser Website：http://tdd.nease.net Email：[email protected] Blog：http://blog.csdn.net/cpluser/ 演示代码下载

三、CppUnit开发环境设置

认识了CppUnit的测试环境，想必你已经是在磨拳擦掌，准备在你的开发过程中感受一下测试驱动开发的感觉了。不过，在使用CppUnit前，还需要设置一下你的开发环境。

1、CppUnit的lib和dll

CppUnit为我们提供了两套框架库，一个为静态的lib，一个为动态的dll。

cppunit project：静态lib

cppunit_dll project：动态dll和lib

在开发中我们可以根据实际情况作出选择。进入src文件夹，打开CppUnitLibraries.dsw。分别编译这两个project，输出位置均为lib文件夹。

另外一个需要关注的project是TestRunner，它输出一个dll，提供了一个基于GUI 方式的测试环境，即前面我们提到的两种测试环境之一。我们也需要编译这个project，输出位置亦为lib文件夹。

为了方便开发，我们把这些编译出来的lib和dll（包括Debug版和Release版） copy 到我们自己建立的一个文件夹中(当然你也可以不这么做)，例如F:\cppunit1.9.0\lib\，同时我们也把CppUnit源代码中include文件夹copy到我们自己的include文件夹下。然后在VC的tools/options/directories/include files和library files中设置include路径和lib路径。最后别忘了在你的project中link正确的lib。

2、在你的VC project中打开RTTI开关。

具体位置Project Settings/C++/C++ Language。

3、为TestRunner.dll设置环境变量

TestRunner.dll为我们提供了基于GUI的测试环境。为了让我们的测试程序能正确的调用它，TestRunner.dll必须位于你的测试程序的路径下。但最简单的方法是在操作系统的环境变量Path中添TestRunner.dll的路径，这样是最省事的。

四、你的第一个TDD example

一切准备就绪，现在我们可以来看看怎样添加测试代码了。前面我们提到过，CppUnit最小的测试单位是TestCase，多个相关TestCase组成一个TestSuite。要添加测试代码最简单的方法就是利用CppUnit为我们提供的几个宏来进行（当然还有其他的手工加入方法，但均是殊途同归，大家可以查阅CppUnit头文件中的演示代码）。这几个宏是：

CPPUNIT_TEST_SUITE() 开始创建一个TestSuite

CPPUNIT_TEST() 添加TestCase

CPPUNIT_TEST_SUITE_END() 结束创建TestSuite

CPPUNIT_TEST_SUITE_NAMED_REGISTRATION() 添加一个TestSuite到一个指定的TestFactoryRegistry工厂

感兴趣的朋友可以在HelperMacros.h看看这几个宏的声明，本文在此不做详述。

1、一个实现两个整数相加的类

假定我们要实现一个类，类名暂且取做CPlus，它的功能主要是实现两个数相加（多简单的一个类啊，这也要测试吗？不要紧，我们只是了解怎样加入测试代码来测试它就行了，所以越简单越好）。 假定这个类要实现的相加的方法是:

int Add(int nNum1, int nNum2);

Ok，那我们先来写测试这个方法的代码吧。TDD 可是先写测试代码，后写产品代码(CPlus)的哦！先写的测试代码往往是不能运行或编译的，我们的目标是在写好测试代码后写产品代码，使之编译通过，然后再进行重构。这就是Kent Beck说的“red/green/refactor”( 还记得基于GUI的测试环境的状态条吗?)。所以，上面的类名和方法应该还只是在你的心里，还只是你的idea而已。

2、在VC中为测试代码建立一个 Project

通常，测试代码和被测试对象是处于不同的Project中的。这样就不会让你的产品代码被测试代码所“污染 ”。

在本例中，我们将建立一个基于GUI 方式的测试环境。在VC中，我们建立一个基于对话框的Project。别忘了link正确的lib，本例中我们使用静态的CppUnit lib。由于我们希望这个Project运行后显示的是图2这样的界面，所以我们需要在App的 Instance()中屏蔽掉原有的对话框，代之以CppUnit的GUI。

CppUnit::MfcUi::TestRunner runner; runner.addTest(PlusTest::suite()); //添加测试 runner.run(); //show UI /* CCPlusTestDlg dlg; m_pMainWnd = &dlg; int nResponse = dlg.DoModal(); if (nResponse == IDOK) { // TODO: Place code here to handle when the dialog is // dismissed with OK } else if (nResponse == IDCANCEL) { // TODO: Place code here to handle when the dialog is // dismissed with Cancel } */

前面我们提到过，TestRunner输出图2这样的对话框，这也是前面我们为什么要为TestRunner.dll的路径设置环境变量的原因。

注意：PlusTest::suite()返回一个指向CppUnit::Test的指针.这个指针就是整个测试的起点。CppUnit::TestFactoryRegistry::getRegistry()根据TestSuite的名字返回TestFactoryRegistry工厂，然后调用工厂里的makeTest()对TestSuite进行组装,这是个递归调用，将建立起一个树状的测试结构。

namespace PlusTest { CppUnit::Test* suite() { CppUnit::TestFactoryRegistry &registry = CppUnit::TestFactoryRegistry::getRegistry(plusSuiteName()); return registry.makeTest(); } }

另外别忘加头文件：

#include "CPlusTestSuite.h" #include <cppunit/ui/mfc/TestRunner.h> #include <cppunit/extensions/TestFactoryRegistry.h>

3、在Project中加入一个类，取名CPlusTestCase

CPlusTestCase从CppUnit::TestCase继承，代码如下：

class CPlusTestCase : public CppUnit::TestCase { CPPUNIT_TEST_SUITE(CPlusTestCase); CPPUNIT_TEST(testAdd); CPPUNIT_TEST_SUITE_END(); public: CPlusTestCase(); virtual ~CPlusTestCase(); void testAdd(); //测试方法 };

看到这几个宏了吗？它们可是在这大显身手了一把。

CPPUNIT_TEST_SUITE(CPlusTestCase);

CPPUNIT_TEST( testAdd );

CPPUNIT_TEST_SUITE_END();

通过这几个宏，我们就把CPlusTestCase和testAdd注册到了测试列表当中。

另外，我们需要在Cpp文件中加入另外一个宏：

CPPUNIT_TEST_SUITE_NAMED_REGISTRATION(CPlusTestCase,PlusTest::plusSuiteName() );

它将CPlusTestCase这个TestSuite注册到一个指定的TestFactory工厂中，这个TestSuite用 PlusTest::plusSuiteName()函数返回的名字来标识（前面介绍的suite()函数中就是通过这个名字来获取这个工厂的）。plusSuiteName()是PlusTest这个namespace下的一个函数，它返回我们为这个TestSuite建立的名字（本例我们取名为“plus”）。其实我们也可以不用这么做，直接在宏里写入“plus“即可。但是这样可以防止硬编码带来的麻烦。

在测试类中，我们添加了一个测试方法：

void testAdd();

它测试的对象是前面提到的CPlus类的方法：

int Add(int nNum1, int nNum2);

我们来看看它的实现：

void CPlusTestCase::testAdd() { CPlus plus; int nResult = plus.Add(10, 20); //执行Add操作 CPPUNIT_ASSERT_EQUAL(30, nResult); //检查结果是否等于30 }

CPPUNIT_ASSERT_EQUAL是一个判断结果的宏。CppUnit中类似的其它宏请查阅TestAssert.h，本文在此不做详述 。

另外，我们还可以覆写基类的 setUp()、tearDown()两个函数。这两个函数实际上是一个模板方法，在测试运行之前会调用setUp()以进行一些初始化的工作，测试结束之后又会调用tearDown()来做一些“善后工作” ，比如资源的回收等等。当然，你也可以不覆写这两个函数，因为它们在基类里定义成了空方法，而不是纯虚函数。

另外，Cpp中要加入头文件：

#include "plusSuite.h"

4、根据测试代码编写产品代码

编写完上面的测试代码后，进行编译。编译肯定通不过，编译器会告诉我们CPlus类没有声明，因为我们还没有实现CPlus类呢！现在的工作就是马上实现CPlus类，让编译通过。现在你应该嗅到一点“测试驱动“的味道了吧？

在VC中建立一个MFC Extension Dll的Project，在这个Project 中加入类CPlus,它的声明如下：

class AFX_EXT_CLASS CPlus { public: CPlus(); virtual ~CPlus(); public: int Add(int nNum1, int nNum2); };

仅有一个方法，就是我们的测试代码要测试的那个方法。来看看它的实现：

int CPlus::Add(int nNum1, int nNum2) { return nNum1+nNum2; }

非常简单，不是吗？现在让前面那个包含测试代码的Project dependent这个Project,include 相关头文件 ,Rebuild All，你会发现编译已通过。你体会到了测试代码驱动产品代码了吗？当然我们的这个例子还很简单 ，没有重构这一步骤。

运行我们的测试程序，你就会看到如图6的界面:

图6

单击”Browse”， 如图7：

图7

这下你应该对前面我们说的TestSuite的名字理解更深了吧。plus是一个测试包TestSuite，它的下面包含一个测试用例，这个测试用例下面又包含一个测试方法。

至此，我们对CppUnit测试框架的应用作了一个详细的介绍，希望能对你在进行TDD过程中有所帮助。

参考资料:

CppUnit源码及说明文档