eu.cqse.check.framework.checktest

Class CheckTestBase

java.lang.Object

eu.cqse.check.framework.checktest.CheckTestBase

@TestInstance(value=PER_CLASS)
public abstract class CheckTestBase
extends java.lang.Object

Parameterized test for check implementations. This base class is based on a mockup of the teamscale infrastructure used in production.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,CheckInfo>	checkInfoBySimpleClassName Maps simple class names to the corresponding check info.
protected java.lang.Class<?>	markerClass

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CheckTestBase(java.lang.Class<?> markerClass)

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,CheckInfo>	buildCheckInfoMap(java.lang.Class<?> clazz) Builds a map from simple class names to check infos.
static ELanguage	determineLanguage(CheckInfo checkInfo, java.lang.String uniformPath) Determines the language to use for the test file based on the ELanguages of the check and the ending of the uniform path.
protected void	runCheckAndAssertFindings(java.lang.String checkSimpleName, ExpectedDataContainer expectedDataContainer, java.util.Map<java.lang.String,java.lang.Object> options, java.util.Map<java.lang.String,CheckInfo> checkInfoBySimpleClassName) Asserts that the check executed on the given code file returns the findings as described by the findings string.
protected void	setUpCheckInfoMap()

Methods inherited from class java.lang.Object

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

Field Detail

checkInfoBySimpleClassName

protected java.util.Map<java.lang.String,CheckInfo> checkInfoBySimpleClassName

Maps simple class names to the corresponding check info.

markerClass

protected final java.lang.Class<?> markerClass

Constructor Detail

CheckTestBase

protected CheckTestBase(java.lang.Class<?> markerClass)

Method Detail

setUpCheckInfoMap

@BeforeEach
protected void setUpCheckInfoMap()
                                      throws java.io.IOException

Throws:

java.io.IOException

determineLanguage

public static ELanguage determineLanguage(CheckInfo checkInfo,
                                          java.lang.String uniformPath)

Determines the language to use for the test file based on the ELanguages of the check and the ending of the uniform path.

buildCheckInfoMap

public static java.util.Map<java.lang.String,CheckInfo> buildCheckInfoMap(java.lang.Class<?> clazz)
                                                                   throws java.io.IOException

Builds a map from simple class names to check infos. The simple class name must be unique. The rationale here is avoid classes with same name in different packages (confusing) but also make the test-data more readable. The clazz will be used to resolve the classpath to search for checks.

Throws:

java.io.IOException

runCheckAndAssertFindings

protected void runCheckAndAssertFindings(java.lang.String checkSimpleName,
                                         ExpectedDataContainer expectedDataContainer,
                                         java.util.Map<java.lang.String,java.lang.Object> options,
                                         java.util.Map<java.lang.String,CheckInfo> checkInfoBySimpleClassName)
                                  throws CheckException

Asserts that the check executed on the given code file returns the findings as described by the findings string.

Throws:

CheckException