Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{iframe:src=http://updateredirect.sonarsource.orgcom/plugins/issuesreport.html|width=700|height=250300|frameborder=0}
YourDocumentation browser does not support iframes.
{iframe}

Description / Features

The Issues Report plugin provides the ability to generate HTML report on issues.

The main use case is for developers to check the code they have added or changed before pushing it back to the SCM.

Here's an example of HTML report (you can download the full report here):

Image Removed

Issues can then be filtered by severity, new issues only, etc.

Info
titleSonar Eclipse Plugin
Note that a SonarQube plugin for Eclipse is also available. It currently supports Java, C/C++ and Python.

...

Usage

As the main use case is for developers to check the code they have added or changed before pushing it back to the SCM, the Issues Report plugin is usually used in preview mode. This is this usage that is detailed below.

Install your favorite analyzer (SonarQube RunnerMaven or Ant) on your local machine. You only have to set the sonar.host.url property to point to your remote SonarQube server (connection settings to the remote database do not have to be provided for a preview as no data is pushed to the database).

Copy the configuration file (sonar-project.properties, pom.xml, etc.) that is used to analyze the project on the remote server to your local machine. Make sure that the sonar.sources property refers to the directory containing the source code on your local machine (or update it accordingly). The tree structure of the source code on your local machine must match the tree structure that has been remotely analyzed by SonarQube. 

To get an HTML report, set the sonar.issuesReport.html.enable property to true. To define its location, set the sonar.issuesReport.html.location property to an absolute or relative path to the destination for the HTML report. The default value is .sonar/issues-report.html for the SonarQube Runner and Ant, and target/sonar/issues-report.html for Maven.

To display a short report in the console, set the sonar.issuesReport.console.enable property to true:Image Removed

Finally, run a preview that generates an HTML report:

 

Code Block
languagebash
# Set the "sonar.dryRun" property to "true" to activate the preview mode
sonar-runner -Dsonar.dryRun=true -Dsonar.issuesReport.html.enable=true

Another useful feature is to limit the scope to the files that have been recently created or modified. To do so, the sonar.inclusions property can be set. In the following example, only the myCobolProgram.cbl Cobol program will be checked:

 

Code Block
languagenone
sonar-runner -Dsonar.dryRun=true -Dsonar.issuesReport.html.enable=true -Dsonar.inclusions=myCobolProgram.cbl

Known Limitation

The Issues Report plugin is not yet compatible with multi-module projects. See https://jira.codehaus.org/browse/SONARPLUGINS-2805.

Change Log

...

has been moved to [http://redirect.sonarsource.com/plugins/issuesreport.html].
{iframe}