Skip to end of metadata
Go to start of metadata

 

 

Upgrade to 2.4

Icon

You CANNOT upgrade automatically to 2.4

Version 2.4 moves Java from being an "ecosystem" of multiple plugins to a single, stand-alone plugin that encompasses most of the functionality formerly contained in the ecosystem. Specifically, 

  • Squid, Surefire and Jacoco have been rolled into the Java plugin.
  • FindBugs has been split off into an independent, optional plugin. To continue using it, upgrade it to version 2.4.

Unfortunately, SonarQube's update center cannot handle the switch gracefully. You may use the update center to download the new version of the plugin. However, you must manually remove the Surefire, JaCoCo, and Squid for Java plugins from$SONARQUBE_HOME/extensions/plugins.

 

 

Live example

Icon

If you want to see a live example of the capabilities of the Java Ecosystem, you can have a look at SonarQube on SonarQube.

Description / Features

The Java plugin is used to monitor the quality of Java within SonarQube.

With additional plugins, you can activate rules from CheckstyleFindBugsPMDClirr, and fb-contrib. However, we highly recommend that you limit your Quality Profiles to from the SonarQube engine because we believe they are faster, more accurate (fewer false positives and false negatives), and more usable (they have better descriptions, etc). Read this blog post for more details.

If your Quality Profile contains rules from the SonarQube engine or FindBugs rules, then byte code will be required by the analysis. This Java Ecosystem is able to analyse any kind of java source files whatever is the version of Java they comply to.

Installation

By default the Java plugin is provided with SonarQube. You can update it from the Update Center or download the latest release from this page header. Don't forget to check the upgrade notes.

Usage

Java bytecode is required

Icon

Analysing a Java project without providing the Java bytecode of the source files and of all the project dependencies (jar files) is possible but will lead to highly decrease the number of issues found by the analyzer (false-negatives). Moreover the detection of cycles between packages and the display of the DSM will be automatically deactivated. As soon as a class required to efficiently do an analysis is missing a warning like the following one is logged :

[WARN] [08:40:21.769] Class 'XXXXXX' is not accessible through the ClassLoader.

Run a SonarQube Analysis

To run an analysis of your Java project, you can use the following analyzers:

Note that you must provide both source code and compiled byte code if the Quality Profile in use contains either SonarQube-native rules, or FindBugs rules.

To provide compiled bytecode and dependencies to the analysis, prior to version 2.5 please refer to the Analysis Parameters Page and use sonar.binaries and sonar.libraries properties. 

From version 2.5, if you are not using maven, use the two following properties : 

KeyDescription
sonar.java.binariesComma-separated paths to directories containing the compiled bytecode files corresponding to your source files

sonar.java.libraries

Comma-separated paths to files with third-party libraries (JAR or Zip files).
Wildcards can be used :

sonar.java.libraries=path/to/specific/library/myLibrary.jar,path/to/library/*.jar,directory/**/*.jar

 

Sample projects for each analyzer are available on GitHub that can be browsed or downloaded: /projects/languages/java

For versions prior to 2.1

Icon
  • The source directory must be set to the directory containing the top parent package. For example, if your directory structure is src/main/java/com/mycompany/..., the source directory must be set to src/main/java.
  • The source directory tree must match the package declaration. For example, the following class:

    MyClass.java

    must be located in the following directory: [mySourceDirectory]/com/mycompany/mypackage/MyClass.java. Otherwise you would get an error like below while running your analysis

    Log

Unit Tests and Code Coverage Reports

To deal with unit tests and code coverage, see Code Coverage by Unit Tests for Java Project tutorial.

To deal with integration tests and code coverage, see Code Coverage by Integration Tests for Java Project tutorial.

To Go Further

Upgrade Notes

Version 2.4

  • Version 2.4 moves Java from being an "ecosystem" of multiple plugins to a single, stand-along plugin that encompasses most of the functionality formerly contained in the ecosystem. Unfortunately, SonarQube's update center cannot handle the switch gracefully. You may use the update center to download the new version of the plugin. However, you must manually remove the Surefire, JaCoCo, and Squid for Java plugins from $SONARQUBE_HOME/extensions/plugins.
  • FindBugs has been split off into an independent, optional plugin. To continue using it, upgrade to version 2.4.

Version 2.2

It is no longer possible to let SonarQube drive the execution of the unit tests. You now have to generate the JUnit and code coverage (JaCoCo or Cobertura or Clover) reports prior to the SonarQube analysis and then feed SonarQube with those reports.

Version 2.0

This version no longer includes the Checkstyle and PMD plugins. Therefore, you should install those two plugins if you're still using some of their rules.

All the valuable rules from PMD and Checkstyle were rewritten based on our own SSLR technology. These rules are now available in the SonarQube repository. Deprecated rules from PMD and Checkstyle are flagged as so and their replacement is stated in the rule description:



See http://www.sonarqube.org/already-158-checkstyle-and-pmd-rules-deprecated-by-sonarqube-java-rules/ for more details.

Version 1.5

  • Property sonar.surefire.reportsPath has been removed and replaced by sonar.junit.reportsPath.

 

  • No labels