Cobertura覆盖率报告未在GitLab MR差异中显示的问题

核心问题分析 #

你遇到的问题是：GitLab自托管14.9.5-ee中，Cobertura总覆盖率能正常显示，但MR差异里没有文件级覆盖率数据，且coverage_reports.json返回空的文件列表。结合你的配置和环境，以下是针对性的解决方案：

1. 确保Coverage报告的文件路径与GitLab仓库路径匹配 #

GitLab无法关联覆盖率数据的最常见原因是coverage.xml中的文件路径与仓库内的相对路径不匹配（比如使用了绝对路径、错误的相对前缀）。

解决操作：

• 修改tox.ini中coverage run命令，添加--source参数指定源码根目录（假设你的源码在仓库根目录）：

  commands =
    coverage run --source=./ -m pytest -s -vv -x --junitxml=public/test-report.xml tests/
    coverage report
    coverage html
    coverage xml
  

• 重新生成报告后，检查coverage.xml中的文件路径，确保是类似src/your_module.py的相对路径，而非绝对路径（比如/home/user/project/src/your_module.py）。

2. 适配GitLab 14.9对Cobertura格式的要求 #

GitLab 14.9对Cobertura报告的格式有严格要求，而Python2.7对应的旧版Coverage.py可能生成的报告格式不完全兼容。

解决操作：

• 升级Coverage.py到支持Python2.7的最新稳定版本（4.5.4是支持Python2.7的最后一个大版本），修改tox.ini的依赖：

  deps =
    coverage==4.5.4
  

• 检查coverage.xml的结构，确保每个<file>节点包含line-rate、lines-covered、lines-valid等统计字段，且<line>标签带有hits属性（表示该行被执行的次数）。

3. 确认新增文件被Coverage正确追踪 #

你提到coverage.xml包含MR差异的2个文件但无覆盖率信息，可能是这些文件未被Coverage追踪到：

• 检查coverage report的输出，确认这两个文件是否出现在报告列表中，如果没有，说明Coverage未统计到它们的执行数据（比如测试用例未覆盖这些代码，或者--source参数未包含这些文件的目录）。
• 若文件未被统计，调整--source参数的范围，比如--source=./src（如果源码在src目录），确保包含所有需要统计的文件。

4. 验证GitLab CI报告配置的正确性 #

虽然你已确认报告文件存在，但可以再检查：

• 确保.gitlab-ci.yml中reports: cobertura的路径是Job工作目录的相对路径，你的配置public/coverage/coverage.xml是正确的，但可以确认tox执行时的工作目录是否在仓库根目录。
• 进入Job的工件页面，下载coverage.xml并手动检查，确认其中包含MR差异文件的覆盖率数据（而非仅文件路径）。

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