JaCoCo

jacoco-plugin

Build Status Build Status Release

Jenkins Plugin GitHub release Jenkins Plugin Installs

A plugin for Jenkins to capture and visualize code coverage testing results for projects using JaCoCo for code-coverage analysis.

More information can be found on the Wiki page https://wiki.jenkins-ci.org/display/JENKINS/JaCoCo+Plugin

Available options are described at https://www.jenkins.io/doc/pipeline/steps/jacoco/

Note: Version 2.0.0 and higher requires using JaCoCo 0.7.5 or newer, if your projects still use JaCoCo 0.7.4, the plugin will not display any code-coverage numbers any more! In this case please use version 1.0.19 until you can update jacoco in your codebase.

Using as part of a pipeline via Jenkinsfile

The following is an example snippet that can be used in a Jenkinsfile

    post {
        success {
            jacoco(
                execPattern: '**/build/jacoco/*.exec',
                classPattern: '**/build/classes/java/main',
                sourcePattern: '**/src/main'
            )
        }
    }

See https://www.jenkins.io/doc/pipeline/steps/jacoco/ for the list of available options.

Looking for ways to contribute?

When looking for things to work at there are pull requests and a list of Jenkins Issues.

In general the plugin is currently in "minimal maintenance" mode, i.e. no larger development is done due to the small number of active contributors and general time constraints.

Please speak up if you are interested in helping to maintain this plugin!

Discussion list

There is a developer list at https://groups.google.com/forum/#!forum/jenkins-jacoco-plugin-mailing-list, it is usually very low volume.

Contributing to the Plugin

Plugin source code is hosted on GitHub.

New feature proposals and bug fix proposals should be submitted as GitHub pull requests.

Fork the repository on GitHub, prepare your change on your forked copy, and submit a pull request (see here for open pull requests). Your pull request will be evaluated by this job.

Before submitting your change, please assure that you've added a test which verifies your change. There have been many developers involved in the jacoco plugin and there are many, many users who depend on the jacoco-plugin. Tests help us assure that we're delivering a reliable plugin, and that we've communicated our intent to other developers in a way that they can detect when they run tests.

Code coverage reporting is available as a maven target and is actively monitored. Please try your best to improve code coverage with tests when you submit.

Before submitting your change, please review the output of the checks that run in CI at https://ci.jenkins.io/job/Plugins/job/jacoco-plugin/ to assure that you haven't introduced new warnings.

How to build and test

  • Build the plugin:

mvn package

  • Test locally (invokes a local Jenkins instance with the plugin installed):

mvn hpi:run

See https://jenkinsci.github.io/maven-hpi-plugin/ for details.

How to release a new version

Rolling a release requires you to set up a few additional things:

  • Run with Java 11 to not push code compiled with a newer version of Java

  • Github authentication should work via SSH, username used should be "git", it should use one of the local private SSH keys which should be uploaded to Github, see https://github.com/settings/keys, test via

    ssh -T git@github.com

You should get back a line containing You've successfully authenticated

See also general documentation about releasing Jenkins plugins:

Basic information

This plugin allows you to capture code coverage report from JaCoCo. Jenkins will generate the trend report of coverage and some other statistics.

It also includes functionality to include columns in Dashboards which displays the latest overall coverage numbers and links to the coverage report.

Getting Started

The plugin provides two things, a build-publisher to record and display coverage data as part of builds as well as a new column-type for dashboard views which can display coverage data in Dashboards.

Recording coverage for builds

Get coverage data as part of your build

First you need to get coverage calculated as part of your build/tests, see the JaCoCo documentation
for details. You need at least one or more *.exec file available after tests are executed. Usually this means adjusting
your Maven pom.xml or Ant build.xml file..

Set up coverage retrieval and publishing

In order to get the coverage data published to Jenkins, you need to add a JaCoCo publisher and configure it so it will
find all the necessary information. Use the help provided via the question-mark links for more information. Basically
you specify where the *.exec files are, where compiled code can be found and where the corresponding source code is
located after the build is finished to let the plugin gather all necessary pieces of information..

Run the job

After the job executed, the build-output will show that the JaCoCo-publisher is executed and collects the data. This
output can also give hints if something goes wrong at this stage:

Zeichne Testergebnisse auf.
[JaCoCo plugin] Collecting JaCoCo coverage data...
[JaCoCo plugin] build/*.exec;build/*-classes;src/java,src/*/java,src/*/src; locations are configured
[JaCoCo plugin] Number of found exec files: 5
[JaCoCo plugin] Saving matched execfiles:  .../build/jacoco-excelant.exec .../build/jacoco-main.exec .../build/jacoco-ooxml-lite.exec
[JaCoCo plugin] Saving matched class directories:  .../build/examples-classes .../build/excelant-classes .../build/excelant-test-classes
[JaCoCo plugin] Saving matched source directories:  .../src/contrib/src .../src/examples/src .../src/excelant/java .../src/java
[JaCoCo plugin] Loading inclusions files..
[JaCoCo plugin] inclusions: []
[JaCoCo plugin] exclusions: [**/Test*]
[JaCoCo plugin] Thresholds: JacocoHealthReportThresholds [minClass=0, maxClass=0, minMethod=0, maxMethod=0, minLine=0, maxLine=0,
minBranch=0, maxBranch=0, minInstruction=0, maxInstruction=0, minComplexity=0, maxComplexity=0]
[JaCoCo plugin] Publishing the results..
[JaCoCo plugin] Loading packages..
[JaCoCo plugin] Done.
Look at results

