C語言單元測試框架

 雖然在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 <stdlib.h>

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的使用方式差不多。其實，單純從使用測試框架本身的角度上來看，是非常簡單的。難的是，測試先行究竟該怎么來做，怎么樣來做好，當程序需要訪問數據庫時候，我們該怎么樣來完成測試用例的編寫，這些都是難點。我決定了，明天出去買一本《測試驅動開發》看看，然后注意在編碼過程中，采用測試先行的方式。等我有了這方面的經驗，我會

拿出來和大家共享，也歡迎已經有這方面經驗的兄弟給出自己的心得，指正我上面文章中的錯誤，讓吾輩從中受益??！
 

原文轉自：http://www.anti-gravitydesign.com