C语言单元测试框架--check工具

C语言单元测试框架--check工具

虽然在UNIX上用C语言做开发已经有一段时间了，但是我不得不承认，自己单元测试做的并不好。恰好最近有新的开发任务，就学习了一些关于测试驱动开发的知识，准备改进自己的单元测试。XP编程已经兴起好一段时间了，也形成了很多优秀的单元测试框架，例如：JUnit，想必使用JAVA的朋友，对该测试框架已经很熟悉了。我记得《程序员》杂志也有一期专门以TDD作为专题。其实，我真的好羡慕JAVA程序员^_^，他们总是有各种各样的优秀的工具可以用。哎。。。，临渊羡鱼，不如退而结网。

CppUnit是一个优秀的C++单元测试框架，因此，它应该也可以作为C语言的单元测试框架。但是，这里我没有选择CppUnit，而是直接选择了一个针对C语言的单元测试框架Check。对于C语言采用哪种单元测试框架比较好，我实在没有这方面的经验^_^。如果那位朋友对C语言单元测试方面有经验，我真心的希望你能给予我帮助，这里我先谢谢了^_^！就象我说的哪样，因为我没有很多测试先行这样的经验，所以这里我只是介绍Check的基本使用方法，搭键单元测试环境的一个过程。Check相关知识是我今天上午才学的，晚上就总结一下写了出来，我是典型的现学现卖^_^。
     我这里介绍一下一个实现加法功能的程序（就是，给定2个数，该程序返回这两个数的和，够简单吧^_^）单元测试过程。首先我建立了3个目录：include、add、unit_test。在include目录里包含uni_test.h（该文件作用下面我会介绍）、add.h、Check.h（该文件是该测试框架源代码中的一个头文件，在建立单元测试的过程中，需要包含该头文件）。在unit_test.h和add.h填入一些最基本代码
uni_test.h
#ifndef _UNIT_TEST_H
#define _UNIT_TEST_H
#endif

#include "Check.h"

#ifdef __cplusplus
extern "C" {
#endif

#ifdef __cplusplus
}
#endif

#endif

      在上面代码中我们包含了Check.h头文件。在add.h头文件中，除了不包含该头文件外，基本代码是类似的。

接着，我们在add目录里建立add.c文件，并在其中#include "add.h"。

      在unit_test目录中，我们建立test_add.c文件（用来编写测试用例的,并在其中包括Check.h）、test_main.c文件（该文件作用下面会介绍,这里面包含main函数）和libcheck.a（该静态库是编译check框架源代码生成的，在编译测试用例的过程中需要连接该库。

ok，万事具备了，开始写测试用例吧。在test_add.c文件中加入测试用例
START_TEST(test_add)
{
 fail_unless(add(2, 3) == 5, "god, 2+3!=5");
}
END_TEST

    通过上面这种方式，我们定义了一个测试用例。该测试用例名字为test_add。并且我们通过宏fail_unless这种方式，预期add(2, 3)会返回5，如果不返回5，那么我们将输出god, 2+3!=5这样的信息。同时，该测试用例没有被PASS^_^，而是FAIL。

现在我们编译test_add.c、test_main.c和add.c，这样当然编译不过去，因为我们还没有写实现代码。在add.c加入如下实现代码：
int add(int i, int j)
{
 return 0;
}

     在add.h里面也加入相应的函数原型。

     这里我们在实现代码里返回0，是故意使测试用例不通过，因为在TDD里面，讲究不通过/通过/重构这么一个持续过程。

     现在我们编译代码，这样当然能编译过了。但是，到目前位置我们还没有运行我们的测试用例。ok，是在test_add.c里面添加我们的测试用例的时候了：
Suite *make_add_suite(void)
{
        Suite *s = suite_create("Add");//建立测试套件（我不知道，这么翻译对不对？^_^）
        TCase *tc_add = tcase_create("add");//建立测试用例集

        suite_add_tcase(s, tc_add);//把测试用例集加入到套件中
        tcase_add_test(tc_add, test_add);//把我们的测试用例加入到测试集中

        return s;
}

在unit_test.h中加入函数原型：Suite *make_add_suite(void)；

ok，是时候介绍test_main.c的时候了，该文件代码如下：
#include "unit_test.h"
#include

int main(void)
{
        int n;
        SRunner *sr;

        sr = srunner_create(make_add_suite());//把Suite加入到SRunner里面

        srunner_run_all(sr, CK_NORMAL);//运行所有测试用例

        n = srunner_ntests_failed(sr);
        srunner_free(sr);

        return (n==0)? EXIT_SUCCESS: EXIT_FAILURE;
}

     我想聪明的朋友也猜到了，为什么运行测试用例的主函数和测试用例本身分别放到不同源文件的原因了。就是为了以后再添加测试用例的时候方便，例如：我现在又增加了减数sub程序，那么为了保持清晰起见，针对sub的测试应该单独组织源文件test_sub.c，现在只需要在test_main.c中的SRunner中加入sub的Suite即可。

     现在编译测试用例相关文件，运行。就会看见我们的测试用例情况。多少通过，多少没有通过，没有通过的测试用例FAIL在那里等等这些信息。

    通过上面的介绍，可以发现Check测试框架和其它测试框架，例如CppUnit的使用方式差不多。其实，单纯从使用测试框架本身的角度上来看，是非常简单的。难的是，测试先行究竟该怎么来做，怎么样来做好，当程序需要访问数据库时候，我们该怎么样来完成测试用例的编写，这些都是难点。我决定了，明天出去买一本《测试驱动开发》看看，然后注意在编码过程中，采用测试先行的方式。等我有了这方面的经验，我会拿出来和大家共享，也欢迎已经有这方面经验的兄弟给出自己的心得，指正我上面文章中的错误，让吾辈从中受益！！