/github-pr-coverage-status-plugin

Nice test coverage icon for your pull requests just from Jenkins

Primary LanguageJavaApache License 2.0Apache-2.0

GitHub Pull Request Coverage Status Plugin for Jenkins

Build Status Coverage Status

Overview

https://wiki.jenkins-ci.org/display/JENKINS/GitHub+PR+Coverage+Status+Plugin

Parse code coverage report generated by build and post code coverage status comment to GitHub pull request: Example

Supports coverage reports

  • Jacoco jacoco.xml
  • Cobertura cobertura.xml or cobertura-coverage.xml
  • Clover clover.xml
  • SimpleCov JSON (Ruby) coverage.json

How to use

  • Select or create new Jenkins build
  • Ensure that build create code coverage report file
  • Configure build to be triggered
  • Install plugin from Jenkins Plugin Repository
  • Or manually
    • Goto releases
    • Download latest version of plugin .hpi file
    • Install to your Jenkins guide
  • Configure global settings of plugin
    • GitHub API URL keep blank for GitHub.com and fill if for dedicated instance of GitHub, example: http(s)://hostname/api/v3/
    • Set Personal Access Token (or keep blank if anonymous access enabled)
  • Setup Master Coverage (options)
    • Add Record Master Coverage post build step to build which test your master
    • Or goto Manage Jenkins and use Use Sonar for master coverage
  • Add Publish coverage to GitHub post build step to build. It should be triggered by GitHub pull request builder plugin

How to use with Jenkins Pipelines

  • After running tests set build result to Success
    • currentBuild.result = 'SUCCESS'
  • Trigger MasterCoverageAction to collect master coverage
    • step([$class: 'MasterCoverageAction'])
  • Trigger CompareCoverageAction to compare coverage and publish results
    • step([$class: 'CompareCoverageAction'])
    • Optionally use can specify here sonar login and sonar password like this: step([$class: 'CompareCoverageAction', sonarLogin: "login", sonarPassword: "password"])

Master Coverage from Sonar

You have the option to get the master coverage (base coverage) from your SonarQube instance. Otherwise the plugin will keep track of the master coverage in the project configuration file.

  • Goto Manage Jenkins
  • Find section Coverage status for GitHub Pull Requests
  • Fill Sonar URL field - e.g. http://sonar.mycompany.com
  • Turn On Use Sonar for master coverage
  • Optionally use can specify your personal Sonar access token.
  • The next pull request build will use SonarQube as the the source for master coverage

The plugin will try to find the project in SonarQube based on the repository name. If more than one projects match, a warning is logged, and the first one will be used to get the coverage data.

Troubleshooting

No coverage picture and my Jenkins is in private network and not accessible for GitHub

Because of that GitHub can't render icon picture hosted on Jenkins. Plugin can use http://shields.io public resource instead of Jenkins hosted picture. To use it:

  • Goto Jenkins Configuration
  • Turn on Jenkins is not accessible for GitHub
  • Done next coverage comment in Pull Request will use http://shields.io

No coverage picture on GitHub Pull Request Page

If you see next picture on your pull request in GitHub:

No coverage picture

In most cases that mean that your Jenkins runs on http instead of https Plugin uses same protocol as your Jenkins, however GitHub in most cases accessible by https Default browser policy to block non secure resources on secure pages from unknown domain.

To fix that:

  1. Configure Jenkins to be accessible for https https://wiki.jenkins-ci.org/display/JENKINS/Starting+and+Accessing+Jenkins
  2. Next you have a few options:
  • Run your Jenkins on https only
  • Or configure plugin to publish link on picture over https
    • Open Jenkins
    • Click Manage Jenkins
    • Click Configure System
      • Find section Coverage status for GitHub Pull Requests
      • Find property Jenkins URL for icon in Pull Request
      • Put URL to your Jenkins with https like https://jenkins.my.com
      • Save
    • Restart Jenkins

Plugin settings

Changelog

1.8.2

  • Fix Master showing 0% even after RecordMasterCoverage is run

1.8.0

  • Sonar token & login/password authentication

1.7.1

  • SimpleCov JSON report fix coverage

1.7.0

1.6.1

  • Support single quotes for Cobertura Report

1.6.0

  • Cobertura plugin ignores zero for lineRate or branchRate as result lineRate=0 branchRate=0.5 => Coverage 25% became 0.5 as lineRate=0, same policy for branchRate
  • Log Enchacements

1.5.0

Supporting Master Coverage from SonarQube. Check (details)[#master-coverage-from-sonar]

1.4.0

Supporting of private Jenkins with public GitHub. To enable that mode goto Jenkins Configuration and turn on Jenkins is not accessible for GitHub

1.3.0

Add support SimpleCov JSON coverage report for Ruby

1.2.0

Add alternative text to coverage image for case when GitHub doesn't able to show image

1.1.1

Correct parsing Cobertura report for edge cases

1.0.8

First public release to Jenkins Plugin Repo