1. Epic GamesDeveloper
  3. FAutomationTestBase

FAutomationTestBase

Simple abstract base class for all automation tests

Unreal Engine C++ API Reference > Runtime > Core > Misc

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/AutomationTest.h
Include #include "Misc/AutomationTest.h"

Syntax

class FAutomationTestBase

Remarks

Simple abstract base class for all automation tests

Variables

  Type Name Description
Protected variable bool bComplexTask Flag to indicate if this is a complex task.
Protected variable bool bRunOnSeparateThread Flag to indicate if this test should be ran on it's own thread.
Protected variable bool bSuppressLogs Flag to suppress logs
Protected variable FAutomationTestExecutionInfo ExecutionInfo Info related to the last execution of this test
Protected variable FString TestName Name of the test
Protected variable FString TestParameterContext Context of the test

Constructors

  Type Name Description
Public function  

FAutomationTestBase ( const FString& InName,
const bool bInComplexTask
)

 Constructor

Destructors

  Type Name Description
Public function Virtual   Destructor

Functions

  Type Name Description
Public function Virtual void

AddAnalyticsItem ( const FString& InAnalyticsItem
)

 Adds a analytics string to parse later
Public function void Enqueues a new latent network command.
Public function void Enqueues a new latent command.
Public function Virtual void

AddError ( const FString& InError,
int32 StackOffset
)

 Adds an error message to this test
Public function Virtual bool

AddErrorIfFalse ( bool bCondition,
const FString& InError,
int32 StackOffset
)

 Adds an error message to this test if the condition is false
Public function Virtual void

AddErrorS ( const FString& InError,
const FString& InFilename,
int32 InLineNumber
)

 Adds an error message to this test
Public function Virtual void

AddEvent ( const FAutomationEvent& InEvent,
int32 StackOffset,
bool bCaptureStack
)

 Adds an automation event directly into the execution log.
Public function void

AddExpectedError ( FString ExpectedPatternString,
EAutomationExpectedErrorFlags::MatchType CompareType,
int32 Occurrences
)

 Adds a regex pattern to an internal list that this test will expect to encounter in error or warning logs during its execution.
Public function void

AddExpectedMessage ( FString ExpectedPatternString,
ELogVerbosity::Type ExpectedVerbosity,
EAutomationExpectedMessageFlags::MatchType CompareType,
int32 Occurrences
)

 Adds a regex pattern to an internal list that this test will expect to encounter in logs (of the specified verbosity) during its execution.
Public function void

AddExpectedMessage ( FString ExpectedPatternString,
EAutomationExpectedMessageFlags::MatchType CompareType,
int32 Occurrences
)

 Adds a regex pattern to an internal list that this test will expect to encounter in logs (of all severities) during its execution.
Public function Virtual void

AddInfo ( const FString& InLogItem,
int32 StackOffset,
bool bCaptureStack
)

 Adds a log item to this test
Public function Virtual void

AddTelemetryData ( const TMap< FString, double >& ValuePairs,
const FString& Context
)

 Adds several telemetry data point measurements
Public function Virtual void

AddTelemetryData ( const FString& DataPoint,
double Measurement,
const FString& Context
)

 Adds a telemetry data point measurement
Public function Virtual void

AddWarning ( const FString& InWarning,
int32 StackOffset
)

 Adds a warning to this test
Public function Virtual void

AddWarningS ( const FString& InWarning,
const FString& InFilename,
int32 InLineNumber
)

 Adds an warning message to this test
Public function Virtual Const bool

CanRunInEnvironment ( const FString& TestParams,
FString* OutReason,
bool* OutWarn
)

 Checks if the test is able to run in the current environment.
Public function void Clear any execution info/results from a prior running of this test
Public function Virtual bool If returns true then logging with a level of Warning will be treated as an error
Protected function uint32 Extracts a combined EAutomationTestFlags value from a string representation using tag notation "[Filter_1]...[Filter_n][Tag_1]...[Tag_m]"
Public function Const void Helper function that will generate a list of sub-tests via GetTests
Protected function Const FString Returns the beautified test name
Public function Const void Populate the provided execution info object with the execution info contained within the test.
Public function Const void Populate the provided expected log messages object with the expected messages contained within the test.
Public function bool Return the last success state for this test
Public function Const uint32 Pure virtual method; returns the number of participants for this test
Public function Virtual TArray< FString > Return suppressed log categories
Public function Virtual Const FString

GetTestAssetPath ( const FString& Parameter
)

 Allows navigation to the asset associated with the test if there is one.
