美文网首页
如何使用CUnit进行单元测试和覆盖率统计

如何使用CUnit进行单元测试和覆盖率统计

作者: Jiafu | 来源:发表于2018-01-22 21:05 被阅读0次

    [TOC]

    CUnit安装

    如果能联网的话,直接

    yum install CUnit-devel.x86_64

    就完成安装了,注意要安装devel版本,这样才能找到头文件。

    编写单元测试代码

    CUnit的测试是单线程启动,只能注册一个Test Registry, 一次测试(Test Registry)可以运行多个测试包(Test Suite),而每个测试包可以包括多个测试用例(Test Case),每个测试用例又包含一个或者多个断言类的语句。

    具体到程序的结构上,一次测试下辖多个Test Suite,它对应于程序中各个独立模块;一个Suite管理多个Test Case,它对应于模块内部函数实现。每个Suite可以含有setup和teardown函数,分别在执行suite的前后调用。

    以下给出一个最简单的示例代码,用的时候,把示例代码直接拷贝走,按自己的实际code,稍微改动一下,就可以用了。

    代码包括4个文件:

    • module.c
    • module.h 前两个文件是我们待测试的模块代码。为了简单起见,这里面只有一个函数。
    • cunit_sample.c:测试代码所在文件。简单起见,这里只有一个文件,实际可能会将不同模块的测试代码放到不同的文件中。
    • Makefile: 执行make clean all生成测试的可执行文件。

    源代码

    module.c

    int func1(int k) {
        if (k < 10) {
            return k;
        } else {
            return k + 1;
        }
    }
    

    module.h

    #ifndef __CUNIT_SAMPLE_MODULE_
    #define __CUNIT_SAMPLE_MODULE_
    
    int func1(int k);
    
    #endif
    

    cunit_sample.c

    #include <stdio.h>
    #include "CUnit.h"
    #include "Automated.h"
    
    #include "module.h"
    
    void utcase_first_case()
    {
        int ret = 0;
        ret = func1(10);
        CU_ASSERT_EQUAL(ret, 11);
    }
    
    static CU_TestInfo ut_cases[] =
    {
        {"case:first_case", utcase_first_case},
        // add more cases here
        CU_TEST_INFO_NULL,
    };
    
    int suite_init(void)
    {
        return 0;
    }
    
    int suite_clean(void)
    {
        return 0;
    }
    
    static CU_SuiteInfo ut_suites[] = 
    {
        {"my_first_suite", suite_init, suite_clean, ut_cases},
        CU_SUITE_INFO_NULL,
    };
    
    int main() {
        int rc = 0;
        CU_ErrorCode err = CUE_SUCCESS;
    
        err = CU_initialize_registry();
        if (err != CUE_SUCCESS) {
            fprintf(stderr, "failed to initialize registry, error %d", err);
            rc = 1;
            goto l_out;
        }
    
        err = CU_register_suites(ut_suites);
        if (err != CUE_SUCCESS) {
            fprintf(stderr, "failed to register suites, error %d, %s", err, CU_get_error_msg());
            rc = 1;
            goto l_clean_register;
        }
    
        CU_set_output_filename("cunit_sample");
    
        err = CU_list_tests_to_file();
        if (err != CUE_SUCCESS) {
            fprintf(stderr, "failed to list tests to file, error %d, %s", err, CU_get_error_msg());
            rc = 1;
            goto l_clean_register;
        }
    
        CU_automated_run_tests();
    
    l_clean_register:
        CU_cleanup_registry();
    
    l_out:
        return rc;
    }
    
    

    Makefile

    NY: all clean
    RM = rm
    RMFLAGS = -fr
    CC = gcc
    
    INC = -I /usr/include/CUnit -I .
    LIBS = /usr/lib64/libcunit.so
    CFLAGS = -fprofile-arcs -ftest-coverage
    CFLAGS += $(INC)
    BIN = cunit_sample
    all: module.c module.h cunit_sample.c
        $(CC) $(CFLAGS) -o module.o -c module.c
        $(CC) $(CFLAGS) -o cunit_sample.o -c cunit_sample.c
        $(CC) $(CFLAGS) $(LIBS) -o $(BIN) module.o cunit_sample.o
    
    clean:
        $(RM) $(RMFLAGS) $(BIN) *.o *.gcda *.gcno *.xml
    
    

    执行测试用例

    执行make clean all后,生成cunit_sample这个可执行文件,直接执行,成功后,会生成两个xml文件,打开cunit_sample-Results.xml,就可以看到每个测试用例的执行结果了。

    覆盖率统计

    安装lcov

    lcov是一个覆盖率的可视化工具,使用

    yum install lcov
    即可完成安装

    在执行测试用例完成后,在源代码所在的目录下(一般我们要看的是源代码的覆盖率),使用以下两个命令,生成代码覆盖率的可视化结果:

    lcov -c -d ./ -o app.info # 指定当前目录,也可以指定其它目录

    顺利的话,会生成app.info文件
    最后一步:

    genhtml app.info -o cc_result

    顺利的话,会生成cc_result的目录,里面就是覆盖率的统计结果,使用浏览器打开cc_result/index.html即可。

    视觉效果如下图:

    代码覆盖率统计

    可以点击任何一个文件,查看某个文件的具体覆盖信息,这里不就赘述了,希望本文可以帮到你。

    相关文章

      网友评论

          本文标题:如何使用CUnit进行单元测试和覆盖率统计

          本文链接:https://www.haomeiwen.com/subject/ypmraxtx.html