C++单元测试覆盖率统计工具：GCOV+LCOV

2024-05-28 13:52
文章标签 工具 c++ 统计 单元测试 覆盖率 gcov lcov

本文主要是介绍C++单元测试覆盖率统计工具：GCOV+LCOV，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1. gcov基础

1.1 gcov概述

gcov是GNU编译器集合（GCC）的一个测试覆盖分析工具，它能够测量程序的执行覆盖率。gcov可以分析源代码中哪些行被执行过，哪些分支被采取过，以及哪些函数被调用过。这对于软件开发者来说是一个宝贵的资源，因为它有助于识别未被测试覆盖的区域，从而提高代码质量和减少潜在的bug。

1.2 安装gcov

gcov通常与GCC捆绑在一起，因此如果你的系统中已经安装了GCC，那么很可能已经拥有了gcov。以下是在不同操作系统上安装gcov的指南：

  • Linux: 大多数Linux发行版可以通过包管理器安装GCC，如下所示：
    sudo apt-get install gcc
  • macOS: 对于macOS用户，可以使用Homebrew来安装GCC：
    brew install gcc
  • Windows: Windows用户可以通过安装MinGW或Cygwin来获取gcov。

安装完成后，可以通过运行gcov --version来验证gcov是否已经正确安装。

1.3 基本使用方法

使用gcov的第一步是确保你的程序是为测试覆盖率编译的。这通常意味着在编译时需要添加特定的GCC选项。以下是使用gcov的步骤：

  1. 编译源代码: 使用-fprofile-arcs和-ftest-coverage选项编译你的源代码。例如，如果你有一个名为example.c的源文件，你可以使用以下命令来编译它：
    gcc -fprofile-arcs -ftest-coverage -o example example.c
  2. 运行程序: 运行编译后的程序，这将生成.gcda文件，记录程序的执行信息。
  3. 生成覆盖率报告: 使用gcov命令来分析这些数据并生成覆盖率报告：
    ./example
gcov example.c

这将生成一个example.gcov文件，其中包含了详细的覆盖率信息。

1.4 gcov的输出

gcov的输出文件.gcov提供了丰富的信息，包括：

  • 覆盖率摘要：显示总体的行覆盖率、分支覆盖率和函数覆盖率。
  • 详细覆盖率数据：为每个源文件中的每行代码提供执行次数，未执行的代码将以红色显示（在支持颜色的编辑器或IDE中）。
  • 函数和分支的覆盖率：显示每个函数的执行次数和覆盖率，以及每个分支的执行情况。

1.4.1 示例

假设我们有以下简单的C语言程序example.c：

#include <stdio.h>int main() {int a = 5;if (a > 3) {printf("a is greater than 3\n");}return 0;
}

按照上述步骤编译并运行程序后，gcov的输出可能如下所示：

File 'example.c'
Lines executed:100.00% of 4
Branches executed:100.00% of 1
Taken at least once:1
No branches
Functions executed:100.00% of 1

这个输出告诉我们，所有的4行代码都被执行了，包括一个条件分支，且所有的函数都被调用了。

1.4.2 使用gcov的技巧

  • 排除文件：使用--exclude选项来排除不需要分析的文件。
  • 汇总报告：使用-all-blocks来生成所有分支的覆盖率报告。
  • 过滤未覆盖的代码：使用--branch-probabilities来显示分支的执行概率，帮助识别未覆盖的分支。

2. lcov基础

2.1 lcov概述

lcov是一个功能强大的工具，用于收集和分析由gcov生成的代码覆盖率数据。与gcov相比，lcov提供了更为丰富的功能，包括生成易于阅读和导航的HTML格式的覆盖率报告。lcov不仅能够提供代码覆盖率的详细视图，还能帮助开发者通过图形界面快速定位未覆盖的代码区域。

2.2 安装lcov

lcov通常与GCC一起提供，但如果你的环境中没有lcov，可以通过以下方式安装：

  • Linux: 在大多数Linux发行版中，可以通过包管理器安装lcov：
    sudo apt-get install lcov
  • macOS: 使用Homebrew安装lcov：
    brew install lcov
  • Windows: Windows用户可以通过安装Linux子系统或使用Cygwin来获取lcov。

安装完成后，可以通过运行lcov --version来验证lcov是否已经正确安装。

2.3 基本使用方法

lcov的使用相对简单，它可以通过命令行与gcov配合工作。以下是使用lcov的基本步骤：

  1. 编译源代码: 首先，需要使用gcov支持的编译选项编译源代码，如前所述。
  2. 运行程序: 运行编译后的程序以生成.gcda文件。
  3. 收集覆盖率数据: 使用lcov命令收集覆盖率数据：
    lcov --capture --directory . --output-file coverage.info
  4. 生成HTML报告: 将收集到的数据转换为HTML格式的报告：
    genhtml coverage.info --output-directory coverage_report

这将生成一个名为coverage_report的目录，其中包含了详细的HTML覆盖率报告。

2.4 lcov的输出

lcov生成的HTML报告提供了丰富的可视化信息，包括：

  • 目录树：显示项目的目录结构，可以快速导航到不同的源文件。
  • 文件覆盖率：每个文件的覆盖率摘要，包括行覆盖率、分支覆盖率和函数覆盖率。
  • 行覆盖率详情：每个文件中每行代码的覆盖情况，未覆盖的行将以不同颜色高亮显示。
  • 分支覆盖率详情：显示每个分支的覆盖情况，包括分支的执行次数和覆盖率。

2.4.1 示例

假设我们继续使用前一章中的example.c程序，以下是使用lcov生成HTML报告的示例：

  1. 编译源代码:
    gcc -fprofile-arcs -ftest-coverage -o example example.c
  2. 运行程序:
    ./example
  3. 收集覆盖率数据:
    lcov --capture --directory . --output-file coverage.info
  4. 生成HTML报告:
    genhtml coverage.info --output-directory coverage_report

生成的HTML报告可以在coverage_report目录中查看。报告将包含一个index.html文件，这是报告的主页面，提供了项目的覆盖率摘要和目录树。点击example.c链接，将打开一个详细页面，显示该文件的覆盖率详情。

2.4.2 使用lcov的技巧

  • 排除特定文件：使用--exclude选项来排除特定文件或目录，例如：
    lcov --capture --directory . --output-file coverage.info --exclude "/usr/*"
  • 过滤未覆盖的代码：使用--remove选项来过滤掉未覆盖的代码段。
  • 自定义报告：使用genhtml的选项来自定义HTML报告的外观和行为，例如设置标题、添加徽章等。

3. 结合gcov和lcov

3.1 整合gcov和lcov

gcov和lcov是两个互补的工具，它们可以一起工作来提供更全面的代码覆盖率分析。gcov负责生成覆盖率数据，而lcov则用于收集这些数据并生成易于理解的HTML报告。这种整合不仅提高了分析的效率，还使得结果更加直观。

3.1.1 整合步骤

以下是整合gcov和lcov的基本步骤：

  1. 编译源代码: 使用gcov支持的编译选项编译源代码。
    gcc -fprofile-arcs -ftest-coverage -o my_program my_program.c
  2. 运行程序: 执行编译后的程序以生成.gcda和.gcno文件。
    ./my_program
  3. 收集覆盖率数据: 使用lcov收集覆盖率数据。
    lcov --capture --directory . --output-file coverage.info
  4. 生成HTML报告: 使用lcov的genhtml工具生成HTML格式的报告。
    genhtml coverage.info --output-directory coverage_report

3.2 高级配置

3.2.1 配置文件

lcov可以使用配置文件（.lcovrc）来定义高级选项，如排除特定目录或文件。例如，创建一个.lcovrc文件并添加以下内容来排除测试目录：

# .lcovrc
# Exclude test directory
exclude_test_dir='*tests*'

然后在运行lcov时指定配置文件：

lcov --rc lcovrc_file=.lcovrc --capture --directory . --output-file coverage.info

3.2.2 排除特定文件或函数

使用lcov的--exclude选项来排除特定文件或函数的覆盖率统计。例如，排除所有.h文件：

lcov --capture --directory . --exclude "*.h" --output-file coverage.info

3.2.3 设置阈值

可以设置覆盖率的阈值，以确保代码质量。例如，设置最低行覆盖率为80%：

genhtml coverage.info --branch-coverage --functions-coverage --legend --title "Code Coverage" --output-directory coverage_report --threshold-percentage 80

3.3 自动化集成

3.3.1 CI/CD集成

将gcov和lcov集成到持续集成/持续部署（CI/CD）流程中，可以自动化测试覆盖率的收集和报告生成。大多数现代CI/CD平台（如Jenkins, Travis CI, GitHub Actions等）都支持自定义脚本，可以添加以下步骤：

  1. 编译源代码: 在构建脚本中添加编译命令。
  2. 运行测试: 执行测试用例。
  3. 收集覆盖率数据: 使用lcov收集数据。
  4. 生成报告: 使用genhtml生成HTML报告。
  5. 上传报告: 将生成的报告上传到服务器或存储库。

3.3.2 示例

假设我们使用GitHub Actions进行CI/CD，以下是.github/workflows目录下的一个示例.yml文件：

name: Code Coverageon: [push, pull_request]jobs:build:runs-on: ubuntu-lateststeps:- uses: actions/checkout@v2- name: Set up GCCrun: sudo apt-get install gcc- name: Compile with Coveragerun: gcc -fprofile-arcs -ftest-coverage -o my_program my_program.c- name: Run Programrun: ./my_program- name: Collect Coverage Datarun: lcov --capture --directory . --output-file coverage.info- name: Generate HTML Reportrun: genhtml coverage.info --output-directory coverage_report- name: Upload Coverage Reportuses: actions/upload-artifact@v2with:name: Code Coverage Reportpath: coverage_report

这个工作流会在每次提交或拉取请求时自动运行，编译源代码，运行程序，收集覆盖率数据，生成HTML报告，并上传报告作为工件。

3.4 可视化覆盖率

3.4.1 覆盖率徽章

可以使用服务如Codecov或Coveralls来显示覆盖率徽章在你的README文件或Pull Request中。这些服务可以解析你的覆盖率报告，并提供一个可视化的徽章来展示当前的覆盖率状态。

4. 场景问题及解决方案

4.1 场景一：覆盖率报告中发现未覆盖的代码

问题描述：在生成的覆盖率报告中，发现某些函数或代码块未被测试覆盖。

解决方案：

  1. 分析覆盖率报告：查看lcov生成的HTML报告，定位未覆盖的代码区域。
  2. 审查代码逻辑：检查未覆盖的代码是否为正常逻辑，还是潜在的代码异味或错误。
  3. 编写测试用例：为未覆盖的代码编写新的测试用例或更新现有测试用例。
  4. 更新测试脚本：在测试脚本中添加新的测试用例，并确保它们能够触发未覆盖的代码路径。

示例脚本：

# 假设我们发现函数 `calculate_tax` 未被覆盖# 步骤1：在测试文件 test_my_program.c 中添加测试用例
// test_my_program.c
void test_calculate_tax() {// 测试不同的输入情况assert(calculate_tax(100) == 10); // 假设税率为10%assert(calculate_tax(200) == 20);// 添加更多测试用例以覆盖所有分支
}// 步骤2：编译测试程序
gcc -fprofile-arcs -ftest-coverage -o test_my_program test_my_program.c my_program.c// 步骤3：运行测试程序
./test_my_program// 步骤4：再次收集覆盖率数据
lcov --capture --directory . --output-file coverage.info// 步骤5：生成新的HTML报告
genhtml coverage.info --output-directory coverage_report// 步骤6：检查新的覆盖率报告是否覆盖了之前未覆盖的代码

4.2 场景二：覆盖率报告过大，难以管理

问题描述：项目中源文件众多，生成的覆盖率报告文件过大，难以有效管理和分析。

解决方案：

  1. 使用lcov的排除功能：通过.lcovrc配置文件排除不必要的目录或文件。
  2. 模块化覆盖率报告：为不同的模块生成单独的覆盖率报告。
  3. 使用CI工具的报告聚合功能：如果使用CI工具，可以利用其报告聚合功能来管理多个覆盖率报告。

