org.sonar.api.batch.sensor.internal

Class SensorContextTester

java.lang.Object

org.sonar.api.batch.sensor.internal.SensorContextTester

All Implemented Interfaces:

SensorContext

@Beta
public class SensorContextTester
extends Object
implements SensorContext

Utility class to help testing Sensor. Usage: call create(File) to create an "in memory" implementation of SensorContext then pass it to your Sensor. You can then query elements provided by your sensor using methods allIssues(), ...

Since:

5.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SensorContextTester.MockAnalysisMode

Method Summary

Methods

Modifier and Type	Method and Description
ActiveRules	activeRules() Get list of active rules.
Collection<Issue>	allIssues()
SensorContextTester.MockAnalysisMode	analysisMode() Get analysis mode.
static SensorContextTester	create(File moduleBaseDir)
Collection<Dependency>	dependencies()
Collection<Duplication>	duplications()
DefaultFileSystem	fileSystem() Get filesystem of the current project.
List<TypeOfText>	highlightingTypeFor(String componentKey, int charIndex)
Collection<Issue>	issues(String componentKey)
<G extends Serializable> Measure<G>	measure(String componetKey, Metric<G> metric)
Measure	measure(String componetKey, String metricKey)
Collection<Measure>	measures(String componetKey)
NewDependency	newDependency() Create a new dependency.
NewDuplication	newDuplication() Builder to manually register duplication in a file.
NewHighlighting	newHighlighting() Builder to define highlighting of a file.
NewIssue	newIssue() Fluent builder to create a new Issue.
<G extends Serializable> NewMeasure<G>	newMeasure() Fluent builder to create a new Measure.
void	setActiveRules(ActiveRules activeRules)
void	setFileSystem(DefaultFileSystem fs)
void	setSettings(Settings settings)
Settings	settings() Get settings of the current project.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SensorContextTester create(File moduleBaseDir)

settings

public Settings settings()

Description copied from interface: SensorContext

Get settings of the current project.

Specified by:

settings in interface SensorContext

setSettings

public void setSettings(Settings settings)

fileSystem

public DefaultFileSystem fileSystem()

Description copied from interface: SensorContext

Get filesystem of the current project.

Specified by:

fileSystem in interface SensorContext

setFileSystem

public void setFileSystem(DefaultFileSystem fs)

activeRules

public ActiveRules activeRules()

Description copied from interface: SensorContext

Get list of active rules.

Specified by:

activeRules in interface SensorContext

setActiveRules

public void setActiveRules(ActiveRules activeRules)

analysisMode

public SensorContextTester.MockAnalysisMode analysisMode()

Description copied from interface: SensorContext

Get analysis mode.

Specified by:

analysisMode in interface SensorContext

newMeasure

public <G extends Serializable> NewMeasure<G> newMeasure()

Description copied from interface: SensorContext

Fluent builder to create a new Measure. Don't forget to call NewMeasure.save() once all parameters are provided.

Specified by:

newMeasure in interface SensorContext

measures

public Collection<Measure> measures(@Nullable
                           String componetKey)

measure

public <G extends Serializable> Measure<G> measure(String componetKey,
                                          Metric<G> metric)

measure

public Measure measure(String componetKey,
              String metricKey)

newIssue

public NewIssue newIssue()

Description copied from interface: SensorContext

Fluent builder to create a new Issue. Don't forget to call NewIssue.save() once all parameters are provided.

Specified by:

newIssue in interface SensorContext

allIssues

public Collection<Issue> allIssues()

issues

public Collection<Issue> issues(@Nullable
                       String componentKey)

Parameters:

componentKey - null for project issues

newHighlighting

public NewHighlighting newHighlighting()

Description copied from interface: SensorContext

Builder to define highlighting of a file. Don't forget to call NewHighlighting.save() once all elements are provided.

Specified by:

newHighlighting in interface SensorContext

highlightingTypeFor

public List<TypeOfText> highlightingTypeFor(String componentKey,
                                   int charIndex)

newDuplication

public NewDuplication newDuplication()

Description copied from interface: SensorContext

Builder to manually register duplication in a file. This can be used in addition to CpdMapping extension point. Don't forget to call NewDuplication.save().

Specified by:

newDuplication in interface SensorContext

duplications

public Collection<Duplication> duplications()

newDependency

public NewDependency newDependency()

Description copied from interface: SensorContext

Create a new dependency. Don't forget to call NewDependency.save() once all parameters are provided.

Specified by:

newDependency in interface SensorContext

dependencies

public Collection<Dependency> dependencies()