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

此示例展示了如何使用 JaCoCo 在多个 Java 子项目中聚合代码覆盖率。 jacoco-report-aggregation 插件 通过一个独立项目提供了此功能,该项目用于指定要包含在聚合中的哪些子项目。

此示例中的项目包含三个“代码”子项目:applicationlistutilities。所有三个项目都应用了 jacoco 插件,并且 application 通过其实现配置使用 listutilities。第四个子项目 code-coverage-report 是用于收集覆盖率结果的独立实用程序项目。

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

repositories {
    mavenCentral()
}

dependencies {
    jacocoAggregation(project(":application")) (1)
}

reporting {
    reports {
        val testCodeCoverageReport by creating(JacocoCoverageReport::class) { (2)
            testType = TestSuiteType.UNIT_TEST
        }
    }
}

tasks.check {
    dependsOn(tasks.named<JacocoReport>("testCodeCoverageReport")) (3)
}
code-coverage-report/build.gradle
plugins {
    id 'base'
    id 'jacoco-report-aggregation'
}

repositories {
    mavenCentral()
}

dependencies {
    jacocoAggregation project(':application') (1)
}

reporting {
    reports {
        testCodeCoverageReport(JacocoCoverageReport) { (2)
            testType = TestSuiteType.UNIT_TEST
        }
    }
}

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

独立项目应用了 jacoco-report-aggregation,但如果 jvm-test-suite 插件也不存在,则需要额外的配置。

在这种情况下,需要进行两个额外的设置步骤。

1 使用jacocoAggregation配置声明依赖项。
2 定义一个类型为JacocoCoverageReport的报告,用于收集来自单元测试套件的覆盖率数据。
3 可选:将 JaCoCo 聚合报告生成作为“check”生命周期阶段的一部分。

报告聚合逻辑不会自动检查所有子项目以获取要聚合的覆盖率数据。相反,jacocoAggregation配置的直接和传递项目依赖项将被选中用于潜在的聚合。

用户还必须声明一个或多个类型为JacocoCoverageReport的报告。每个报告实例都指定了一个testType属性,用于匹配生成覆盖率数据的测试套件。对于每个用户定义的报告,都会合成一个JacocoReport任务,并执行聚合。调用此任务将导致在jacocoAggregation配置的依赖项目中执行测试。

运行测试并生成报告。

$ ./gradlew testCodeCoverageReport

BUILD SUCCESSFUL
25 actionable tasks: 25 executed

现在可以在code-coverage-report/build/reports/jacoco/testCodeCoverageReport下找到 XML 和 HTML 报告。

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