/sonar-coverage-badge

A simple node.js server that will display badges for Code Coverage from a source SonarQube server
  1. JavaScript 89.3%
  2. Makefile 9.6%
  3. Smarty 1.1%
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

@xeb
xeb Adding JavaScript as example
Latest commit c032aed May 31, 2016
Permalink
Failed to load latest commit information.
src Fixing links and integration tests May 31, 2016
test Fixing links and integration tests May 31, 2016
.env.tpl Add .env.tpl and dotenv for env vars (default sonar host/token) Apr 18, 2016
.gitignore Add .env.tpl and dotenv for env vars (default sonar host/token) Apr 18, 2016
.travis.yml chore(travis): Update Node versions for testing. Nov 1, 2015
Dockerfile Add docker file Apr 18, 2016
Makefile Fixing links and integration tests May 31, 2016
README.md Adding JavaScript as example May 31, 2016
Web.config Fixing IIS config Sep 6, 2015
package.json Fix dependency as devDependency (node-uuid) Apr 18, 2016
sonar-project.properties Refactoring SSL to get 100% coverage Sep 6, 2015

README.md

Sonar Coverage Badge

This is a small node.js server that will generate a coverage badge (similar to: http://coveralls.io/) but from a SonarQube server.

Usage

node src\\index.js --port=8087 or npm start

Then simply specify three parameters:

  • *server* - Hostname of the target SonarQube server
  • *resource* - the key as defined by http://{SONAR}/api/projects
  • *metrics* - usually either 'coverage' or 'branch_coverage'

    • Example: http://localhost:8087/?server=nemo.sonarqube.org&resource=junit:junit&metrics=coverage&ssl=true

    Will display:

    Note about SSL

    There is a quick way to turn on SSL queries if your SonarQube server requires SSL.
    Just add ssl=true to the end of the query string.
    All of the examples in this README referencing Nemo.sonarqube.org have SSL enabled.

    Color Settings

    To adjust the badge colors, simply update the colorSettings var at the beginning of the script. Note that it will be evaluated in order.

    Samples

    JUnit

    <a href="http://nemo.sonarqube.org/drilldown/measures/252031?metric=coverage">
	<img src="http://localhost:8087/?server=nemo.sonarqube.org&resource=junit:junit&metrics=coverage&ssl=true" />
</a>

    JavaScript

    <a href="http://nemo.sonarqube.org/drilldown/measures/875157?metric=coverage">
	<img src="http://localhost:8087/?server=nemo.sonarqube.org&resource=org.sonarsource.javascript:javascript&metrics=coverage&ssl=true" />
</a>