TeamCity supports JaCoCo, a Java Code Coverage tool allowing you to measure a wide set of coverage metrics and code complexity.
TeamCity is bundled with the following versions of JaCoCo: 0.7.5 (default), 0.8.2, and 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.
Classfile directories or jars
Newline-delimited set of path patterns in the form of
Classes to instrument
Newline-delimited set of classname patterns in the form of
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 will use the default JaCoCo version to parse the imported data. Note that if the imported coverage was generated by a different minor version (the second digit in X.X.X), TeamCity won't be able to process its classfiles and collect the coverage. To prevent this, make sure that the default version selected in Administration | Tools | JaCoCo Coverage corresponds to the tool version of the coverage you want to import.
Alternatively, you can specify the required tool version directly in the service message body:
##teamcity[jacocoReport dataPath='coverage_data/jacoco.exec' includes='*' classpath='+:build/classes/java/main/**' toolVersion='X.X.X']. Make sure that the specified version is installed on the TeamCity server.
Space-delimited set of paths relative to the checkout directory to read the jacoco data file
Space-delimited set of classname include patterns
Space-delimited set of classname exclude patterns
Space-delimited set of paths relative to the checkout directory to read sources from. Does not need to be listed by default.
Space-delimited set of path patterns in the form of
Path to the directory to store temporary files. The report will be generated as coverage
A random directory under Agent's temp directory
An example of a complete service message: