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
String	getControllerHost()
int	getControllerPort()
int	getControllerServerPort()
abstract List<org.evomaster.clientJava.controllerApi.dto.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.
abstract List<org.evomaster.clientJava.instrumentation.TargetInfo>	getTargetInfos(Collection<Integer> ids)
abstract String	getUrlOfSwaggerJSON() Provide the URL of where the swagger.json can be found
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	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	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)

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

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 generate 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<org.evomaster.clientJava.controllerApi.dto.AuthenticationDto> getInfoForAuthentication()

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

Returns:

getTargetInfos

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