玩转Google开源C++单元测试框架Google Test系列(gtest)之八 - 打造自己的单元测试框架

转自：http://www.cnblogs.com/coderzh/archive/2009/04/12/1434155.html

一、前言

上一篇我们分析了gtest的一些内部实现，总的来说整体的流程并不复杂。本篇我们就尝试编写一个精简版本的C++单元测试框架：nancytest ，通过编写这个简单的测试框架，将有助于我们理解gtest。

二、整体设计

使用最精简的设计，我们就用两个类，够简单吧：

1. TestCase类
包含单个测试案例的信息。 

2. UnitTest类

负责所有测试案例的执行，管理。

三、TestCase类

TestCase类包含一个测试案例的基本信息，包括：测试案例名称，测试案例执行结果，同时还提供了测试案例执行的方法。我们编写的测试案例都继承自TestCase类。

class  TestCase
{
public :
    TestCase( const   char *  case_name) : testcase_name(case_name){}

     //  执行测试案例的方法
     virtual   void  Run()  =   0 ;

     int  nTestResult;  //  测试案例的执行结果 
     const   char *  testcase_name;  //  测试案例名称
};

 

四、UnitTest类

我们的UnitTest类和gtest的一样，是一个单件。我们的UnitTest类的逻辑非常简单：

1. 整个进程空间保存一个UnitTest 的单例。

2. 通过RegisterTestCase()将测试案例添加到测试案例集合testcases_中。

3. 执行测试案例时，调用UnitTest::Run()，遍历测试案例集合testcases_，调用案例的Run()方法

class  UnitTest
{
public :
     //  获取单例
     static  UnitTest *  GetInstance(); 

     //  注册测试案例
    TestCase *  RegisterTestCase(TestCase *  testcase);
    
     //  执行单元测试
     int  Run();

    TestCase *  CurrentTestCase;  //  记录当前执行的测试案例
     int  nTestResult;  //  总的执行结果
     int  nPassed;  //  通过案例数
     int  nFailed;  //  失败案例数
protected :
    std::vector < TestCase *>  testcases_;  //  案例集合
};

下面是UnitTest类的实现：

UnitTest *  UnitTest::GetInstance()
{
     static  UnitTest instance;
     return   & instance;
}

TestCase *  UnitTest::RegisterTestCase(TestCase *  testcase)
{
    testcases_.push_back(testcase);
     return  testcase;
}

int  UnitTest::Run()
{
    nTestResult  =   1 ;
     for  (std::vector < TestCase *> ::iterator it  =  testcases_.begin();
        it  !=  testcases_.end();  ++ it)
    {
        TestCase *  testcase  =   * it;
        CurrentTestCase  =  testcase;
        std::cout  <<  green  <<   " ====================================== "   <<  std::endl;
        std::cout  <<  green  <<   " Run TestCase: "   <<  testcase -> testcase_name  <<  std::endl;
        testcase -> Run();
        std::cout  <<  green  <<   " End TestCase: "   <<  testcase -> testcase_name  <<  std::endl;
         if  (testcase -> nTestResult)
        {
            nPassed ++ ;
        }
         else
        {
            nFailed ++ ;
            nTestResult  =   0 ;
        }
    }

    std::cout  <<  green  <<   " ====================================== "   <<  std::endl;
    std::cout  <<  green  <<   " Total TestCase :  "   <<  nPassed  +  nFailed  <<  std::endl;
    std::cout  <<  green  <<   " Passed :  "   <<  nPassed  <<  std::endl;
    std::cout  <<  red  <<   " Failed :  "   <<  nFailed  <<  std::endl;
     return  nTestResult;
}

五、NTEST宏

接下来定一个宏NTEST，方便我们写我们的测试案例的类。

#define  TESTCASE_NAME(testcase_name) \
    testcase_name##_TEST

