CUnit的用法

本文转载自 http://blog.csdn.net/scucj/article/details/4385630

感谢逍遥剑客

CUnit下载地址: http://sourceforge.net/projects/cunit/
CUnit 在线文档帮助:http://cunit.sourceforge.net/doc/index.html

 

关于CUnit, 本文主要从介绍三方面的内容：
1.CUnit的介绍。
1.1 介绍如何使用CUnit。

CUnit是一个对C语言编写的程序进行单元测试的框架，在线文档说它作为一个静态链接库被链接到用户的测试代码中。它提供了一种简洁的框架来建立测试架构，并提供丰富的断言(Assertion)来测试通用数据类型。除此之外，它还提供了许多不同的结构来运行测试用例和报告测试结果。

(1)CUnit的架构
                      Test Registry
                            |
             ------------------------------
             |                            |
          Suite '1'      . . . .       Suite 'N'
             |                            |
       ---------------             ---------------
       |             |             |             |
    Test '11' ... Test '1M'     Test 'N1' ... Test 'NM'

提到这个框架，为后面如何使用CUnit提供了基础。
先介绍这个框架，从底层往上介绍就两句话：
(1)每个测试用例被包装在一个测试包(suite)中，
(2)每个测试包(suite)是在有效的测试注册单元(Test Registry)中注册的。

对于CUnit来说，它是单线程运行，所以每次只能有一个有效的测试注册单元(Test Registry)，这个测试注册单元下面可以包含多个测试包(suite)，每个测试包可以拥有多个测试用例。划分测试包(suite)的规则可以自由约定，比如按照模块来划分，一个模块的测试用例集中到一个测试包中(suite)。至于测试用例，则用来测试模块内部的函数。测试用例函数通过提供的各类输入调用被测试的函数，返回执行结果，然后通过CUnit提供的断言来判断被测试的函数是否正确。

(2)测试模式

下面是四种测试模式：
1 Automated Output to xml file            Non-interactive
2 Basic      Flexible programming        interface Non-interactive  
3 Console    Console interface (ansi C)     Interactive  
4 Curses     Graphical interface (Unix)     Interactive
第一种模式是将结果输出到XML文档中，便于生成报告。第二种模式是每一次运行结束之后在standard output中显示测试结果，不能保留测试结果数据。第三种模式是console方式的，可以人机交互；前两种模式是非交互式的。第四种只在Unix中使用。

(3)测试的基本流程
1)编写单元测试函数(有必要的话要写suite的init/cleanup函数)。Write functions for tests (and suite init/cleanup if necessary). 
2)调用函数CU_initialize_registry()初始化测试注册单元(Test Registry)。 Initialize the test registry - CU_initialize_registry() 
3)调用函数CU_add_suite() 将测试包(suite)添加到测试注册单元(Test Registry)中。Add suites to the test registry - CU_add_suite() 
4)调用函数CU_add_test()将测试用例添加到测试包(suite)中。Add tests to the suites - CU_add_test() 
5)使用合适的接口来运行测试用例。Run tests using an appropriate interface, e.g. CU_console_run_tests 
6)调用函数CU_cleanup_registry清除测试注册单元(Test Registry)。Cleanup the test registry - CU_cleanup_registry()

1.2 通过一个例子来说明使用方法。
先说明文件的组织结构:
1.被测试的模块：
(1)文件MainModule.c，定义了一个求和函数cal_num。
(2)头文件MainModule.h，声明了求和函数cal_num。
2.测试用例和测试包
(1)文件TestMainModule.c，定义了测试用例。
3.单元测试运行入口
(1)文件CUnitRunTest.c

各个文件的内容如下:

【1】MainModule.h

[cpp]  view plain copy

1. #ifndef __MAIN_MODULE_H__  
2. #define __MAIN_MODULE_H__  
3. #include <stdio.h>  
4.   
5. //计算两个数之和  
6. int cal_num(int a, int b);  
7.   
8. #endif  

【2】MainModule.c

