ExternalSutController (evomaster-client-java-controller 3.3.0 API)

java.lang.Object
- org.evomaster.client.java.controller.internal.SutController
- - org.evomaster.client.java.controller.ExternalSutController

All Implemented Interfaces:: CustomizationHandler, SutHandler

public abstract class ExternalSutController
extends SutController

Field Summary

Fields
Modifier and Type Field and Description

protected Process process

static String PROP_MUTE_SUT
System property to avoid printing the console output of the SUT.

Fields
Modifier and Type	Field and Description
`protected Process`	`process`
`static String`	`PROP_MUTE_SUT` System property to avoid printing the console output of the SUT.

Constructor Summary

Constructors
Constructor and Description

ExternalSutController()

Constructors
Constructor and Description
`ExternalSutController()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdditionalInfo>`	`getAdditionalInfoList()`
`List<TargetInfo>`	`getAllCoveredTargetInfos()`
`abstract String`	`getBaseURL()`
`BootTimeInfoDto`	`getBootTimeInfoDto()`
`String`	`getExecutableFullPath()`
`abstract String[]`	`getInputParameters()`
`void`	`getJvmDtoSchema(List<String> dtoNames)`
`abstract String[]`	`getJVMParameters()`
`abstract String`	`getLogMessageOfInitializedServer()`
`abstract long`	`getMaxAwaitForInitializationInSeconds()`
`abstract String`	`getPathToExecutableJar()`
`List<TargetInfo>`	`getTargetInfos(Collection<Integer> ids)`
`UnitsInfoDto`	`getUnitsInfoDto()`
`int`	`getWaitingSecondsForIncomingConnection()`
`boolean`	`isInstrumentationActivated()` Check if bytecode instrumentation is on.
`Boolean`	`isSUTInitialized()` a customized interface to implement for checking if the system under test is started.
`boolean`	`isSutRunning()` Check if the system under test (SUT) is running and fully initialized
`void`	`newActionSpecificHandler(ActionDto dto)`
`void`	`newSearch()` Re-initialize all internal data to enable a completely new search phase which should be independent from previous ones
`void`	`newTestSpecificHandler()`
`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`	`setExecutingAction(boolean executingAction)`
`void`	`setExecutingInitMongo(boolean executingInitMongo)`
`void`	`setExecutingInitSql(boolean executingInitSql)`
`void`	`setInstrumentation(boolean instrumentation)`
`ExternalSutController`	`setJaCoCo(String jaCoCoAgentLocation, String jaCoCoCliLocation, String jaCoCoOutputFile, int port)`
`ExternalSutController`	`setJavaCommand(String command)`
`void`	`setKillSwitch(boolean b)`
`void`	`setNeedsJdk17Options(boolean needsJdk17Options)`
`void`	`setupForGeneratedTest()` There might be different settings based on when the SUT is run during the search of EvoMaster, and when it is later started in the generated tests.
`protected void`	`startExternalProcessPrinter(boolean checkSutInitializedWithLog)`
`String`	`startSut()` Start a new instance of the SUT.
`void`	`stopSut()` Stop the SUT.

