org.evomaster.client.java.instrumentation.staticstate

Class ExecutionTracer

java.lang.Object

org.evomaster.client.java.instrumentation.staticstate.ExecutionTracer

public class ExecutionTracer
extends Object

Methods of this class will be injected in the SUT to keep track of what the tests do execute/cover.

A problem here is that we can have threads left executing SUT instrumented classes after a HTTP call is finished, which can lead to an inconsistent state. So, we added thread synchronization. But issue of possible performance overhead, as this is done on every single instruction... :( Furthermore, this issue does not really seem to happen in Spring... as the sending of HTTP responses is not handled in the instrumented classes, but rather in the framework itself.

TODO sync only when necessary... however, currently the overhead seems minimal (but proper tests would be needed to confirm it)

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLETED_LAST_EXECUTED_STATEMENT_DESCRIPTOR
static String	COMPLETED_LAST_EXECUTED_STATEMENT_NAME
static String	EXECUTED_LINE_DESCRIPTOR
static String	EXECUTED_LINE_METHOD_NAME
static String	EXECUTING_BRANCH_JUMP_METHOD_NAME
static String	EXECUTING_METHOD_DESCRIPTOR
static String	EXECUTING_METHOD_METHOD_NAME
static String	JUMP_DESC_1_VALUE
static String	JUMP_DESC_2_VALUES
static String	JUMP_DESC_NULL
static String	JUMP_DESC_OBJECTS
static String	SET_LAST_CALLER_CLASS_DESC
static String	SET_LAST_CALLER_CLASS_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
ExecutionTracer()

Method Summary

Modifier and Type	Method and Description
static void	addEmployedDefaultWMHost(ExternalServiceInfo hostInfo) track what host uses the default WM
static void	addExternalServiceHost(ExternalServiceInfo hostInfo) To add the external service information to [AdditionalInfo]
static void	addHeader(String header)
static void	addHostnameInfo(HostnameResolutionInfo hostnameResolutionInfo) To add HostnameResolution information to [AdditionalInfo]
static void	addMongoCollectionType(MongoCollectionSchema mongoCollectionSchema)
static void	addMongoInfo(MongoFindCommand info)
static void	addParsedDtoName(String name)
static void	addQueryParameter(String param)
static void	addSqlInfo(SqlInfo info)
static void	addStringSpecialization(String taintInputName, StringSpecializationInfo info)
static void	completedLastExecutedStatement()
static void	executedLine(String className, String methodName, String descriptor, int line) Report on the fact that a given line has been executed.
static void	executedNumericComparison(String idTemplate, double lt, double eq, double gt)
static void	executedReplacedMethod(String idTemplate, ReplacementType type, Truthness t)
static void	executingBranchJump(int firstValue, int secondValue, int opcode, String className, int line, int branchId)
static void	executingBranchJump(int value, int opcode, String className, int line, int branchId)
static void	executingBranchJump(Object obj, int opcode, String className, int line, int branchId)
static void	executingBranchJump(Object first, Object second, int opcode, String className, int line, int branchId)
static void	executingMethod(String className, int line, int index, boolean completed) Report on whether method calls have been successfully completed.
static List<AdditionalInfo>	exposeAdditionalInfoList()
static String	getActionName()
static String	getDefaultSinkholeAddress()
static String	getExternalMappingForHostname(String hostname)
static String	getExternalMappingForSignature(String signature) Return the WireMock IP if there is a mapping for the hostname.
static Map<String,TargetInfo>	getInternalReferenceToObjectiveCoverage()
static String	getLastCallerClass()
static ClassLoader	getLastCallerClassLoader()
static String	getLastExecutedStatement()
static String	getLocalAddress(String hostname)
static Set<String>	getNonCoveredObjectives(String prefix)
static int	getNumberOfNonCoveredObjectives(String prefix) Note: only the objectives encountered so far can have been recorded.
static int	getNumberOfObjectives()
static int	getNumberOfObjectives(String prefix)
static String	getRemoteHostname(String localAddress) Return the respective remote hostname for the given local IP address
static TaintType	getTaintType(String input)
static Double	getValue(String id)
static void	handleExtraHeaderTaint(String left, String right)
static void	handleExtraParamTaint(String left, String right)
static void	handleTaintForStringEquals(String left, String right, boolean ignoreCase)
static boolean	hasActiveExternalMappingForSignature(String signature)
static boolean	hasLocalAddressForHost(String hostname) Check whether there is a local IP address available for the given remote hostname.
static boolean	hasMappingForLocalAddress(String localAddress) Checks for any replacement available to given local IP address.
static boolean	hasMockServerForHostname(String hostname)
static void	increaseExpensiveOperationCount()
static boolean	isExecutingAction()
static boolean	isExecutingInitSql()
static boolean	isKillSwitch()
static boolean	isTaintInput(String input) Check if the given input represented a tainted value from the test cases.
static boolean	isTooManyExpensiveOperations()
static void	markLastExecutedStatement(String lastLine, String lastMethod)
static void	markRawAccessOfHttpBodyPayload()
static void	reportSleeping()
static void	reset()
static void	setAction(Action action)
static void	setExecutingAction(boolean executingAction)
static void	setExecutingInitMongo(boolean executingInitMongo)
static void	setExecutingInitSql(boolean executingInitSql)
static void	setKillSwitch(boolean killSwitch)
static void	setLastCallerClass(String className)
static boolean	skipHostname(String hostname)
static boolean	skipHostnameAndPort(String hostname, int port)

Methods inherited from class java.lang.Object

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

Field Detail

SET_LAST_CALLER_CLASS_METHOD_NAME

public static final String SET_LAST_CALLER_CLASS_METHOD_NAME

See Also:

Constant Field Values

SET_LAST_CALLER_CLASS_DESC

public static final String SET_LAST_CALLER_CLASS_DESC

See Also:

Constant Field Values

COMPLETED_LAST_EXECUTED_STATEMENT_NAME

public static final String COMPLETED_LAST_EXECUTED_STATEMENT_NAME

See Also:

Constant Field Values

COMPLETED_LAST_EXECUTED_STATEMENT_DESCRIPTOR

public static final String COMPLETED_LAST_EXECUTED_STATEMENT_DESCRIPTOR

See Also:

Constant Field Values

EXECUTED_LINE_METHOD_NAME

public static final String EXECUTED_LINE_METHOD_NAME

See Also:

Constant Field Values

EXECUTED_LINE_DESCRIPTOR

public static final String EXECUTED_LINE_DESCRIPTOR

See Also:

Constant Field Values

EXECUTING_METHOD_METHOD_NAME

public static final String EXECUTING_METHOD_METHOD_NAME

See Also:

Constant Field Values

EXECUTING_METHOD_DESCRIPTOR

public static final String EXECUTING_METHOD_DESCRIPTOR

See Also:

Constant Field Values

EXECUTING_BRANCH_JUMP_METHOD_NAME

public static final String EXECUTING_BRANCH_JUMP_METHOD_NAME

See Also:

Constant Field Values

JUMP_DESC_1_VALUE

public static final String JUMP_DESC_1_VALUE

See Also:

Constant Field Values

JUMP_DESC_2_VALUES

public static final String JUMP_DESC_2_VALUES

See Also:

Constant Field Values

JUMP_DESC_OBJECTS

public static final String JUMP_DESC_OBJECTS

See Also:

Constant Field Values

JUMP_DESC_NULL

public static final String JUMP_DESC_NULL

See Also:

Constant Field Values

Constructor Detail

ExecutionTracer

public ExecutionTracer()

Method Detail

reset

public static void reset()

getActionName

public static String getActionName()

setLastCallerClass

public static void setLastCallerClass(String className)

getLastCallerClassLoader

public static ClassLoader getLastCallerClassLoader()

getLastCallerClass

public static String getLastCallerClass()

reportSleeping

public static void reportSleeping()

isKillSwitch

public static boolean isKillSwitch()

setKillSwitch

public static void setKillSwitch(boolean killSwitch)

isExecutingInitSql

public static boolean isExecutingInitSql()

setExecutingInitSql

public static void setExecutingInitSql(boolean executingInitSql)

setExecutingInitMongo

public static void setExecutingInitMongo(boolean executingInitMongo)

isExecutingAction

public static boolean isExecutingAction()

setExecutingAction

public static void setExecutingAction(boolean executingAction)

setAction

public static void setAction(Action action)

increaseExpensiveOperationCount

public static void increaseExpensiveOperationCount()

isTooManyExpensiveOperations

public static boolean isTooManyExpensiveOperations()

isTaintInput

public static boolean isTaintInput(String input)

Check if the given input represented a tainted value from the test cases. This could be based on static info of the input (eg, according to a precise name convention given by TaintInputName), or dynamic info given directly by the test itself (eg, the test at action can register a list of values to check for)

handleExtraParamTaint

public static void handleExtraParamTaint(String left,
                                         String right)

handleExtraHeaderTaint

public static void handleExtraHeaderTaint(String left,
                                          String right)

handleTaintForStringEquals

public static void handleTaintForStringEquals(String left,
                                              String right,
                                              boolean ignoreCase)

getTaintType

public static TaintType getTaintType(String input)

exposeAdditionalInfoList

public static List<AdditionalInfo> exposeAdditionalInfoList()

markRawAccessOfHttpBodyPayload

public static void markRawAccessOfHttpBodyPayload()

addParsedDtoName

public static void addParsedDtoName(String name)

addQueryParameter

public static void addQueryParameter(String param)

addHeader

public static void addHeader(String header)

addStringSpecialization

public static void addStringSpecialization(String taintInputName,
                                           StringSpecializationInfo info)

addSqlInfo

public static void addSqlInfo(SqlInfo info)

addMongoInfo

public static void addMongoInfo(MongoFindCommand info)

addMongoCollectionType

public static void addMongoCollectionType(MongoCollectionSchema mongoCollectionSchema)

markLastExecutedStatement

public static void markLastExecutedStatement(String lastLine,
                                             String lastMethod)

getLastExecutedStatement

public static String getLastExecutedStatement()

completedLastExecutedStatement

public static void completedLastExecutedStatement()

getInternalReferenceToObjectiveCoverage

public static Map<String,TargetInfo> getInternalReferenceToObjectiveCoverage()

getNumberOfObjectives

public static int getNumberOfObjectives()

Returns:

the number of objectives that have been encountered during the test execution

getNumberOfObjectives

public static int getNumberOfObjectives(String prefix)

getNumberOfNonCoveredObjectives

public static int getNumberOfNonCoveredObjectives(String prefix)

Note: only the objectives encountered so far can have been recorded. So, this is a relative value, not based on the code of the whole SUT (just the parts executed so far). Therefore, it is quite useless for binary values (ie 0 or 1), like current implementation of basic line coverage.

Parameters:

prefix - used for string matching of which objectives types to consider, eg only lines or only branches. Use "" or null to pick up everything

Returns:

getNonCoveredObjectives

public static Set<String> getNonCoveredObjectives(String prefix)

getValue

public static Double getValue(String id)

executedNumericComparison

public static void executedNumericComparison(String idTemplate,
                                             double lt,
                                             double eq,
                                             double gt)

executedReplacedMethod

public static void executedReplacedMethod(String idTemplate,
                                          ReplacementType type,
                                          Truthness t)

executedLine

public static void executedLine(String className,
                                String methodName,
                                String descriptor,
                                int line)

Report on the fact that a given line has been executed.

executingMethod

public static void executingMethod(String className,
                                   int line,
                                   int index,
                                   boolean completed)

Report on whether method calls have been successfully completed. Failures can happen due to thrown exceptions.

Parameters:

className -

line -

index - as there can be many method calls on same line, need to differentiate them

completed - whether the method call was successfully completed.

executingBranchJump

public static void executingBranchJump(int value,
                                       int opcode,
                                       String className,
                                       int line,
                                       int branchId)

executingBranchJump

public static void executingBranchJump(int firstValue,
                                       int secondValue,
                                       int opcode,
                                       String className,
                                       int line,
                                       int branchId)

executingBranchJump

public static void executingBranchJump(Object first,
                                       Object second,
                                       int opcode,
                                       String className,
                                       int line,
                                       int branchId)

executingBranchJump

public static void executingBranchJump(Object obj,
                                       int opcode,
                                       String className,
                                       int line,
                                       int branchId)

addHostnameInfo

public static void addHostnameInfo(HostnameResolutionInfo hostnameResolutionInfo)

To add HostnameResolution information to [AdditionalInfo]

addExternalServiceHost

public static void addExternalServiceHost(ExternalServiceInfo hostInfo)

To add the external service information to [AdditionalInfo]

addEmployedDefaultWMHost

public static void addEmployedDefaultWMHost(ExternalServiceInfo hostInfo)

track what host uses the default WM

getExternalMappingForSignature

public static String getExternalMappingForSignature(String signature)

Return the WireMock IP if there is a mapping for the hostname. If there is no mapping NULL will be returned

getExternalMappingForHostname

public static String getExternalMappingForHostname(String hostname)

hasActiveExternalMappingForSignature

public static boolean hasActiveExternalMappingForSignature(String signature)

hasMockServerForHostname

public static boolean hasMockServerForHostname(String hostname)

hasLocalAddressForHost

public static boolean hasLocalAddressForHost(String hostname)

Check whether there is a local IP address available for the given remote hostname.

hasMappingForLocalAddress

public static boolean hasMappingForLocalAddress(String localAddress)

Checks for any replacement available to given local IP address.

getRemoteHostname

public static String getRemoteHostname(String localAddress)

Return the respective remote hostname for the given local IP address

getLocalAddress

public static String getLocalAddress(String hostname)

getDefaultSinkholeAddress

public static String getDefaultSinkholeAddress()

skipHostname

public static boolean skipHostname(String hostname)

skipHostnameAndPort

public static boolean skipHostnameAndPort(String hostname,
                                          int port)