c/c++代码的unit-test中覆盖率的统计

gcov lcov genhtml工具

     gcov伴随gcc 发布。gcc编译加入-fprofile-arcs -ftest-coverage 参数生成二进制程序，执行测试用例生成代码覆盖率信息。

使用这些工具产生代码覆盖率的统计，需要经过：编译参数设置&编译、运行、gcov生成覆盖信息、locv生成 html报表数据、genhtml根据报表数据生成可视化的html报告 这几个步骤

编译参数设置&编译

    用GCC编译的时候加上-fprofile-arcs -ftest-coverage选项，链接的时候也加上。
    fprofile-arcs参数使gcc创建一个程序的流图，之后找到适合图的生成树。只有不在生成树中的弧被操纵（instrumented）：gcc添加了代码来清点这些弧执行的次数。当这段弧是一个块的唯一出口或入口时，操纵工具代码（instrumentation code)将会添加到块中，否则创建一个基础块来包含操纵工具代码。

    编译成功后，会生成各*.c对应的 *.gcno文件。*.gcno是由-ftest-coverage产生的，它包含了重建基本块图和相应的块的源码的行号的信息。

运行

    也就是执行单元测试进程，如果编译参数中加了gcov相关的参数后，执行结果会生成 各 *.c文件对应的 *.gcda文件。*gcda是由加了-fprofile-arcs编译参数的编译后的文件运行所产生的，它包含了弧跳变的次数和其他的概要信息（而gcda只能在程序运行完毕后才能产生的）。

 

gcov生成覆盖信息

     Gcov执行函数覆盖、语句覆盖和分支覆盖。gcov工具会生成各*.c文件对应的 *.c.gcov 文件，不过*.c.gcov在lcov命令执行后，会被删除。*.c.gcov包含了函数和代码执行次数的信息。

locv生成 html报表数据

Lcov则是上的gcov 结果展现的一个前端，可以将覆盖率信息转换成html展现，它用来解析*.c.gcov中晦涩的字符，生成代码覆盖的信息，并输出到文件(*.info)，genhtml根据*.info文件生成html报告。

lcov -d ./ -c  -o $(LCOV_INFO) -b ./

 

genhtml根据报表数据生成可视化的html报告

genhtml -o $(COV_REPORT) $(LCOV_INFO) --show-details –legend

 

最终的报告,*.html文件

 

 

完整的makfile

# makefile for sample cpputest

INC_DIR := -I../inc -I../inc/mysql -I../src/libcas
SRC_FILE := libcas.c cJSON.c qs_thread.c qs_init.c qs_paltask.c qs_cmd.c qs_db.c  qs_main.c
SRC_OBJS := libcas.so
SRC_LNAME := cas

TEST_GROUP_FILE := test.c  mocks.c
TEST_EXE := test_libcas

RUN_PREPARE := "cp ../bin/cas.json ."

UT_LOG := result.log
CU_PROJECT_NAME := $(shell pwd |awk -F "/" '{print $$NF}' )
LCOV_INFO  := $(CU_PROJECT_NAME).info
COV_REPORT := $(CU_PROJECT_NAME)_cover

all: $(TEST_EXE) $(SRC_OBJS)

CPPUTEST_HOME := /usr/cpputest

CC      := gcc -Wformat
CCFLAGS  := -g -DLINUX $(INC_DIR) -shared -fPIC  -fprofile-arcs -ftest-coverage  --coverage
CCFLAGS  += -D CPPUTEST          # 编译测试文件时, 忽略被测代码 *.c 的main函数, test.c 的代码中用了宏CPPUTEST
CCLDFLAGS := -lgcov
CCLDFLAGS += -L../bin -lm -lvst_memory -lvst_shell_log -ldbase_comm -lbase_log -lvst_plat -lpthread \
              -loam_proxy -ldbase_my

CPP     := g++
CPPFLAGS  := -g -w  -fpermissive -DLINUX -fprofile-arcs -ftest-coverage  --coverage
CPPFLAGS  += -I$(CPPUTEST_HOME)/include  $(INC_DIR)
CPPLDFLAGS := -lgcov
CPPLDFLAGS += -Wl,-rpath,./,-rpath,./../bin -L$(CPPUTEST_HOME)/lib -L../bin -lCppUTest -lCppUTestExt
CPPLDFLAGS += -lssl -ldl -lpthread -lvst_com -lvst_memory -lvst_plat -lvst_encrypt\
              -lvst_shell_cli -lvst_shell_log -lm -lvst_thpool -lreadline \
              -lvst_thpool -ldbcfg_parse -ldata_parse \
              -lipdr -laccpwd -lstat -luas -ldata_stat 

CPPLDFLAGS += -l$(SRC_LNAME)

SRCDIR := $(shell ls -d ../src/*)
vpath
vpath %.c $(SRCDIR)

$(SRC_OBJS): $(SRC_FILE)
    $(CC) -o $@ $^ $(CCFLAGS) $(CCLDFLAGS)

$(TEST_EXE): $(TEST_GROUP_FILE) $(SRC_OBJS)
    $(CPP) -o $@ $^  $(CPPFLAGS) $(CPPLDFLAGS)

.PHONY: clean
clean:
    @echo "clean..."
    rm -f $(SRC_OBJS) $(TEST_EXE)
    rm -f *.gcda
    rm -f *.gcno
    rm -f *.gcov
    rm -f $(UT_LOG)
    rm -rf $(COV_REPORT)
    rm -f *.info

run:
    eval $(RUN_PREPARE)
    ./$(TEST_EXE) &> $(UT_LOG)

cover:
    for file in $(SRC_FILE);\
        do\
            gcov -b "$$file";\
        done
    lcov -d ./ -c  -o $(LCOV_INFO) -b ./
    genhtml -o $(COV_REPORT) $(LCOV_INFO) --show-details --legend

 

一些问题

一开始的时候，生成的报告，只有 line和functions的统计，没有branches的统计。

在执行 make cover后，日志只有：

gcov命令执行的日志中，有branch的信息：

开始解决问题的思路：是不是gcov 或lcov的命令参数不对，查了命令及尝试了修改参数后，仍未解决。

后来发现 lcov的命令日志中有如下告警：

按告警信息搜索，发现了 stackoverflow上有个相似的问题：

http://stackoverflow.com/questions/13378640/lcov-can-not-collect-branch-coverage-statistics

参照上面的思路，修改了/etc/lcovrc中

lcov_branch_coverage=1

genhtml_branch_coverage=1

后，最终的html报告中才有branches的统计。