[cpp]  view plain copy

1. #include "MainModule.h"  
2.   
3. 计算两个数之和  
4. int cal_num(int a, int b)  
5. {  
6.     int c;  
7.   
8.     c = a + b;  
9.   
10.     return c;  
11. }  

【3】TestMainModule.c

[cpp]  view plain copy

1. #include <stdio.h>  
2. #include <assert.h>  
3. #include "CUnit-2.1-0/include/CUnit/console.h"  
4. #include "MainModule.h"  
5.   
6. int InitSuite()  
7. {  
8.     return 0;  
9. }   
10.   
11. int EndSuite()  
12. {  
13.     return 0;  
14. }  
15.   
16. int Test_Is_Equal(int a, int b, int real)  
17. {  
18.     int result;  
19.   
20.     result = cal_num(a, b);  
21.     if(result == real)  
22.     {  
23.         return 1;  
24.     }  
25.     return 0;  
26. }  
27.   
28. int Test_Is_Not_Equal(int a, int b, int real)  
29. {  
30.     int result;  
31.   
32.     result = cal_num(a, b);  
33.     if(result != real)  
34.     {  
35.         return 1;  
36.     }  
37.     return 0;  
38. }  
39.   
40. void Test1()  
41. {  
42.     CU_ASSERT(Test_Is_Equal(3, 4, 7));  
43. }  
44.   
45. void Test2()  
46. {  
47.     CU_ASSERT(Test_Is_Not_Equal(4, 5, 10));  
48. }  
49.   
50. /*0 表示成功，1表示失败*/  
51. int AddTestMainModule()  
52. {  
53.     CU_pSuite pSuite = NULL;  
54.   
55.     /*************** 
56.     * 1. CU_add_suite 增加一个Suite  
57.     * 2. Suite名字 : testSuite 
58.     * 3. InitSuite EndSuite：分别是测试单元初始和释放函数，如不需要则NULL传递 
59.     ****************/  
60.     pSuite = CU_add_suite("testSuite", InitSuite, EndSuite);    
61.   
62.     //检测注册Suite情况  
63.     if(NULL == pSuite)  
64.     {  
65.         //return 1;  
66.     }  
67.       
68.     /*************** 
69.     * 1. 注册当前Suite下的测试用例　 
70.     * 2. pSuite：用例指针 
71.     * 3. "Test1"： 测试单元名称  
72.     * 4. Test1：测试函数 
73.     ***************/  
74.     if( NULL == CU_add_test(pSuite, "Test1", Test1) ||  
75.         NULL == CU_add_test(pSuite, "Test2", Test2))  
76.     {  
77.         return 1;  
78.     }  
79.       
80.     /***另外一种测试方式***************/  
81.     /* 
82.     CU_TestInfo testcases[] = { 
83.         {"Test1:", Test1}, 
84.         {"Test2:", Test2}, 
85.         CU_TEST_INFO_NULL 
86.     }; 
87.  
88.     CU_SuiteInfo suites[] = { 
89.         {"Testing the function cal_num:", InitSuite, EndSuite, testcases}, 
90.         CU_SUITE_INFO_NULL 
91.     }; 
92.  
93.     if(CUE_SUCCESS != CU_register_suites(suites)) 
94.     { 
95.         return 1; 
96.     } 
97.     */  
98.     /************************************/  
99.   
100.     return 0;  
101. }  

【4】CUnitRunTest.c

[cpp]  view plain copy

