org.evomaster.clientJava.controller.internal

Class SutController

java.lang.Object

org.evomaster.clientJava.controller.internal.SutController

All Implemented Interfaces:

SutHandler

Direct Known Subclasses:

EmbeddedSutController, ExternalSutController

public abstract class SutController
extends Object
implements SutHandler

Abstract class used to connect to the EvoMaster process, and that is responsible to start/stop/restart the tested application, ie the system under test (SUT)

Constructor Summary

Constructors

Constructor and Description
SutController()

Method Summary

Modifier and Type	Method and Description
void	execInsertionsIntoDatabase(List<InsertionDto> insertions) Execute the given data insertions into the database (if any)
abstract Connection	getConnection() If the system under test (SUT) uses a SQL database, we need to have a configured connection to access it.
String	getControllerHost()
int	getControllerPort()
int	getControllerServerPort()
abstract String	getDatabaseDriverName() If the system under test (SUT) uses a SQL database, we need to specify the driver used to connect, eg.
abstract List<String>	getEndpointsToSkip() When testing a REST API, there might be some endpoints that are not so important to test.
ExtraHeuristicDto	getExtraHeuristics()
abstract List<AuthenticationDto>	getInfoForAuthentication() Provide a list of valid authentication credentials, or null if none is necessary
abstract String	getPackagePrefixesToCover() a "," separated list of package prefixes or class names.
DbSchemaDto	getSqlDatabaseSchema() Extra information about the SQL Database Schema, if any is present.
abstract List<TargetInfo>	getTargetInfos(Collection<Integer> ids)
abstract String	getUrlOfSwaggerJSON() Provide the URL of where the swagger.json can be found
void	handleSql(String sql) Calculate heuristics based on intercepted SQL commands
void	initSqlHandler() This is needed only during test generation (not execution), and it is automatically called by the EM controller after the SUT is started.
abstract boolean	isInstrumentationActivated() Check if bytecode instrumentation is on.
abstract boolean	isSutRunning() Check if the system under test (SUT) is running and fully initialized
abstract void	newAction(int actionIndex) As some heuristics are based on which action (eg HTTP call, or click of button) in the test sequence is executed, and their order, we need to keep track of which action does cover what.
abstract void	newSearch() Re-initialize all internal data to enable a completely new search phase which should be independent from previous ones
abstract void	newTest() Re-initialize some internal data needed before running a new test
void	resetExtraHeuristics()
void	setControllerHost(String controllerHost)
void	setControllerPort(int controllerPort)
boolean	startTheControllerServer() Start the controller as a RESTful server.
boolean	stopTheControllerServer()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.evomaster.clientJava.controller.SutHandler

resetStateOfSUT, startSut, stopSut

Constructor Detail

SutController

public SutController()

Method Detail

startTheControllerServer

public final boolean startTheControllerServer()

Start the controller as a RESTful server. Use the setters of this class to change the default port and host.
This method is blocking until the server is initialized.

stopTheControllerServer

public final boolean stopTheControllerServer()

getControllerServerPort

public final int getControllerServerPort()

Returns:

the actual port in use (eg, if it was an ephemeral 0)

getControllerPort

public final int getControllerPort()

setControllerPort

public final void setControllerPort(int controllerPort)

getControllerHost

public final String getControllerHost()

setControllerHost

public final void setControllerHost(String controllerHost)

execInsertionsIntoDatabase

public void execInsertionsIntoDatabase(List<InsertionDto> insertions)

Description copied from interface: SutHandler

Execute the given data insertions into the database (if any)

Specified by:

execInsertionsIntoDatabase in interface SutHandler

handleSql

public final void handleSql(String sql)

Calculate heuristics based on intercepted SQL commands

Parameters:

sql -

initSqlHandler

public final void initSqlHandler()

This is needed only during test generation (not execution), and it is automatically called by the EM controller after the SUT is started.

resetExtraHeuristics

public final void resetExtraHeuristics()

getExtraHeuristics

public final ExtraHeuristicDto getExtraHeuristics()

getSqlDatabaseSchema

public final DbSchemaDto getSqlDatabaseSchema()

Extra information about the SQL Database Schema, if any is present. Note: this is extracted by querying the database itself. So it must be up and running.

See Also:

getConnection()

newSearch

public abstract void newSearch()

Re-initialize all internal data to enable a completely new search phase which should be independent from previous ones

newTest

public abstract void newTest()

Re-initialize some internal data needed before running a new test

newAction

public abstract void newAction(int actionIndex)

As some heuristics are based on which action (eg HTTP call, or click of button) in the test sequence is executed, and their order, we need to keep track of which action does cover what.

isInstrumentationActivated

public abstract boolean isInstrumentationActivated()

Check if bytecode instrumentation is on.
This method needs to be overwritten if SUT is started in a new process.

Returns:

isSutRunning

public abstract boolean isSutRunning()

Check if the system under test (SUT) is running and fully initialized

Returns:

getPackagePrefixesToCover

public abstract String getPackagePrefixesToCover()

a "," separated list of package prefixes or class names. For example, "com.foo.,com.bar.Bar". Note: be careful of using something as general as "com." or "org.", as most likely ALL your third-party libraries would be instrumented as well, which could have a severe impact on performance

Returns:

getUrlOfSwaggerJSON

public abstract String getUrlOfSwaggerJSON()

Provide the URL of where the swagger.json can be found

Returns:

getInfoForAuthentication

public abstract List<AuthenticationDto> getInfoForAuthentication()

Provide a list of valid authentication credentials, or null if none is necessary

Returns:

getConnection

public abstract Connection getConnection()

If the system under test (SUT) uses a SQL database, we need to have a configured connection to access it.

Returns:

null if the SUT does not use any SQL database

getDatabaseDriverName

public abstract String getDatabaseDriverName()

If the system under test (SUT) uses a SQL database, we need to specify the driver used to connect, eg. org.h2.Driver. This is needed for when we intercept SQL commands with P6Spy

Returns:

null if the SUT does not use any SQL database

getTargetInfos

public abstract List<TargetInfo> getTargetInfos(Collection<Integer> ids)

getEndpointsToSkip

public abstract List<String> getEndpointsToSkip()

When testing a REST API, there might be some endpoints that are not so important to test. For example, in Spring, health-check endpoints like "/heapdump" are not so interesting to test, and they can be very expensive to run.

Returns:

a list of endpoints (as defined in schema) to skip