Chapter 61. The JaCoCo Plugin

Table of Contents

61.1. Getting Started
61.2. Configuring the JaCoCo Plugin
61.3. JaCoCo Report configuration
61.4. JaCoCo specific task configuration
61.5. Tasks
61.6. Dependency management

The JaCoCo plugin is currently incubating. Please be aware that the DSL and other configuration may change in later Gradle versions.

The JaCoCo plugin provides code coverage metrics for Java code via integration with JaCoCo.

61.1. Getting Started

To get started, apply the JaCoCo plugin to the project you want to calculate code coverage for.

Example 61.1. Applying the JaCoCo plugin

build.gradle

apply plugin: "jacoco"

If the Java plugin is also applied to your project, a new task named jacocoTestReport is created that depends on the test task. The report is available at $buildDir/reports/jacoco/test. By default, a HTML report is generated.

61.2. Configuring the JaCoCo Plugin

The JaCoCo plugin adds a project extension named jacoco of type JacocoPluginExtension, which allows configuring defaults for JaCoCo usage in your build.

Example 61.2. Configuring JaCoCo plugin settings

build.gradle

jacoco {
    toolVersion = "0.7.6.201602180812"
    reportsDir = file("$buildDir/customJacocoReportDir")
}

Table 61.1. Gradle defaults for JaCoCo properties

Property	Gradle default
reportsDir	“`$buildDir`/reports/jacoco”

61.3. JaCoCo Report configuration

The JacocoReport task can be used to generate code coverage reports in different formats. It implements the standard Gradle type Reporting and exposes a report container of type JacocoReportsContainer.

Example 61.3. Configuring test task

build.gradle

jacocoTestReport {
    reports {
        xml.enabled false
        csv.enabled false
        html.destination "${buildDir}/jacocoHtml"
    }
}

61.4. JaCoCo specific task configuration

The JaCoCo plugin adds a JacocoTaskExtension extension to all tasks of type Test. This extension allows the configuration of the JaCoCo specific properties of the test task.

Example 61.4. Configuring test task

build.gradle

test {
    jacoco {
        append = false
        destinationFile = file("$buildDir/jacoco/jacocoTest.exec")
        classDumpFile = file("$buildDir/jacoco/classpathdumps")
    }
}

Table 61.2. Default values of the JaCoCo Task extension

Property	Gradle default
enabled	true
destPath	`$buildDir`/jacoco
append	true
includes	[]
excludes	[]
excludeClassLoaders	[]
includeNoLocationClasses	false
sessionId	`auto-generated`
dumpOnExit	`true`
output	`Output.FILE`
address	`-`
port	`-`
classDumpPath	`-`
jmx	`false`

While all tasks of type Test are automatically enhanced to provide coverage information when the java plugin has been applied, any task that implements JavaForkOptions can be enhanced by the JaCoCo plugin. That is, any task that forks Java processes can be used to generate coverage information.

For example you can configure your build to generate code coverage using the application plugin.

Example 61.5. Using application plugin to generate code coverage data

build.gradle

apply plugin: "application"
apply plugin: "jacoco"

mainClassName = "org.gradle.MyMain"

jacoco {
    applyTo run
}

task applicationCodeCoverageReport(type:JacocoReport){
    executionData run
    sourceSets sourceSets.main
}

Note: The code for this example can be found at samples/testing/jacoco/application in the ‘-all’ distribution of Gradle.

Example 61.6. Coverage reports generated by applicationCodeCoverageReport

Build layout

application/
  build/
    jacoco/
      run.exec
    reports/jacoco/applicationCodeCoverageReport/html/
      index.html

61.5. Tasks

For projects that also apply the Java Plugin, The JaCoCo plugin automatically adds the following tasks:

Table 61.3. JaCoCo plugin - tasks

Task name	Depends on	Type	Description
`jacocoTestReport`	-	`JacocoReport`	Generates code coverage report for the test task.

61.6. Dependency management

The JaCoCo plugin adds the following dependency configurations:

Table 61.4. JaCoCo plugin - dependency configurations

Name	Meaning
`jacocoAnt`	The JaCoCo Ant library used for running the `JacocoReport` and `JacocoMerge` tasks.
`jacocoAgent`	The JaCoCo agent library used for instrumenting the code under test.