GitLab Runner多Job下CMake绝对路径致代码覆盖率问题求解

针对CMake生成的.gcno文件含绝对路径，导致GitLab CI多Job拆分后无法生成覆盖率报告的问题，以下是几个实用的解决思路：

1. 统一所有Job的绝对工作路径 #

在GitLab CI配置中指定固定的构建目录，让编译和测试Job使用完全相同的绝对路径，确保.gcno中记录的路径在测试环境中存在。

示例CI配置：

variables:
  FIXED_BUILD_DIR: "/opt/ci-builds/my-project"

build:
  script:
    - mkdir -p $FIXED_BUILD_DIR
    - cd $FIXED_BUILD_DIR
    - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="--coverage" $CI_PROJECT_DIR
    - make
  artifacts:
    paths:
      - $FIXED_BUILD_DIR/**/*.gcno

test:
  script:
    - cd $FIXED_BUILD_DIR
    - ./bin/test-suite
    - lcov --capture --directory . --output-file coverage.info
    - lcov --remove coverage.info '/usr/*' --output-file coverage.clean.info
    - genhtml coverage.clean.info --output-dir coverage-report
  needs: ["build"]

2. 用gcovr的路径映射参数兼容不同路径 #

gcovr支持通过参数忽略.gcno中的绝对路径前缀，只匹配相对路径部分，适合不同Runner路径不一致的场景。

测试Job中生成报告的命令示例：

# 假设编译Job的源路径是/runner-a/build，测试Job的路径是/runner-b/build
gcovr --root $CI_PROJECT_DIR --source-prefix /runner-a/build --output coverage.xml

# 或者直接使用相对路径模式
gcovr --relative-only --root $CI_PROJECT_DIR --output coverage.xml

3. 指定gcda文件的输出目录 #

通过CMake编译参数指定.gcda的输出目录，避免依赖编译时的绝对路径，同时将该目录作为artifacts传递到测试Job。

编译Job的CMake命令：

cmake -DCMAKE_BUILD_TYPE=Debug \
      -DCMAKE_CXX_FLAGS="--coverage -fprofile-dir=$CI_PROJECT_DIR/coverage-data" \
      -DCMAKE_C_FLAGS="--coverage -fprofile-dir=$CI_PROJECT_DIR/coverage-data" \
      $CI_PROJECT_DIR
make

CI配置中传递artifacts：

build:
  artifacts:
    paths:
      - coverage-data/
      - **/*.gcno

测试Job中收集报告：

./bin/test-suite
lcov --capture --directory coverage-data --output-file coverage.info

4. 使用Docker镜像统一环境 #

用自定义Docker镜像封装构建和测试环境，在镜像中固定工作目录（比如/app），确保所有Job的路径完全一致。

示例CI配置：

build:
  image: my-project-ci-image:v1
  script:
    - cd /app
    - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="--coverage" $CI_PROJECT_DIR
    - make
  artifacts:
    paths:
      - /app/**/*.gcno

test:
  image: my-project-ci-image:v1
  script:
    - cd /app
    - ./bin/test-suite
    - lcov --capture --directory . --output-file coverage.info
  needs: ["build"]

内容的提问来源于stack exchange，提问作者Charles G