CppUnit学习笔记

如何在VS2010中编译CppUnit：http://www.cnblogs.com/justin_s/archive/2012/05/25/2517722.html http://blog.csdn.net/x_iya/article/details/8433716 http://www.cnblogs.com/zhcncn/archive/2012/12/25/2832162.html

CppUnit SVN地址：https://svn.code.sf.net/p/cppunit/code/

---

 

使用指南（IBM developer works）：http://www.ibm.com/developerworks/cn/linux/l-cppunit/

 

学习主线：

 

CppUnit工作原理（e.g. setup()、teardown()、testcase()的设计思想） --------> 使用方法（工程搭建、配置、可调用的函数方法） --------> CppUnit的输出（报告、结果、记录..） 

 

---

学习背景

• 测试代码没有很好地维护而废弃，再次需要测试时还需要重写；
• 投入太多的精力，找 bug，而新的代码仍然会出现类似 bug；
• 写完代码，心里没底，是否有大量 bug 等待自己；
• 新修改的代码不知道是否影响其他部分代码；
• 由于牵扯太多，导致不敢进行修改代码；

一、CppUnit 的原理

在 CppUnit 中，一个或一组测试用例的测试对象被称为 Fixture（设施，下文为方便理解尽量使用英文名称）。Fixture 就是被测试的目标，可能是一个对象或者一组相关的对象，甚至一个函数。

有了被测试的 fixture，就可以对这个 fixture 的某个功能、某个可能出错的流程编写测试代码，这样对某个方面完整的测试被称为TestCase（测试用例）。通常写一个 TestCase 的步骤包括：

1. 对 fixture 进行初始化，及其他初始化操作，比如：生成一组被测试的对象，初始化值；
2. 按照要测试的某个功能或者某个流程对 fixture 进行操作；
3. 验证结果是否正确；
4. 对 fixture 的及其他的资源释放等清理工作。

对 fixture 的多个测试用例，通常（1）（4）部分代码都是相似的，CppUnit 在很多地方引入了 setUp 和 tearDown 虚函数。可以在 setUp 函数里完成（1）初始化代码，而在 tearDown 函数中完成（4）代码。具体测试用例函数中只需要完成（2）（3）部分代码即可，运行时 CppUnit 会自动为每个测试用例函数运行 setUp，之后运行 tearDown，这样测试用例之间就没有交叉影响。

对 fixture 的所有测试用例可以被封装在一个 CppUnit::TestFixture 的子类（命名惯例是[ClassName]Test）中。然后定义这个fixture 的 setUp 和 tearDown 函数，为每个测试用例定义一个测试函数（命名惯例是 testXXX）。下面是个简单的例子：

 

class MathTest : public CppUnit::TestFixture {
 protected:
   int m_value1, m_value2;
 public:
   MathTest() {}
  // 初始化函数
   void setUp () {
     m_value1 = 2;
     m_value2 = 3;
   }
   // 测试加法的测试函数
   void testAdd () {
       // 步骤(2),对 fixture 进行操作
     int result = m_value1 + m_value2;
       // 步骤(3),验证结果是否正确
     CPPUNIT_ASSERT( result == 5 );
   }
   // 没有什么清理工作没有定义 tearDown. 
 }

在测试函数中对执行结果的验证成功或者失败直接反应这个测试用例的成功和失败。CppUnit 提供了多种验证成功失败的方式：

CPPUNIT_ASSERT(condition)   // 确信condition为真
CPPUNIT_ASSERT_MESSAGE(message, condition)  
// 当condition为假时失败, 并打印message
CPPUNIT_FAIL(message)            
// 当前测试失败, 并打印message
CPPUNIT_ASSERT_EQUAL(expected, actual)    
// 确信两者相等
CPPUNIT_ASSERT_EQUAL_MESSAGE(message, expected, actual)  
// 失败的同时打印message
CPPUNIT_ASSERT_DOUBLES_EQUAL(expected, actual, delta)  
// 当expected和actual之间差大于delta时失败

