6.2.11.12. ImportSpotBugs¶
Run SpotBugs and import its results
Runs SpotBugs and imports its bug instances as analysis violations.
SpotBugs is invoked with -textui -sarif; each result of its SARIF
report becomes a violation with the provider option's
value, spotbugs by default, and the bug type as its error number.
Use additional_args for the analyzed class
files and set cwd for your project.
Set source_directories so that bugs are reported at their source files, which the analysis's include and exclude patterns then apply to.
Possible Messages
This rule has no predefined messages.
Options¶
This rule shares the following common options: exclude_messages_in_system_headers, excludes, includes, justification_checker, post_processing, provider, severity
The following places define options that affect this rule: Analysis-GlobalOptions
additional_args¶
additional_args : list[str] = []
check_returncode¶
check_returncode : bool = True
Whether a non-zero exit status of the tool fails the rule. Turn it off for tools that report findings through their exit status, as many linters do.
Independent of this option, a run that imports no violations while the tool exits non-zero fails: its results are indistinguishable from a run in which the tool found nothing.
cwd¶
cwd : bauhaus.analysis.config.LayerRelativePath | None = None
encoding¶
encoding : str = 'utf-8'
encoding_error_handler¶
encoding_error_handler
Type: EncodingErrorHandler
Default:
'IGNORE'
The strategy to handle encoding errors during processing of the output of the executed command.
STRICT: abort with on error on encoding errors,IGNORE: ignore encoding errors (accepting data loss),REPLACE: replace problematic code points with a question mark (?).
environment¶
environment : dict[str, str] = {}
exclude_filter¶
exclude_filter : bauhaus.analysis.config.PlainPath | None = None
-exclude.
executable¶
executable : bauhaus.analysis.config.PlainPath | None = None
include_filter¶
include_filter : bauhaus.analysis.config.PlainPath | None = None
-include.
source_directories¶
source_directories : list[bauhaus.analysis.config.PlainPath] = []
-sourcepath and used to map the reported bugs to
source files.
Option Types¶
These types are used by options listed above:
EncodingErrorHandler¶
STRICT
IGNORE
REPLACE