Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 38 Next »

Name

Sonar PDF Plugin

Authors

Antonio Manuel Muñiz (blog), GMV (http://www.gmv.com)

Jira

http://jira.codehaus.org/browse/SONARPLUGINS/component/13739

Last Version

0.2

License

LGPL v3

Download sources

http://svn.codehaus.org/sonar-plugins/trunk/pdf-report/

Compatibility with Sonar

Plugin versions

1.4

1.5

1.6

1.7

1.8

1.9

1.10.X

0.1

0.2

0.3

Description / Features

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


  • Global dashboard (similar to Sonar 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

As Maven Plugin

First analyze your project in sonar. Then run the generate goal:

Available properties (-Dproperty=value)

  • sonar.host.url: sonar server URL (i.e http://my-host:9000/sonar)
  • branch: report on a project branch
  • report.type: select a report type. Values:
    • -Dreport.type=executive
    • -Dreport.type=workbook (default)

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

As Sonar Plugin (post-job)

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

  • Dowload pdf-report-0.3.jar
  • Copy to [sonar-dir]/extensions/plugins
  • Restart Sonar

You can skip report generation at top level or project level:

Changelog

 0.3 Release (Coming soon)

  • Sonar 1.10.X compatibility
  • More deep information about violations
    • Violation and violated line numbers on most violated rules
    • For each module and parent project (if exists)
  • New Sonar Post-job hook

 0.2 Release

  • Sonar 1.9 compatibility
  • Hotspots info
    • Most violated rules
    • Most violated files
    • Most complex classes
    • Most duplicated files
  • Possibility of use "-Dbranch" parameter
  • Better tendency images

0.1 First release

  • Initial data set
    • Dashboard
    • Categories violations

Known limitations

First compatible version: Sonar 1.8

  • No labels