> 文章列表 > 使用Glib中测试框架对C代码进行单元测试

使用Glib中测试框架对C代码进行单元测试

使用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_testgtest一样需要在使用前进行初始化:

g_test_init(&argc, &argv, NULL);

然后注册测试用例,这里介绍常见的三种方式:

  1. 无输入参数的测试用例
    使用g_test_add_func函数注册,原型为:
typedef void (*GTestFunc)        (void);
void    g_test_add_func                 (const char     *testpath,GTestFunc       test_func);
  1. 有输入参数的测试用例
    使用g_test_add_data_func函数注册,原型为:
typedef const void *gconstpointer;
typedef void (*GTestDataFunc)    (gconstpointer user_data);
void    g_test_add_data_func            (const char     *testpath,gconstpointer   test_data,GTestDataFunc   test_func);

user_data就是输入的测试参数

  1. 复杂的,需要在测试前进行数据准备,测试后进行清理的测试用例
    使用宏g_test_add来注册,原型为:
#define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \\G_STMT_START {			\\void (*add_vtable) (const char*,       \\gsize,             \\gconstpointer,     \\void (*) (Fixture*, gconstpointer),   \\void (*) (Fixture*, gconstpointer),   \\void (*) (Fixture*, gconstpointer)) =  (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \\add_vtable \\(testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \\} G_STMT_END

实际上它是使用函数g_test_add_vtable来注册的:

typedef void (*GTestFixtureFunc) (gpointer      fixture,gconstpointer user_data);
void    g_test_add_vtable               (const char     *testpath,gsize           data_size,gconstpointer   test_data,GTestFixtureFunc  data_setup,GTestFixtureFunc  data_test,GTestFixtureFunc  data_teardown);

user_data是输入的测试参数,data_setup是测试前的数据准备函数,data_test是正式的测试用例函数,data_teardown是测试完后做善后处理的函数。

每一个测试用例都需要一个路径testpath,且不能重复。

三、实例

main.c源码:

#include <glib.h>typedef struct A
{int v;
} A;void test()
{g_print("test\\n");
}void foo(gconstpointer test_data)
{A* a = (A*)test_data;g_print("A.v = %d\\n", a->v);
}/* run a test with fixture setup and teardown */
typedef struct
{guint seed;guint prime;gchar *msg;
} Fixturetest;static void
fixturetest_setup(Fixturetest *fix,gconstpointer test_data)
{g_assert_true(test_data == (void *)0xc0cac01a);fix->seed = 18;fix->prime = 19;fix->msg = g_strdup_printf("%d", fix->prime);
}static void
fixturetest_test(Fixturetest *fix,gconstpointer test_data)
{guint prime = g_spaced_primes_closest(fix->seed);g_assert_cmpint(prime, ==, fix->prime);prime = g_ascii_strtoull(fix->msg, NULL, 0);g_assert_cmpint(prime, ==, fix->prime);g_assert_true(test_data == (void *)0xc0cac01a);
}static void
fixturetest_teardown(Fixturetest *fix,gconstpointer test_data)
{g_assert_true(test_data == (void *)0xc0cac01a);g_free(fix->msg);
}int main(int argc, char **argv)
{gchar *base_name = g_path_get_basename(argv[0]);g_set_prgname(base_name);g_free(base_name);g_log_set_debug_enabled(TRUE);g_debug("start test...");A a;a.v = 100;g_test_init(&argc, &argv, NULL);g_test_add_func("/t", test);g_test_add_data_func("/td", &a, foo);g_test_add("/t1", Fixturetest, (void*)0xc0cac01a, fixturetest_setup, fixturetest_test, fixturetest_teardown);int ret = g_test_run();g_message("A:%d", a.v);return ret;
}

CMakeLists.txt源码:

cmake_minimum_required(VERSION 3.12.0)
project(demo VERSION 0.1.0)include(CTest)enable_testing()add_executable(${PROJECT_NAME} main.c)
find_package(PkgConfig REQUIRED)
pkg_check_modules (GLIB2 REQUIRED IMPORTED_TARGET glib-2.0>=2.70)
target_link_libraries(${PROJECT_NAME} PkgConfig::GLIB2)message(STATUS "GLIB2_INCLUDE_DIRS: ${GLIB2_INCLUDE_DIRS}")
message(STATUS "GLIB2_LIBRARY_DIRS: ${GLIB2_LIBRARY_DIRS}")
message(STATUS "GLIB2_LIBRARIES: ${GLIB2_LIBRARIES}")add_test(NAME ${PROJECT_NAME} COMMAND ${PROJECT_NAME})

运行结果:
使用Glib中测试框架对C代码进行单元测试

使用CTest测试结果:

使用Glib中测试框架对C代码进行单元测试

Glib还有很多非常强大的功能,感兴趣的读者可以去深究!