Navigation
Unreal Engine C++ API Reference > Developer > AutomationController
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
Type | Name | Description | |
---|---|---|---|
![]() |
FOnSetResultsEvent | OnSetResults |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Virtual destructor |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | AddArtifact
(
const int32 ClusterIndex, |
|
![]() |
void | ClustersUpdated
(
const int32 NumClusters |
Updates the report when the number of clusters changes. |
![]() |
void | Empty () |
Remove all child tests |
![]() |
TSharedPtr< IAutomationReport > | EnsureReportExists
(
FAutomationTestInfo& TestInfo, |
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< TSharedPtr< IAutomationReport > > & | 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, |
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 FString & | Returns the name of this level in the test hierarchy for the purposes of grouping. | |
![]() ![]() |
FString | Returns the name of this level in the test hierarchy for the purposes of UI. | |
![]() |
const bool | GetDurationRange
(
float& OutMinTime, |
Gets the min and max time this test took to execute. |
![]() ![]() |
void | GetEnabledTestNames
(
TArray< FString >& OutEnabledTestNames, |
Gets the names of all the enabled tests |
![]() |
void | GetEnabledTestReports
(
TArray< TSharedPtr< IAutomationReport >>& OutReports |
Returns all the enabled test reports. |
![]() ![]() |
int32 | Recursively gets the number of enabled tests | |
![]() |
TSharedPtr< FAutomationTestExcludeOptions > | Produce exclude options . | |
![]() |
TArray< TSharedPtr< IAutomationReport > > & | Returns the array of child reports that should be visible to the UI based on filtering. | |
![]() ![]() |
void | GetFilteredTestNames
(
TArray< FString >& OutFilteredTestNames, |
Gets the names of all the filtered tests |
![]() ![]() |
const FString & | 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< IAutomationReport > | GetNextReportToExecute
(
bool& bOutAllTestsComplete, |
Returns the next test in the hierarchy to run. |
![]() ![]() |
const int32 | Get the number of devices which have been given this test to run. | |
![]() ![]() |
const int32 | 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 | ||
![]() |
const FAutomationTestResults & | GetResults
(
const int32 ClusterIndex, |
Gets a copy of errors and warnings that were found |
![]() ![]() |
FString | Gets the source file the test was defined on. | |
![]() ![]() |
int32 | Gets the source file line number the test was defined on. | |
![]() ![]() |
EAutomationState | GetState
(
const int32 ClusterIndex, |
Returns the state of the test (not run, in process, success, failure). |
![]() ![]() |
uint32 | GetTestFlags () |
Get the test type. |
![]() ![]() |
FString | Get the name of the asset associated with this test. | |
![]() ![]() |
int32 | Recursively gets the number of child nodes | |
![]() ![]() |
int32 | 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 | 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 |
![]() ![]() |
bool | IsToBeSkipped
(
FName* OutReason, |
Is the test need to be skipped. |
![]() ![]() |
bool | Is the test is to be skipped through propagation. | |
![]() ![]() |
bool | Is the test need to be skipped on specific conditions. | |
![]() |
void | ResetForExecution
(
const int32 NumTestPasses |
Recursively resets the report to "needs to be run", clears cached warnings and errors. |
![]() |
void | ||
![]() |
void | SetEnabled
(
bool bShouldBeEnabled |
Sets whether this test should be executed or not. |
![]() |
void | SetEnabledTests
(
const TArray< FString >& EnabledTests, |
Sets which tests are enabled based off the enabled tests list |
![]() |
bool | SetFilter
(
TSharedPtr< AutomationFilterCollection > InFilter, |
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, |
Sets the results of the test for use by the UI. |
![]() |
void | SetSkipFlag
(
bool bEnableSkip, |
Add or remove test from exclude list. |
![]() |
void | SetState
(
const EAutomationState State |
Set the state of the test (not run, in process, success, failure). |
![]() |
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 | Stop the test which is creating this report. |
Typedefs
Name | Description |
---|---|
FOnSetResultsEvent | Event that allows log to refresh once a test has finished. |