JaCoCo 插件通过与 JaCoCo 集成,为 Java 代码提供代码覆盖率指标。
入门
要开始使用,请将 JaCoCo 插件应用于您要计算代码覆盖率的项目。
plugins {
jacoco
}
plugins {
id 'jacoco'
}
如果 Java 插件也应用于您的项目,则会创建一个名为 jacocoTestReport
的新 Task。默认情况下,HTML 报告生成在 layout.buildDirectory.dir("reports/jacoco/test")
。
虽然测试应在报告生成之前执行,但 jacocoTestReport Task 不依赖于 test Task。 |
根据您的用例,您可能希望始终生成 jacocoTestReport
或在显式生成报告之前运行 test
Task。
tasks.test {
finalizedBy(tasks.jacocoTestReport) // report is always generated after tests run
}
tasks.jacocoTestReport {
dependsOn(tasks.test) // tests are required to run before generating the report
}
test {
finalizedBy jacocoTestReport // report is always generated after tests run
}
jacocoTestReport {
dependsOn test // tests are required to run before generating the report
}
配置 JaCoCo 插件
JaCoCo 插件添加了一个名为 jacoco
的项目扩展,类型为 JacocoPluginExtension,允许配置 JaCoCo 在构建中使用的默认设置。
jacoco {
toolVersion = "0.8.12"
reportsDirectory = layout.buildDirectory.dir("customJacocoReportDir")
}
jacoco {
toolVersion = "0.8.12"
reportsDirectory = layout.buildDirectory.dir('customJacocoReportDir')
}
属性 | Gradle 默认值 |
---|---|
reportsDirectory |
|
JaCoCo 报告配置
JacocoReport Task 可用于生成不同格式的代码覆盖率报告。它实现了标准的 Gradle 类型 Reporting 并公开了类型为 JacocoReportsContainer 的报告容器。
tasks.jacocoTestReport {
reports {
xml.required = false
csv.required = false
html.outputLocation = layout.buildDirectory.dir("jacocoHtml")
}
}
jacocoTestReport {
reports {
xml.required = false
csv.required = false
html.outputLocation = layout.buildDirectory.dir('jacocoHtml')
}
}

