代码覆盖率生成工具gcov/lcov

一、代码覆盖率生成工具gcov

1.1.gcov工具简介

gcov是代码覆盖率测试工具,与GCC一同使用,且只能用于GCC编译程序,其具有以下功能。

  • 统计C/C++程序某行代码执行次数。
  • 统计C/C++程序哪些代码被执行过。

说明:通常生成代码覆盖率信息需要配合单元测试工具(gtest)使用,配合单元测试发现哪些代码/分支被有效执行。

1.2.gcov工具使用

当使用gcov工具时,你必须在编译文件时使用参数--coverage,这会告诉编译器去嵌入多余代码段,生成gcov工具需要的信息。

当编译程序时,<sourcefile>.gcno文件将生成于当前目录(等同于编译时使用参数-ftest-coverage)。

当运行程序时,<sourcefile>.gcda文件将会生成于当前目录(等同于编译时使用参数-fprofile-arcs)。

gcov需要上述两个文件来生成相关的代码覆盖率信息。

总结:

  • .gcda文件在程序执行后生成,该程序编译时需要加入参数-fprofile-arcs

  • .gcno文件在编译程序时生成,该程序编译时需要加入参数-ftest-coverage

  • 编译时添加参数--coverage等同于-fprofile-arcs -ftest-coverage

1.3.gcov使用示例

首先我们创建一个名test.cppC++源文件(插入排序)。

/* FILENAME : test.cpp */
#include <iostream>
#include <algorithm>
#include <vector>

template<class It>
using value_type_t = typename std::iterator_traits<It>::value_type;

template<class It, class Compare = std::less<value_type_t<It>>>
void InsertionSort(It begin, It end, Compare cmp = Compare()) {
    for(auto it = begin; it != end; it = std::next(it)) {
        auto const insertion = std::upper_bound(begin, it, *it, cmp);
        std::rotate(insertion, it, std::next(it));
    }
}

int main(int argc, char *argv[]) {
    std::vector<int> arr = {8,3,4,0,5,1,2,9,7,6};
    InsertionSort(arr.begin(), arr.end());
    for(int i : arr) {
        std::cout << i << " ";
    }
    std::cout << std::endl;
    return 0;
}

生成可执行文件$ g++ -o test test.cpp --coverage,此时会产生成test.gcno文件。

运行程序$ ./test,此时会产生test.gcda文件。

使用命令$ gcov test.gcda生成test.cpp.gcov文件。

/* test.cpp.gcov */
 -:    0:Source:test.cpp                 
 -:    0:Graph:test.gcno            
 -:    0:Data:test.gcda
 -:    0:Runs:1
 -:    0:Programs:1
 -:    1:#include <iostream>
 -:    2:#include <algorithm>
 -:    3:#include <vector>
 -:    4:
 -:    5:template<class It>
 -:    6:using value_type_t = typename std::iterator_traits<It>::value_type;
 -:    7:
 -:    8:template<class It, class Compare = std::less<value_type_t<It>>>
 1:    9:void InsertionSort(It begin, It end, Compare cmp = Compare()) {
11:   10:    for(auto it = begin; it != end; it = std::next(it)) {
10:   11:        auto const insertion = std::upper_bound(begin, it, *it, cmp);
10:   12:        std::rotate(insertion, it, std::next(it));
 -:   13:    }
 1:   14:}
 -:   15:
 1:   16:int main(int argc, char *argv[]) {
 1:   17:    std::vector<int> arr = {8,3,4,0,5,1,2,9,7,6};
 1:   18:    InsertionSort(arr.begin(), arr.end());
11:   19:    for(int i : arr) {
10:   20:        std::cout << i << " ";
 -:   21:    }
 1:   22:    std::cout << std::endl;
 1:   23:    return 0;
 -:   24:}

二、代码覆盖率生成工具lcov

2.1.lcov工具简介

lcovGCOV的图形化前端工具集,其主要包含工具如下:

  • lcov - 获取LCOV覆盖率数据
  • genhtml - 将LCOV覆盖率数据生成HTML文件

2.2.lcov工具示例

通过gcov工具,生成如下覆盖率统计文件:

test          - 可执行文件
test.cpp      - 源代码
test.cpp.gcov - gcov工具产生文件
test.gcda     - 运行test后参数统计数据
test.gcno     - 编译test后参数统计数据

使用lcov生成LCOV覆盖率数据文件:

$ lcov --directory ./ --capture --output-file test.info

删除LCOV覆盖率数据中统计到的库文件:

$lcov --remove test.info '/usr/local/*' --output-file test.info

  • --directory - .gcda文件所在目录

  • --capture - 统计覆盖率数据

  • --output-file - 输出LCOV覆盖率数据的文件名

  • --remove - 删除LCOV覆盖率数据中不需要统计的文件名

使用genhtml工具生成html页面:

$ genhtml test.info --output-directory result

  • --output-directory - 生成html文件夹名
image

三、参考链接

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容