IAutomationReport

Inheritance Hierarchy

TSharedFromThis

IAutomationReport

Syntax

class IAutomationReport : public TSharedFromThis< IAutomationReport >

Remarks

Interface for automation test results

Variables

Name Description

Public variable

FOnSetResultsEv ...

 

OnSetResults

Destructors

Name Description

Public function Virtual

~IAutomationReport()

Virtual destructor

Functions

Name Description

Public function

void

 

AddArtifact

(
    const int32 ClusterIndex,
    const int32 PassIndex,
    const FAutomationArtifact & Artifac...
)

Public function

void

 

ClustersUpdated

(
    const int32 NumClusters
)

Updates the report when the number of clusters changes.

Public function

void

 

Empty()

Remove all child tests

Public function

TSharedPtr < ...

 

EnsureReportExists

(
    FAutomationTestInfo & TestInfo,
    const int32 ClusterIndex,
    const int32 NumPasses
)

Add a child test to the hierarchy, creating internal tree nodes as needed.

Public function

const bool

 

ExpandInUI()

Should we expand this node in the UI - A child has passed the filter.

Public function

FString

 

GetAssetPath()

Gets the asset path associated with a test, it may not have one.

Public function

TArray < TSha ...

 

GetChildReports()

Returns the array of child reports.

Public function

FString

 

GetCommand()

Returns the complete command for an automation test including any relevant parameters.

Public function

void

 

GetCompletionStatus

(
    const int32 ClusterIndex,
    const int32 PassIndex,
    FAutomationCompleteState & OutCompl...
)

Returns completion statistics for this branch of the testing hierarchy.

Public function

const int32

 

GetCurrentPassIndex

(
    const int32 ClusterIndex
)

Finds the current pass by looking at the current state

Public function

const FStrin ...

 

GetDisplayName()

Returns the name of this level in the test hierarchy for the purposes of grouping.

Public function

FString

 

GetDisplayNameWithDecoration()

Returns the name of this level in the test hierarchy for the purposes of UI.

Public function

const bool

 

GetDurationRange

(
    float& OutMinTime,
    float& OutMaxTime
)

Gets the min and max time this test took to execute.

Public function

void

 

GetEnabledTestNames

(
    TArray < FString >& OutEnabledTestN...,
    FString CurrentPath
)

Gets the names of all the enabled tests

Public function

int32

 

GetEnabledTestsNum()

Recursively gets the number of enabled tests

Public function

TArray < TSha ...

 

GetFilteredChildren()

Returns the array of child reports that should be visible to the UI based on filtering.

Public function

const FStrin ...

 

GetFullTestPath()

Returns the full path for the test, e.g. System.Audio.PlaySoundTest.

Public function

FString

 

GetGameInstanceName

(
    const int32 ClusterIndex
)

Gets the name of the instance that ran the test.

Public function

TSharedPtr < ...

 

GetNextReportToExecute

(
    bool& bOutAllTestsComplete,
    const int32 ClusterIndex,
    const int32 PassIndex,
    const int32 NumDevicesInCluster
)

Returns the next test in the hierarchy to run.

Public function

const int32

 

GetNumDevicesRunningTest()

Get the number of devices which have been given this test to run.

Public function

const int32

 

GetNumParticipantsRequired()

Get the number of participants this test requires.

Public function

const int32

 

GetNumResults

(
    const int32 ClusterIndex
)

Gets the number of available test results for a given cluster.

Public function

FString

 

GetOpenCommand()

Public function

const FAutom ...

 

GetResults

(
    const int32 ClusterIndex,
    const int32 PassIndex
)

Gets a copy of errors and warnings that were found

Public function

FString

 

GetSourceFile()

Gets the source file the test was defined on.

Public function

int32

 

GetSourceFileLine()

Gets the source file line number the test was defined on.

Public function

EAutomationS ...

 

GetState

(
    const int32 ClusterIndex,
    const int32 PassIndex
)

Returns the state of the test (not run, in process, success, failure).

Public function

uint32

 

GetTestFlags()

Get the test type.

Public function

FString

 

GetTestParameter()

Get the name of the asset associated with this test.

Public function

int32

 

GetTotalNumChildren()

Recursively gets the number of child nodes

Public function

int32

 

GetTotalNumFilteredChildren()

Recursively gets the total number of filtered children

Public function

const bool

 

HasErrors()

Returns if there have been any errors in the test.

Public function

const bool

 

HasWarnings()

Returns if there have been any warnings in the test.

Public function

bool

 

IncrementNetworkCommandResponses()

Increment the number of network responses.

Public function

bool

 

IsEnabled()

Return if this test should be executed

Public function

const bool

 

IsParent()

Is this a parent type.

Public function

const bool

 

IsSmokeTest()

Is this a smoke test.

Public function

bool

 

IsSupported

(
    const int32 ClusterIndex
)

Returns if a particular platform is supported

Public function

void

 

ResetForExecution

(
    const int32 NumTestPasses
)

Recursively resets the report to "needs to be run", clears cached warnings and errors.

Public function

void

 

ResetNetworkCommandResponses()

Public function

void

 

SetEnabled

(
    bool bShouldBeEnabled
)

Sets whether this test should be executed or not.

Public function

void

 

SetEnabledTests

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

Sets which tests are enabled based off the enabled tests list

Public function

bool

 

SetFilter

(
    TSharedPtr < AutomationFilterCollect ...,
    const bool ParentPassedFilter
)

Filters the visible tests based on search text, execution status, regression test, etc.

Public function

void

 

SetNumParticipantsRequired

(
    const int32 NewCount
)

Set the number of participants this test requires if less than what is already set.

Public function

void

 

SetResults

(
    const int32 ClusterIndex,
    const int32 PassIndex,
    const FAutomationTestResults & InRe...
)

Sets the results of the test for use by the UI.

Public function

void

 

SetSupport

(
    const int32 ClusterIndex
)

Sets whether this test is supported on a particular platform.

Public function

void

 

SetTestFlags

(
    const uint32 InTestFlags
)

Set the test flags.

Public function

void

 

StopRunningTest()

Stop the test which is creating this report.

Typedefs

Name

Description

FOnSetResultsEvent

Event that allows log to refresh once a test has finished.

References

Module

AutomationController

Header

Developer/AutomationController/Public/IAutomationReport.h