Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If you are happy with PDF Plugin then you could recomend recommend it.

There is also Commercial edition supported by klicap.

Description / Features

Sonar PDF This plugin allows to generate a report in PDF format that contains the most relevant information showed by Sonar SonarQubeTM web interface. The report aims to be a deliverable as part of project documentation.
Actually the report contains:

  • Global dashboard (similar to Sonar SonarQubeTM web interface dashboard)
  • Violations by categories
  • Hotspots:
    • Most violated rules
    • Most violated files
    • Most complex classes
    • Most duplicated files
  • Dashboard, violations and hotspots for all child modules (if they exists)

You can download an example of report here.

Usage

Maven Plugin

First analyze your project in sonarSonarQubeTM. Then run the generate goal (report will be created in the target directory):

...

Available properties (-Dproperty=value)

  • sonar.host.url: sonar SonarQubeTM server URL (i.e http://my-host:9000/sonar)
  • sonar.branch (-Dbranch is also supported): report on a project branch
  • report.type: select a report type. Values:
    • -Dreport.type=executive
    • -Dreport.type=workbook (default)
  • sonar.pdf.username: username for access WS API
  • sonar.pdf.password: password for the user

If your Sonar SonarQubeTM server URL is http://localhost:9000 you don't need to specify sonar.host.url.

...

SonarQubeTM Plugin (post-job)

 
Sonar SonarQubeTM PDF can be used as a plugin of sonar SonarQubeTM modeling a post-job work. In this way, a PDF report is generated after each analysis in Sonar SonarQubeTM (mvn sonar:sonar includes the generation of report).
 
How to install Sonar SonarQubeTM PDF in Sonar

Use update center, or alternatively:

  • Dowload sonar-pdfreport-plugin-1.3.jar
  • Copy to [sonar-dir]/extensions/plugins
  • Restart SonarSonarQubeTM

Configuration

You can skip report generation or select report type (executive or workbook) at top level or project level. Also you can provide an username/password if your project are secured by Sonar SonarQubeTM user management:

Download the report

PDF report can be downloaded from Sonar SonarQubeTM GUI:

Changelog

JIRA Issues
anonymoustrue
titleRelease 1.3.1
height70
width900
columnstype;key;summary;priority;status;resolution
urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=19241&pid=11911&sorter/field=issuekey&sorter/order=DESC&tempMax=1000

...

JIRA Issues
anonymoustrue
titleRelease 0.1
height70
width900
columnstype;key;summary;priority;status;resolution
urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=15232&pid=11911&sorter/field=issuekey&sorter/order=DESC&tempMax=1000

 

Known limitations

Ant task and Sonar Runner are not supported.