1. Epic GamesDeveloper
  3. IAutomationReport

IAutomationReport

Interface for automation test results

API > API/Developer > API/Developer/AutomationController

Interface for automation test results

   
Name IAutomationReport
Type class
Header File /Engine/Source/Developer/AutomationController/Public/IAutomationReport.h
Include Path #include "IAutomationReport.h"

Syntax

class IAutomationReport : public TSharedFromThis< IAutomationReport >

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IAutomationReport()

 Virtual destructor IAutomationReport.h  

Typedefs

Name Type Remarks Include Path
FOnSetResultsEvent TBaseDelegate_OneParam< void, TSharedPtr< IAutomationReport > > Event that allows log to refresh once a test has finished. IAutomationReport.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnSetResults FOnSetResultsEvent   IAutomationReport.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddArtifact ( const int32 ClusterIndex,
const int32 PassIndex,
const FAutomationArtifact& Artifact
)

   IAutomationReport.h  

void ClustersUpdated ( const int32 NumClusters
)

 Updates the report when the number of clusters changes. IAutomationReport.h  

void Empty()

 Remove all child tests IAutomationReport.h  

TSharedPtr< IAutomationReport > EnsureReportExists ( FAutomationTestInfo& TestInfo,
const int32 ClusterIndex,
const int32 NumPasses
)

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

const bool ExpandInUI()

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

FString GetAssetPath()

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

TArray< TSharedPtr< IAutomationReport > > & GetChildReports()

 Returns the array of child reports. IAutomationReport.h  
Returns the complete command for an automation test including any relevant parameters. IAutomationReport.h  

void GetCompletionStatus ( const int32 ClusterIndex,
const int32 PassIndex,
FAutomationCompleteState& OutCompletionState
)

 Returns completion statistics for this branch of the testing hierarchy. IAutomationReport.h  

const int32 GetCurrentPassIndex ( const int32 ClusterIndex
)

 Finds the current pass by looking at the current state IAutomationReport.h  

const FString & GetDisplayName ()

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

const bool GetDurationRange ( float& OutMinTime,
float& OutMaxTime
)

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

void GetEnabledTestNames ( TArray< FString >& OutEnabledTestNames,
FString CurrentPath
) const

 Gets the names of all the enabled tests IAutomationReport.h  

void GetEnabledTestReports ( TArray< TSharedPtr< IAutomationReport > >& OutReports
)

 Returns all the enabled test reports. IAutomationReport.h  

int32 GetEnabledTestsNum()

 Recursively gets the number of enabled tests IAutomationReport.h  

TSharedPtr< FAutomationTestExcludeOptions > GetExcludeOptions()

 Produce exclude options . IAutomationReport.h  

TArray< TSharedPtr< IAutomationReport > > & GetFilteredChildren()

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

void GetFilteredTestNames ( TArray< FString >& OutFilteredTestNames,
FString CurrentPath
) const

 Gets the names of all the filtered tests IAutomationReport.h  

const FString & GetFullTestPath()

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

FString GetGameInstanceName ( const int32 ClusterIndex
)

 Gets the name of the instance that ran the test. IAutomationReport.h  

TSharedPtr< IAutomationReport > GetNextReportToExecute ( bool& bOutAllTestsComplete,
const int32 ClusterIndex,
const int32 PassIndex,
const int32 NumDevicesInCluster
)

 Returns the next test in the hierarchy to run. IAutomationReport.h  

const int32 GetNumDevicesRunningTest()

 Get the number of devices which have been given this test to run. IAutomationReport.h  
Get the number of participants this test requires. IAutomationReport.h  

const int32 GetNumResults ( const int32 ClusterIndex
)

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

FString GetOpenCommand()

   IAutomationReport.h  

const FAutomationTestResults & GetResults ( const int32 ClusterIndex,
const int32 PassIndex
)

 Gets a copy of errors and warnings that were found IAutomationReport.h  

FString GetSourceFile()

 Gets the source file the test was defined on. IAutomationReport.h  

int32 GetSourceFileLine()

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

EAutomationState GetState ( const int32 ClusterIndex,
const int32 PassIndex
) const

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

FString GetTags()

 Get the tags associated with this test. IAutomationReport.h  

TArray< FString > GetTagsArray()

 Get the tags associated with this test, as an array. IAutomationReport.h  

EAutomationTestFlags GetTestFlags()

 Get the test type. IAutomationReport.h  

FString GetTestParameter()

 Get the name of the asset associated with this test. IAutomationReport.h  

int32 GetTotalNumChildren()

 Recursively gets the number of child nodes IAutomationReport.h  

int32 GetTotalNumFilteredChildren()

 Recursively gets the total number of filtered children IAutomationReport.h  

const bool HasErrors()

 Returns if there have been any errors in the test. IAutomationReport.h  

const bool HasWarnings()

 Returns if there have been any warnings in the test. IAutomationReport.h  

bool IncrementNetworkCommandResponses()

 Increment the number of network responses. IAutomationReport.h  

bool IsEnabled()

 Return if this test should be executed IAutomationReport.h  

const bool IsParent()

 Is this a parent type. IAutomationReport.h  

const bool IsSmokeTest()

 Is this a smoke test. IAutomationReport.h  

bool IsSupported ( const int32 ClusterIndex
) const

 Returns if a particular platform is supported IAutomationReport.h  

bool IsToBeSkipped ( FName* OutReason,
bool* OutWarn
) const

 Is the test need to be skipped. IAutomationReport.h  

bool IsToBeSkippedByPropagation()

 Is the test is to be skipped through propagation. IAutomationReport.h  

bool IsToBeSkippedOnConditions()

 Is the test need to be skipped on specific conditions. IAutomationReport.h  

void ResetForExecution ( const int32 NumTestPasses
)

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

void ResetNetworkCommandResponses()

   IAutomationReport.h  

void SetEnabled ( bool bShouldBeEnabled
)

 Sets whether this test should be executed or not. IAutomationReport.h  

void SetEnabledTests ( const TArray< FString >& EnabledTests,
FString CurrentPath
)

 Sets which tests are enabled based off the enabled tests list IAutomationReport.h  

bool SetFilter ( TSharedPtr< AutomationFilterCollection > InFilter,
const bool ParentPassedFilter
)

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

void SetNumParticipantsRequired ( const int32 NewCount
)

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

void SetResults ( const int32 ClusterIndex,
const int32 PassIndex,
const FAutomationTestResults& InResults
)

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

void SetSkipFlag ( bool bEnableSkip,
const FAutomationTestExcludelistEntry* Template,
bool bFromPropagation
)

 Add or remove test from exclude list. IAutomationReport.h  

void SetState ( const EAutomationState State
)

 Set the state of the test (not run, in process, success, failure). IAutomationReport.h  

void SetSupport ( const int32 ClusterIndex
)

 Sets whether this test is supported on a particular platform. IAutomationReport.h  

void SetTestFlags ( const EAutomationTestFlags InTestFlags
)

 Set the test flags. IAutomationReport.h  

void StopRunningTest()

 Stop the test which is creating this report. IAutomationReport.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page