If data gathering is successful, the build will include a link to the coverage results similar to the HTML report of
JaCoCo itself. The job page will be enhanced with a chart with the trend of code coverage over the last builds.

Coverage column

This part of the JaCoCo plugin allows you to add a new type of column to a project-table in the Dashboard view which
will show the coverage number of the last build for ajob together with some color coding which allows to quickly see
projects with low coverage.

The fill-color in use by the column is a continuous color-range with the following points:

  • PERFECT = 100.0
  • EXCELLENT at 97.0
  • GOOD at 92.0
  • SUFFICIENT at 85.0
  • FAIR at 75.0
  • POOR at 50.0
  • TRAGIC at 25.0
  • ABYSSMAL at 0.0
  • NA = No coverage configured

Open Tickets (bugs and feature requests)

See the Jenkins JIRA

Build Status


Troubleshooting

  • Unfortunately JaCoCo 0.7.5 breaks compatibility to previous binary formats of the jacoco.exec files. The JaCoCo plugin up to version 1.0.19 is based on JaCoCo 0.7.4, thus you cannot use this version with projects which already use JaCoCo 0.7.5 or newer. JaCoCo plugin starting with version 2.0.0 uses JaCoCo 0.7.5 and thus requires also this version to be used in your projects. Please stick to JaCoCo plugin 1.0.19 or lower if you still use JaCoCo 0.7.4 or lower

Change Log

For current versions see the changelog in the release-area at https://github.com/jenkinsci/jacoco-plugin/releases

Historic Change Log

Version 2.0.1 (Jan 15, 2016)

  • Fix the m2e lifecycle-mapping, #64
  • Integrate automated builds via travis-ci and show the build-state on the github page
  • Fix for JENKINS-31751 JaCoCo 2.0.0 plugin shows html instead of coverage report chart

Version 2.0.0 (Nov 23, 2015)

  • Major version change because the jacoco.exec file from the newer JaCoCo is binary incompatible with previous builds
  • Update to JaCoCo 0.7.5, this causes binary incompatibility! See #55
  • Add coverage summary on build status/result page. Thanks to Felipe Brandão for the patch, see #61

Version 1.0.19 (Apr 7, 2015)

  • Update used version of JaCoCo to 0.7.4

Version 1.0.18 (Dec 7, 2014)

  • Fix JENKINS-23708 NullPointerException if older JaCoCo reports are opened

Version 1.0.17 (Nov 25, 2014)

Version 1.0.16 (Jun 24, 2014)

Version 1.0.15 (Jun 11, 2014)

Version 1.0.14 (Nov 9, 2013)

Core JaCoCo plugin

Version 1.0.13 (Aug 22, 2013)

Core JaCoCo plugin

Coverage column:

Version 1.0.12 (Feb 22, 2013)

Version 1.0.11 (Feb 21, 2013)

Version 1.0.10 (Feb 05, 2013)

Version 1.0.9 (Nov 18, 2012)

Version 1.0.8 (Okt 15, 2012)

Version 1.0.7 (Okt 8, 2012)

Version 1.0.6 (Okt 2, 2012)

Version 1.0.5 (Sep 09, 2012)

  • Fixed JENKINS-15088: When the missed count is bigger than the covered, the redbar becomes too long

Version 1.0.4 (Sep 03, 2012)

  • Fixed JENKINS-14896: java.io.FileNotFoundException when saving module data

Version 1.0.3 (Aug 20, 2012)

  • New concept implemented JENKINS-14927: Use the EXEC files instead the XMLs
  • Fixed JENKINS-14279: Report "missed items" rather that coverage percentage
  • Fixed JENKINS-14159: 404 when trying to see coverage on java code (implementation of sourcefile highlighting)
  • New feature JENKINS-14274: Multi module reporting

Version 1.0.2 (Jul 01, 2012)

  • Fixed JENKINS-14270: The report does not show the covered/all, it shows something different

Version 1.0.1 (Jun 25, 2012)

  • Fixed testcases to have all the tests passed for a release
  • Fixed JENKINS-14203: The total summary is double counted

Version 1.0.0 (Jun 14, 2012)

  • Fixed 3 testcases to have all the tests passed for a release
  • Fixed POM: making it releasabl
Version: 3.3.6
Released:
Requires Jenkins 2.426.3
ID: jacoco
Installed on 7.60% of controllers
View detailed version information
Links
GitHub
Open issues (Jira)
Report an issue (Jira)
Pipeline Step Reference
Extension Points
Javadoc
Labels
Build Reports
Maintainers
centic
Ognjen Bubalo
Help us improve this page!
To propose a change submit a pull request to the plugin page on GitHub.
Previous Security Warnings