1. #include <stdio.h>  
2. #include <assert.h>  
3. #include "CUnit-2.1-0/include/CUnit/console.h"  
4.   
5. extern int AddTestMainModule();  
6.   
7. int main()  
8. {  
9.      
10.     //CU_initialize_registry 注册函数注册一个用例返回CUE_系列异常值  
11.     if( CUE_SUCCESS != CU_initialize_registry())  
12.     {  
13.         return CU_get_error();  
14.     }  
15.   
16.     //CU_get_registry 返回注册到用例指针   
17.     assert(NULL != CU_get_registry());  
18.       
19.     //检测是否在执行   
20.     assert(!CU_is_test_running());   
21.   
22.     //调用测试模块完成测试用例  
23.     if (0 != AddTestMainModule())  
24.     {  
25.         CU_cleanup_registry();  
26.         return CU_get_error();  
27.     }  
28.   
29.     //使用console控制交互界面的函数入口   
30.     CU_console_run_tests();  
31.   
32.     /***使用自动产生XML文件的模式******** 
33.     CU_set_output_filename("TestMax"); 
34.     CU_list_tests_to_file(); 
35.     CU_automated_run_tests(); 
36.     ***********************************/  
37.       
38.     //调用完毕清除注册信息   
39.     CU_cleanup_registry();  
40.       
41.     return 0;  
42. }  

 

2.在两种不同环境下使用CUnit来上面的例子进行单元测试。

2.1 在Windows XP下，在VC 6.0 集成CUnit来进行单元测试。
(1)自己动手生成链接静态库CUnit.lib。
下载CUnit-2.1-0-src.zip，解压，在CUnit-2.1-0/CUnit目录下，用VC 6.0打开工程文件CUnit.dsp，有个提示，说没有找到workspace文件，不会理会，直接确定。然后在当前打开的工程项目中，点击"FileView"，展开文件树形结构，任意点击一个文件打开，然后在最上面的工具栏点击“编译”和“链接”，在CUnit-2.1-0/CUnit目录下就生产CUnit.lib。
(2)在VC 6.0新建一个名为"Test_CUit"的Win32 console application工程，将上面例子中的文件包含进来。
(3)下载CUnit-2.1-0-winlib.zip，解压，把解压的目录CUnit-2.1-0复制到当前的工程目录下。
(4)将CUnit.lib叶复制到当前的工程目录下，并在"Project"->"Settings..."->"Link"->"Object/library modules"中内容的末尾增加CUnit.lib，用空格和前面的静态库文件隔开，然后点击"OK"即可。
(5)在"Test_CUit"工程项目中，在最上面的工具栏点击“编译”->“链接”->“运行”，就可以看到控制台界面。输入相应的操作符号进行对应的操作，不再详述。

备注：在TestMainModule.c的AddTestMainModule()函数中注释掉的部分是第一种测试模式"Automated Output to xml file"，默认的模式是第三种控制台模式。把控制台模式注释掉，而把第一种测试模式打开，则运行时会在当前目录下三个XML文件：CUnit-Memory-Dump.xml，TestMax-Listing.xml，TestMax-Results.xml。将这三个文件复制到目录CUnit-2.1-0/share/CUnit下，然后用浏览器打开后两个XML文件，可以看到测试报告的结果。

2.2 在Linux下，利用CUnit来进行单元测试。
1.编译CUnit,编译后，头文件目录在/root/local/include/CUnit中，静态库文件在/root/local/lib/下。
(1)用root用户登录，下载CUnit-2.1-0-src.tar.gz。
(2)tar -zxvf CUnit-2.1-0-src.tar.gz
(3)cd CUnit-2.1-0
(4)./configure --prefix=$HOME/local
(5)make
(6)make install
2.编写一个Makefile文件，放入到在源文件目录中，内容如下：

[cpp]  view plain copy

1. INC=-I/root/local/include  
2. LIB=-L/root/local/lib  
3.   
4. all: MainModule.c TestMainModule.c CUnitRunTest.c  
5.     gcc $^ -o test $(INC) $(LIB) -lcunit -lcurses -static  
6. clean:  
7.     rm -rf test  

3.在源文件目录下执行make命令即可。
4.运行./test即可看见console命令界面。

