1. Epic GamesDeveloper
  3. IAutomationReport

IAutomationReport

Interface for automation test results

API > API/Developer > API/Developer/AutomationController

Inheritance Hierarchy

References

   
Module AutomationController
Header /Engine/Source/Developer/AutomationController/Public/IAutomationReport.h
Include #include "IAutomationReport.h"

Syntax

class IAutomationReport : public TSharedFromThis< IAutomationReport >

Remarks

Interface for automation test results

Variables

  Type Name Description
Public variable FOnSetResultsEvent OnSetResults  

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function void

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

  
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< IAutomationReport >

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 const bool Should we expand this node in the UI - A child has passed the filter.
Public function Const FString Gets the asset path associated with a test, it may not have one.
Public function TArray< TSharedPtr< IAutomationReport > > & Returns the array of child reports.
Public function Const FString Returns the complete command for an automation test including any relevant parameters.
Public function void

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

 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 const FString & Returns the name of this level in the test hierarchy for the purposes of grouping.
Public function Const FString 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 Const void

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

 Gets the names of all the enabled tests
Public function void Returns all the enabled test reports.
Public function Const int32 Recursively gets the number of enabled tests
Public function TSharedPtr< FAutomationTestExcludeOptions > Produce exclude options .
Public function TArray< TSharedPtr< IAutomationReport > > & Returns the array of child reports that should be visible to the UI based on filtering.
Public function Const void

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

 Gets the names of all the filtered tests
Public function Const const FString & 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< IAutomationReport >

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

 Returns the next test in the hierarchy to run.
Public function Const const int32 Get the number of devices which have been given this test to run.
Public function Const const int32 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 Const FString  
Public function const FAutomationTestResults &

GetResults ( const int32 ClusterIndex,
const int32 PassIndex
)

 Gets a copy of errors and warnings that were found
Public function Const FString Gets the source file the test was defined on.
Public function Const int32 Gets the source file line number the test was defined on.
Public function Const EAutomationState

GetState ( const int32 ClusterIndex,
const int32 PassIndex
)

 Returns the state of the test (not run, in process, success, failure).
Public function Const uint32 Get the test type.
Public function Const FString Get the name of the asset associated with this test.
Public function Const int32 Recursively gets the number of child nodes
Public function Const int32 Recursively gets the total number of filtered children
Public function const bool Returns if there have been any errors in the test.
Public function const bool Returns if there have been any warnings in the test.
Public function bool Increment the number of network responses.
Public function Const bool Return if this test should be executed
Public function const bool Is this a parent type.
Public function const bool Is this a smoke test.
Public function Const bool

IsSupported ( const int32 ClusterIndex
)

 Returns if a particular platform is supported
Public function Const bool

IsToBeSkipped ( FName* OutReason,
bool* OutWarn
)

 Is the test need to be skipped.
Public function Const bool Is the test is to be skipped through propagation.
Public function Const bool Is the test need to be skipped on specific conditions.
Public function void

ResetForExecution ( const int32 NumTestPasses
)

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

SetEnabled ( bool bShouldBeEnabled
)

 Sets whether this test should be executed or not.
Public function void

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

 Sets which tests are enabled based off the enabled tests list
Public function bool

SetFilter ( TSharedPtr< AutomationFilterCollection > InFilter,
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& InResults
)

 Sets the results of the test for use by the UI.
Public function void

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

 Add or remove test from exclude list.
Public function void

SetState ( const EAutomationState State
)

 Set the state of the test (not run, in process, success, failure).
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 Stop the test which is creating this report.

Typedefs

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page