SensorContextTester (SonarQube :: Plugin API 6.4 API)

java.lang.Object
- org.sonar.api.batch.sensor.internal.SensorContextTester

All Implemented Interfaces:

SensorContext
```
public class SensorContextTester
extends Object
implements SensorContext
```
Utility class to help testing Sensor. This is not an API and method signature may evolve. Usage: call create(File) to create an "in memory" implementation of SensorContext with a filesystem initialized with provided baseDir.
You have to manually register inputFiles using:
```
   sensorContextTester.fileSystem().add(new DefaultInputFile("myProjectKey", "src/Foo.java")
      .setLanguage("java")
      .initMetadata("public class Foo {\n}"));
 
```
Then pass it to your Sensor. You can then query elements provided by your sensor using methods allIssues(), ...

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActiveRules`	`activeRules()` Get list of active rules.
`void`	`addContextProperty(String key, String value)` Add a property to the scanner context.
`Collection<AnalysisError>`	`allAnalysisErrors()`
`Collection<Issue>`	`allIssues()`
`Integer`	`conditions(String fileKey, int line)`
`Integer`	`coveredConditions(String fileKey, int line)`
`List<TokensLine>`	`cpdTokens(String componentKey)`
`static SensorContextTester`	`create(File moduleBaseDir)`
`static SensorContextTester`	`create(Path moduleBaseDir)`
`DefaultFileSystem`	`fileSystem()` Get filesystem of the current module.
`Map<String,String>`	`getContextProperties()`
`Version`	`getSonarQubeVersion()` Default value is the version of this API at compilation time.
`List<TypeOfText>`	`highlightingTypeAt(String componentKey, int line, int lineOffset)` Return list of syntax highlighting applied for a given position in a file.
`boolean`	`isCancelled()` Test if a cancellation of the analysis was requested.
`Integer`	`lineHits(String fileKey, int line)`
`void`	`markForPublishing(InputFile inputFile)` Indicate that a file should be published in the report sent to SonarQube.
`static Integer`	`maxOrNull(Integer o1, Integer o2)`
`<G extends Serializable> Measure<G>`	`measure(String componentKey, Metric<G> metric)`
`<G extends Serializable> Measure<G>`	`measure(String componentKey, String metricKey)`
`Collection<Measure>`	`measures(String componentKey)`
`InputModule`	`module()`
`NewAnalysisError`	`newAnalysisError()` Builder to declare errors that happened while processing a source file.
`NewCoverage`	`newCoverage()` Builder to define coverage in a file.
`NewCpdTokens`	`newCpdTokens()` Builder to define CPD tokens 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`.
`NewSymbolTable`	`newSymbolTable()` Builder to define symbol table of a file.
`Collection<TextRange>`	`referencesForSymbolAt(String componentKey, int line, int lineOffset)` Return list of symbol references ranges for the symbol at a given position in a file.
`SonarRuntime`	`runtime()` Runtime information, mainly: to be able to have different behaviours between SonarQube and SonarLint to enable new features depending on version of API available at runtime
`SensorContextTester`	`setActiveRules(ActiveRules activeRules)`
`void`	`setCancelled(boolean cancelled)`
`SensorContextTester`	`setFileSystem(DefaultFileSystem fs)`
`SensorContextTester`	`setRuntime(SonarRuntime runtime)`
`SensorContextTester`	`setSettings(Settings settings)`
`Settings`	`settings()` Get settings of the current module.
`static Integer`	`sumOrNull(Integer o1, Integer o2)`

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)
```
  - create
```
public static SensorContextTester create(Path moduleBaseDir)
```
  - settings
```
public Settings settings()
```
    Description copied from interface: SensorContext
    
    Get settings of the current module.
    
    Specified by:
    
    settings in interface SensorContext
  - setSettings
```
public SensorContextTester setSettings(Settings settings)
```
  - fileSystem
```
public DefaultFileSystem fileSystem()
```
    Description copied from interface: SensorContext
    
    Get filesystem of the current module.
    
    Specified by:
    
    fileSystem in interface SensorContext
  - setFileSystem
```
public SensorContextTester 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 SensorContextTester setActiveRules(ActiveRules activeRules)
```
  - getSonarQubeVersion
```
public Version getSonarQubeVersion()
```
    Default value is the version of this API at compilation time. You can override it using setRuntime(SonarRuntime) to test your Sensor behaviour.
    
    Specified by:
    
    getSonarQubeVersion in interface SensorContext
    
    See Also:
    
    since version 6.0.
  - runtime
```
public SonarRuntime runtime()
```
    Description copied from interface: SensorContext
    Runtime information, mainly:
    - to be able to have different behaviours between SonarQube and SonarLint
    - to enable new features depending on version of API available at runtime
    Specified by:
    
    runtime in interface SensorContext
    
    See Also:
    
    to override defaults (SonarQube scanner with version of this API as used at compilation time).
  - setRuntime
```
public SensorContextTester setRuntime(SonarRuntime runtime)
```
  - isCancelled
```
public boolean isCancelled()
```
    Description copied from interface: SensorContext
    
    Test if a cancellation of the analysis was requested. Sensors should periodically test this flag and gracefully stop if value is true. For example it could be tested between each processed file.
    
    Specified by:
    
    isCancelled in interface SensorContext
  - setCancelled
```
public void setCancelled(boolean cancelled)
```
  - module
```
public InputModule module()
```
    Specified by:
    
    module 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(String componentKey)
```
  - measure
