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

最新推荐文章于 2024-07-24 21:43:47 发布

行动π技术博客

最新推荐文章于 2024-07-24 21:43:47 发布

阅读量2k

点赞数 23

文章标签： c++ 单元测试测试覆盖率

本文链接：https://blog.csdn.net/shippingxing/article/details/139262592

版权

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的步骤：

编译源代码: 使用-fprofile-arcs和-ftest-coverage选项编译你的源代码。例如，如果你有一个名为example.c的源文件，你可以使用以下命令来编译它：
```
gcc -fprofile-arcs -ftest-coverage -o example example.c
```
运行程序: 运行编译后的程序，这将生成.gcda文件，记录程序的执行信息。
生成覆盖率报告: 使用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的基本步骤：

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

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

2.4 lcov的输出

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

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

2.4.1 示例

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

编译源代码:

gcc -fprofile-arcs -ftest-coverage -o example example.c

运行程序:
```
./example
```

收集覆盖率数据:

lcov --capture --directory . --output-file coverage.info

生成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的基本步骤：

编译源代码: 使用gcov支持的编译选项编译源代码。
```
gcc -fprofile-arcs -ftest-coverage -o my_program my_program.c
```
运行程序: 执行编译后的程序以生成.gcda和.gcno文件。
```
./my_program
```

收集覆盖率数据: 使用lcov收集覆盖率数据。

lcov --capture --directory . --output-file coverage.info

生成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等）都支持自定义脚本，可以添加以下步骤：

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

3.3.2 示例

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

name: Code Coverage

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2

    - name: Set up GCC
      run: sudo apt-get install gcc

    - name: Compile with Coverage
      run: gcc -fprofile-arcs -ftest-coverage -o my_program my_program.c

    - name: Run Program
      run: ./my_program

    - name: Collect Coverage Data
      run: lcov --capture --directory . --output-file coverage.info

    - name: Generate HTML Report
      run: genhtml coverage.info --output-directory coverage_report

    - name: Upload Coverage Report
      uses: actions/upload-artifact@v2
      with:
        name: Code Coverage Report
        path: coverage_report

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

3.4 可视化覆盖率

3.4.1 覆盖率徽章

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

4. 场景问题及解决方案

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

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

解决方案：

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

示例脚本：

# 假设我们发现函数 `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 场景二：覆盖率报告过大，难以管理

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

解决方案：

使用lcov的排除功能：通过.lcovrc配置文件排除不必要的目录或文件。
模块化覆盖率报告：为不同的模块生成单独的覆盖率报告。
使用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流程中，新提交的代码导致整体覆盖率下降。

解决方案：

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

示例脚本（GitHub Actions）：

name: Code Coverage Check

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2

    - name: Set up GCC
      run: sudo apt-get install gcc

    - name: Compile with Coverage
      run: gcc -fprofile-arcs -ftest-coverage -o my_program my_program.c

    - name: Run Program
      run: ./my_program

    - name: Collect Coverage Data
      run: lcov --capture --directory . --output-file coverage.info

    - name: Check Coverage Rate
      run: |
        current_coverage=$(genhtml -e coverage.info)
        base_coverage=$(grep -oP 'Overall coverage' base_coverage.info | grep -oP '\d+')
        if [ "$current_coverage" -lt "$base_coverage" ]; then
          echo "Coverage rate has decreased!"
          exit 1
        fi

    - name: Generate HTML Report
      run: genhtml coverage.info --output-directory coverage_report

    - name: Upload Coverage Report
      uses: actions/upload-artifact@v2
      with:
        name: Code Coverage Report
        path: coverage_report

行动π技术博客

关注

23
点赞
踩
32

收藏

觉得还不错? 一键收藏
打赏
0
评论
C++单元测试覆盖率统计工具：GCOV+LCOV

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

扫一扫