|Latest version||2.3 ( 26 june 2014 )|
|Requires SonarQube version||4.2 or higher ( check version compatibility )|
|License||GNU LGPL 3|
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.
Description / Features
The ecosystem enables analysis of Java projects within Sonar.
The Java Ecosystem is a set of plugins used to monitor the quality of Java within SonarQube.
On top of the coding rules provided by the 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.
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.
By default the Java Ecosystem is provided with Sonar.As any other plugins, you can update it through the SonarQube. You can update it from the Update Center or download new version into the SONAR_HOME/extensions/plugins directory. Then restart the Sonar serverthe latest release from this page header. Don't forget to check the upgrade notes.
- 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
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.
Run a Sonar Analysis with the other Analyzers
Unit Tests and Code Coverage Reports
Extending Coding Rules using XPath
New coding rules can be added using XPath. See the related documentation.
To 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
- Java Ecosystem FAQ
- Metric definitions
- Additional plugins are available:
- Extending Coding Rules. To navigate the AST, download
- the SSLR Java Toolkit.
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.
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