JaCoCo

TeamCity supports JaCoCo, a Java Code Coverage tool allowing you to measure a wide set of coverage metrics and code complexity.

JaCoCo is available for the following build runners: Ant, IntelliJ IDEA Project, Gradle, and Maven.

TeamCity 2020.1 offers three bundled versions of JaCoCo:

0.7.5 (default)
0.8.2
0.8.4

Enabling JaCoco coverage

TeamCity supports the Java agent coverage mode allowing you to collect coverage without modifying build scripts or binaries. No additional build steps needed - just choose JaCoCo coverage in a build step which runs tests:

In the Code Coverage section, select JaCoCo as a coverage tool in the Choose coverage runner drop-down menu.
Set up the coverage options - refer to the description of the available options below.

Option	Description	Example
Classfile directories or jars	Newline-delimited set of path patterns in the form of `+\|-:[path]` relative to the checkout directory to scan for classfiles to be analyzed. Libraries and test classfiles don't have to be listed unless their coverage is wanted. Here, the pipe symbol `\|` represents the OR command, as in regular expressions: use `+` for including, OR `-` for excluding.	`+:target/main/java/**`
Classes to instrument	Newline-delimited set of classname patterns in the form of `+\|-:[path]`. Allows filtering out unwanted classes listed in "Classfile directories or jars" field. Useful in case test classes are compiled.	`+:com.package.core.` `-:com.package.Test*`

Option

Description

Example

Classfile directories or jars

Newline-delimited set of path patterns in the form of +|-:[path] relative to the checkout directory to scan for classfiles to be analyzed. Libraries and test classfiles don't have to be listed unless their coverage is wanted.

+:target/main/java/**

Classes to instrument

Newline-delimited set of classname patterns in the form of +|-:[path]. Allows filtering out unwanted classes listed in "Classfile directories or jars" field. Useful in case test classes are compiled.

+:com.package.core.*

-:com.package.*Test*

The code coverage results can be viewed on the Overview tab of the Build Results page; detailed report is displayed on the dedicated Code Coverage tab.

Importing JaCoCo coverage data to TeamCity

TeamCity can parse JaCoCo coverage data and generate a report using a service message of the following format:

##teamcity[jacocoReport dataPath='<path to jacoco.exec file>']

Attribute name	Description	Default value	Example
dataPath	Space-delimited set of paths relative to the checkout directory to read the jacoco data file		`jacocoResults/jacoco.exec jacocoResults/anotherJacocoRun.exec`
includes	Space-delimited set of classname include patterns	`*`	`com.package.core.* com.package.api.*`
excludes	Space-delimited set of classname exclude patterns		`com.package.test.* .*Test`
sources	Space-delimited set of paths relative to the checkout directory to read sources from. Does not need to be listed by default.	`.`	`src`
classpath	Space-delimited set of path patterns in the form of `+\|-:[path]` to scan for classfiles to be analyzed. Libraries and test classfiles do not need to be listed unless their coverage is wanted.	`+:*/`	`+:target/main/java/**`
reportDir	Path to the directory to store temporary files. The report will be generated as coverage `.zip` under this directory. Check that there is no existing directory with the same name.	A random directory under Agent's temp directory	jacocoReport

An example of a complete service message:

##teamcity[jacocoReport dataPath='jacoco.exec' includes='com.package.core.*' classpath='classes/lib/some.jar' reportDir='temp/jacocoReport']

Last modified: 05 March 2021