您可以使用 IntelliJ 原生导入器Eclipse Buildship 在 IDE 中打开此示例。

此示例展示了如何使用 JaCoCo 在多个 Java 子项目中聚合代码覆盖率。当应用于分发项目(例如 Android 应用程序或 WAR 子项目)时,jacoco-report-aggregation 插件 提供了此功能。

此示例中的项目包含三个项目:applicationlistutilities。所有三个项目都应用了 jacoco 插件,application 在其实现配置中同时使用 listutilitiesapplication 子项目是此软件项目的最终分发,并应用 jacoco-report-aggregation 来执行代码覆盖率聚合。

测试报告聚合插件目前不适用于 com.android.application 插件。
application/build.gradle.kts
plugins {
    id("myproject.java-conventions")
    application
    id("jacoco-report-aggregation") (1)
}

dependencies {
    implementation(project(":list"))
    implementation(project(":utilities"))
}

application {
    mainClass = "org.gradle.sample.Main"
}

tasks.check {
    dependsOn(tasks.named<JacocoReport>("testCodeCoverageReport")) (2)
}
application/build.gradle
plugins {
    id 'myproject.java-conventions'
    id 'application'
    id 'jacoco-report-aggregation' (1)
}

dependencies {
    implementation project(':list')
    implementation project(':utilities')
}

application {
    mainClass = 'org.gradle.sample.Main'
}

tasks.named('check') {
    dependsOn tasks.named('testCodeCoverageReport', JacocoReport) (2)
}

如果存在 jvm-test-suite 插件,application 项目不需要额外的配置。

1 应用 jacoco-report-aggregation 插件
2 可选:将 JaCoCo 聚合报告生成作为 'check' 生命周期阶段的一部分

报告聚合逻辑不会自动检查所有子项目以获取要聚合的覆盖率数据。相反,将选择分发项目的运行时类路径的直接和传递 项目依赖项 以进行潜在的聚合。

对于名为 'test' 的默认测试套件,无需额外配置。基于 application 项目中存在的测试套件,会合成聚合报告及其类型为 JacocoReport 的支持任务。具有相同 testType 属性的测试套件将被聚合。

运行测试并生成报告

$ ./gradlew testCodeCoverageReport

BUILD SUCCESSFUL
25 actionable tasks: 25 executed

现在可以在 application/build/reports/jacoco/testCodeCoverageReport 下找到 XML 和 HTML 报告。

有关更多信息,请参阅 Java 项目测试章节