eu.cqse.check.framework.checktest

Class TestCheckContext

java.lang.Object

eu.cqse.check.framework.checktest.TestTokenElementContext

eu.cqse.check.framework.checktest.TestCheckContext

All Implemented Interfaces:

ICheckContext, ITokenElementContext

public class TestCheckContext
extends TestTokenElementContext
implements ICheckContext

The context implementation used during testing. This context can maintain filtered and unfiltered code separate from each other. However, if the filtered and unfiltered content is different, the line numbers of created findings might not be correct because we cannot convert between filtered and unfiltered offsets like normal teamscale. Therefore, line numbers for reported findings might be wrong in the test context depending on which code (filtered or unfiltered) the custom check computes its finding offsets.

Constructor Summary

Constructors

Constructor and Description
TestCheckContext(java.io.File codeFile, CheckInfo checkInfo) Constructor.
TestCheckContext(java.lang.String uniformPath, java.lang.String code, CheckInfo checkInfo)
TestCheckContext(java.lang.String uniformPath, java.lang.String unfilteredCode, java.util.List<java.util.regex.Pattern> filterPatterns, CheckInfo checkInfo)

Method Summary

Modifier and Type	Method and Description
protected void	accessAst() Template method that is called before accessing the AST.
<T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.function.Function<java.lang.String,java.util.List<T>>	accessPhaseInvertedResult(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass) Returns an accessor function to read inverted results of the provided phase.
<T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.function.Function<java.lang.String,java.util.List<T>>	accessPhaseResult(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass) Returns an accessor function to read results of the provided phase.
protected void	accessTypeResolution() Template method called before accessing type resolution.
void	createFindingForElement(java.lang.String message) Creates a finding with the given message for the whole analyzed token element.
void	createFindingForLines(java.lang.String message, int startLine, int endLine, ECodeViewOption.ETextViewOption view) Creates a finding with the given message from the given start line (inclusive) to the given end line (inclusive).
void	createFindingForOffsets(java.lang.String message, int startOffset, int endOffset, ECodeViewOption.ETextViewOption view) Creates a finding with the given message from the given start offset (inclusive) to the given end offset (inclusive).
void	createFindingForSiblings(java.lang.String message, CheckTextRegionLocation mainLocation, java.util.List<CheckTextRegionLocation> siblingLocations) Creates one finding for the given message and main location.
void	createFindingForSiblingsInCurrentFile(java.lang.String message, java.util.List<OffsetBasedRegion> regions) Creates a finding for each entry in the given List of OffsetBasedRegion with the given message from the given start offsets (inclusive) to the corresponding end offsets (inclusive).
CheckInfo	getCheckInfo()
java.lang.StringBuilder	getFindings()
java.lang.String	getFindingsString() Returns a string representation of the findings found.
<T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.List<java.lang.String>	listAllPhaseValues(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass) Returns all values that have been extracted by the phase.

Methods inherited from class eu.cqse.check.framework.checktest.TestTokenElementContext

getAbstractSyntaxTree, getClangTranslationUnitWrapper, getFilteredOffset, getLanguage, getRootEntity, getTextContent, getTokens, getTypeResolution, getUniformPath, isInFilteredRegion

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cqse.check.framework.core.phase.ITokenElementContext

calculateLocalPreprocessedTokens, getAbstractSyntaxTree, getClangTranslationUnitWrapper, getLanguage, getRootEntity, getTextContent, getTokens, getTypeResolution, getUniformPath

Constructor Detail

TestCheckContext

public TestCheckContext(java.io.File codeFile,
                        CheckInfo checkInfo)
                 throws java.io.IOException

Constructor.

Throws:

java.io.IOException

TestCheckContext

public TestCheckContext(java.lang.String uniformPath,
                        java.lang.String code,
                        CheckInfo checkInfo)

TestCheckContext

public TestCheckContext(java.lang.String uniformPath,
                        java.lang.String unfilteredCode,
                        java.util.List<java.util.regex.Pattern> filterPatterns,
                        CheckInfo checkInfo)

Method Detail

createFindingForElement

public void createFindingForElement(java.lang.String message)

Description copied from interface: ICheckContext

Creates a finding with the given message for the whole analyzed token element.

Specified by:

createFindingForElement in interface ICheckContext

getFindingsString

public java.lang.String getFindingsString()

Returns a string representation of the findings found.

getFindings

public java.lang.StringBuilder getFindings()

See Also:

findingsStringBuilder

getCheckInfo

public CheckInfo getCheckInfo()

See Also:

checkInfo

createFindingForLines

public void createFindingForLines(java.lang.String message,
                                  int startLine,
                                  int endLine,
                                  ECodeViewOption.ETextViewOption view)

Description copied from interface: ICheckContext

Creates a finding with the given message from the given start line (inclusive) to the given end line (inclusive). Provide the ECodeViewOption.ETextViewOption that was used to get the token stream. If textView is ECodeViewOption.ETextViewOption.UNFILTERED_CONTENT and the finding refers to filtered code, then it will be ignored.

Specified by:

createFindingForLines in interface ICheckContext

createFindingForOffsets

public void createFindingForOffsets(java.lang.String message,
                                    int startOffset,
                                    int endOffset,
                                    ECodeViewOption.ETextViewOption view)

Description copied from interface: ICheckContext

Creates a finding with the given message from the given start offset (inclusive) to the given end offset (inclusive). Provide the ECodeViewOption.ETextViewOption that was used to get the token stream. If textView is ECodeViewOption.ETextViewOption.UNFILTERED_CONTENT and the finding refers to filtered code, then it will be ignored.

Specified by:

createFindingForOffsets in interface ICheckContext

createFindingForSiblingsInCurrentFile

public void createFindingForSiblingsInCurrentFile(java.lang.String message,
                                                  java.util.List<OffsetBasedRegion> regions)

Description copied from interface: ICheckContext

Creates a finding for each entry in the given List of OffsetBasedRegion with the given message from the given start offsets (inclusive) to the corresponding end offsets (inclusive). Offsets must be based on filtered content (ECodeViewOption.ETextViewOption.FILTERED_CONTENT).

Specified by:

createFindingForSiblingsInCurrentFile in interface ICheckContext

createFindingForSiblings

public void createFindingForSiblings(java.lang.String message,
                                     CheckTextRegionLocation mainLocation,
                                     java.util.List<CheckTextRegionLocation> siblingLocations)

Description copied from interface: ICheckContext

Creates one finding for the given message and main location. Adds the given siblingLocations as siblings to the new finding. The list of sibling locations must not contain the main location. All offsets/line numbers are based on ECodeViewOption.ETextViewOption.UNFILTERED_CONTENT.

Specified by:

createFindingForSiblings in interface ICheckContext

accessAst

protected void accessAst()

Description copied from class: TestTokenElementContext

Template method that is called before accessing the AST.

Overrides:

accessAst in class TestTokenElementContext

accessTypeResolution

protected void accessTypeResolution()

Description copied from class: TestTokenElementContext

Template method called before accessing type resolution.

Overrides:

accessTypeResolution in class TestTokenElementContext

accessPhaseResult

public <T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.function.Function<java.lang.String,java.util.List<T>> accessPhaseResult(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass)

Description copied from interface: ICheckContext

Returns an accessor function to read results of the provided phase. The accessor returns the values for a given uniform path.

Specified by:

accessPhaseResult in interface ICheckContext

accessPhaseInvertedResult

public <T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.function.Function<java.lang.String,java.util.List<T>> accessPhaseInvertedResult(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass)

Description copied from interface: ICheckContext

Returns an accessor function to read inverted results of the provided phase. The accessor returns the values for a given value.

Specified by:

accessPhaseInvertedResult in interface ICheckContext

listAllPhaseValues

public <T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.List<java.lang.String> listAllPhaseValues(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass)

Description copied from interface: ICheckContext

Returns all values that have been extracted by the phase. This is potentially expensive if a lot of values are expected from a phase. For phases with few expected values, this can be used safely.

Specified by:

listAllPhaseValues in interface ICheckContext