Methods inherited from class org.evomaster.client.java.controller.internal.SutController
addSuccessfulInitSqlInsertion, addTableToInserted, categorizeBasedOnResponse, cleanAccessedTables, computeExtraHeuristics, computeMongoHeuristics, customizeMockingDatabase, customizeMockingRPCExternalService, customizeRPCTestOutput, doEmploySmartDbClean, enableComputeSqlHeuristicsOrExtractExecution, execInsertionsIntoDatabase, execInsertionsIntoMongoDatabase, executeAction, executeHandleLocalAuthenticationSetup, executeRPCEndpoint, extractRPCProblemDto, extractRPCSchema, getActionIndex, getBootTimeInfoDto, getConnection, getConnectionIfExist, getControllerHost, getControllerPort, getControllerServerPort, getCustomizedValueInRequests, getDatabaseDriverName, getExceptionImportanceLevels, getExtraHeuristics, getInfoForAuthentication, getLocalAuthSetupSchemaMap, getPackagePrefixesToCover, getPreferredOutputFormat, getProblemInfo, getRPCClient, getRPCSchema, getSqlDatabaseSchema, getUnitsInfoDto, handleSeededTests, initMongoHandler, initSqlHandler, mockDatabasesWithCustomizedHandling, mockRPCExternalServicesWithCustomizedHandling, newAction, newTest, packagesToSkipInstrumentation, postSearchAction, readFileAsStringFromTestResource, registerOrExecuteInitSqlCommandsIfNeeded, registerOrExecuteInitSqlCommandsIfNeeded, resetCustomizedMethodForMockObject, resetDatabase, resetExtraHeuristics, seedRPCTests, setControllerHost, setControllerPort, specifyCustomizedNotNullAnnotation, startTheControllerServer, stopTheControllerServer, verifySqlConnection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.evomaster.client.java.controller.SutHandler
getDbSpecifications, getMongoConnection, handleLocalAuthenticationSetup, resetStateOfSUT

- Field Detail
  - PROP_MUTE_SUT
```
public static final String PROP_MUTE_SUT
```
    System property to avoid printing the console output of the SUT.
    
    See Also:
    
    Constant Field Values
  - process
```
protected volatile Process process
```
- Constructor Detail
  - ExternalSutController
```
public ExternalSutController()
```
- Method Detail
  - setJaCoCo
```
public final ExternalSutController setJaCoCo(String jaCoCoAgentLocation,
                                             String jaCoCoCliLocation,
                                             String jaCoCoOutputFile,
                                             int port)
```
  - getWaitingSecondsForIncomingConnection
```
public int getWaitingSecondsForIncomingConnection()
```
  - setupForGeneratedTest
```
public final void setupForGeneratedTest()
```
    Description copied from interface: SutHandler
    
    There might be different settings based on when the SUT is run during the search of EvoMaster, and when it is later started in the generated tests.
  - setNeedsJdk17Options
```
public void setNeedsJdk17Options(boolean needsJdk17Options)
```
  - setInstrumentation