示例脚本：

# 步骤1：创建.lcovrc配置文件，排除测试目录和第三方库
echo "exclude_test_dir='*tests*'" > .lcovrc
echo "exclude_directories='*/third_party/*'" >> .lcovrc# 步骤2：为每个模块单独收集覆盖率数据
lcov --capture --directory ./module1 --output-file coverage_module1.info
lcov --capture --directory ./module2 --output-file coverage_module2.info
# 重复此步骤为其他模块生成覆盖率数据# 步骤3：为每个模块生成HTML报告
genhtml coverage_module1.info --output-directory coverage_report_module1
genhtml coverage_module2.info --output-directory coverage_report_module2
# 重复此步骤为其他模块生成HTML报告# 步骤4：在CI工具中配置报告聚合（以Jenkins为例）
# 在Jenkins中配置Post-build Action以聚合所有模块的覆盖率报告

4.3 场景三：CI/CD流程中的覆盖率下降

问题描述：在CI/CD流程中，新提交的代码导致整体覆盖率下降。

解决方案：

  1. 立即通知：配置CI/CD流程，当覆盖率下降时发送通知给相关开发者。
  2. 分析覆盖率变化：确定覆盖率下降的原因，是否是因为新代码未被覆盖，或者是因为原有测试用例被破坏。
  3. 修复问题：根据分析结果，编写新的测试用例或修复现有测试用例。
  4. 重新运行测试：在修复问题后，重新运行测试并验证覆盖率。

示例脚本（GitHub Actions）：

name: Code Coverage Checkon: [push, pull_request]jobs:build:runs-on: ubuntu-lateststeps:- uses: actions/checkout@v2- name: Set up GCCrun: sudo apt-get install gcc- name: Compile with Coveragerun: gcc -fprofile-arcs -ftest-coverage -o my_program my_program.c- name: Run Programrun: ./my_program- name: Collect Coverage Datarun: lcov --capture --directory . --output-file coverage.info- name: Check Coverage Raterun: |current_coverage=$(genhtml -e coverage.info)base_coverage=$(grep -oP 'Overall coverage' base_coverage.info | grep -oP '\d+')if [ "$current_coverage" -lt "$base_coverage" ]; thenecho "Coverage rate has decreased!"exit 1fi- name: Generate HTML Reportrun: genhtml coverage.info --output-directory coverage_report- name: Upload Coverage Reportuses: actions/upload-artifact@v2with:name: Code Coverage Reportpath: coverage_report

这篇关于C++单元测试覆盖率统计工具：GCOV+LCOV的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1010749。

相关文章

hdu1496（用hash思想统计数目）

hdu1496（用hash思想统计数目）

作为一个刚学hash的孩子，感觉这道题目很不错，灵活的运用的数组的下标。 解题步骤：如果用常规方法解，那么时间复杂度为O（n^4）,肯定会超时，然后参考了网上的解题方法，将等式分成两个部分，a*x1^2+b*x2^2和c*x3^2+d*x4^2， 各自作为数组的下标，如果两部分相加为0，则满足等式； 代码如下： #include<iostream>#include<algorithm
阅读更多...
【C++ Primer Plus习题】13.4

【C++ Primer Plus习题】13.4

大家好,这里是国中之林! ❥前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到网站。有兴趣的可以点点进去看看← 问题: 解答: main.cpp #include <iostream>#include "port.h"int main() {Port p1;Port p2("Abc", "Bcc", 30);std::cout <<
阅读更多...
C++包装器

C++包装器

包装器 在 C++ 中，“包装器”通常指的是一种设计模式或编程技巧，用于封装其他代码或对象，使其更易于使用、管理或扩展。包装器的概念在编程中非常普遍，可以用于函数、类、库等多个方面。下面是几个常见的 “包装器” 类型： 1. 函数包装器 函数包装器用于封装一个或多个函数，使其接口更统一或更便于调用。例如，std::function 是一个通用的函数包装器，它可以存储任意可调用对象（函数、函数
阅读更多...
C++11第三弹：lambda表达式 | 新的类功能 | 模板的可变参数

