org.evomaster.clientJava.controller

Class ExternalSutController

java.lang.Object

org.evomaster.clientJava.controller.internal.SutController

org.evomaster.clientJava.controller.ExternalSutController

All Implemented Interfaces:

SutHandler

public abstract class ExternalSutController
extends SutController

Field Summary

Fields

Modifier and Type	Field and Description
protected Process	process

Constructor Summary

Constructors

Constructor and Description
ExternalSutController()

Method Summary

Modifier and Type	Method and Description
abstract String	getBaseURL()
abstract String[]	getInputParameters()
abstract String[]	getJVMParameters()
abstract String	getLogMessageOfInitializedServer()
abstract long	getMaxAwaitForInitializationInSeconds() How long (in seconds) we should wait at most to check if SUT is ready and initialized (this related to the getLogMessageOfInitializedServer() method)
abstract String	getPathToExecutableJar()
List<org.evomaster.clientJava.instrumentation.TargetInfo>	getTargetInfos(Collection<Integer> ids)
boolean	isInstrumentationActivated() Check if bytecode instrumentation is on.
boolean	isSutRunning() Check if the system under test (SUT) is running and fully initialized
void	newSearch() Re-initialize all internal data to enable a completely new search phase which should be independent from previous ones
void	newTest() Re-initialize some internal data needed before running a new test
abstract void	postStart() This method is going to be called after the SUT is started.
abstract void	postStop() If the SUT needs some third-party processes (eg a non-embedded database), here we can shut them down once the SUT has been stopped.
abstract void	preStart() If the SUT needs some third-party processes (eg a non-embedded database), here they can be configured and started.
abstract void	preStop() This method is going to be called before the SUT is stopped.
void	setInstrumentation(boolean instrumentation)
protected void	startExternalProcessPrinter()
String	startSut() Start a new instance of the SUT.
void	stopSut() Stop the system under test

Methods inherited from class org.evomaster.clientJava.controller.internal.SutController

getControllerHost, getControllerPort, getControllerServerPort, getInfoForAuthentication, getPackagePrefixesToCover, getUrlOfSwaggerJSON, setControllerHost, setControllerPort, startTheControllerServer, 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

Field Detail

process

protected volatile Process process

Constructor Detail

ExternalSutController

public ExternalSutController()

Method Detail

setInstrumentation

public void setInstrumentation(boolean instrumentation)

getInputParameters

public abstract String[] getInputParameters()

Returns:

the input parameters with which the system under test should be started

getJVMParameters

public abstract String[] getJVMParameters()

Returns:

the JVM parameters (eg -X and -D) with which the system under test should be started

getBaseURL

public abstract String getBaseURL()

Returns:

the base URL of the running SUT, eg "http://localhost:8080". Note: this value will likely depend on how getInputParameters() has been implemented

getPathToExecutableJar

public abstract String getPathToExecutableJar()

Returns:

a String representing either a relative or absolute path to the where the JAR of the system under test is located

getLogMessageOfInitializedServer

public abstract String getLogMessageOfInitializedServer()

Returns:

a string subtext that should be present in the logs (std output) of the system under test to check if the server is up and ready.

getMaxAwaitForInitializationInSeconds

public abstract long getMaxAwaitForInitializationInSeconds()

How long (in seconds) we should wait at most to check if SUT is ready and initialized (this related to the getLogMessageOfInitializedServer() method)

Returns:

preStart

public abstract void preStart()

If the SUT needs some third-party processes (eg a non-embedded database), here they can be configured and started. This method is going to be called before we start the SUT.

postStart

public abstract void postStart()

This method is going to be called after the SUT is started.

preStop

public abstract void preStop()

This method is going to be called before the SUT is stopped.

postStop

public abstract void postStop()

If the SUT needs some third-party processes (eg a non-embedded database), here we can shut them down once the SUT has been stopped.

startSut

public String startSut()

Description copied from interface: SutHandler

Start a new instance of the SUT.
This method must be blocking.

Returns:

the base URL of the running SUT, eg "http://localhost:8080"

isSutRunning

public boolean isSutRunning()

Description copied from class: SutController

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

Specified by:

isSutRunning in class SutController

Returns:

stopSut

public void stopSut()

Description copied from interface: SutHandler

Stop the system under test

isInstrumentationActivated

public final boolean isInstrumentationActivated()

Description copied from class: SutController

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

Specified by:

isInstrumentationActivated in class SutController

Returns:

newSearch

public final void newSearch()

Description copied from class: SutController

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

Specified by:

newSearch in class SutController

newTest

public final void newTest()

Description copied from class: SutController

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

Specified by:

newTest in class SutController

getTargetInfos

public final List<org.evomaster.clientJava.instrumentation.TargetInfo> getTargetInfos(Collection<Integer> ids)

Specified by:

getTargetInfos in class SutController

startExternalProcessPrinter

protected void startExternalProcessPrinter()