ReportGenerator项目中的JSON格式测试覆盖率报告解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00965/article/details/148758492

ReportGenerator项目中的JSON格式测试覆盖率报告解析

ReportGenerator ReportGenerator converts coverage reports generated by coverlet, OpenCover, dotCover, Visual Studio, NCover, Cobertura, JaCoCo, Clover, gcov or lcov into human readable reports in various formats. 项目地址: https://gitcode.com/gh_mirrors/re/ReportGenerator

什么是ReportGenerator

ReportGenerator是一个强大的代码覆盖率报告生成工具，它能够将各种测试覆盖率工具生成的原始数据转换为易于阅读和理解的形式。该工具支持多种输入格式，并能生成多种输出格式的报告，包括HTML、XML、JSON等。

JSON格式覆盖率报告详解

JSON格式的测试覆盖率报告提供了代码库测试覆盖情况的详细数据，下面我们通过一个示例报告来解析各个关键指标的含义。

报告概览部分

"summary": {
  "generatedon": "2025-02-09T17:56:57Z",
  "parser": "OpenCover",
  "assemblies": 1,
  "classes": 4,
  "files": 5,
  "coveredlines": 75,
  "uncoveredlines": 33,
  "coverablelines": 108,
  "totallines": 260,
  "linecoverage": 69.4,
  "coveredbranches": 4,
  "totalbranches": 8,
  "branchcoverage": 50,
  "coveredmethods": 16,
  "fullcoveredmethods": 9,
  "totalmethods": 24,
  "methodcoverage": 66.6,
  "fullmethodcoverage": 37.5
}

关键指标解释

行覆盖率(Line Coverage): 69.4%
- 表示被测试覆盖的代码行占总可覆盖代码行的比例
- 计算方式: 75(coveredlines)/108(coverablelines)
分支覆盖率(Branch Coverage): 50%
- 表示被测试覆盖的分支(如if-else语句)占总分支数的比例
- 计算方式: 4(coveredbranches)/8(totalbranches)
方法覆盖率(Method Coverage): 66.6%
- 表示被测试覆盖的方法占总方法数的比例
- 计算方式: 16(coveredmethods)/24(totalmethods)
完整方法覆盖率(Full Method Coverage): 37.5%
- 表示被完全测试覆盖的方法占总方法数的比例
- 计算方式: 9(fullcoveredmethods)/24(totalmethods)

详细覆盖率数据

报告还提供了按程序集(assembly)和类(class)细分的覆盖率数据：

"coverage": {
  "assemblies": [
    { 
      "name": "Sample", 
      "classes": 4, 
      "coverage": 69.4,
      ...
      "classesinassembly": [
        { "name": "Sample.PartialClass", "coverage": 54.5, ... },
        { "name": "Test.Program", "coverage": 100, ... },
        { "name": "Test.TestClass", "coverage": 72.7, ... },
        { "name": "Test.TestClass2", "coverage": 63.1, ... }
      ]
    }
  ]
}

程序集级别分析

整个项目包含1个程序集(Sample)
该程序集包含4个类
整体行覆盖率为69.4%

类级别分析

Sample.PartialClass
- 行覆盖率: 54.5%
- 方法覆盖率: 50%
- 完整方法覆盖率: 33.3%
- 这是项目中覆盖率最低的类，需要重点关注
Test.Program
- 行覆盖率: 100%
- 方法覆盖率: 100%
- 完整方法覆盖率: 100%
- 这是项目中唯一一个完全覆盖的类
Test.TestClass
- 行覆盖率: 72.7%
- 方法覆盖率: 80%
- 完整方法覆盖率: 20%
- 虽然方法覆盖率较高，但完整方法覆盖率较低，说明部分方法测试不充分
Test.TestClass2
- 行覆盖率: 63.1%
- 方法覆盖率: 60%
- 完整方法覆盖率: 30%
- 各项指标均低于平均水平，需要改进测试