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

Description / Features

The Java Ecosystem is a set of Sonar plugins used to monitor the quality of Java projects within Sonar.

Installation

The Java Ecosystem is a set of plugins:

• Mandatory 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 Sonar engine
     
• Optional plugins adding features from external tools:
  
  • 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 default the Java Ecosystem is provided with Sonar.

You can update it from the Update Center (since Sonar 3.5) or download the latest release from this page header.

Usage

Run a Sonar Analysis

To launch a Sonar analysis of your Java project, it is recommended to use the following analyzers:

• Maven for Maven projects
• Ant for Ant projects
• Sonar Runner otherwise

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

Notes:

• The source directory should 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 has to match the package declaration. For example, the following class:

must be located in the following directory: [mySourceDirectory]/com/mycompany/mypackage/MyClass.java.

Otherwise you would get such an error while running your analysis:

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.

By default the code coverage engine is JaCoCo but Cobertura, Emma or Clover can also be used.

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.

Advanced Settings

Documentation on advanced parameters is available on the Analysis Parameters page.

Advanced parameters specific to Java are:

FAQ

See Java Ecosystem FAQ.

Metrics

See Metrics documentation page.

Android

A sample project with code coverage computed with Emma is available on GitHub that can be browsed or downloaded: /projects/android

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.

Change Log

Release 1.1 (15 issues)
Type	Key	Summary	Priority
	SONARJAVA-18	Grab violations directly from findbugs without xml-report generation
	SONARJAVA-80	L10n files are not in the correct folder
	SONARJAVA-20	Upgrade to SSLR 1.16 and switch to lexerless parser
	SONARJAVA-3	The literal "42L" should be lexed as a LONG_LITERAL instead of a INTEGER_LITERAL
	SONARJAVA-2	The literal "42.0" should be lexed as a DOUBLE_LITERAL instead of a FLOATING_LITERAL
	SONARJAVA-1	OutOfMemoryError when attempting to lex an unterminated single quote
	SONARJAVA-14	findbugs-result.xml contains invalid character entity
	SONARJAVA-15	When using the property 'sonar.findbugs.excludesFilters' an INFO log should be generated to clearly show that the external Findbugs filter is taken into account
	SONARJAVA-39	New property 'sonar.java.coveragePlugin'
	SONARJAVA-4	Upgrade to Checkstyle 5.6
	SONARJAVA-5	Rule: Generic Java rule to define some homemade checks with an XPath expression
	SONARJAVA-17	When the last line of a source code file is a blank line, this line is not counted in the "lines" measure
	SONARJAVA-44	The IT and Overall code coverage should not be computed when the code coverage by unit tests is not computed with jacoco
	SONARJAVA-22	The two properties of the Checkstyle rule 'RegexpHeaderCheck' should be TEXT
	SONARJAVA-84	Typo in the Checkstyle rule "ReturnCount"