C语言单元测试

C语言单元测试

 对于敏捷开发来说，单元测试必不可少，对于Java开发来说，JUnit非常好，对于C++开发，也有CPPUnit可供使用，而对于传统的C语言开发，就没有很好的工具可供使用，可以找到的有这么几个工具：

1.  CuTest -- CuTest(Cute Test)是一个非常简单的C语言单元测试工具。在使用它的时候，只需要包含两个文件“CuTest.c CuTest.h”，然后就可以写测试用例，进行测试了。它对用例几乎没有管理功能，报表输出也非常简单，可以用来试验单元测试的基本想法。
2. CUnit -- CUnit是一个轻型的C语言单元测试框架。它提供了设计、管理、运行测试用例的功能。它的报表功能比较强大，但是比较麻烦，更适合于较大一些的项目。
3. Check -- 不错的工具。
   在这里（http://www.laatuk.com/tools/testing_tools.html）给出了各种软件测试工具，没事可以研究一下。

CUnit

这里主要讲CUnit在Linux平台下的应用。这里有一篇 CUnit测试工具使用 ，另一篇 C单元测试包设计与实现 讲的不错，可以看一下。CUnit的主页是 http://cunit.sourceforge.net/index.html。
CUnit以静态库的形式提供给用户使用，用户编写程序的时候直接链接此静态库就可以了。它提供了一个简单的单元测试框架，并且为常用的数据类型提供了丰富的断言语句支持。

CUnit基本架构

                       Test Registry
                            |
             ------------------------------
             |                            |
          Suite '1'      . . . .       Suite 'N'
             |                            |
       ---------------             ---------------
       |             |             |             |
    Test '11' ... Test '1M'     Test 'N1' ... Test 'NM'

一次测试（Test Registry）可以运行多个测试包（Test Suite），而每个测试包可以包括多个测试用例（Test Case），每个测试用例又包含一个或者多个断言类的语句。具体到程序的结构上，一次测试下辖多个Test Suite，它对应于程序中各个独立模块；一个Suite管理多个Test Case，它对应于模块内部函数实现。每个Suite可以含有setup和teardown函数，分别在执行suite的前后调用。

CUnit测试模式

CUnit使用四种不同的接口，供用户来运行测试和汇报测试结果：

1. 自动输出到XML文件，     非交互式
2. 基本扩展编程方式，        非交互式
3. 控制台方式，              交互式
4. Curses图形接口，          交互式

注意1和2是非交互式的,4只能在Unix下使用，常用console，而且console是可以人机交互的。

CUnit测试流程

使用CUnit进行测试的基本流程如下所示：

1. 书写代测试的函数（如果必要，需要写suite的init/cleanup函数）
2. 初始化Test Registry - CU_initialize_registry()
3. 把测试包（Test Suites）加入到Test Registry - CU_add_suite()
4. 加入测试用例（Test Case）到测试包当中 - CU_add_test()
5. 使用适当的接口来运行测试测试程序，例如 CU_console_run_tests()
6. 清除Test Registry - CU_cleanup_registry()

CUnit使用范例

CUnit的在线文档是 http://cunit.sourceforge.net/doc/index.html ，上面有着详细的论述。这里以使用自动产生XML文件的接口为例，讲述CUnit-2.1-0在Linux平台下的使用。
我要测试的是整数求最大值的函数maxi，我使用如下文件组织结构：

1. func.c ：定义maxi()函数
2. test_func.c ：定义测试用例和测试包
3. run_test.c ：调用CUnit的Automated接口运行测试
4. Makefile ：生成测试程序。

这样组织的好处是，我们可以把各个功能分离，当要改变待测试函数的定义的时候，我们只需要修改func.c，而要增减、修改测试用例，只修改test_func.c就可以了，要使用CUnit提供的别的API，那就修改run_test.c。

它们的内容分别如下所示：

1) func.c

/**
 * file: func.c
 **/

int  maxi( int  i,  int  j)
{
        //return i>j?i:j;
        return i;
}