#define  NANCY_TEST_(testcase_name) \
class  TESTCASE_NAME(testcase_name) :  public  TestCase \
{ \
public : \
    TESTCASE_NAME(testcase_name)( const   char *  case_name) : TestCase(case_name){}; \
     virtual   void  Run(); \
private : \
     static  TestCase *   const  testcase_; \
}; \
\
TestCase *   const  TESTCASE_NAME(testcase_name) \
    ::testcase_  =  UnitTest::GetInstance() -> RegisterTestCase( \
         new  TESTCASE_NAME(testcase_name)(#testcase_name)); \
void  TESTCASE_NAME(testcase_name)::Run()

#define  NTEST(testcase_name) \
    NANCY_TEST_(testcase_name)

 

六、RUN_ALL_TEST宏

然后是执行所有测试案例的一个宏：

#define  RUN_ALL_TESTS() \
    UnitTest::GetInstance() -> Run();

七、断言的宏EXPECT_EQ 

这里，我只写一个简单的EXPECT_EQ ：

#define  EXPECT_EQ(m, n) \
     if  (m  !=  n) \
    { \
        UnitTest::GetInstance() -> CurrentTestCase -> nTestResult  =   0 ; \
        std::cout  <<  red  <<   " Failed "   <<  std::endl; \
        std::cout  <<  red  <<   " Expect: "   <<  m  <<  std::endl; \
        std::cout  <<  red  <<   " Actual: "   <<  n  <<  std::endl; \
    }

 

八、案例Demo

够简单吧，再来看看案例怎么写：

#include  " nancytest.h "

int  Foo( int  a,  int  b)
{
     return  a  +  b;
}

NTEST(FooTest_PassDemo)
{
    EXPECT_EQ( 3 , Foo( 1 ,  2 ));
    EXPECT_EQ( 2 , Foo( 1 ,  1 ));
}

NTEST(FooTest_FailDemo)
{
    EXPECT_EQ( 4 , Foo( 1 ,  2 ));
    EXPECT_EQ( 2 , Foo( 1 ,  2 ));
}

int  _tmain( int  argc, _TCHAR *  argv[])
{
     return  RUN_ALL_TESTS();
}

整个一山寨版gtest，呵。执行一下，看看结果怎么样：

 

九、总结 

本篇介绍性的文字比较少，主要是我们在上一篇深入解析gtest时已经将整个流程弄清楚了，而现在编写的nancytest又是其非常的精简版本，所有直接看代码就可以完全理解。希望通过这个Demo，能够让大家对gtest有更加直观的了解。回到开篇时所说的，我们没有必要每个人都造一个轮子，因为gtest已经非常出色的为我们做好了这一切。如果我们每个人都写一个自己的框架的话，一方面我们要付出大量的维护成本，一方面，这个框架也许只能对你有用，无法让大家从中受益。
gtest正是这么一个优秀C++单元测试框架，它完全开源，允许我们一起为其贡献力量，并能让更多人从中受益。如果你在使用gtest过程中发现gtest不能满足你的需求时（或发现BUG），gtest的开发人员非常急切的想知道他们哪来没做好，或者是gtest其实有这个功能，但是很多用户都不知道。所以你可以直接联系gtest的开发人员，或者你直接在这里回帖，我会将您的意见转告给gtest的主要开发人员。
如果你是gtest的超级粉丝，原意为gtest贡献代码的话，加入他们吧。　　　

本Demo代码下载：/Files/coderzh/Code/nancytest.rar 

本篇是该系列最后一篇，其实gtest还有更多东西值得我们去探索，本系列也不可能将gtest介绍完全，还是那句话，想了解更多gtest相关的内容的话：

访问官方主页：http://code.google.com/p/googletest/

下载gtest源码： http://code.google.com/p/googletest/downloads/list

系列链接：

1.玩转Google开源C++单元测试框架Google Test系列(gtest)之一 - 初识gtest

2.玩转Google开源C++单元测试框架Google Test系列(gtest)之二 - 断言

3.玩转Google开源C++单元测试框架Google Test系列(gtest)之三 - 事件机制

4.玩转Google开源C++单元测试框架Google Test系列(gtest)之四 - 参数化

5.玩转Google开源C++单元测试框架Google Test系列(gtest)之五 - 死亡测试 

6.玩转Google开源C++单元测试框架Google Test系列(gtest)之六 - 运行参数

7.玩转Google开源C++单元测试框架Google Test系列(gtest)之七 - 深入解析gtest

8.玩转Google开源C++单元测试框架Google Test系列(gtest)之八 - 打造自己的单元测试框架

 

作者：CoderZh（CoderZh的技术博客 - 博客园）
微博：http://t.sina.com.cn/coderzh 
出处：http://coderzh.cnblogs.com
文章版权归本人所有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。

【yasi】

没看这篇文章之前，一直不清楚 RUN_ALL_TESTS() 一个简单的宏是怎么将所有test case都跑起来的，现就上面的简单示例总结如下（gtest的玩法应该类似）：

1. RUN_ALL_TESTS()去遍历UnitTest类中注册的所有TestCase对象，执行它们的Run()方法
2. 通过NTEST()宏生成的每个TestCase子类都有一个重载的Run()方法，其内容就是NTEST宏下面的{}中的语句
3. 用NTEST宏产生的新的TestCase子类在代码中看不见，但它真实存在，每个这样的TestCase子类都会被注册到UnitTest类中
4. “TestCase子类都被注册到UnitTest类中”是怎么实现的？在NTEST宏产生的TestCase子类中，有静态成员变量testcase_，在运行RUN_ALL_TESTS()之前，它会被创建出来（这是由C++语言类的静态成员变量的特性决定的）；创建的时候会调用UnitTest::GetInstance()->RegisterTestCase(...)语句，将自己（TestCase子类对象指针）注册给UnitTest类
5. NTEST()宏下面的{}中的语句可以是直接执行类似Foo(1, 2)这样的语句，但这样不能验证执行结果是否正确，因此使用了EXPECT_EQ(4, Foo(1, 2))这样的宏，对执行结果做判断和输出
   
6. main()函数之前的所有的NTEST()宏的效果是：为每个测试用例申明了一个TestCase子类，并将它们注册给了UnitTest类；每个TestCase子类都有一个Run()方法，其内容就是对应的NTEST()宏下面的一对{}中的语句
7. main()函数从表面看，只是执行了一个简单的宏RUN_ALL_TESTS()，甚至连main()上面写的那些测试用例都没关联上；但是，实际上，通过(4)的方式关联上了，并且通过(5)和(6)的方式，执行了NTEST()宏下面的{}中的语句，对执行结果做判断和输出