JaCoCo 报告聚合插件 (插件 ID: jacoco-report-aggregation) 提供了将多个 JaCoCo 代码覆盖率报告(可能跨越多个 Gradle 项目)的结果聚合到单个 HTML 报告中的能力。覆盖率报告背后的二进制数据由 Test task 调用产生;更多信息请参见 JaCoCo 插件 章节。

用法

要使用 JaCoCo 报告聚合插件,请在你的构建脚本中包含以下内容

plugins {
    id 'jacoco-report-aggregation'
}
plugins {
    id("jacoco-report-aggregation")
}

请注意,除非与 JVM Test Suite 插件 结合使用,否则此插件不会执行任何操作。Java 插件 会自动应用 JVM Test Suite 插件。

现在有两种方法可以跨多个子项目收集代码覆盖率结果

  1. 从发行版的项目,例如应用程序或 WAR 子项目 → distribution 示例

  2. 使用独立的项目来指定子项目 → standalone 示例

示例 2 也可用于通过根项目聚合结果。

JaCoCo 报告聚合插件目前不适用于 com.android.application 插件。

Tasks

当项目也应用了 jvm-test-suite 插件时,将为每个测试套件添加以下 tasks

testSuiteCodeCoverageReportJacocoReport

依赖于:匹配以下属性的变体的工件

通过 jacocoAggregation 配置收集直接和传递项目依赖项的变体。将匹配以下属性

    - org.gradle.category         = verification     (1)
    - org.gradle.testsuite.name   = test             (2)
    - org.gradle.verificationtype = jacoco-results   (3)
1 Category attribute;值是固定的。
2 TestSuiteName attribute;值派生自 TestSuite#getName()
3 VerificationType attribute;值是固定的。

有关使用 JaCoCo 执行测试生成的变体的更多信息,请参见 JaCoCo 插件文档的 Outgoing Variants 部分。

报告

默认情况下,当任何 task 失败时(包括测试失败),Gradle 都会停止执行 tasks。为了确保你的构建始终生成聚合报告,请在 Gradle 命令中指定 --continue 选项。有关更多信息,请参见 在发生故障时继续构建

自动报告创建

当项目也应用了 jvm-test-suite 插件时,将为每个测试套件添加以下报告对象

testSuiteCodeCoverageReportJacocoCoverageReport

创建一个聚合 Jacoco 报告,聚合所有项目依赖项中具有给定 name 的所有测试套件。

手动报告创建

当项目未应用 jvm-test-suite 插件时,你必须手动注册一个或多个报告

build.gradle.kts
reporting {
    reports {
        val testCodeCoverageReport by creating(JacocoCoverageReport::class) { (1)
            testSuiteName = "test"
        }
    }
}
build.gradle
reporting {
    reports {
        testCodeCoverageReport(JacocoCoverageReport) { (1)
            testSuiteName = "test"
        }
    }
}
1 创建一个名为 testCodeCoverageReportJacocoCoverageReport 类型的报告,聚合来自所有项目依赖项的所有测试套件,这些测试套件具有给定的 TestSuite#getName()

报告创建会自动创建后备 tasks,以聚合给定测试套件类型值的覆盖率结果。

依赖管理

JaCoCo 报告聚合插件添加了以下依赖配置

表 1. JaCoCo 报告聚合插件 - 依赖配置
名称 含义

jacocoAggregation

用于声明要聚合的代码覆盖率数据的所有项目依赖项的配置。

aggregateCodeCoverageReportResults

使用 变体感知匹配jacocoAggregation 配置中使用项目依赖项,以找到合适的测试套件类型。

如果项目也应用了 jvm-test-suite 插件,则无需显式地向 jacocoAggregation 配置添加依赖项。