2) test_func.c

/**
 * file: test_func.c
 **/
#include  < stdio.h >
#include  < stdlib.h >
#include  < assert.h >
#include  " CUnit/CUnit.h "
#include  " CUnit/Automated.h "  

/*---- functions to be tested ------*/
extern   int  maxi( int  i,  int  j); 

/*---- test cases ------------------*/
void  testIQJ()
{
        CU_ASSERT_EQUAL(maxi(1,1),1);
        CU_ASSERT_EQUAL(maxi(0,-0),0);
}
 
void  testIGJ()
{
        CU_ASSERT_EQUAL(maxi(2,1),2);
        CU_ASSERT_EQUAL(maxi(0,-1),0);
        CU_ASSERT_EQUAL(maxi(-1,-2),-1);
}
 
void  testILJ()
{
        CU_ASSERT_EQUAL(maxi(1,2),2);
        CU_ASSERT_EQUAL(maxi(-1,0),0);
        CU_ASSERT_EQUAL(maxi(-2,-1),-1);
}  

CU_TestInfo testcases[]  =   {
        {"Testing i equals j:", testIQJ},
        {"Testing i greater than j:", testIGJ},
        {"Testing i less than j:", testILJ},
        CU_TEST_INFO_NULL
} ;
 

/*---- test suites ------------------*/
int  suite_success_init( void )  { return 0; }
int  suite_success_clean( void )  { return 0; }  

CU_SuiteInfo suites[]  =   {
        {"Testing the function maxi:", suite_success_init, suite_success_clean, testcases},
        CU_SUITE_INFO_NULL
} ;
 

/*---- setting enviroment -----------*/

void  AddTests( void )
{
        assert(NULL != CU_get_registry());
        assert(!CU_is_test_running());
        /* shortcut regitry */

        if(CUE_SUCCESS != CU_register_suites(suites)){
                fprintf(stderr, "Register suites failed - %s ", CU_get_error_msg());
                exit(EXIT_FAILURE);
        }
}

 3) run_test.c

/**
 * file: run_test.c
 **/

#include  < stdio.h >
#include  < stdlib.h >
#include  < assert.h >

int  main(  int  argc,  char   * argv[] )
{
       if(CU_initialize_registry()){
                fprintf(stderr, " Initialization of Test Registry failed. ");
                exit(EXIT_FAILURE);
        }else{
                AddTests();
                CU_set_output_filename("TestMax");
                CU_list_tests_to_file();
                CU_automated_run_tests();
                CU_cleanup_registry();
        }
        return 0;
}

4) Makefile 

INC = -I / home / lirui / local / include
LIB = -L / home / lirui / local / lib

all: func . c test_func . c run_test . c
        gcc -o test  $( INC )   $( LIB ) -lcunit -lcurses -static  $ ^

由于CUnit是以库的形式提供的，所以我们在编译和链接的时候需要指明头文件和库所在的位置，又由于使用了Curses库，所以也要指定这个。

测试报告

 运行上面产生的test程序，会在当前目录下产生两个xml文件：

1. TestMax-Listing.xml ：对测试用例的报告
2. TestMax-Results.xml ：对测试结果的报告

要查看这两个文件，需要使用如下xsl和dtd文件：CUnit-List.dtd和CUnit-List.xsl用于解析列表文件， CUnit-Run.dtd和CUnit-Run.xsl用于解析结果文件。这四个文件在CUnit包里面有提供，安装之后在$(PREFIX) /share/CUnit目录下，在我的配置当中，它在/home/lirui/local/share/CUnit目录下。在查看结果之前，需要把这六个文件：TestMax-Listing.xml, TestMax-Results.xml, CUnit-List.dtd, CUnit-List.xsl, CUnit-Run.dtd, CUnit-Run.xsl拷贝到一个目录下，然后用浏览器打开两个结果的xml文件就可以了。

1) TestMax-Listing.xml在IE当中显示如下：

2) TestMax-Results.xml在IE当中显示如下：