|Latest version||12.3 ( 25 June 2013 26 june 2014 )|
|Requires SonarQube version||34.62 or higher ( check version compatibility )|
|License||GNU LGPL 3|
If you want to see a live example of the capabilities of the Java Ecosystem, you can have a look at SonarQube on SonarQube.
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 Java Ecosystem is a set of plugins used to monitor the quality of Java projects within SonarQube.
The Java Ecosystem is a set of plugins:
- Java [sonar-java-plugin]: to parse Java code source, compute metrics, etc.
- Squid [sonar-squid-java-plugin]: to compute additional metrics, check code against rules provided by the SonarQube engine
- 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 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 SonarQube. You You can update it from the Update Center (since SonarQube 3.5) or or download the latest release from this page header. Once the Java Ecosystem is installed, other plugins are available for download: Emma, Clover, etcDon't forget to check the upgrade notes.
Run a SonarQube Analysis
- 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.
Unit Tests and Code Coverage
The default code coverage engine for unit tests can be set in Settings > General Settings > Java > Code coverage plugin property.
To deal with unit tests and code coverage, see Code Coverage by Unit Tests for Java Project tutorial.
- Java Ecosystem FAQ
- Metric definitions
- Additional plugins are available: A
- A sample
- Extending Coding Rules using XPath. To 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