|Latest version||12.10 ( 22 December 2012 7 january 2014 )|
|Requires Sonar SonarQube version||3.46 or higher ( check version compatibility )|
|License||GNU LGPL 3|
Description / Features
The Java Ecosystem is a set of Sonar plugins used to monitor the quality of Java projects within SonarSonarQube.
The Java Ecosystem is a set of plugins:
On top of the coding rules provided by the
- Checkstyle [sonar-checkstyle-plugin]: to check code against rules provided by Checkstyle
- FindBugs [sonar-findbugs-plugin]: to check code against rules provided by FindBugs
- PMD [sonar-pmd-plugin]: to check code against rules provided by PMD
- Surefire [sonar-surefire-plugin]: to execute unit tests with Surefire
- Cobertura [sonar-cobertura-plugin]: to get code coverage with Cobertura
- JaCoCo [sonar-jacoco-plugin]: to get code coverage with JaCoCo
Note that by SonarQube engine, you can activate rules from Checkstyle, FindBugs, PMD, Clirr, 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.
By default the Java Ecosystem is provided with SonarSonarQube.You You can update it from the Update Center (since Sonar 3.5) or or download the latest release from this page header. Don't forget to check the upgrade notes.
To launch a Sonar run an analysis of your Java project, it is recommended to you can use the following analyzers:
- SonarQube Runner: recommended for all non-Maven projects
- Maven: recommended for all projects built with Maven
- SonarQube Ant Task: to integrate with projects built with Ant
- Gradle: to integrate with projects built with Gradle
- 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:
package com.mycompany.mypackage; ...
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:
Exception in thread "main" org.sonar.batch.bootstrapper.BootstrapException: org.sonar.squid.api.AnalysisException: Got an exception - org.sonar.squid.api.AnalysisException: The source directory does not correspond to the package declaration com.mycompany.mypackage, file : ..\src\MyClass.java ...
Tests and Code Coverage
The default code coverage engine for unit tests can be set in Settings > Configuration > General Settings > Java > Code coverage plugin property.
To deal with unit tests and code coverage for Java project in Sonar, see Code Coverage by Unit Tests for Java Project tutorial.
To deal with integration tests and code coverage for Java project in Sonar, see Code Coverage by Integration Tests for Java Project tutorial.
Documentation on advanced parameters is available on the Analysis Parameters page.
Advanced parameters specific to Java are:
Deactivate Java bytecode analysis. The Java bytecode is analyzed by Sonar in order to extract dependencies between packages and files. These dependencies are used for instance to display the DSM (Dependency System Matrix). This bytecode analysis can be deactivated.
Java version of the source code. This property is not used by the Sonar core but can be used by Java Sonar plugin like the PMD plugin.
See Java Ecosystem FAQ.
To Go Further
- Java Ecosystem FAQ
- Metric definitions
- Additional plugins are available:
- Android: sample projects with code coverage computed with Emma
- Extending Coding Rules using XPath
New coding rules can be added using XPath. See the related documentation.
- . To navigate the AST, download the SSLR Java Toolkit.
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:
sonar.surefire.reportsPathhas been removed and replaced by