要把对 fixture 的一个测试函数转变成一个测试用例，需要生成一个 CppUnit::TestCaller 对象。而最终运行整个应用程序的测试代码的时候，可能需要同时运行对一个 fixture 的多个测试函数，甚至多个 fixture 的测试用例。CppUnit 中把这种同时运行的测试案例的集合称为 TestSuite。而 TestRunner 则运行测试用例或者 TestSuite，具体管理所有测试用例的生命周期。目前提供了 3 类TestRunner，包括：

  CppUnit::TextUi::TestRunner   // 文本方式的TestRunner
  CppUnit::QtUi::TestRunner    // QT方式的TestRunner
  CppUnit::MfcUi::TestRunner    // MFC方式的TestRunner

下面是个文本方式 TestRunner 的例子：

  CppUnit::TextUi::TestRunner runner;
  CppUnit::TestSuite *suite= new CppUnit::TestSuite();
  
  // 添加一个测试用例
  suite->addTest(new CppUnit::TestCaller<MathTest> (
                "testAdd", &MathTest::testAdd));
  
  // 指定运行TestSuite 
  runner.addTest( suite );
  // 开始运行, 自动显示测试进度和测试结果
  runner.run( "", true );    // Run all tests and wait

对 测试结果的管理、显示等功能 涉及到另一类对象，主要用于内部对测试结果、进度的管理，以及进度和结果的显示。这里不做介绍。

下面我们整理一下思路，结合一个简单的例子，把上面说的思路串在一起。

二、手动使用步骤（使用方法）

首先要明确测试的对象 fixture，然后根据其功能、流程，以及以前的经验，确定测试用例。这个步骤非常重要，直接关系到测试的最终效果。当然 增加测试用例的过程是个阶段性的工作 ，开始完成代码后，先完成对功能的测试用例，保证其完成功能 ；然后对可能出错的部分，结合以前的经验（比如 边界值测试、路径覆盖测试 等）编写测试用例；最后在发现相关 bug 时，根据 bug 完成测试用例。

比如对整数加法进行测试，首先定义一个新的 TestFixture 子类，MathTest，编写测试用例的测试代码。后期需要添加新的测试用例时只需要添加新的测试函数，根据需要修改 setUp 和 tearDown 即可。如果需要对新的 fixture 进行测试，定义新的 TestFixture 子类即可。注：下面代码仅用来表示原理，不能编译。

/// MathTest.h
// A TestFixture subclass.
// Announce: use as your owner risk.
// Author  : liqun (liqun@nsfocus.com)
// Data    : 2003-7-5
#include "cppunit/TestFixture.h"
class MathTest : public CppUnit::TestFixture {
protected:
  int m_value1, m_value2;
  
public:
  MathTest() {}
  
  // 初始化函数
  void setUp ();
  // 清理函数
  void tearDown();
  
  // 测试加法的测试函数
  void testAdd ();
  // 可以添加新的测试函数
};

---

/// MathTest.cpp
// A TestFixture subclass.
// Announce: use as your owner risk.
// Author  : liqun (liqun@nsfocus.com)
// Data    : 2003-7-5
#include "MathTest.h"
#include "cppunit/TestAssert.h"
void MathTest::setUp()
{
     m_value1 = 2;
     m_value2 = 3;
}
void MathTest::tearDown()
{
}
void MathTest::testAdd()
{
     int result = m_value1 + m_value2;
     CPPUNIT_ASSERT( result == 5 );
}

然后编写 main 函数，把需要测试的测试用例组织到 TestSuite 中，然后通过 TestRuner 运行。这部分代码后期添加新的测试用例时需要改动的不多。只需要把新的测试用例添加到 TestSuite 中即可。

/// main.cpp
// Main file for cppunit test.
// Announce: use as your owner risk.
// Author  : liqun (liqun@nsfocus.com)
// Data    : 2003-7-5
// Note     : Cannot compile, only for study.  
#include "MathTest.h"
#include "cppunit/ui/text/TestRunner.h"
#include "cppunit/TestCaller.h"
#include "cppunit/TestSuite.h"
int main()
{
  CppUnit::TextUi::TestRunner runner;
  CppUnit::TestSuite *suite= new CppUnit::TestSuite();
  
  // 添加一个测试用例
  suite->addTest(new CppUnit::TestCaller<MathTest> (
                "testAdd", testAdd));
  
  // 指定运行TestSuite 
  runner.addTest( suite );
  // 开始运行, 自动显示测试进度和测试结果
  runner.run( "", true );    // Run all tests and wait
}

 三、常用 使用方式