强制代码覆盖率指标
此功能需要使用 JaCoCo 0.6.3 或更高版本。 |
JacocoCoverageVerification Task 可用于验证是否满足基于配置规则的代码覆盖率指标。其 API 公开了方法 JacocoCoverageVerification.violationRules(org.gradle.api.Action),该方法用作配置规则的主要入口点。调用这些方法中的任何一个都会返回 JacocoViolationRulesContainer 的实例,提供广泛的配置选项。如果任何配置的规则未满足,构建将失败。JaCoCo 仅报告第一个违反的规则。
代码覆盖率要求可以为整个项目、单个文件以及特定的 JaCoCo 特定覆盖类型(例如,覆盖的行或覆盖的分支)指定。以下示例描述了语法。
tasks.jacocoTestCoverageVerification {
violationRules {
rule {
limit {
minimum = "0.5".toBigDecimal()
}
}
rule {
isEnabled = false
element = "CLASS"
includes = listOf("org.gradle.*")
limit {
counter = "LINE"
value = "TOTALCOUNT"
maximum = "0.3".toBigDecimal()
}
}
}
}
jacocoTestCoverageVerification {
violationRules {
rule {
limit {
minimum = 0.5
}
}
rule {
enabled = false
element = 'CLASS'
includes = ['org.gradle.*']
limit {
counter = 'LINE'
value = 'TOTALCOUNT'
maximum = 0.3
}
}
}
}
JacocoCoverageVerification Task 不是 Java 插件提供的 check
Task 的 Task 依赖项。这样做是有充分理由的。该 Task 目前不是增量的,因为它没有声明任何输出。当执行 check
Task 时,任何违反声明规则的行为都会自动导致构建失败。这种行为可能并非所有用户都希望如此。未来版本的 Gradle 可能会更改此行为。
JaCoCo 特定任务配置
JaCoCo 插件将 JacocoTaskExtension 扩展添加到 Test 类型的所有 Task。此扩展允许配置 test Task 的 JaCoCo 特定属性。
tasks.test {
extensions.configure(JacocoTaskExtension::class) {
destinationFile = layout.buildDirectory.file("jacoco/jacocoTest.exec").get().asFile
classDumpDir = layout.buildDirectory.dir("jacoco/classpathdumps").get().asFile
}
}
test {
jacoco {
destinationFile = layout.buildDirectory.file('jacoco/jacocoTest.exec').get().asFile
classDumpDir = layout.buildDirectory.dir('jacoco/classpathdumps').get().asFile
}
}
配置为使用 JaCoCo Agent 运行的 Task 在 Task 开始执行时删除执行数据的目标文件。这确保执行数据中不存在过时的覆盖率数据。 |
JaCoCo Task 扩展的默认值
tasks.test {
configure<JacocoTaskExtension> {
isEnabled = true
destinationFile = layout.buildDirectory.file("jacoco/${name}.exec").get().asFile
includes = emptyList()
excludes = emptyList()
excludeClassLoaders = emptyList()
isIncludeNoLocationClasses = false
sessionId = "<auto-generated value>"
isDumpOnExit = true
classDumpDir = null
output = JacocoTaskExtension.Output.FILE
address = "localhost"
port = 6300
isJmx = false
}
}
test {
jacoco {
enabled = true
destinationFile = layout.buildDirectory.file("jacoco/${name}.exec").get().asFile
includes = []
excludes = []
excludeClassLoaders = []
includeNoLocationClasses = false
sessionId = "<auto-generated value>"
dumpOnExit = true
classDumpDir = null
output = JacocoTaskExtension.Output.FILE
address = "localhost"
port = 6300
jmx = false
}
}
虽然当应用 java
插件时,Test 类型的所有 Task 都会自动增强以提供覆盖率信息,但任何实现 JavaForkOptions 的 Task 都可以通过 JaCoCo 插件进行增强。也就是说,任何 fork Java 进程的 Task 都可以用于生成覆盖率信息。
例如,您可以配置您的构建以使用 application
插件生成代码覆盖率。
plugins {
application
jacoco
}
application {
mainClass = "org.gradle.MyMain"
}
jacoco {
applyTo(tasks.run.get())
}
tasks.register<JacocoReport>("applicationCodeCoverageReport") {
executionData(tasks.run.get())
sourceSets(sourceSets.main.get())
}
plugins {
id 'application'
id 'jacoco'
}
application {
mainClass = 'org.gradle.MyMain'
}
jacoco {
applyTo run
}
tasks.register('applicationCodeCoverageReport', JacocoReport) {
executionData run
sourceSets sourceSets.main
}
. └── build ├── jacoco │ └── run.exec └── reports └── jacoco └── applicationCodeCoverageReport └── html └── index.html
Tasks
对于也应用 Java 插件的项目,JaCoCo 插件会自动添加以下 Task
jacocoTestReport
— JacocoReport-
为 test Task 生成代码覆盖率报告。
jacocoTestCoverageVerification
— JacocoCoverageVerification-
根据 test Task 的指定规则验证代码覆盖率指标。
依赖管理
JaCoCo 插件添加以下依赖配置
名称 | 含义 |
---|---|
|
用于运行 |
|
用于检测被测代码的 JaCoCo Agent 库。 |
传出变体
当生成 JaCoCo 覆盖率数据的项目与 JVM Test Suite Plugin 一起应用时,将创建额外的传出变体。这些变体旨在供 JaCoCo Report Aggregation Plugin 使用。
属性将类似于以下内容。用户可配置的属性在示例下方突出显示。
--------------------------------------------------
Variant coverageDataElementsForTest (i)
--------------------------------------------------
Binary results containing Jacoco test coverage for all targets in the 'test' Test Suite.
Capabilities
- org.gradle.sample:application:1.0.2 (default capability)
Attributes
- org.gradle.category = verification
- org.gradle.testsuite.name = test (1)
- org.gradle.verificationtype = jacoco-coverage
Artifacts
- build/jacoco/test.exec (artifactType = binary)
1 | TestSuiteName 属性;值来源于 TestSuite#getName()。 |