The Jenkins Code Coverage Plug-in collects reports of code coverage or mutation coverage tools. It has support for the following report formats:
If your coverage tool is not yet supported by the code coverage plugin you can provide a pull request for the Coverage Model.
The plugin publishes a report of the code coverage and mutation coverage in your build, so you can navigate to a summary report from the main build page. From there you can also dive into the details:
- tree charts that show the distribution of coverage by type (line, instruction, branch, method, class, etc.)
- tabular listing of all files with their coverage
- source code of the files with the coverage highlighted
- trend charts of the coverage over time
This project was part of GSoC 2018.
The code coverage plug-in provides the following features when added as a post build action (or step) to a job:
- Coverage analysis of projects and pull requests: The plugin now computes and shows the absolute coverage of the project, the coverage of the modified files and the coverage of the modified lines, so you can see how the changes actually affect the code coverage. Additionally, the delta of these coverages with respect to the reference build are computed and the coverage changes created by changed test cases (indirect coverage changes).
-
Coverage overview and trend:
-
Colored project coverage tree map for line, branch, instruction and mutation coverage:
-
Source code navigation with a configuration option to store the source code files for all builds, for current build only, or for changed files only:
-
Specific source code view for analyzing the coverage of changed code lines:
-
Specific source code view for analyzing the coverage changes that are a result of test changes (indirect coverage changes):
-
Customizable coverage overview for the Jenkins dashboard view and for build results:
-
Quality Gates: You can specify an arbitrary number of quality gates that allow to set the build to unstable or failed if the thresholds are not met. For each quality gate the metric (branch coverage, complexity, etc.) and the baseline (whole project, changed files, etc.) can be defined.
-
Cyclomatic Complexity and LOC metrics: Several coverage parsers support the measurement of cyclomatic complexity and lines of code. These metrics are now computed and recorded as well:
-
The recorder has been extended with a native step that is capable of setting the step status (unstable, failed, ok):
-
GitHub checks report to show the detailed line and branch coverage results for pull request:
-
GitHub checks report to show the detailed line and mutation coverage results for pull request:
❗ The plugin does not run the code coverage, it just visualizes the results reported by such tools. You still need to enable and configure the code coverage tool in your build file or Jenkinsfile. ❗
The Code Coverage Plug-in supports the following Jenkins project types:
- Freestyle Project
- Maven Project
- Scripted Pipeline (sequential and parallel steps)
- Declarative Pipeline (sequential and parallel steps)
- Multi-branch Pipeline
Enable the "Record code coverage results" publisher in the Post-build Actions section of your job. Select at least one coverage tool and specify the path to the report file. If you do not specify a path, the plugin will search for the report file in the workspace using the default pattern of the tool.
The plugin can compare the coverage results of the current build with the results of a reference build. The reference build will be discovered using the forensics-api plugin.
We also support pipeline configuration, you can generate pipeline code in Jenkins' Snippet Generator.
recordCoverage(tools: [[parser: 'JACOCO']], id: 'jacoco', name: 'JaCoCo Coverage', sourceCodeRetention: 'EVERY_BUILD', qualityGates: [ [threshold: 60.0, metric: 'LINE', baseline: 'PROJECT', unstable: true], [threshold: 60.0, metric: 'BRANCH', baseline: 'PROJECT', unstable: true]]) We provide a remote API to retrieve coverage data, using the following URL: https://[jenkins-url]/job/[job-name]/[build-number]/coverage/api/json?pretty=true.
Example output:
{ "_class" : "io.jenkins.plugins.coverage.metrics.steps.CoverageApi", "modifiedFilesDelta" : { "branch" : "+1.72%", "class" : "-3.54%", "complexity" : "-236", "complexity-density" : "+0.47%", "file" : "+0.00%", "instruction" : "+0.16%", "line" : "-0.48%", "loc" : "-482", "method" : "+1.23%", "module" : "+0.00%", "package" : "+0.00%" }, "modifiedFilesStatistics" : { "branch" : "83.91%", "class" : "93.33%", "complexity" : "392", "complexity-density" : "+50.19%", "file" : "100.00%", "instruction" : "88.19%", "line" : "87.96%", "loc" : "781", "method" : "86.18%", "module" : "100.00%", "package" : "100.00%" }, "modifiedLinesDelta" : { "branch" : "+8.95%", "file" : "+0.00%", "line" : "+3.85%", "loc" : "-610", "module" : "+0.00%", "package" : "+0.00%" }, "modifiedLinesStatistics" : { "branch" : "92.86%", "file" : "100.00%", "line" : "91.81%", "loc" : "171", "module" : "100.00%", "package" : "100.00%" }, "projectDelta" : { "branch" : "+4.43%", "class" : "+2.94%", "complexity" : "-8", "complexity-density" : "+1.28%", "file" : "+4.00%", "instruction" : "+2.59%", "line" : "+3.37%", "loc" : "-50", "method" : "+1.28%", "module" : "+0.00%", "package" : "+0.00%" }, "projectStatistics" : { "branch" : "82.19%", "class" : "96.88%", "complexity" : "628", "complexity-density" : "+49.72%", "file" : "100.00%", "instruction" : "88.03%", "line" : "88.44%", "loc" : "1263", "method" : "84.94%", "module" : "100.00%", "package" : "100.00%" }, "qualityGates" : { "overallResult" : "SUCCESS", "resultItems" : [ { "qualityGate" : "Overall project - Line Coverage", "result" : "SUCCESS", "threshold" : 60.0, "value" : "88.44%" }, { "qualityGate" : "Overall project - Branch Coverage", "result" : "SUCCESS", "threshold" : 60.0, "value" : "82.19%" } ] }, "referenceBuild" : "<a href=\"http://localhost:8080/job/coverage-model-history/10/\" class=\"model-link inside\">coverage-model-history #10</a>" }