如何使用JaCoCo统计每个单元/API测试用例覆盖的方法及代码行

要拿到单个测试用例独立覆盖的方法、代码行范围，核心思路是拆分每个用例的覆盖率采集生命周期，避免所有用例共享同一份采集计数，不要直接跑完全量用例再统一导出覆盖率，那样只能拿到合并后的整体结果。

单元测试场景落地 #

• Java技术栈（以JUnit+JaCoCo为例）
  1. 测试启动时挂载JaCoCo agent，关闭默认的全量采集、执行结束自动dump配置
  2. 自定义测试执行监听器，绑定@Test方法的生命周期钩子：每个用例执行前调用JaCoCo的reset接口清空已采集的探针数据，标记采集启动；单个用例执行完成后立刻触发dump，将当前探针数据按「测试类名#方法名」的命名规则单独存储为独立的.exec文件，避免不同用例的数据互相覆盖
  3. 所有用例执行完成后，调用JaCoCo的解析API逐个读取单份.exec文件，关联源码的行号、方法元数据，就能直接输出每个用例独立覆盖的方法列表、代码行区间
• Python技术栈（以pytest+coverage.py为例）
  直接通过coverage.py的原生API，结合pytest的fixture控制采集周期即可，参考实现：

  import coverage
  import os
  
  # 测试会话开始前创建单独存单用例覆盖率的目录
  def pytest_configure(config):
      os.makedirs("./single_test_cov", exist_ok=True)
  
  # 单个用例启动前初始化覆盖率采集器
  def pytest_runtest_setup(item):
      item.cov_collector = coverage.Coverage()
      item.cov_collector.start()
  
  # 单个用例执行完停止采集，按用例名单独存结果
  def pytest_runtest_teardown(item):
      item.cov_collector.stop()
      item.cov_collector.save(f"./single_test_cov/{item.name}.cov")
  

  后续直接调用coverage的分析接口读取每份.cov文件，即可拿到对应用例覆盖的行号、命中方法信息。

API测试场景落地 #

API测试属于跨进程调用，需要在被测服务侧加简单的采集控制逻辑：

1. 被测服务启动时挂载对应技术栈的覆盖率探针，额外开放两个无鉴权的内部临时接口：一个用于重置当前服务的探针采集计数，一个用于触发探针数据dump并返回原始采集结果
2. 编排API用例执行逻辑：每个用例发起请求前，先调用重置接口清空历史采集数据；再发送当前用例的API请求，等待所有同步、异步逻辑执行完成后，调用dump接口拉取当前的覆盖率原始数据，按用例名单独存储
3. 后续解析逻辑和单元测试场景一致，关联源码元数据即可输出单API用例的覆盖范围。

常见注意事项 #

• 采集单用例覆盖率时不要开启测试并行执行，同一时间节点只能运行一个用例，否则不同用例的探针数据会发生串扰，导致结果不准
• 每次采集完单个用例的数据必须重置探针计数器，否则上一个用例命中的代码行会被重复统计到后续执行的用例结果中
• 服务启动阶段执行的静态代码块、全局初始化逻辑，默认会被第一个执行的用例统计到，如果需要拆分这部分覆盖数据，可以在所有用例执行前先dump一次初始化阶段的覆盖率，后续每个用例的结果和初始化结果做差集排除即可
• 如果需要统计方法维度的覆盖情况，提前解析源码生成每个方法的行号区间映射，将探针命中的行号和方法区间做匹配，就能关联到每个用例覆盖的具体方法。

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