如何在GitHub Action中合并Python多模块项目的coverage.xml报告

问题背景 #

当前GitHub Actions工作流中，每次单独执行app_layer、core、model模块的pytest命令时，coverage.xml文件会被重复覆盖，最终只能保留最后一个模块的覆盖率数据，无法生成三个模块的合并报告。

解决方案 #

方案1：一次性运行所有模块测试（推荐） #

直接合并三个模块的测试命令，一次生成合并覆盖率报告，避免多次覆盖文件。修改Run tests步骤的命令如下：

- name: Run tests
  run: |
    LOG_FILE=compute.log pytest \
      --junitxml=pytest.xml \
      -v \
      app_layer/tests/ core/tests/ model/tests/ \
      --cov-report json \
      --cov='app_layer/src' \
      --cov='core/src' \
      --cov='model/src' \
      --cov-report "xml:coverage.xml" \
      --cov-branch
    echo "Tests complete"

方案2：分模块运行并追加覆盖率数据 #

如果需要分模块单独运行测试，可使用--cov-append参数让pytest-cov将每次的覆盖率数据追加到统计中，而不是覆盖。同时先生成临时覆盖率文件，最后合并生成最终报告：

- name: Run tests
  run: |
    # 运行app_layer测试并生成临时覆盖率数据
    pytest --junitxml=pytest-app.xml -v app_layer/tests/ --cov='app_layer/src' --cov-append --cov-report=json:cov-app.json --cov-branch
    # 运行core测试并追加覆盖率数据
    pytest --junitxml=pytest-core.xml -v core/tests/ --cov='core/src' --cov-append --cov-report=json:cov-core.json --cov-branch
    # 运行model测试并追加覆盖率数据
    pytest --junitxml=pytest-model.xml -v model/tests/ --cov='model/src' --cov-append --cov-report=json:cov-model.json --cov-branch
    
    # 合并JUnit XML（可选，生成统一测试报告）
    python -c "import xml.etree.ElementTree as ET; root = ET.Element('testsuites'); for f in ['pytest-app.xml', 'pytest-core.xml', 'pytest-model.xml']: tree = ET.parse(f); root.append(tree.getroot()[0]); ET.ElementTree(root).write('pytest.xml')"
    
    # 生成最终合并的coverage.xml
    coverage xml -i -o coverage.xml
    echo "Tests complete"

额外优化建议 #

• 依赖安装优化：将所有依赖整理到requirements.txt文件中，替换步骤中逐个安装的命令，提升可读性和维护性。
• 临时文件清理：在生成最终报告后，可添加命令删除临时的覆盖率和JUnit文件，避免冗余文件上传。

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