C++11第三弹：lambda表达式 | 新的类功能 | 模板的可变参数

🌈个人主页： 南桥几晴秋 🌈C++专栏： 南桥谈C++ 🌈C语言专栏： C语言学习系列 🌈Linux学习专栏： 南桥谈Linux 🌈数据结构学习专栏： 数据结构杂谈 🌈数据库学习专栏： 南桥谈MySQL 🌈Qt学习专栏： 南桥谈Qt 🌈菜鸡代码练习： 练习随想记录 🌈git学习： 南桥谈Git 🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈�
阅读更多...
【C++】_list常用方法解析及模拟实现

【C++】_list常用方法解析及模拟实现

相信自己的力量，只要对自己始终保持信心，尽自己最大努力去完成任何事，就算事情最终结果是失败了，努力了也不留遗憾。💓💓💓 目录   ✨说在前面 🍋知识点一：什么是list？ •🌰1.list的定义 •🌰2.list的基本特性 •🌰3.常用接口介绍 🍋知识点二：list常用接口 •🌰1.默认成员函数 🔥构造函数（⭐） 🔥析构函数 •🌰2.list对象
阅读更多...
高效录音转文字：2024年四大工具精选！

高效录音转文字：2024年四大工具精选！

在快节奏的工作生活中，能够快速将录音转换成文字是一项非常实用的能力。特别是在需要记录会议纪要、讲座内容或者是采访素材的时候，一款优秀的在线录音转文字工具能派上大用场。以下推荐几个好用的录音转文字工具！ 365在线转文字 直达链接：https://www.pdf365.cn/ 365在线转文字是一款提供在线录音转文字服务的工具，它以其高效、便捷的特点受到用户的青睐。用户无需下载安装任何软件，只
阅读更多...
06 C++Lambda表达式

06 C++Lambda表达式

lambda表达式的定义 没有显式模版形参的lambda表达式 [捕获] 前属性 (形参列表) 说明符 异常 后属性 尾随类型 约束 {函数体} 有显式模版形参的lambda表达式 [捕获] <模版形参> 模版约束 前属性 (形参列表) 说明符 异常 后属性 尾随类型 约束 {函数体} 含义 捕获：包含零个或者多个捕获符的逗号分隔列表 模板形参：用于泛型lambda提供个模板形参的名
阅读更多...
6.1.数据结构-c/c++堆详解下篇（堆排序，TopK问题）

6.1.数据结构-c/c++堆详解下篇（堆排序，TopK问题）

上篇：6.1.数据结构-c/c++模拟实现堆上篇（向下，上调整算法，建堆，增删数据）-CSDN博客 本章重点 1.使用堆来完成堆排序 2.使用堆解决TopK问题 目录 一.堆排序 1.1 思路 1.2 代码 1.3 简单测试 二.TopK问题 2.1 思路(求最小)： 2.2 C语言代码（手写堆） 2.3 C++代码（使用优先级队列 priority_queue）
阅读更多...
【C++高阶】C++类型转换全攻略：深入理解并高效应用

【C++高阶】C++类型转换全攻略：深入理解并高效应用

📝个人主页🌹：Eternity._ ⏩收录专栏⏪：C++ “ 登神长阶 ” 🤡往期回顾🤡：C++ 智能指针 🌹🌹期待您的关注 🌹🌹 ❀C++的类型转换 📒1. C语言中的类型转换📚2. C++强制类型转换⛰️static_cast🌞reinterpret_cast⭐const_cast🍁dynamic_cast 📜3. C++强制类型转换的原因📝
阅读更多...
【Linux 从基础到进阶】Ansible自动化运维工具使用

【Linux 从基础到进阶】Ansible自动化运维工具使用

Ansible自动化运维工具使用 Ansible 是一款开源的自动化运维工具，采用无代理架构（agentless），基于 SSH 连接进行管理，具有简单易用、灵活强大、可扩展性高等特点。它广泛用于服务器管理、应用部署、配置管理等任务。本文将介绍 Ansible 的安装、基本使用方法及一些实际运维场景中的应用，旨在帮助运维人员快速上手并熟练运用 Ansible。 1. Ansible的核心概念
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2