```
public final 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. If there is the need to do something more sophisticated to check if the SUT has started, then this method should be left returning null, and rather override the method isSUTInitialized()
  - isSUTInitialized
```
public Boolean isSUTInitialized()
```
    a customized interface to implement for checking if the system under test is started. by default (returning null), such check is performed based on messages in log.
    
    Returns:
    
    Boolean representing if the system under test is up and ready.
  - getMaxAwaitForInitializationInSeconds
```
public abstract long getMaxAwaitForInitializationInSeconds()
```
    Returns:
    
    how long (in seconds) we should wait at most to check if SUT is ready and initialized (this related to the getLogMessageOfInitializedServer() method)
  - 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.
  - setJavaCommand
```
public final ExternalSutController setJavaCommand(String command)
```
  - startSut
```
public final String startSut()
```
    Description copied from interface: SutHandler
    
    Start a new instance of the SUT.
    
    This method must be blocking until the SUT is initialized.
    
    How this method is implemented depends on the library/framework in which the application is written. For example, in Spring applications you can use something like: SpringApplication.run()
    
    Returns:
    
    the base URL of the running SUT, eg "http://localhost:8080"
  - isSutRunning
```
public final boolean isSutRunning()
```
    Description copied from class: SutController
    
    Check if the system under test (SUT) is running and fully initialized
    
    How to implement this method depends on the library/framework used to build the application. In Spring applications, this can be done with something like: ctx != null && ctx.isRunning(), where ctx is a field where ConfigurableApplicationContext should be stored when starting the application.
    
    Specified by:
    
    isSutRunning in class SutController
    
    Returns:
    
    true if the SUT is running
  - stopSut
```
public final void stopSut()
```
    Description copied from interface: SutHandler
    
    Stop the SUT.
    
    How to implement this method depends on the library/framework in which the application is written. For example, in Spring applications you can save in a variable the ConfigurableApplicationContext returned when starting the application, and then call stop() on it here.
  - isInstrumentationActivated
```
public final boolean isInstrumentationActivated()
```
    Description copied from class: SutController
    
    Check if bytecode instrumentation is on.
    
    Specified by:
    
    isInstrumentationActivated in class SutController
    
    Returns:
    
    true if the instrumentation is on
  - 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
  - newTestSpecificHandler
```
public final void newTestSpecificHandler()
```
    Specified by:
    
    newTestSpecificHandler in class SutController
  - getTargetInfos
```
public final List<TargetInfo> getTargetInfos(Collection<Integer> ids)
```
    Specified by:
    
    getTargetInfos in class SutController
  - getAllCoveredTargetInfos
```
public final List<TargetInfo> getAllCoveredTargetInfos()
```
    Specified by:
    
    getAllCoveredTargetInfos in class SutController
  - getAdditionalInfoList
```
public final List<AdditionalInfo> getAdditionalInfoList()
```
    Specified by:
    
    getAdditionalInfoList in class SutController
    
    Returns:
    
    additional info for each action in the test. The list is ordered based on the action index.
  - getBootTimeInfoDto
```
public BootTimeInfoDto getBootTimeInfoDto()
```
    Specified by:
    
    getBootTimeInfoDto in class SutController
  - newActionSpecificHandler
```
public final void newActionSpecificHandler(ActionDto dto)
```
    Specified by:
    
    newActionSpecificHandler in class SutController
  - getUnitsInfoDto
```
public final UnitsInfoDto getUnitsInfoDto()
```
    Specified by:
    
    getUnitsInfoDto in class SutController
  - setKillSwitch
```
public final void setKillSwitch(boolean b)
```
    Specified by:
    
    setKillSwitch in class SutController
  - setExecutingInitSql
```
public final void setExecutingInitSql(boolean executingInitSql)
```
    Specified by:
    
    setExecutingInitSql in class SutController
  - setExecutingInitMongo
```
public final void setExecutingInitMongo(boolean executingInitMongo)
```
    Specified by:
    
    setExecutingInitMongo in class SutController
  - setExecutingAction
```
public final void setExecutingAction(boolean executingAction)
```
    Specified by:
    
    setExecutingAction in class SutController
  - getExecutableFullPath
```
public final String getExecutableFullPath()
```
    Specified by:
    
    getExecutableFullPath in class SutController
  - getJvmDtoSchema
```
public final void getJvmDtoSchema(List<String> dtoNames)
```
    Specified by:
    
    getJvmDtoSchema in class SutController
  - startExternalProcessPrinter
```
protected void startExternalProcessPrinter(boolean checkSutInitializedWithLog)
```

Class ExternalSutController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.evomaster.client.java.controller.internal.SutController

Methods inherited from class java.lang.Object

Methods inherited from interface org.evomaster.client.java.controller.SutHandler

Field Detail

PROP_MUTE_SUT

process

Constructor Detail

ExternalSutController

Method Detail

setJaCoCo

getWaitingSecondsForIncomingConnection

setupForGeneratedTest

setNeedsJdk17Options

setInstrumentation

getInputParameters

getJVMParameters

getBaseURL

getPathToExecutableJar

getLogMessageOfInitializedServer

isSUTInitialized

getMaxAwaitForInitializationInSeconds

preStart

postStart

preStop

postStop

setJavaCommand

startSut

isSutRunning

stopSut

isInstrumentationActivated

newSearch

newTestSpecificHandler

getTargetInfos

getAllCoveredTargetInfos

getAdditionalInfoList

getBootTimeInfoDto

newActionSpecificHandler

getUnitsInfoDto

setKillSwitch

setExecutingInitSql

setExecutingInitMongo

setExecutingAction

getExecutableFullPath

getJvmDtoSchema

startExternalProcessPrinter