Blogger | Tony Bai

八月 26, 2009

近两天一有空就会去看看项目代码，思考一下如何利用cmockery对项目里已有的代码进行测试。项目代码中很多被调用的接口都带有输出参数，而且在这些接口中多利用返回值指示执行成败也否，而利用输出参数返回一些关键结果，这些结果值甚至影响着后续的函数执行流程。前期研究cmockery时没有注意到cmockery是否可以设置被mock接口的输出参数的值，不过回顾了一下cmockery实现的原理，觉得cmockery是应该可以支持的。遂重新翻看了一下cmockery的manual，发现在mock_query_database中确有对输出参数的mock调用，代码如下：

// Mock query database function.
unsigned int mock_query_database( DatabaseConnection* const connection,
const char * const query_string, void *** const results)
{
*results = (void**)mock();
return (unsigned int)mock();
}

void test_get_customer_id_by_name(void **state) {
DatabaseConnection connection = { "somedatabase.somewhere.com", 12345678, mock_query_database };
int customer_ids = 543;
will_return(mock_query_database, &customer_ids);
will_return(mock_query_database, 1);
assert_int_equal(get_customer_id_by_name(&connection, "john doe"), 543);
}

上面代码在test_get_customer_id_by_name中两次针对被mock的接口mock_query_database调用will_return，实际上是在符号“mock_query_database”对应的value list里插入了两个item，第一个item的值为&customer_ids，第二个为1。当测试执行到mock_query_database的第一个mock时，返回第一个item：&customer_ids，执行到第二个mock时返回第二个item的值1。这样在测试过程中设置输出参数值的目的就达到了。

在使用cmockery时唯一需要你关注的就是will_return设置的顺序和在被mock接口中调用mock的顺序，切记不要弄反了。

这里再举一个例子，再直观感受一下：

/* message_handler.c */

#include

extern int dispatch_message(void *msg);
extern int get_next_message(void **msg);

int handle_next_message() {
void * temp_msg = NULL;
int rv = 0;

        rv = get_next_message(&temp_msg);
        if (!rv) {
                if (!temp_msg) {
                        return -1;
                } else {
                        return dispatch_message(temp_msg);
                }

}

return rv;
}

/* test_message_handler.c */
#include
#include
#include
#include "cmockery.h"
#include

int dispatch_message(void *msg) {
return 0;
}

int get_next_message(void **msg) {
(*msg) = (void*)mock();
return (int)mock();
}

extern int handle_next_message();

void test_handle_next_message_success(void **state) {
        will_return(get_next_message, 0×1234);
        will_return(get_next_message, 0);
        assert_true(handle_next_message() == 0);
}

void test_handle_next_message_fail(void **state) {
        will_return(get_next_message, NULL);
        will_return(get_next_message, 0);
        assert_true(handle_next_message() == -1);
}

int main() {
        const UnitTest tests[] = {
                unit_test(test_handle_next_message_success),
                unit_test(test_handle_next_message_fail)
        };
        return run_tests(tests);
}

执行结果：
test_handle_next_message_success: Starting test
test_handle_next_message_success: Test completed successfully.
test_handle_next_message_fail: Starting test
test_handle_next_message_fail: Test completed successfully.
All 2 tests passed

C单元测试之使用cmockery

八月 22, 2009

2 条评论

这么久以来一直没有找到一款很好的支持mock测试的C语言单元测试工具包，但前不久在一网友的评论中得知：去年Google曾发布了一款c语言的轻量级单元测试framework — “cmockery”，cmcokery很小巧，对其他开源包没有依赖，对被测试代码侵入性小；它支持mock test，同样也可以支持常规的单元测试。

之前在博客中曾描述过C语言实现mock的一个思路，不过和cmockery对比起来，当时我的思路显然还处于初级阶段，而cmockery则走到了更高级，使用起来也更为简便。

还是以我上一篇文章中的代码来举例，利用cmockery来对biz.c进行mock test。

应用层被测试代码不变：
/* biz.h */
#ifndef BIZ_H
#define BIZ_H

#include

int biz_operation(char *fname);
#endif

/* biz.c */
#include "biz.h"

int biz_operation(char *fname) {
FILE *fp = NULL;

        fp = fopen(fname, "r");
        if (fp == NULL) {
                printf("fail to open fle!\n");
                return 1;
        } else {
                printf("succeed to open file!\n");
                return 0;
        }
}

利用cmockery改造测试代码如下：
/* test.c */
#include
#include
#include
#include
#include "cmockery.h"
#include "biz.h"

FILE *fopen(const char *filename, const char *mode) {
return (FILE*)mock();
}

void test_biz_operation_return_succ(void **state) {
will_return(fopen, 0×1234);
assert_true(biz_operation("foo.txt") == 0);
}

void test_biz_operation_return_fail(void **state) {
will_return(fopen, NULL);
assert_true(biz_operation("foo.txt") == 1);
}

int main() {
        const UnitTest tests[] = {
                unit_test(test_biz_operation_return_succ),
                unit_test(test_biz_operation_return_fail),
    };
        return run_tests(tests);
}

gcc biz.c test.c -I ./ -I {YOUR_CMOCKERY_INSTALL_DIR}/include/google -L {YOUR_CMOCKERY_INSTALL_DIR}/lib -lcmockery

执行a.out结果如下：
test_biz_operation_return_succ: Starting test
succeed to open file!
test_biz_operation_return_succ: Test completed successfully.
test_biz_operation_return_fail: Starting test
fail to open fle!
test_biz_operation_return_fail: Test completed successfully.
All 2 tests passed

在测试代码中override了C标准库中fopen的实现，代码很简单，就是调用一个mock，然后根据返回值类型做一个强制类型转换。那么执行
起来后mock究竟会返回什么值呢？这个值你可以任意设定，看到下面test_biz_operation_return_xx中的
will_return宏了吗，在will_return中你可以设定fopen中mock()调用的返回值：will_return(fopen,
0×1234)或will_return(fopen, NULL);
是不是思路清晰了许多了呢，没错。cmockery就是通过在will_return中设置mock的返回值，并在执行fopen这类被mock的函数接
口中通过接口实现中的mock调用将你设定的值返回出来，从而控制被测试接口biz_operation的执行路径和执行结果，以达到mock
test的目的。

cmockery的源代码行数不到3K，你阅读一下will_return和mock的源代码就一目了然了。大致思路应
该是：在堆上分配一块内存，用来存储你在will_return中设定的返回值，用函数名字符串做索引；在mock()中则通过调用mock的函数的名字
去匹配，得到已经设定好的存储在堆内存上的那个值，并在转型后返回。

以上是cmockery支持的对通用函数返回值的
mock，cmockery还支持mock function的parameters checking、setup和teardown、assert
failure和dynamic memory allocation的mock等，cmockery的manual中
有细致说明。不过原理都类似，在上面也都说过了。不过有些机制对被测试代码还是有一定侵入性的。cmockery虽好，但是毕竟是针对C语言的，就无法逃
过链接阶段符号resolved的问题，测试上面简单的代码还好，如果测试大工程中某复杂源代码文件中的接口时，链接时就会有些麻烦，所以工程源代码组织
的扁平化、接口功能单一化、包含和清晰的调用关系都会大大有助于实施mock单元测试，否则一旦你的biz_operation接口功能很复杂，调用了很
多其他接口，实现很冗长的话，那么你的mock测试同样也会很麻烦，这时你需要做的就应该是重构你的代码，将复杂的biz_operation拆分开了。

另外cmockery的安装很简单，遵循常规的configure->make->make install，这里不再贽述了。