3.关于断言的使用
CUnit提供了一系列的断言来测试逻辑条件，这些断言的成功或是失败的结果都由CUnit单元测试框架跟踪，并在单元测试结束后可以看到。每个断言测试一个逻辑条件。如果选择"XXX_FATAL"这些断言，意味着断言失败后单元测试用例不再继续执行，所以带"FATAL"的断言版本需要谨慎使用。断言被包含在"CUnit/CUnit.h"这个头文件中声明的。现在就从CUnit的文档说明中摘录它的断言声明。

CU_ASSERT(int expression) CU_ASSERT_FATAL(int expression) CU_TEST(int expression) CU_TEST_FATAL(int expression)	Assert that expression is TRUE (non-zero)
CU_ASSERT_TRUE(value) CU_ASSERT_TRUE_FATAL(value)	Assert that value is TRUE (non-zero)
CU_ASSERT_FALSE(value) CU_ASSERT_FALSE_FATAL(value)	Assert that value is FALSE (zero)
CU_ASSERT_EQUAL(actual, expected) CU_ASSERT_EQUAL_FATAL(actual, expected)	Assert that actual = = expected
CU_ASSERT_NOT_EQUAL(actual, expected)) CU_ASSERT_NOT_EQUAL_FATAL(actual, expected)	Assert that actual != expected
CU_ASSERT_PTR_EQUAL(actual, expected) CU_ASSERT_PTR_EQUAL_FATAL(actual, expected)	Assert that pointers actual = = expected
CU_ASSERT_PTR_NOT_EQUAL(actual, expected) CU_ASSERT_PTR_NOT_EQUAL_FATAL(actual, expected)	Assert that pointers actual != expected
CU_ASSERT_PTR_NULL(value) CU_ASSERT_PTR_NULL_FATAL(value)	Assert that pointer value == NULL
CU_ASSERT_PTR_NOT_NULL(value) CU_ASSERT_PTR_NOT_NULL_FATAL(value)	Assert that pointer value != NULL
CU_ASSERT_STRING_EQUAL(actual, expected) CU_ASSERT_STRING_EQUAL_FATAL(actual, expected)	Assert that strings actual and expected are equivalent
CU_ASSERT_STRING_NOT_EQUAL(actual, expected) CU_ASSERT_STRING_NOT_EQUAL_FATAL(actual, expected)	Assert that strings actual and expected differ
CU_ASSERT_NSTRING_EQUAL(actual, expected, count) CU_ASSERT_NSTRING_EQUAL_FATAL(actual, expected, count)	Assert that 1st count chars of actual and expected are the same
CU_ASSERT_NSTRING_NOT_EQUAL(actual, expected, count) CU_ASSERT_NSTRING_NOT_EQUAL_FATAL(actual, expected, count)	Assert that 1st count chars of actual and expected differ
CU_ASSERT_DOUBLE_EQUAL(actual, expected, granularity) CU_ASSERT_DOUBLE_EQUAL_FATAL(actual, expected, granularity)	Assert that |actual - expected| <= |granularity| Math library must be linked in for this assertion.
CU_ASSERT_DOUBLE_NOT_EQUAL(actual, expected, granularity) CU_ASSERT_DOUBLE_NOT_EQUAL_FATAL(actual, expected, granularity)	Assert that |actual - expected| > |granularity| Math library must be linked in for this assertion.
CU_PASS(message)	Register a passing assertion with the specified message. No logical test is performed.
CU_FAIL(message) CU_FAIL_FATAL(message)	Register a failed assertion with the specified message. No logical test is performed

 

给出两个版本的源代码供下载。注：在VC6.0下面的源文件不能直接在Linux下使用，如果要用，则提示每个源文件的末尾都要加一个换行符。

【1】VC 6.0 的例子

【2】Linux的例子(无法上传.tar.gz格式的文件)
 

引用及参考资料:
[1]http://blog.csdn.net/colin719/archive/2006/11/29/1420583.aspx
[2]http://cunit.sourceforge.net/doc/introduction.html
[3]http://hi.baidu.com/yshsh/blog/item/ea2e0a735451cb1f8601b029.html
[4]http://blog.csdn.net/jiantiantian/archive/2008/12/18/3546887.aspx