使用Glib中测试框架对C代码进行单元测试
C++项目的测试框架比较常见的是Google的gtest
(前文
CMake项目使用ctest+gtest进行单元测试有使用实例介绍gtest
,感兴趣的读者可以去看看),也有一些其它框架,比如Boost中的测试框架。这些框架虽然也可以测试C代码,但是如果在一个纯C项目中引入这些的框架,则需要使用C++编译器。那有没有纯C的测试框架呢?
当然有。
如果是进行纯C项目开发的话,各个平台的开发套件并没有像C++那样实现一个标准的STL库供开发人员使用,这就需要自己定义各种常见的数据结构,比如链表,数组,字典,字符串的处理,队列等等,也许每写一个项目就需要重复造这些轮子,甚至一个大项目中就重复造了不少这样的轮子。为了避免重复造轮子,推荐使用glib库,它不仅提供了前述数据结构,还提供了不少其它功能,包括测试框架,感兴趣的读者可以去官网了解,下面简单介绍一下GLib库。
一、GLib简介
在Windows上做开发可能很少甚至没有听过GLib库,但是在Linux下,它却是一个非常重要的库,Linux下的著名桌面GUI GNOME的基石就是它,GNOME是使用GTK开发的,而GTK的底层库就是GLib。
glib库官网: https://developer.gnome.org/glib/,按官网的介绍:
GLib是一个通用的,跨平台的实用库,它提供了许多有用的数据结构,宏,类型转换,字符串实用库,文件实用库,一个抽象的主循环等等。
它是使用的LGPL许可发布的,可以在Unix、Linux、Windows、MacOS平台上运行。
二、使用GLib的g_test框架
为了避免与Google的gtest
混淆,GLib的测试框架写为g_test
。
g_test
与gtest
一样需要在使用前进行初始化:
1g_test_init(&argc, &argv, NULL);
然后注册测试用例,这里介绍常见的三种方式:
- 无输入参数的测试用例 使用
g_test_add_func
函数注册,原型为:
1typedef void (*GTestFunc) (void);
2void g_test_add_func (const char *testpath,
3 GTestFunc test_func);
- 有输入参数的测试用例 使用
g_test_add_data_func
函数注册,原型为:
1typedef const void *gconstpointer;
2typedef void (*GTestDataFunc) (gconstpointer user_data);
3void g_test_add_data_func (const char *testpath,
4 gconstpointer test_data,
5 GTestDataFunc test_func);
user_data
就是输入的测试参数
- 复杂的,需要在测试前进行数据准备,测试后进行清理的测试用例 使用宏
g_test_add
来注册,原型为:
1#define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
2 G_STMT_START { \
3 void (*add_vtable) (const char*, \
4 gsize, \
5 gconstpointer, \
6 void (*) (Fixture*, gconstpointer), \
7 void (*) (Fixture*, gconstpointer), \
8 void (*) (Fixture*, gconstpointer)) = (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
9 add_vtable \
10 (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
11 } G_STMT_END
实际上它是使用函数g_test_add_vtable
来注册的:
1typedef void (*GTestFixtureFunc) (gpointer fixture,
2 gconstpointer user_data);
3void g_test_add_vtable (const char *testpath,
4 gsize data_size,
5 gconstpointer test_data,
6 GTestFixtureFunc data_setup,
7 GTestFixtureFunc data_test,
8 GTestFixtureFunc data_teardown);
user_data
是输入的测试参数,data_setup
是测试前的数据准备函数,data_test
是正式的测试用例函数,data_teardown
是测试完后做善后处理的函数。
每一个测试用例都需要一个路径testpath
,且不能重复。
三、实例
main.c
源码:
1#include <glib.h>
2
3typedef struct A
4{
5 int v;
6} A;
7
8void test()
9{
10 g_print("test\n");
11}
12
13void foo(gconstpointer test_data)
14{
15 A* a = (A*)test_data;
16 g_print("A.v = %d\n", a->v);
17}
18
19/* run a test with fixture setup and teardown */
20typedef struct
21{
22 guint seed;
23 guint prime;
24 gchar *msg;
25} Fixturetest;
26
27static void
28fixturetest_setup(Fixturetest *fix,
29 gconstpointer test_data)
30{
31 g_assert_true(test_data == (void *)0xc0cac01a);
32 fix->seed = 18;
33 fix->prime = 19;
34 fix->msg = g_strdup_printf("%d", fix->prime);
35}
36
37static void
38fixturetest_test(Fixturetest *fix,
39 gconstpointer test_data)
40{
41 guint prime = g_spaced_primes_closest(fix->seed);
42 g_assert_cmpint(prime, ==, fix->prime);
43 prime = g_ascii_strtoull(fix->msg, NULL, 0);
44 g_assert_cmpint(prime, ==, fix->prime);
45 g_assert_true(test_data == (void *)0xc0cac01a);
46}
47
48static void
49fixturetest_teardown(Fixturetest *fix,
50 gconstpointer test_data)
51{
52 g_assert_true(test_data == (void *)0xc0cac01a);
53 g_free(fix->msg);
54}
55
56int main(int argc, char **argv)
57{
58 gchar *base_name = g_path_get_basename(argv[0]);
59 g_set_prgname(base_name);
60 g_free(base_name);
61
62 g_log_set_debug_enabled(TRUE);
63 g_debug("start test...");
64
65 A a;
66 a.v = 100;
67
68 g_test_init(&argc, &argv, NULL);
69 g_test_add_func("/t", test);
70 g_test_add_data_func("/td", &a, foo);
71
72 g_test_add("/t1", Fixturetest, (void*)0xc0cac01a, fixturetest_setup, fixturetest_test, fixturetest_teardown);
73 int ret = g_test_run();
74 g_message("A:%d", a.v);
75 return ret;
76}
CMakeLists.txt
源码:
1cmake_minimum_required(VERSION 3.12.0)
2project(demo VERSION 0.1.0)
3
4include(CTest)
5
6enable_testing()
7
8add_executable(${PROJECT_NAME} main.c)
9find_package(PkgConfig REQUIRED)
10pkg_check_modules (GLIB2 REQUIRED IMPORTED_TARGET glib-2.0>=2.70)
11target_link_libraries(${PROJECT_NAME} PkgConfig::GLIB2)
12
13message(STATUS "GLIB2_INCLUDE_DIRS: ${GLIB2_INCLUDE_DIRS}")
14message(STATUS "GLIB2_LIBRARY_DIRS: ${GLIB2_LIBRARY_DIRS}")
15message(STATUS "GLIB2_LIBRARIES: ${GLIB2_LIBRARIES}")
16
17add_test(NAME ${PROJECT_NAME} COMMAND ${PROJECT_NAME})
运行结果:
使用CTest测试结果:
Glib还有很多非常强大的功能,感兴趣的读者可以去深究!
- 原文作者:Witton
- 原文链接:https://wittonbell.github.io/posts/2023/2023-04-21-使用Glib中测试框架对C代码进行单元测试/
- 版权声明:本作品采用知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议. 进行许可,非商业转载请注明出处(作者,原文链接),商业转载请联系作者获得授权。