com.github.sbaudoin.sonar.plugins.shellcheck.rules

Class ShellCheckSensor

java.lang.Object

com.github.sbaudoin.sonar.plugins.shellcheck.rules.ShellCheckSensor

All Implemented Interfaces:

org.sonar.api.batch.sensor.Sensor

public class ShellCheckSensor
extends Object
implements org.sonar.api.batch.sensor.Sensor

SonarQube sensor class responsible for analyzing Shell scripts with ShellCheck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ShellCheckSensor.UnexpectedCommandOutputException Class thrown when the executed command does not return the expected output

Constructor Summary

Constructors

Constructor and Description
ShellCheckSensor(org.sonar.api.batch.fs.FileSystem fileSystem, org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory) Constructor

Method Summary

Modifier and Type	Method and Description
void	describe(org.sonar.api.batch.sensor.SensorDescriptor descriptor)
void	execute(org.sonar.api.batch.sensor.SensorContext context) Executes shellcheck and saves the issues detected with this tool
protected int	executeCommand(List<String> command, List<String> stdOut, List<String> errOut) Executes a system command and writes the standard and error outputs to the passed StringBuilder if not null
protected org.sonar.api.rule.RuleKey	getRuleKey(org.sonar.api.batch.sensor.SensorContext context, String ruleId) Returns the RuleKey identified as the passed ruleId or null if no corresponding active rule has been found
protected String	getShellCheckPath(org.sonar.api.batch.sensor.SensorContext context) Returns the plugin configuration parameter (settings) that defines the path to the command shellcheck
protected void	saveIssue(org.sonar.api.batch.sensor.SensorContext context, org.sonar.api.batch.fs.InputFile inputFile, int line, String ruleId, String message) Saves the found issues in SonarQube
protected void	saveIssues(org.sonar.api.batch.fs.InputFile inputFile, String output, org.sonar.api.batch.sensor.SensorContext context) Saves in SonarQube all the issues found in the passed JSON output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShellCheckSensor

public ShellCheckSensor(org.sonar.api.batch.fs.FileSystem fileSystem,
                        org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory)

Constructor

Parameters:

fileSystem - injected by the Sonar framework, used to get access to the scanned files

fileLinesContextFactory - injected by the Sonar framework, used to set line measures

Method Detail

describe

public void describe(org.sonar.api.batch.sensor.SensorDescriptor descriptor)

Specified by:

describe in interface org.sonar.api.batch.sensor.Sensor

execute

public void execute(org.sonar.api.batch.sensor.SensorContext context)

Executes shellcheck and saves the issues detected with this tool

Specified by:

execute in interface org.sonar.api.batch.sensor.Sensor

Parameters:

context - the execution sensor context (taken from the method execute(SensorContext) of the child class)

getShellCheckPath

protected String getShellCheckPath(org.sonar.api.batch.sensor.SensorContext context)

Returns the plugin configuration parameter (settings) that defines the path to the command shellcheck

Parameters:

context - the execution sensor context (taken from the method execute(SensorContext) of the child class)

Returns:

the path to the command shellcheck or shellcheck if the plugin setting is not set

See Also:

ShellCheckSettings.SHELLCHECK_PATH_KEY

executeCommand

protected int executeCommand(List<String> command,
                             List<String> stdOut,
                             List<String> errOut)
                      throws InterruptedException,
                             IOException

Executes a system command and writes the standard and error outputs to the passed StringBuilder if not null

Parameters:

command - the command to be executed

stdOut - where the standard output is written to line by line

errOut - where the error output is written to

Returns:

the command exit code

Throws:

IOException - if an error occurred executing the command. See ProcessBuilder.start() and Process.waitFor()

InterruptedException - if an error occurred executing the command. See ProcessBuilder.start() and Process.waitFor()

See Also:

ProcessBuilder.start(), Process.waitFor()

saveIssues

protected void saveIssues(org.sonar.api.batch.fs.InputFile inputFile,
                          String output,
                          org.sonar.api.batch.sensor.SensorContext context)

Saves in SonarQube all the issues found in the passed JSON output. If the output is not JSON compliant, an IllegaArgumentException is raised.

Parameters:

inputFile - the file that has the issues to be saved

output - JSON output received from shellcheck

context - the execution sensor context (taken from the method execute(SensorContext) of the child class)

saveIssue

protected void saveIssue(org.sonar.api.batch.sensor.SensorContext context,
                         org.sonar.api.batch.fs.InputFile inputFile,
                         int line,
                         String ruleId,
                         String message)

Saves the found issues in SonarQube

Parameters:

context - the context

inputFile - the file where the issue was found

line - the line where the issue was found

ruleId - the Id of the rule that raised the issue

message - a message describing the issue

getRuleKey

protected org.sonar.api.rule.RuleKey getRuleKey(org.sonar.api.batch.sensor.SensorContext context,
                                                String ruleId)

Returns the RuleKey identified as the passed ruleId or null if no corresponding active rule has been found

Parameters:

context - the sensor context (that contains the active rules)

ruleId - the rule Id (corresponding to the searched RuleKey)

Returns:

the RuleKey or null if no active rule has been found