IAutomationControllerManager

Syntax

class IAutomationControllerManager

Remarks

Interface for AutomationController .

Destructors

Name Description

Public function Virtual

~IAutomationControllerManager()

Virtual destructor.

Functions

Name Description

Public function

const bool

 

CheckTestResultsAvailable()

Check if the automation tests have completed.

Public function

void

 

CleanUpCheckpointFile()

Public function

void

 

ClearAutomationReports()

Remove results from the automation controller module.

Public function

const bool

 

ExportReport

(
    uint32 FileExportTypeMask
)

Generate an automation report.

Public function

TArray < FStr ...

 

GetCheckpointFileContents()

Public function

FArchive ...

 

GetCheckpointFileForWrite()

Public function

FString

 

GetClusterGroupName

(
    const int32 ClusterIndex
)

Get the group name of the specified cluster.

Public function

FString

 

GetDeviceTypeName

(
    const int32 ClusterIndex
)

Get name of a particular device cluster.

Public function

void

 

GetEnabledTestNames

(
    TArray < FString >& OutEnabledTestN...
)

Gets the names of all the enabled tests.

Public function

int32

 

GetEnabledTestsNum()

Returns number of tests that will be run.

Public function

FString

 

GetGameInstanceName

(
    const int32 ClusterIndex,
    const int32 DeviceIndex
)

Get a game instance name.

Public function

int32

 

GetNumDeviceClusters()

Get num devices types.

Public function

int32

 

GetNumDevicesInCluster

(
    const int32 ClusterIndex
)

Get num devices in specified cluster.

Public function

int32

 

GetNumPasses()

Get the number of test passes.

Public function

FString

 

GetReportOutputPath()

Public function

TArray < TSha ...

 

GetReports()

Gives the array of test results to the UI.

Public function

EAutomationC ...

 

GetTestState()

Gets the controller's current test state.

Public function

void

 

Init()

Initializes the automation controller.

Public function

bool

 

IsDeveloperDirectoryIncluded()

Returns whether the automation tests should include developer content directories.

Public function

bool

 

IsDeviceGroupFlagSet

Checks if a device group flag is set.

Public function

bool

 

IsSendAnalytics()

Returns if analytics should be sent

Public function

bool

 

IsTestRunnable

(
    IAutomationReportPtr InReport
)

Check that the test we are looking to run is runnable.

Public function

FOnAutomatio ...

 

OnControllerReset()

Gets a delegate that is invoked when the controller's reset.

Public function

FOnAutomatio ...

 

OnShutdown()

Gets the multicast delegate that is invoked when the controller manager shuts down.

Public function

FOnAutomatio ...

 

OnTestsAvailable()

Gets the multicast delegate that is invoked when the controller has tests available.

Public function

FOnAutomatio ...

 

OnTestsComplete()

Gets the test complete multicast delegate.

Public function

FOnAutomatio ...

 

OnTestsRefreshed()

Gets the multicast delegate that is invoked when the controller's test status changes.

Public function

void

 

RemoveCallbacks()

Removes all callbacks.

Public function

const bool

 

ReportsHaveErrors()

Check if the automation tests results have errors.

Public function

const bool

 

ReportsHaveLogs()

Check if the automation tests results have logs.

Public function

const bool

 

ReportsHaveWarnings()

Check if the automation tests results have warnings.

Public function

void

 

RequestAvailableWorkers

(
    const FGuid & InSessionId
)

Broadcast a request for workers to ping if they are available.

Public function

void

 

RequestLoadAsset

(
    const FString & InAssetName
)

Request an asset to be loaded in the editor.

Public function

void

 

RequestTests()

Send request for tests that are available to run.

Public function

void

 

ResetAutomationTestTimeout

(
    const TCHAR * Reason
)

Public function

void

 

RunTests

(
    const bool bIsLocalSession
)

Resets all enabled tests to be able to run during Tick by local/remote machines.

Public function

void

 

SetDeveloperDirectoryIncluded

(
    const bool bInDeveloperDirectoryInc...
)

Sets whether the automation tests should include developer content directories.

Public function

void

 

SetEnabledTests

(
    const TArray < FString >& EnabledTe...
)

Sets any tests that match a name in the enabled tests array.

Public function

void

 

SetFilter

Filters the visible list of tests.

Public function

void

 

SetNumPasses

(
    const int32 InNumPasses
)

Sets the number of test passes.

Public function

void

 

SetRequestedTestFlags

(
    const uint32 InRequestedTestFlags
)

Sets what flags we're considering automation tests from

Public function

void

 

SetSendAnalytics

(
    const bool bNewValue
)

Sets if analytics should be sent

Public function

void

 

SetVisibleTestsEnabled

(
    const bool bEnabled
)

Sets whether all visible tests are enabled or not.

Public function

void

 

Shutdown()

Shuts down the manager.

Public function

void

 

Startup()

Starts up the manager.

Public function

void

 

StopTests()

Stops all running tests.

Public function

void

 

Tick()

Tick function that will execute enabled tests for different device clusters.

Public function

void

 

ToggleDeviceGroupFlag

Toggles a device group flag.

Public function

void

 

UpdateDeviceGroups()

Updates the clusters when the device grouping changes.

Public function

void

 

WriteLineToCheckpointFile

(
    FString LineToWrite
)

Public function

void

 

WriteLoadedCheckpointDataToFile()

References

Module

AutomationController

Header

Developer/AutomationController/Public/IAutomationControllerManager.h