Public function Const FString Gets the parameter context of the test.
Public function Const uint32 Pure virtual method; returns the flags associated with the given automation test
Public function Virtual Const FString Returns the beautified test name with test context.
Public function Const FString Gets the C++ name of the test.
Public function Virtual Const FString

GetTestOpenCommand ( const FString& Parameter
)

 Return an exec command to open the test associated with this parameter.
Protected function Const void

GetTests ( TArray< FString >& OutBeautifiedNames,
TArray< FString >& OutTestCommands
)

 Asks the test to enumerate variants that will all go through the "RunTest" function with different parameters (for load all maps, this should enumerate all maps to load)\
Public function Virtual Const int32 Gets the line number where this test was defined.
Public function Virtual Const int32

GetTestSourceFileLine ( const FString& InTestName
)

 Gets the line number where this test was defined.
Public function Virtual Const FString

GetTestSourceFileName ( const FString& InTestName
)

 Gets the filename where this test was defined.
Public function Virtual Const FString Gets the filename where this test was defined.
Public function Const bool Returns whether this test has any errors associated with it or not
Public function bool Returns whether this test has encountered all expected errors defined for it
Public function bool Returns whether this test has encountered all expected log messages defined for it
Public function Const const bool Is this a complex tast - if so it will be a stress test.
Public function Const const bool  
Public function Static void Enables log settings from config
Public function Static bool Helper function that determines if the given log category matches the expected category, inclusively (so an Error counts as a Warning)
Public function void  
Public function void

PushContext ( const FString& Context
)

  
Protected function bool

RunTest ( const FString& Parameters
)

 Virtual call to execute the automation test.
Public function Virtual void

SetTelemetryStorage ( const FString& StorageName
)

 Set telemetry storage name
Protected function Virtual void

SetTestContext ( FString Context
)

 Sets the parameter context of the test.
Public function Virtual Const bool

ShouldCaptureLogCategory ( const FName& Category
)

 Should the log category be captured and surfaced as part of the test.
Public function Virtual bool If returns true then logging with a level of Error will not be recorded in test results
Public function Virtual bool If true no logging will be included in test events
Public function Virtual bool If returns true then logging with a level of Warning will not be recorded in test results
Public function bool

TestEqual ( const TCHAR* What,
const ValueType& Actual,
const ValueType& Expected
)

 Logs an error if the two values are not equal.
Public function bool

TestEqual ( const FString& What,
const ValueType& Actual,
const ValueType& Expected
)

  
Public function bool

TestEqual ( const TCHAR* What,
const double Actual,
const double Expected,
double Tolerance
)

  
Public function bool

TestEqual ( const TCHAR* What,
const FVector Actual,
const FVector Expected,
float Tolerance
)

  
Public function bool

TestEqual ( const TCHAR* What,
const FTransform Actual,
const FTransform Expected,
float Tolerance
)

  
Public function bool

TestEqual ( const FString& What,
const double Actual,
const double Expected,
double Tolerance
)

  
Public function bool

TestEqual ( const FString& What,
const float Actual,
const float Expected,
float Tolerance
)

  
Public function bool

TestEqual ( const FString& What,
const FRotator Actual,
const FRotator Expected,
float Tolerance
)

  
Public function bool

TestEqual ( const FString& What,
const FVector Actual,
const FVector Expected,
float Tolerance
)

  
Public function bool

TestEqual ( const FString& What,
const FTransform Actual,
const FTransform Expected,
float Tolerance
)

  
Public function bool

TestEqual ( const FString& What,
const FString& Actual,
const FString& Expected
)

  
Public function bool

TestEqual ( const TCHAR* What,
const FRotator Actual,
const FRotator Expected,
float Tolerance
)

  
Public function bool

TestEqual ( const TCHAR* What,
const FString& Actual,
const FString& Expected
)

  
Public function bool

TestEqual ( const TCHAR* What,
const float Actual,
const float Expected,
float Tolerance
)

  
Public function bool

TestEqual ( const TCHAR* What,
const TCHAR* Actual,
const FString& Expected
)

  
Public function bool

TestEqual ( const FString& What,
const TCHAR* Actual,
const FString& Expected
)

  
Public function bool

TestEqual ( const TCHAR* What,
const int64 Actual,
const int64 Expected
)

  
Public function bool

TestEqual ( const TCHAR* What,
const FColor Actual,
const FColor Expected
)

  
Public function bool

TestEqual ( const TCHAR* What,
const FLinearColor Actual,
const FLinearColor Expected
)

  
Public function bool

TestEqual ( const TCHAR* What,
const TCHAR* Actual,
const TCHAR* Expected
)

  
Public function bool

TestEqual ( const TCHAR* What,
const int32 Actual,
const int32 Expected
)

  
Public function bool

TestEqual ( const FString& What,
const FColor Actual,
const FColor Expected
)

  
Public function bool

TestEqual ( const FString& What,
const TCHAR* Actual,
const TCHAR* Expected
)

  
Public function bool

TestEqual ( const TCHAR* What,
const FString& Actual,
const TCHAR* Expected
)

  
Public function bool

TestEqual ( const FString& What,
const FString& Actual,
const TCHAR* Expected
)

  
Public function bool

TestEqual ( const FString& What,
const int32 Actual,
const int32 Expected
)

  
Public function bool

TestEqualInsensitive ( const TCHAR* What,
const TCHAR* Actual,
const TCHAR* Expected
)

  
Public function bool

TestFalse ( const TCHAR* What,
bool Value
)

 Logs an error if the specified Boolean value is not false.
Public function bool

TestFalse ( const FString& What,
bool Value
)

  
Public function bool

TestInvalid ( const TCHAR* Description,
const TSharedPtr< ValueType >& SharedPointer
)

 Logs an error if the given shared pointer is valid.
Public function bool

TestInvalid ( const FString& Description,
const TSharedPtr< ValueType >& SharedPointer
)

  
Public function bool

TestNearlyEqual ( const FString& What,
const FRotator Actual,
const FRotator Expected,
float Tolerance
)

  
Public function bool

TestNearlyEqual ( const FString& What,
const FTransform Actual,
const FTransform Expected,
float Tolerance
)

  
Public function bool

TestNearlyEqual ( const FString& What,
const FVector Actual,
const FVector Expected,
float Tolerance
)

  
Public function bool

TestNearlyEqual ( const FString& What,
const double Actual,
const double Expected,
double Tolerance
)

  
Public function bool

TestNearlyEqual ( const FString& What,
const float Actual,
const float Expected,
float Tolerance
)

  
Public function bool

TestNearlyEqual ( const TCHAR* What,
const FTransform Actual,
const FTransform Expected,
float Tolerance
)

  
Public function bool

TestNearlyEqual ( const TCHAR* What,
const FVector Actual,
const FVector Expected,
float Tolerance
)

  
Public function bool

TestNearlyEqual ( const TCHAR* What,
const double Actual,
const double Expected,
double Tolerance
)

  
Public function bool

TestNearlyEqual ( const TCHAR* What,
const float Actual,
const float Expected,
float Tolerance
)

  
Public function bool

TestNearlyEqual ( const TCHAR* What,
const FRotator Actual,
const FRotator Expected,
float Tolerance
)

  
Public function bool

TestNotEqual ( const TCHAR* Description,
const ValueType& Actual,
const ValueType& Expected
)

 Logs an error if the two values are equal.
Public function bool

TestNotEqual ( const FString& Description,
const ValueType& Actual,
const ValueType& Expected
)

  
Public function bool

TestNotNull ( const TCHAR* What,
const ValueType* Pointer
)

 Logs an error if the specified pointer is NULL.
Public function bool

TestNotNull ( const FString& What,
const ValueType* Pointer
)

  
Public function bool

TestNotSame ( const FString& Description,
const ValueType& Actual,
const ValueType& Expected
)

  
Public function bool

TestNotSame ( const TCHAR* Description,
const ValueType& Actual,
const ValueType& Expected
)

 Logs an error if the two values are the same object in memory.
Public function bool

TestNull ( const TCHAR* What,
const void* Pointer
)

 Logs an error if the specified pointer is not NULL.
Public function bool

TestNull ( const FString& What,
const void* Pointer
)

  
Public function bool

TestSame ( const TCHAR* Description,
const ValueType& Actual,
const ValueType& Expected
)

 Logs an error if the two values are not the same object in memory.
Public function bool

TestSame ( const FString& Description,
const ValueType& Actual,
const ValueType& Expected
)

  
Public function bool

TestTrue ( const TCHAR* What,
bool Value
)

 Logs an error if the specified Boolean value is not true.
Public function bool

TestTrue ( const FString& What,
bool Value
)

  
Public function bool

TestValid ( const TCHAR* Description,
const TSharedPtr< ValueType >& SharedPointer
)

 Logs an error if the given shared pointer is not valid.
Public function bool

TestValid ( const FString& Description,
const TSharedPtr< ValueType >& SharedPointer
)

  

Constants

Name Description
bElevateLogWarningsToErrors  
bSuppressLogErrors  
bSuppressLogWarnings Log flags
SuppressedLogCategories  

Deprecated Functions

  Type Name Description
Public function bool Use GetLastExecutionSuccessState instead.
Public function void

SetSuccessState ( bool bSuccessful
)

 Use AddError(msg) instead to change the state of the test to a failure.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page