如何用Python合并多包测试覆盖率XML报告？解决合并报错问题

方案一：修正coverage combine流程生成合并XML #

你之前遇到的解析错误，大概率是因为各个.coverage文件生成时的工作目录不一致，导致合并后的文件中记录的源文件路径无法被正确解析，或者文件本身损坏。可以通过统一工作目录并指定独立的覆盖率数据文件来解决：

1. 重新执行测试，生成独立的覆盖率数据文件
   在项目根目录main_dir下，执行每个包的测试时，通过--cov-data-file参数指定不同的覆盖率数据文件名，避免覆盖：

   # 测试package_1
   python -m pytest package_1/tests --junitxml package_1/test_result.xml --cov package_1 --cov-branch --cov-report xml:package_1/test_coverage.xml --cov-data-file .coverage.package1
   
   # 测试package_2
   python -m pytest package_2/tests --junitxml package_2/test_result.xml --cov package_2 --cov-branch --cov-report xml:package_2/test_coverage.xml --cov-data-file .coverage.package2
   
   # 测试package_3
   python -m pytest package_3/tests --junitxml package_3/test_result.xml --cov package_3 --cov-branch --cov-report xml:package_3/test_coverage.xml --cov-data-file .coverage.package3
   

2. 合并覆盖率数据并生成XML
   同样在main_dir下执行：

   # 合并所有独立的覆盖率数据文件
   coverage combine .coverage.package1 .coverage.package2 .coverage.package3
   
   # 生成合并后的XML文件
   coverage xml -o combined_coverage.xml
   

方案二：直接合并已生成的XML文件 #

如果不想依赖coverage combine，可以直接合并各个包生成的test_coverage.xml文件。以下是一个简单的Python脚本，用于合并标准格式的覆盖率XML：

import xml.etree.ElementTree as ET
from collections import defaultdict

def merge_coverage_xmls(xml_paths, output_path):
    # 初始化合并后的根节点
    merged_root = ET.Element("coverage")
    total_stats = defaultdict(int)

    for xml_path in xml_paths:
        tree = ET.parse(xml_path)
        root = tree.getroot()

        # 累加全局统计数据
        for stat_key in ['lines-covered', 'lines-valid', 'branch-covered', 'branch-valid', 'complexity']:
            if stat_key in root.attrib:
                total_stats[stat_key] += int(root.attrib[stat_key])

        # 将当前XML中的所有package节点复制到合并后的根节点
        for package_node in root.findall("package"):
            merged_root.append(package_node)

    # 更新合并后的全局统计属性
    for key, value in total_stats.items():
        merged_root.set(key, str(value))

    # 计算并设置覆盖率
    if total_stats['lines-valid'] > 0:
        merged_root.set('line-rate', str(round(total_stats['lines-covered'] / total_stats['lines-valid'], 4)))
    if total_stats['branch-valid'] > 0:
        merged_root.set('branch-rate', str(round(total_stats['branch-covered'] / total_stats['branch-valid'], 4)))

    # 写入合并后的XML文件
    ET.ElementTree(merged_root).write(output_path, encoding='utf-8', xml_declaration=True)

# 调用示例，替换为你的实际文件路径
merge_coverage_xmls(
    ["package_1/test_coverage.xml", "package_2/test_coverage.xml", "package_3/test_coverage.xml"],
    "combined_coverage.xml"
)

使用方法：

• 将脚本保存为merge_coverage.py，放在main_dir下
• 执行python merge_coverage.py，即可生成合并后的combined_coverage.xml

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