```
public <G extends Serializable> Measure<G> measure(String componentKey,
                                                   Metric<G> metric)
```
  - measure
```
public <G extends Serializable> Measure<G> measure(String componentKey,
                                                   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()
```
  - allAnalysisErrors
```
public Collection<AnalysisError> allAnalysisErrors()
```
  - lineHits
```
@CheckForNull
public Integer lineHits(String fileKey,
                                      int line)
```
  - sumOrNull
```
@CheckForNull
public static Integer sumOrNull(@Nullable
                                              Integer o1,
                                              @Nullable
                                              Integer o2)
```
  - conditions
```
@CheckForNull
public Integer conditions(String fileKey,
                                        int line)
```
  - coveredConditions
```
@CheckForNull
public Integer coveredConditions(String fileKey,
                                               int line)
```
  - maxOrNull
```
@CheckForNull
public static Integer maxOrNull(@Nullable
                                              Integer o1,
                                              @Nullable
                                              Integer o2)
```
  - cpdTokens
```
@CheckForNull
public List<TokensLine> cpdTokens(String componentKey)
```
  - 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
  - newCoverage
```
public NewCoverage newCoverage()
```
    Description copied from interface: SensorContext
    
    Builder to define coverage in a file. Don't forget to call NewCoverage.save().
    
    Specified by:
    
    newCoverage in interface SensorContext
  - newCpdTokens
```
public NewCpdTokens newCpdTokens()
```
    Description copied from interface: SensorContext
    
    Builder to define CPD tokens in a file. Don't forget to call NewCpdTokens.save().
    
    Specified by:
    
    newCpdTokens in interface SensorContext
  - newSymbolTable
```
public NewSymbolTable newSymbolTable()
```
    Description copied from interface: SensorContext
    
    Builder to define symbol table of a file. Don't forget to call NewSymbolTable.save() once all symbols are provided.
    
    Specified by:
    
    newSymbolTable in interface SensorContext
  - newAnalysisError
```
public NewAnalysisError newAnalysisError()
```
    Description copied from interface: SensorContext
    
    Builder to declare errors that happened while processing a source file. Don't forget to call NewAnalysisError.save().
    
    Specified by:
    
    newAnalysisError in interface SensorContext
  - highlightingTypeAt
```
public List<TypeOfText> highlightingTypeAt(String componentKey,
                                           int line,
                                           int lineOffset)
```
    Return list of syntax highlighting applied for a given position in a file. The result is a list because in theory you can apply several styles to the same range.
    
    Parameters:
    
    componentKey - Key of the file like 'myProjectKey:src/foo.php'
    
    line - Line you want to query
    
    lineOffset - Offset you want to query.
    
    Returns:
    
    List of styles applied to this position or empty list if there is no highlighting at this position.
  - referencesForSymbolAt
```
@CheckForNull
public Collection<TextRange> referencesForSymbolAt(String componentKey,
                                                                 int line,
                                                                 int lineOffset)
```
    Return list of symbol references ranges for the symbol at a given position in a file.
    
    Parameters:
    
    componentKey - Key of the file like 'myProjectKey:src/foo.php'
    
    line - Line you want to query
    
    lineOffset - Offset you want to query.
    
    Returns:
    
    List of references for the symbol (potentially empty) or null if there is no symbol at this position.
  - addContextProperty
```
public void addContextProperty(String key,
                               String value)
```
    Description copied from interface: SensorContext
    
    Add a property to the scanner context. This context is available in Compute Engine when processing the report.
    The properties starting with "sonar.analysis." are included to the payload of webhooks.
    
    Specified by:
    
    addContextProperty in interface SensorContext
    
    See Also:
    
    PostProjectAnalysisTask.ProjectAnalysis.getScannerContext()
  - getContextProperties
```
public Map<String,String> getContextProperties()
```
    Returns:
    
    an immutable map of the context properties defined with SensorContext.addContextProperty(String, String).
    
    Since:
    
    6.1
  - markForPublishing
```
public void markForPublishing(InputFile inputFile)
```
    Description copied from interface: SensorContext
    
    Indicate that a file should be published in the report sent to SonarQube. Files are automatically marked if any data is created for it (issues, highlighting, coverage, etc.).
    
    Specified by:
    
    markForPublishing in interface SensorContext

Class SensorContextTester

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

settings

setSettings

fileSystem

setFileSystem

activeRules

setActiveRules

getSonarQubeVersion

runtime

setRuntime

isCancelled

setCancelled

module

newMeasure

measures

measure

measure

newIssue

allIssues

allAnalysisErrors

lineHits

sumOrNull

conditions

coveredConditions

maxOrNull

cpdTokens

newHighlighting

newCoverage

newCpdTokens

newSymbolTable

newAnalysisError

highlightingTypeAt

referencesForSymbolAt

addContextProperty

getContextProperties

markForPublishing