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 50 Next »

Description / Features

The Issues Report plugin provides the ability to run preview SonarQube analyses on your machine. The main use case is for developers to check the code they have added or changed before pushing it back to the SCM.

It generates an HTML report that displays a list of issues that can be filtered by severity, new issues only (comparison made against the latest version available on the remote server), etc.

It supports all languages.

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

Sonar Eclipse Plugin

Icon
Note that to perform local analyses, a SonarQube plugin for Eclipse is also available. It currently supports Java, C/C++ and Python.

Installation

  1. Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
  2. Restart the SonarQube server

Usage

Note that you do not need to install a SonarQube server and database on your local machine. Just install and configure your favorite analyzer (SonarQube RunnerMaven or Ant).

Basically, the way to run an analysis and a preview is the same. Copy to your local machine the analysis configuration file (sonar-project.properties, pom.xml, etc.) that is used to analyze the project on the remote server. 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. Finally, run a local analysis:

To get a local report:

  • 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:


A useful feature is to limit the scope of the analysis to the files that have been created or modified. To do so, the sonar.inclusions property can be set.

In the following example, SonarQube will only check the myCobolProgram.cbl Cobol program. The analysis will be local: nothing will be pushed to the database, thus the results will not be available through the SonarQube server web interface. An HTML report will be generated to display the list of issues on the myCobolProgram.cbl file:

 

Multi-module project compatibility

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

 

Change Log

Loading

Version 1.0 (4 issues)

  • No labels