SpotBugs plugin for SonarQube
Clone or download
Latest commit 96c460a Nov 8, 2018

README.md

SonarQube Spotbugs Plugin

Build Status FindBugs Rules Coverage Status

Description / Features

This plugin requires the SonarJava Plugin, and uses SpotBugs, fb-contrib and Find Security Bugs to provide coding rules.

Usage

In the quality profile, activate some rules from Spotbugs, fb-contrib or Find Security Bugs rule repositories and run an analysis on your project.

Configuration

This plugin can be configured with sonar web interface (see General/Java section) or with project properties.

Confidence level (sonar.findbugs.confidenceLevel): Specifies the confidence threshold (previously called "priority") for reporting issues. If set to "low", confidence is not used to filter bugs. If set to "medium" (the default), low confidence issues are supressed. If set to "high", only high confidence bugs are reported.

Effort (sonar.findbugs.effort): Effort of the bug finders. Valid values are Min, Default and Max. Setting 'Max' increases precision but also increases memory consumption.

Excludes (sonar.findbugs.excludesFilters): Paths to findbugs filter-files with exclusions.

Timeout (sonar.findbugs.timeout): Specifies the amount of time, in milliseconds, that FindBugs may run before it is assumed to be hung and is terminated. The default is 600,000 milliseconds, which is ten minutes.

Compiled code

FindBugs requires the compiled classes to run.

Make sure that you compile your source code with debug information on (to get the line numbers in the Java bytecode). Debug is usually on by default unless you're compiling with Ant, in which case, you will need to turn it on explicitly. If the debug information is not available, the issues raised by FindBugs will be displayed at the beginning of the file because the correct line numbers were not available.

Compatibility

Since version 3.0, the plugin embed FindBugs 3.0.0 which supports analysis of Java 8 bytecode but requires Java 1.7 to run (see Compatibility section). Please find below the compatibility matrix of the plugin.

Findbugs Plugin version Embedded SpotBugs/Findbugs version Embedded Findsecbugs version Embedded FB-Contrib version Minimal Java version Minimum SonarQube version Minimum sonar-java version
2.4 2.0.3 N/A 5.2.1 1.6 4.2 2.4
3.0 3.0.0 N/A 6.0.0 1.7 4.2 2.4
3.2 3.0.1 1.3.0 6.0.0 1.7 4.5.2 2.7
3.3 3.0.1 1.4.2 6.2.3 1.7 4.5.2 2.7
3.4 3.0.1 1.4.6 6.6.1 1.8 5.6 3.13.1
3.5 3.1.0 RC1 (SpotBugs) 1.6.0 7.0.0 1.8 5.6.6 4.0
3.6 3.1.0 RC4 (SpotBugs) 1.6.0 7.0.0 1.8 5.6.7 4.15.0.12310
3.7 3.1.2 (SpotBugs) 1.7.1 7.2.1sb 1.8 6.7.1 5.1.0.13090
3.8 3.1.6 (SpotBugs) 1.8.0 7.4.3sb 1.8 6.7.1 5.1.0.13090
3.9 3.1.8 (SpotBugs) 1.8.0 7.4.3sb 1.8 6.7.1 5.2.0.13398
3.10-SNAPSHOT 3.1.8 (SpotBugs) 1.8.0 7.4.3sb 1.8 6.7.1 5.2.0.13398