按照上面的方式，如果要添加新的测试用例，需要把每个测试用例添加到 TestSuite 中，而且添加新的 TestFixture 需要把所有头文件添加到 main.cpp 中，比较麻烦。为此 CppUnit 提供了 CppUnit::TestSuiteBuilder，CppUnit::TestFactoryRegistry 和一堆 宏，用来方便地把 TestFixture 和测试用例注册到 TestSuite 中。下面就是通常的使用方式：

/// MathTest.h
// A TestFixture subclass.
// Announce: use as your owner risk.
// Author  : liqun (liqun@nsfocus.com)
// Data    : 2003-7-5

#include "cppunit/extensions/HelperMacros.h"
class MathTest : public CppUnit::TestFixture {
  // 声明一个TestSuite
  CPPUNIT_TEST_SUITE( MathTest );
  // 添加测试用例到TestSuite, 定义新的测试用例需要在这儿声明一下
  CPPUNIT_TEST( testAdd );
  // TestSuite声明完成
  CPPUNIT_TEST_SUITE_END();
  // 其余不变
protected:
  int m_value1, m_value2;
  
public:
  MathTest() {}
  
  // 初始化函数
  void setUp ();
  // 清理函数
  void tearDown();
  
  // 测试加法的测试函数
  void testAdd ();
  // 可以添加新的测试函数
};

---

/// MathTest.cpp
// A TestFixture subclass.
// Announce: use as your owner risk.
// Author  : liqun (liqun@nsfocus.com)
// Data    : 2003-7-5
#include "MathTest.h"
// 把这个TestSuite注册到名字为"alltest"的TestSuite中, 如果没有定义会自动定义
// 也可以CPPUNIT_TEST_SUITE_REGISTRATION( MathTest );注册到全局的一个未命名的TestSuite中.
CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( MathTest, "alltest" );
// 下面不变
void MathTest::setUp()
{
     m_value1 = 2;
     m_value2 = 3;
}
void MathTest::tearDown()
{
}
void MathTest::testAdd()
{
     int result = m_value1 + m_value2;
     CPPUNIT_ASSERT( result == 5 );
}

---

/// main.cpp
// Main file for cppunit test.
// Announce: use as your owner risk.
// Compile : g++ -lcppunit MathTest.cpp main.cpp
// Run     : ./a.out
// Test    : RedHat 8.0 CppUnit1.8.0
// Author  : liqun ( a litthle modification. liqun@nsfocus.com)
// Data    : 2003-7-5
// 不用再包含所有TestFixture子类的头文件

#include <cppunit/extensions/TestFactoryRegistry.h>
#include <cppunit/ui/text/TestRunner.h>
// 如果不更改TestSuite, 本文件后期不需要更改. 
int main()
{
  CppUnit::TextUi::TestRunner runner;
  
  // 从注册的TestSuite中获取特定的TestSuite, 没有参数获取未命名的TestSuite.
  CppUnit::TestFactoryRegistry &registry = 
      CppUnit::TestFactoryRegistry::getRegistry("alltest");
  // 添加这个TestSuite到TestRunner中
  runner.addTest( registry.makeTest() );
  // 运行测试
  runner.run();
}

 这样添加新的测试用例只需要在类定义的开始声明一下即可。

 

---

 

其他实际问题（输出）

通常包含测试用例代码和被测试对象是在不同的项目中。应该在另一个项目（最好在不同的目录）中编写 TestFixture，然后把被测试的对象包含在测试项目中。

对某个类或者某个函数进行测试的时候，这个 TestFixture 可能引用了别的类或者别的函数，为了隔离其他部分代码的影响，应该在源文件中临时定义一些 桩程序 ，模拟这些类或者函数。这些代码可以通过宏定义在测试项目中有效，而在被测试的项目中无效。