C++之单元测试

以前编写程序从没有做过单元测试的工作，所以在后期会花很多时间去纠错，这也就是软件工程中的2:8定律。最近要完成一个项目，要求要对系统中的主类和主函数作出单元测试的保证，才去查找了相关方面的资料，看过后觉得单元测试在工程中是必不可少的一项，下面就对有关C++的单元测试做一个简单的介绍，因为本人还没有系统的去理解相关方面的内容，所以只是介绍一些简单的应用和浅显的原理，有不到之处还请指出：

1) 什么是单元测试

单元测试（unit test,模块测试又称白盒测试）是开发者编写的一小段代码，用于检测被测代码的一个很小的，很明确的功能是否正确，通过编写单元测试可以在编码阶段发现程序编码错误，甚至是程序设计错误。现在回想下我们平时编程的过程：梳理逻辑->编写代码->调bug的一个循环过程；其中调试bug是一个很耗费时间的过程，而且调完一堆bug后我们对自己程序的信任度却在不断降低，因为不知道还会不会出bug。这是因为我们所调试的bug只是当前出现的，没有出现的呢，我们就说不好了。我们知道程序中一个简单的if...else...语句都会对数据流有一次分类，不同类的数据流所对应的操作不同，想想这些你就会觉得自己的代码还不知道要出多少bug。单元测试却很好的解决了这个问题，你要做的就是对核心的函数，核心的逻辑，将所有可能的数据流都列出来，进行一次全覆盖测试，这样你代码的健壮性就会很强。

2）如何写单元测试

最简单的方法那就是自己将核心的函数抽出来，重新建立一个项目，提供所有可能的数据流入口，对函数进行测试。这样做有两个缺陷：1、只能处理一些简单的项目，对于逻辑较为复杂，数据分支较多的就无法操作了；2、没有一个很好的框架，写出的代码没有一个统一的规则，可读性不强；为此，依托一个现有的测试框架是必不可少的。CppUnit是xunit家族的一员，xunit是一种测试框架，最早是在smalltalk上实现，后来被广泛的在各种语言上实现，除了Cppunit还有NUnit（c#版本）phpunit(php版本）和CppUnit相似的gtest(google的C++测试工具，据说在应用上要优于CppUnit,没有用过，大家可以试试)，cmockery(c语言测试工具，也是google的)。cppunit以源码的方式发布，所以想要使用这个工具就要自己下载编译（后面会介绍到），同时在windows下CppUnit还带了一个MFC项目，可以以图形界面的方式报告编译情况。

3）如何编译CppUnit

我的编译环境是win7,vs2010;

1 :下载源码包最新的版本是1.21.1（2008年最后一次更新）

地址：http://sourceforge.net/projects/cppunit/ 或者直接点击 http://sourceforge.net/projects/cppunit/files/cppunit/1.12.1/cppunit-1.12.1.tar.gz/download

2 : 复制cppunt-1.12.1到c:解压得到目录C:cppunit-1.12.1

3 : 进入C:cppunit-1.12.1src 用VS2010打开CppUnitLibraries.dsw提示转换，转换之

4 : 在项目列表看见一堆项目，默认是以Debug的方式编译，如以该方式编译需要修改目标文件名

cppunit $(ProjectName) -> $(ProjectName)d
cppunit_dll $(ProjectName) -> cppunitd_dll
DllPlugInTester $(ProjectName) -> $(ProjectName)d_dll
TestPlugInRunner $(ProjectName) -> $(ProjectName)d
TestRunner $(ProjectName) -> $(ProjectName)d

需要修改目标文件名的原因是上述项目都设置了生成事件，在生成以后都会把生成的文件复制到lib目录下，个人判断d应该是代表了测试版的意思，如果是Release版本生成的目标文件都是项目名不需要修改

5 : 修改DSPlugIn入口
属性,配置属性，链接器，高级，无入口点设置是

6 : 修改无法加载类型库（编译TestPlugInRunner,TestRunner）会报错其中7.0修改为8.0
#import "libid:80cc9f66-e7d8-4ddd-85b6-d9e6cd0e93e2" version("7.0") lcid("0") raw_interfaces_only named_guids

以上设置都全做完以后就可以整体编译解决方案了(这里要注意一点，要将上述所有的配置实现后再编译，不要对每个项目进行单独编译；否则会出现诸如“该文件没有一个关联的程序...”这样的问题)

4）如何用Cppunit

先写一个测试的Demo，初步体验下Cppunit的用法

1、打开vs2010文件项，新建VC++空项目：cppUnitTest

2、设置环境变量；在系统变量PATH的尾巴上添加“C:cppunit-1.12.1”（这是我的地址）

3、 [项目cppUnitTest]-[属性]-[配置属性]-[C/C++]-[常规]-[附加包含目录]: "../include"

4、 [项目cppUnitTest]-[属性]-[配置属性]-[链接器]-[常规]-[附加库目录]: "../lib"

5、 [项目cppUnitTest]-[属性]-[配置属性]-[链接器]-[输入]-[附加依赖项]: "cppunitd.lib"

6、新建文件main.cpp

#include <cppunit/TestCase.h>
#include <cppunit/TestResult.h>
#include <cppunit/TestResultCollector.h>
#include <cppunit/TextOutputter.h>
#include <cppunit/TestCaller.h>
#include <cppunit/TestRunner.h>

// 定义测试类
class StringTest : public CppUnit::TestFixture
{
public:
    void setUp() // 初始化
    {
        m_str1 = "Hello, world";
        m_str2 = "Hi, cppunit";
    }

    void tearDown() // 清理
    {
    }

    void testSwap() // 测试方法1
    {
        std::string str1 = m_str1;
        std::string str2 = m_str2;
        m_str1.swap(m_str2);
        
        CPPUNIT_ASSERT(m_str1 == str2);
        CPPUNIT_ASSERT(m_str2 == str1);
    }

    void testFind() // 测试方法2
    {
        int pos1 = m_str1.find(',');
        int pos2 = m_str2.rfind(',');

        CPPUNIT_ASSERT_EQUAL(5, pos1);
        CPPUNIT_ASSERT_EQUAL(2, pos2);
    }

protected:
    std::string     m_str1;
    std::string     m_str2;
};

int main(int argc, char* argv[])
{
    CppUnit::TestResult r; 
    CppUnit::TestResultCollector rc;
    r.addListener(&rc); // 准备好结果收集器 

    CppUnit::TestRunner runner; // 定义执行实体
    runner.addTest(new CppUnit::TestCaller<StringTest>("testSwap", &StringTest::testSwap)); // 构建测试用例1
    runner.addTest(new CppUnit::TestCaller<StringTest>("testFind", &StringTest::testFind)); // 构建测试用例2
    runner.run(r); // 运行测试

    CppUnit::TextOutputter o(&rc, std::cout);
    o.write(); // 将结果输出

    return rc.wasSuccessful() ? 0 : -1;
}

以上代码时使用Cppunit框架对string类的两个函数进行测试，在testFind()中调用string的find函数并通过CPPUNIT_ASSERT对结果进行测试；