Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > AutomationController > IAutomationReport

Light Theme

Dark Theme

IAutomationReport

Interface for automation test results

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

IAutomationReport

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

		Name	Description
	FOnSetResultsEv...	OnSetResults

Destructors

	Name	Description
	~IAutomationReport()	Virtual destructor

Functions

	Name	Description
void	AddArtifact ( const int32 ClusterIndex, const int32 PassIndex, const FAutomationArtifact& Artifac... )
void	ClustersUpdated ( const int32 NumClusters )	Updates the report when the number of clusters changes.
void	Empty()	Remove all child tests
TSharedPtr< ...	EnsureReportExists ( FAutomationTestInfo& TestInfo, const int32 ClusterIndex, const int32 NumPasses )	Add a child test to the hierarchy, creating internal tree nodes as needed.
const bool	ExpandInUI()	Should we expand this node in the UI - A child has passed the filter.
FString	GetAssetPath()	Gets the asset path associated with a test, it may not have one.
TArray< TSha...	GetChildReports()	Returns the array of child reports.
FString	GetCommand()	Returns the complete command for an automation test including any relevant parameters.
void	GetCompletionStatus ( const int32 ClusterIndex, const int32 PassIndex, FAutomationCompleteState& OutCompl... )	Returns completion statistics for this branch of the testing hierarchy.
const int32	GetCurrentPassIndex ( const int32 ClusterIndex )	Finds the current pass by looking at the current state
const FStrin...	GetDisplayName()	Returns the name of this level in the test hierarchy for the purposes of grouping.
FString	GetDisplayNameWithDecoration()	Returns the name of this level in the test hierarchy for the purposes of UI.
const bool	GetDurationRange ( float& OutMinTime, float& OutMaxTime )	Gets the min and max time this test took to execute.
void	GetEnabledTestNames ( TArray< FString >& OutEnabledTestN..., FString CurrentPath )	Gets the names of all the enabled tests
int32	GetEnabledTestsNum()	Recursively gets the number of enabled tests
TArray< TSha...	GetFilteredChildren()	Returns the array of child reports that should be visible to the UI based on filtering.
const FStrin...	GetFullTestPath()	Returns the full path for the test, e.g. System.Audio.PlaySoundTest.
FString	GetGameInstanceName ( const int32 ClusterIndex )	Gets the name of the instance that ran the test.
TSharedPtr< ...	GetNextReportToExecute ( bool& bOutAllTestsComplete, const int32 ClusterIndex, const int32 PassIndex, const int32 NumDevicesInCluster )	Returns the next test in the hierarchy to run.
const int32	GetNumDevicesRunningTest()	Get the number of devices which have been given this test to run.
const int32	GetNumParticipantsRequired()	Get the number of participants this test requires.
const int32	GetNumResults ( const int32 ClusterIndex )	Gets the number of available test results for a given cluster.
FString	GetOpenCommand()
const FAutom...	GetResults ( const int32 ClusterIndex, const int32 PassIndex )	Gets a copy of errors and warnings that were found
FString	GetSourceFile()	Gets the source file the test was defined on.
int32	GetSourceFileLine()	Gets the source file line number the test was defined on.
EAutomationS...	GetState ( const int32 ClusterIndex, const int32 PassIndex )	Returns the state of the test (not run, in process, success, failure).
uint32	GetTestFlags()	Get the test type.
FString	GetTestParameter()	Get the name of the asset associated with this test.
int32	GetTotalNumChildren()	Recursively gets the number of child nodes
int32	GetTotalNumFilteredChildren()	Recursively gets the total number of filtered children
const bool	HasErrors()	Returns if there have been any errors in the test.
const bool	HasWarnings()	Returns if there have been any warnings in the test.
bool	IncrementNetworkCommandResponses()	Increment the number of network responses.
bool	IsEnabled()	Return if this test should be executed
const bool	IsParent()	Is this a parent type.
const bool	IsSmokeTest()	Is this a smoke test.
bool	IsSupported ( const int32 ClusterIndex )	Returns if a particular platform is supported
void	ResetForExecution ( const int32 NumTestPasses )	Recursively resets the report to "needs to be run", clears cached warnings and errors.
void	ResetNetworkCommandResponses()
void	SetEnabled ( bool bShouldBeEnabled )	Sets whether this test should be executed or not.
void	SetEnabledTests ( const TArray< FString >& EnabledTe..., FString CurrentPath )	Sets which tests are enabled based off the enabled tests list
bool	SetFilter ( TSharedPtr< AutomationFilterCollect..., const bool ParentPassedFilter )	Filters the visible tests based on search text, execution status, regression test, etc.
void	SetNumParticipantsRequired ( const int32 NewCount )	Set the number of participants this test requires if less than what is already set.
void	SetResults ( const int32 ClusterIndex, const int32 PassIndex, const FAutomationTestResults& InRe... )	Sets the results of the test for use by the UI.
void	SetSupport ( const int32 ClusterIndex )	Sets whether this test is supported on a particular platform.
void	SetTestFlags ( const uint32 InTestFlags )	Set the test flags.
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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss