#include <AutomationTest.h>

Inheritance diagram for FAutomationTestBase:

Public Member Functions
CORE_API	FAutomationTestBase (const FString &InName, const bool bInComplexTask)

virtual CORE_API	~FAutomationTestBase ()

virtual EAutomationTestFlags	GetTestFlags () const =0

FString	GetTestName () const

FString	GetTestContext () const

virtual FString	GetBeautifiedTestName () const =0

virtual FString	GetTestFullName () const

virtual uint32	GetRequiredDeviceNum () const =0

CORE_API void	ClearExecutionInfo ()

virtual CORE_API void	AddError (const FString &InError, int32 StackOffset=0)

virtual CORE_API bool	AddErrorIfFalse (bool bCondition, const FString &InError, int32 StackOffset=0)

virtual CORE_API void	AddErrorS (const FString &InError, const FString &InFilename, int32 InLineNumber)

virtual CORE_API void	AddWarningS (const FString &InWarning, const FString &InFilename, int32 InLineNumber)

virtual CORE_API void	AddWarning (const FString &InWarning, int32 StackOffset=0)

virtual CORE_API void	AddInfo (const FString &InLogItem, int32 StackOffset=0, bool bCaptureStack=false)

virtual CORE_API void	AddEvent (const FAutomationEvent &InEvent, int32 StackOffset=0, bool bCaptureStack=false)

virtual CORE_API void	AddAnalyticsItem (const FString &InAnalyticsItem)

virtual CORE_API void	AddTelemetryData (const FString &DataPoint, double Measurement, const FString &Context=TEXT(""))

virtual CORE_API void	AddTelemetryData (const TMap< FString, double > &ValuePairs, const FString &Context=TEXT(""))

virtual CORE_API void	SetTelemetryStorage (const FString &StorageName)

CORE_API bool	HasAnyErrors () const

CORE_API bool	HasMetExpectedMessages (ELogVerbosity::Type VerbosityType=ELogVerbosity::All)

CORE_API bool	HasMetExpectedErrors ()

CORE_API bool	GetLastExecutionSuccessState ()

CORE_API void	GetExecutionInfo (FAutomationTestExecutionInfo &OutInfo) const

CORE_API void	GenerateTestNames (TArray< FAutomationTestInfo > &TestInfo) const

CORE_API void	AddExpectedMessage (FString ExpectedPatternString, ELogVerbosity::Type ExpectedVerbosity, EAutomationExpectedMessageFlags::MatchType CompareType=EAutomationExpectedMessageFlags::Contains, int32 Occurrences=1, bool IsRegex=true)

CORE_API void	AddExpectedMessagePlain (FString ExpectedString, ELogVerbosity::Type ExpectedVerbosity, EAutomationExpectedMessageFlags::MatchType CompareType=EAutomationExpectedMessageFlags::Contains, int32 Occurrences=1)

CORE_API void	AddExpectedMessage (FString ExpectedPatternString, EAutomationExpectedMessageFlags::MatchType CompareType=EAutomationExpectedMessageFlags::Contains, int32 Occurrences=1, bool IsRegex=true)

CORE_API void	AddExpectedMessagePlain (FString ExpectedString, EAutomationExpectedMessageFlags::MatchType CompareType=EAutomationExpectedMessageFlags::Contains, int32 Occurrences=1)

CORE_API void	GetExpectedMessages (TArray< FAutomationExpectedMessage > &OutInfo, ELogVerbosity::Type Verbosity=ELogVerbosity::All) const

CORE_API void	GetExpectedMessages (TArray< FAutomationExpectedMessage > &OutInfo, bool IncludeSuppressed, ELogVerbosity::Type Verbosity=ELogVerbosity::All) const

CORE_API void	AddExpectedError (FString ExpectedPatternString, EAutomationExpectedErrorFlags::MatchType CompareType=EAutomationExpectedErrorFlags::Contains, int32 Occurrences=1, bool IsRegex=true)

CORE_API void	AddExpectedErrorPlain (FString ExpectedString, EAutomationExpectedErrorFlags::MatchType CompareType=EAutomationExpectedErrorFlags::Contains, int32 Occurrences=1)

const bool	IsComplexTask () const

const bool	IsRanOnSeparateThread () const

virtual bool	SuppressLogs ()

virtual bool	ShouldCaptureLogCategory (const class FName &Category) const

virtual bool	SuppressLogErrors ()

virtual bool	SuppressLogWarnings ()

virtual bool	ElevateLogWarningsToErrors ()

virtual TArray< FString >	GetSuppressedLogCategories ()

void	AddCommand (IAutomationLatentCommand *NewCommand)

void	AddCommand (IAutomationNetworkCommand *NewCommand)

virtual FString	GetTestSourceFileName () const

virtual int32	GetTestSourceFileLine () const

virtual FString	GetTestSourceFileName (const FString &InTestName) const

virtual int32	GetTestSourceFileLine (const FString &InTestName) const

virtual FString	GetTestAssetPath (const FString &Parameter) const

virtual FString	GetTestOpenCommand (const FString &Parameter) const

void	PushContext (const FString &Context)

void	PopContext ()

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

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

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

CORE_API bool	TestEqual (const TCHAR *What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestEqual (const TCHAR *What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestEqual (const TCHAR *What, const FVector Actual, const FVector Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestEqual (const TCHAR *What, const FTransform Actual, const FTransform Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestEqual (const TCHAR *What, const FRotator Actual, const FRotator Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

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

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

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

CORE_API bool	TestEqual (const TCHAR *What, FStringView Actual, FStringView Expected)

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

CORE_API bool	TestEqual (const TCHAR *What, FUtf8StringView Actual, FUtf8StringView Expected)

CORE_API bool	TestEqual (const TCHAR *What, const FText Actual, const FText Expected)

CORE_API bool	TestEqual (const TCHAR *What, const FName Actual, const FName Expected)

CORE_API bool	TestNotEqual (const TCHAR What, const TCHAR Actual, const TCHAR *Expected)

CORE_API bool	TestNotEqual (const TCHAR *What, FStringView Actual, FStringView Expected)

bool	TestNotEqual (const TCHAR *What, const FString &Actual, const FString &Expected)

CORE_API bool	TestNotEqual (const TCHAR *What, FUtf8StringView Actual, FUtf8StringView Expected)

CORE_API bool	TestNotEqual (const TCHAR *What, const FText Actual, const FText Expected)

CORE_API bool	TestNotEqual (const TCHAR *What, const FName Actual, const FName Expected)

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

CORE_API bool	TestEqualInsensitive (const TCHAR *What, FStringView Actual, FStringView Expected)

CORE_API bool	TestEqualInsensitive (const TCHAR *What, FUtf8StringView Actual, FUtf8StringView Expected)

CORE_API bool	TestNotEqualInsensitive (const TCHAR What, const TCHAR Actual, const TCHAR *Expected)

CORE_API bool	TestNotEqualInsensitive (const TCHAR *What, FStringView Actual, FStringView Expected)

CORE_API bool	TestNotEqualInsensitive (const TCHAR *What, FUtf8StringView Actual, FUtf8StringView Expected)

CORE_API bool	TestEqualSensitive (const TCHAR What, const TCHAR Actual, const TCHAR *Expected)

CORE_API bool	TestEqualSensitive (const TCHAR *What, FStringView Actual, FStringView Expected)

bool	TestEqualSensitive (const TCHAR *What, const FString &Actual, const FString &Expected)

CORE_API bool	TestEqualSensitive (const TCHAR *What, FUtf8StringView Actual, FUtf8StringView Expected)

CORE_API bool	TestNotEqualSensitive (const TCHAR What, const TCHAR Actual, const TCHAR *Expected)

CORE_API bool	TestNotEqualSensitive (const TCHAR *What, FStringView Actual, FStringView Expected)

bool	TestNotEqualSensitive (const TCHAR *What, const FString &Actual, const FString &Expected)

CORE_API bool	TestNotEqualSensitive (const TCHAR *What, FUtf8StringView Actual, FUtf8StringView Expected)

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

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

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

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

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

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

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

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

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

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

bool	TestEqual (const FString &What, FStringView Actual, FUtf8StringView Expected)

bool	TestEqual (const FString &What, FUtf8StringView Actual, FStringView Expected)

bool	TestEqualSensitive (const FString &What, const TCHAR Actual, const TCHAR Expected)

bool	TestEqualSensitive (const FString &What, FUtf8StringView Actual, FUtf8StringView Expected)

bool	TestEqualSensitive (const FString &What, FStringView Actual, FStringView Expected)

bool	TestEqualSensitive (const FString &What, FStringView Actual, FUtf8StringView Expected)

bool	TestEqualSensitive (const FString &What, FUtf8StringView Actual, FStringView Expected)

bool	TestNotEqualSensitive (const FString &What, const TCHAR Actual, const TCHAR Expected)

bool	TestNotEqualSensitive (const FString &What, FUtf8StringView Actual, FUtf8StringView Expected)

bool	TestNotEqualSensitive (const FString &What, FStringView Actual, FStringView Expected)

bool	TestNotEqualSensitive (const FString &What, FStringView Actual, FUtf8StringView Expected)

bool	TestNotEqualSensitive (const FString &What, FUtf8StringView Actual, FStringView Expected)

template<typename ValueType >
bool	TestEqual (const TCHAR *What, const ValueType &Actual, const ValueType &Expected)

template<typename ValueType >
bool	TestEqual (const FString &What, const ValueType &Actual, const ValueType &Expected)

CORE_API bool	TestNearlyEqual (const TCHAR *What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestNearlyEqual (const TCHAR *What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestNearlyEqual (const TCHAR *What, const FVector Actual, const FVector Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestNearlyEqual (const TCHAR *What, const FTransform Actual, const FTransform Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestNearlyEqual (const TCHAR *What, const FRotator Actual, const FRotator Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

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

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

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

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

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

CORE_API bool	TestLessThan (const TCHAR *What, const int32 Actual, const int32 Expected)

CORE_API bool	TestLessThan (const TCHAR *What, const int64 Actual, const int64 Expected)

CORE_API bool	TestGreaterThan (const TCHAR *What, const int32 Actual, const int32 Expected)

CORE_API bool	TestGreaterThan (const TCHAR *What, const int64 Actual, const int64 Expected)

CORE_API bool	TestLessEqual (const TCHAR *What, const int32 Actual, const int32 Expected)

CORE_API bool	TestLessEqual (const TCHAR *What, const int64 Actual, const int64 Expected)

CORE_API bool	TestGreaterEqual (const TCHAR *What, const int32 Actual, const int32 Expected)

CORE_API bool	TestGreaterEqual (const TCHAR *What, const int64 Actual, const int64 Expected)

CORE_API bool	TestLessThan (const TCHAR *What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestLessThan (const TCHAR *What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestGreaterThan (const TCHAR *What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestGreaterThan (const TCHAR *What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestLessEqual (const TCHAR *What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestLessEqual (const TCHAR *What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestGreaterEqual (const TCHAR *What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestGreaterEqual (const TCHAR *What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestLessThan (const FString &What, const int32 Actual, const int32 Expected)

bool	TestLessThan (const FString &What, const int64 Actual, const int64 Expected)

bool	TestGreaterThan (const FString &What, const int32 Actual, const int32 Expected)

bool	TestGreaterThan (const FString &What, const int64 Actual, const int64 Expected)

bool	TestLessEqual (const FString &What, const int32 Actual, const int32 Expected)

bool	TestLessEqual (const FString &What, const int64 Actual, const int64 Expected)

bool	TestGreaterEqual (const FString &What, const int32 Actual, const int32 Expected)

bool	TestGreaterEqual (const FString &What, const int64 Actual, const int64 Expected)

bool	TestLessThan (const FString &What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestLessThan (const FString &What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestGreaterThan (const FString &What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestGreaterThan (const FString &What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestLessEqual (const FString &What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestLessEqual (const FString &What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestGreaterEqual (const FString &What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestGreaterEqual (const FString &What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestFalse (const TCHAR *What, bool Value)

bool	TestFalse (const FString &What, bool Value)

template<typename ValueType >
bool	TestInvalid (const TCHAR *Description, const ValueType &Value)

template<typename ValueType >
bool	TestInvalid (const FString &Description, const ValueType &Value)

template<typename ValueType >
bool	TestNotEqual (const TCHAR *Description, const ValueType &Actual, const ValueType &Expected)

template<typename ValueType >
bool	TestNotEqual (const FString &Description, const ValueType &Actual, const ValueType &Expected)

CORE_API bool	TestNotEqual (const TCHAR *What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

CORE_API bool	TestNotEqual (const TCHAR *What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestNotEqual (const FString &What, const float Actual, const float Expected, float Tolerance=UE_KINDA_SMALL_NUMBER)

bool	TestNotEqual (const FString &What, const double Actual, const double Expected, double Tolerance=UE_KINDA_SMALL_NUMBER)

template<typename ValueType >
bool	TestNotNull (const TCHAR What, const ValueType Pointer)

template<typename ValueType >
bool	TestNotNull (const FString &What, const ValueType *Pointer)

template<typename ValueType >
bool	TestNotSame (const TCHAR *Description, const ValueType &Actual, const ValueType &Expected)

template<typename ValueType >
bool	TestNotSame (const FString &Description, const ValueType &Actual, const ValueType &Expected)

template<typename ValueType >
bool	TestNotSamePtr (const TCHAR Description, const ValueType Actual, const ValueType *Expected)

template<typename ValueType >
bool	TestNotSamePtr (const FString &Description, const ValueType Actual, const ValueType Expected)

CORE_API bool	TestNull (const TCHAR What, const void Pointer)

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

template<typename ValueType >
bool	TestSame (const TCHAR *Description, const ValueType &Actual, const ValueType &Expected)

template<typename ValueType >
bool	TestSame (const FString &Description, const ValueType &Actual, const ValueType &Expected)

template<typename ValueType >
bool	TestSamePtr (const TCHAR Description, const ValueType Actual, const ValueType *Expected)

template<typename ValueType >
bool	TestSamePtr (const FString &Description, const ValueType Actual, const ValueType Expected)

CORE_API bool	TestTrue (const TCHAR *What, bool Value)

bool	TestTrue (const FString &What, bool Value)

template<typename ValueType >
bool	TestValid (const TCHAR *Description, const ValueType &Value)

template<typename ValueType >
bool	TestValid (const FString &Description, const ValueType &Value)

Static Public Member Functions
static CORE_API bool	LogCategoryMatchesSeverityInclusive (ELogVerbosity::Type Actual, ELogVerbosity::Type MaximumVerbosity)

static CORE_API void	LoadDefaultLogSettings ()

Static Public Attributes
static CORE_API bool	bSuppressLogWarnings = false

static CORE_API bool	bSuppressLogErrors = false

static CORE_API bool	bElevateLogWarningsToErrors = false

static CORE_API TArray< FString >	SuppressedLogCategories

Protected Member Functions
virtual void	GetTests (TArray< FString > &OutBeautifiedNames, TArray< FString > &OutTestCommands) const =0

virtual bool	RunTest (const FString &Parameters)=0

virtual void	SetTestContext (FString Context)

CORE_API EAutomationTestFlags	ExtractAutomationTestFlags (FString InTagNotation)

Protected Attributes
bool	bComplexTask

bool	bRunOnSeparateThread

bool	bSuppressLogs = false

FString	TestName

FString	TestParameterContext

FAutomationTestExecutionInfo	ExecutionInfo

Friends
class	FAutomationTestFramework

Detailed Description

Simple abstract base class for all automation tests

Constructor & Destructor Documentation

◆ FAutomationTestBase()

FAutomationTestBase::FAutomationTestBase	(	const FString &	InName,
		const bool	bInComplexTask
	)

Constructor

Parameters

InName Name of the test

◆ ~FAutomationTestBase()

FAutomationTestBase::~FAutomationTestBase ( )

virtual

Destructor

Member Function Documentation

◆ AddAnalyticsItem()

UE_AUTORTFM_ALWAYS_OPEN void FAutomationTestBase::AddAnalyticsItem ( const FString & InAnalyticsItem )

virtual

Adds a analytics string to parse later

Parameters

InLogItem Log item to add to this test

◆ AddCommand() [1/2]

void FAutomationTestBase::AddCommand ( IAutomationLatentCommand * NewCommand )

inline

Enqueues a new latent command.

◆ AddCommand() [2/2]

void FAutomationTestBase::AddCommand ( IAutomationNetworkCommand * NewCommand )

inline

Enqueues a new latent network command.

◆ AddError()

UE_AUTORTFM_ALWAYS_OPEN void FAutomationTestBase::AddError	(	const FString &	InError,
		int32	StackOffset = `0`
	)

virtual

Adds an error message to this test

Parameters

InError Error message to add to this test

◆ AddErrorIfFalse()

UE_AUTORTFM_ALWAYS_OPEN bool FAutomationTestBase::AddErrorIfFalse	(	bool	bCondition,
		const FString &	InError,
		int32	StackOffset = `0`
	)

virtual

Adds an error message to this test if the condition is false

Parameters

bCondition	The condition to validate.
InError	Error message to add to this test

Returns: False if there was an error

◆ AddErrorS()

UE_AUTORTFM_ALWAYS_OPEN void FAutomationTestBase::AddErrorS	(	const FString &	InError,
		const FString &	InFilename,
		int32	InLineNumber
	)

virtual

Adds an error message to this test

Parameters

InError	Error message to add to this test
InFilename	The filename the error originated in
InLineNumber	The line number in the file this error originated in

◆ AddEvent()

UE_AUTORTFM_ALWAYS_OPEN void FAutomationTestBase::AddEvent	(	const FAutomationEvent &	InEvent,
		int32	StackOffset = `0`,
		bool	bCaptureStack = `false`
	)

virtual

Adds an automation event directly into the execution log.

Parameters

InLogItem Log item to add to this test

◆ AddExpectedError()

void FAutomationTestBase::AddExpectedError	(	FString	ExpectedPatternString,
		EAutomationExpectedErrorFlags::MatchType	CompareType = `EAutomationExpectedErrorFlags::Contains`,
		int32	Occurrences = `1`,
		bool	IsRegex = `true`
	)

Adds a regex pattern to an internal list that this test will expect to encounter in error or warning logs during its execution. If an expected pattern is not encountered, it will cause this test to fail.

Parameters

ExpectedPatternString	- The expected message string. Supports basic regex patterns.
CompareType	- How to match this string with an encountered error, should it match exactly or simply just contain the string.
Occurrences	- How many times to expect this error string to be seen. If > 0, the error must be seen the exact number of times specified or the test will fail. If == 0, the error must be seen one or more times (with no upper limit) or the test will fail. If < 0, occurrences of this message will be silently ignored.
IsRegex	- If the pattern is to be used as regex or plain string. Default is true.

◆ AddExpectedErrorPlain()

void FAutomationTestBase::AddExpectedErrorPlain	(	FString	ExpectedString,
		EAutomationExpectedErrorFlags::MatchType	CompareType = `EAutomationExpectedErrorFlags::Contains`,
		int32	Occurrences = `1`
	)

Adds a plain string to an internal list that this test will expect to encounter in error or warning logs during its execution. If an expected pattern is not encountered, it will cause this test to fail.

Parameters

ExpectedString	- The expected message string.
CompareType	- How to match this string with an encountered error, should it match exactly or simply just contain the string.
Occurrences	- How many times to expect this error string to be seen. If > 0, the error must be seen the exact number of times specified or the test will fail. If == 0, the error must be seen one or more times (with no upper limit) or the test will fail. If < 0, occurrences of this message will be silently ignored.

◆ AddExpectedMessage() [1/2]

void FAutomationTestBase::AddExpectedMessage	(	FString	ExpectedPatternString,
		EAutomationExpectedMessageFlags::MatchType	CompareType = `EAutomationExpectedMessageFlags::Contains`,
		int32	Occurrences = `1`,
		bool	IsRegex = `true`
	)

Adds a regex pattern to an internal list that this test will expect to encounter in logs (of all severities) during its execution. If an expected pattern is not encountered, it will cause this test to fail.

Parameters

ExpectedPatternString	- The expected message string. Supports basic regex patterns.
CompareType	- How to match this string with an encountered message, should it match exactly or simply just contain the string.
Occurrences	- How many times to expect this message string to be seen. If > 0, the message must be seen the exact number of times specified or the test will fail. If == 0, the message must be seen one or more times (with no upper limit) or the test will fail. If < 0, occurrences of this message will be silently ignored.
IsRegex	- If the pattern is to be used as regex or plain string. Default is true.

◆ AddExpectedMessage() [2/2]

void FAutomationTestBase::AddExpectedMessage	(	FString	ExpectedPatternString,
		ELogVerbosity::Type	ExpectedVerbosity,
		EAutomationExpectedMessageFlags::MatchType	CompareType = `EAutomationExpectedMessageFlags::Contains`,
		int32	Occurrences = `1`,
		bool	IsRegex = `true`
	)

Adds a regex pattern to an internal list that this test will expect to encounter in logs (of the specified verbosity) during its execution. If an expected pattern is not encountered, it will cause this test to fail.

Parameters

ExpectedPatternString	- The expected message string. Supports basic regex patterns if IsRegex is set to true (the default).
ExpectedVerbosity	- The expected message verbosity. This is treated as a minimum requirement, so for example the Warning level will intercept Warnings, Errors and Fatal.
CompareType	- How to match this string with an encountered message, should it match exactly or simply just contain the string.
Occurrences	- How many times to expect this message string to be seen. If > 0, the message must be seen the exact number of times specified or the test will fail. If == 0, the message must be seen one or more times (with no upper limit) or the test will fail. If < 0, occurrences of this message will be silently ignored.
IsRegex	- If the pattern is to be used as regex or plain string. Default is true.

◆ AddExpectedMessagePlain() [1/2]

void FAutomationTestBase::AddExpectedMessagePlain	(	FString	ExpectedString,
		EAutomationExpectedMessageFlags::MatchType	CompareType = `EAutomationExpectedMessageFlags::Contains`,
		int32	Occurrences = `1`
	)

Adds a plain string to an internal list that this test will expect to encounter in logs (of all severities) during its execution. If an expected pattern is not encountered, it will cause this test to fail.

Parameters

ExpectedString	- The expected message string.
CompareType	- How to match this string with an encountered message, should it match exactly or simply just contain the string.
Occurrences	- How many times to expect this message string to be seen. If > 0, the message must be seen the exact number of times specified or the test will fail. If == 0, the message must be seen one or more times (with no upper limit) or the test will fail. If < 0, occurrences of this message will be silently ignored.

◆ AddExpectedMessagePlain() [2/2]

void FAutomationTestBase::AddExpectedMessagePlain	(	FString	ExpectedString,
		ELogVerbosity::Type	ExpectedVerbosity,
		EAutomationExpectedMessageFlags::MatchType	CompareType = `EAutomationExpectedMessageFlags::Contains`,
		int32	Occurrences = `1`
	)

Adds a plain string to an internal list that this test will expect to encounter in logs (of the specified verbosity) during its execution. If an expected pattern is not encountered, it will cause this test to fail.

Parameters

ExpectedString	- The expected message string.
ExpectedVerbosity	- The expected message verbosity. This is treated as a minimum requirement, so for example the Warning level will intercept Warnings, Errors and Fatal.
CompareType	- How to match this string with an encountered message, should it match exactly or simply just contain the string.
Occurrences	- How many times to expect this message string to be seen. If > 0, the message must be seen the exact number of times specified or the test will fail. If == 0, the message must be seen one or more times (with no upper limit) or the test will fail. If < 0, occurrences of this message will be silently ignored.

◆ AddInfo()

UE_AUTORTFM_ALWAYS_OPEN void FAutomationTestBase::AddInfo	(	const FString &	InLogItem,
		int32	StackOffset = `0`,
		bool	bCaptureStack = `false`
	)

virtual

Adds a log item to this test

Parameters

InLogItem Log item to add to this test

◆ AddTelemetryData() [1/2]

UE_AUTORTFM_ALWAYS_OPEN void FAutomationTestBase::AddTelemetryData	(	const FString &	DataPoint,
		double	Measurement,
		const FString &	Context = `TEXT("")`
	)

virtual

Adds a telemetry data point measurement

Parameters

DataPoint	Name of the Data point
Measurement	Value to associate to the data point
Context	optional context associated with the data point

◆ AddTelemetryData() [2/2]

UE_AUTORTFM_ALWAYS_OPEN void FAutomationTestBase::AddTelemetryData	(	const TMap< FString, double > &	ValuePairs,
		const FString &	Context = `TEXT("")`
	)

virtual

Adds several telemetry data point measurements

Parameters

ValuePairs	value pair of Name and Measurement of several Data points
Context	optional context associated with the data point

◆ AddWarning()

UE_AUTORTFM_ALWAYS_OPEN void FAutomationTestBase::AddWarning	(	const FString &	InWarning,
		int32	StackOffset = `0`
	)

virtual

Adds a warning to this test

Parameters

InWarning Warning message to add to this test

◆ AddWarningS()

UE_AUTORTFM_ALWAYS_OPEN void FAutomationTestBase::AddWarningS	(	const FString &	InWarning,
		const FString &	InFilename,
		int32	InLineNumber
	)

virtual

Adds an warning message to this test

Parameters

InWarning	Warning message to add to this test
InFilename	The filename the error originated in
InLineNumber	The line number in the file this error originated in

◆ CanRunInEnvironment()

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

inlinevirtual

Checks if the test is able to run in the current environment.

◆ ClearExecutionInfo()

void FAutomationTestBase::ClearExecutionInfo ( )

Clear any execution info/results from a prior running of this test

◆ ElevateLogWarningsToErrors()

virtual bool FAutomationTestBase::ElevateLogWarningsToErrors ( )

inlinevirtual

If returns true then logging with a level of Warning will be treated as an error

Returns: true to make warnings errors

Reimplemented in FAutomationTestUObjectClassBase.

◆ ExtractAutomationTestFlags()

EAutomationTestFlags FAutomationTestBase::ExtractAutomationTestFlags ( FString InTagNotation )

protected

Extracts a combined EAutomationTestFlags value from a string representation using tag notation "[Filter_1]...[Filter_n][Tag_1]...[Tag_m]"

◆ GenerateTestNames()

void FAutomationTestBase::GenerateTestNames ( TArray< FAutomationTestInfo > & TestInfo ) const

Helper function that will generate a list of sub-tests via GetTests

◆ GetBeautifiedTestName()

virtual FString FAutomationTestBase::GetBeautifiedTestName ( ) const

pure virtual

Returns the beautified test name

◆ GetExecutionInfo()

void FAutomationTestBase::GetExecutionInfo ( FAutomationTestExecutionInfo & OutInfo ) const

Populate the provided execution info object with the execution info contained within the test. Not particularly efficient, but providing direct access to the test's private execution info could result in errors.

Parameters

OutInfo Execution info to be populated with the same data contained within this test's execution info

◆ GetExpectedMessages() [1/2]

void FAutomationTestBase::GetExpectedMessages	(	TArray< FAutomationExpectedMessage > &	OutInfo,
		bool	IncludeSuppressed,
		ELogVerbosity::Type	Verbosity = `ELogVerbosity::All`
	)		const

Populate the provided expected log messages object with the expected messages contained within the test. Not particularly efficient, but providing direct access to the test's private execution messages list could result in errors.

Parameters

OutInfo	- Array of Expected Messages to be populated with the same data contained within this test's expected messages list
IncludeSuppressed	- Include the expected errors that have been marked as being suppressed.
Verbosity	- Optionally filter the returned messages by verbosity. This is inclusive, so Warning will return Warnings, Errors, etc.

◆ GetExpectedMessages() [2/2]

void FAutomationTestBase::GetExpectedMessages	(	TArray< FAutomationExpectedMessage > &	OutInfo,
		ELogVerbosity::Type	Verbosity = `ELogVerbosity::All`
	)		const

Populate the provided expected log messages object with the expected messages contained within the test. Not particularly efficient, but providing direct access to the test's private execution messages list could result in errors.

Parameters

OutInfo	- Array of Expected Messages to be populated with the same data contained within this test's expected messages list
Verbosity	- Optionally filter the returned messages by verbosity. This is inclusive, so Warning will return Warnings, Errors, etc.

Note: This will not include any messages that are supposed to be suppressed

◆ GetLastExecutionSuccessState()

bool FAutomationTestBase::GetLastExecutionSuccessState ( )

Return the last success state for this test

◆ GetRequiredDeviceNum()

virtual uint32 FAutomationTestBase::GetRequiredDeviceNum ( ) const

pure virtual

Pure virtual method; returns the number of participants for this test

Returns: Number of required participants

Implemented in FAutomationSpecBase.

◆ GetSuppressedLogCategories()

virtual TArray< FString > FAutomationTestBase::GetSuppressedLogCategories ( )

inlinevirtual

Return suppressed log categories

◆ GetTestAssetPath()

virtual FString FAutomationTestBase::GetTestAssetPath ( const FString & Parameter ) const

inlinevirtual

Allows navigation to the asset associated with the test if there is one.

◆ GetTestContext()

FString FAutomationTestBase::GetTestContext ( ) const

inline

Gets the parameter context of the test.

◆ GetTestFlags()

virtual EAutomationTestFlags FAutomationTestBase::GetTestFlags ( ) const

pure virtual

Pure virtual method; returns the flags associated with the given automation test

Returns: Automation test flags associated with the test

◆ GetTestFullName()

virtual FString FAutomationTestBase::GetTestFullName ( ) const

inlinevirtual

Returns the beautified test name with test context. Should return what is displayed in the Test Automation UI. See GenerateTestNames()

◆ GetTestName()

FString FAutomationTestBase::GetTestName ( ) const

inline

Gets the C++ name of the test.

◆ GetTestOpenCommand()

virtual FString FAutomationTestBase::GetTestOpenCommand ( const FString & Parameter ) const

inlinevirtual

Return an exec command to open the test associated with this parameter.

◆ GetTests()

virtual void FAutomationTestBase::GetTests	(	TArray< FString > &	OutBeautifiedNames,
		TArray< FString > &	OutTestCommands
	)		const

protectedpure virtual

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)\

Parameters

OutBeautifiedNames	- Name of the test that can be displayed by the UI (for load all maps, it would be the map name without any directory prefix)
OutTestCommands	- The parameters to be specified to each call to RunTests (for load all maps, it would be the map name to load)

Implemented in FBDDAutomationTestBase, and FAutomationSpecBase.

◆ GetTestSourceFileLine() [1/2]

virtual int32 FAutomationTestBase::GetTestSourceFileLine ( ) const

inlinevirtual

Gets the line number where this test was defined.

◆ GetTestSourceFileLine() [2/2]

virtual int32 FAutomationTestBase::GetTestSourceFileLine ( const FString & InTestName ) const

inlinevirtual

Gets the line number where this test was defined.

Reimplemented in FAutomationSpecBase.

◆ GetTestSourceFileName() [1/2]

virtual FString FAutomationTestBase::GetTestSourceFileName ( ) const

inlinevirtual

Gets the filename where this test was defined.

◆ GetTestSourceFileName() [2/2]

virtual FString FAutomationTestBase::GetTestSourceFileName ( const FString & InTestName ) const

inlinevirtual

Gets the filename where this test was defined.

Reimplemented in FAutomationSpecBase.

◆ HasAnyErrors()

bool FAutomationTestBase::HasAnyErrors ( ) const

Returns whether this test has any errors associated with it or not

Returns: true if this test has at least one error associated with it; false if not

◆ HasMetExpectedErrors()

bool FAutomationTestBase::HasMetExpectedErrors ( )

Returns whether this test has encountered all expected errors defined for it

Returns: true if this test has encountered all expected errors; false if not

◆ HasMetExpectedMessages()

bool FAutomationTestBase::HasMetExpectedMessages ( ELogVerbosity::Type VerbosityType = ELogVerbosity::All )

Returns whether this test has encountered all expected log messages defined for it

Parameters

VerbosityType Optionally specify to check by log level. Defaults to all.

Returns: true if this test has encountered all expected messages; false if not

◆ IsComplexTask()

const bool FAutomationTestBase::IsComplexTask ( ) const

inline

Is this a complex tast - if so it will be a stress test.

Returns: true if this is a complex task.

◆ IsRanOnSeparateThread()

const bool FAutomationTestBase::IsRanOnSeparateThread ( ) const

inline

◆ LoadDefaultLogSettings()

void FAutomationTestBase::LoadDefaultLogSettings ( )

static

Enables log settings from config

◆ LogCategoryMatchesSeverityInclusive()

bool FAutomationTestBase::LogCategoryMatchesSeverityInclusive	(	ELogVerbosity::Type	Actual,
		ELogVerbosity::Type	MaximumVerbosity
	)

static

Helper function that determines if the given log category matches the expected category, inclusively (so an Error counts as a Warning)

◆ PopContext()

void FAutomationTestBase::PopContext ( )

inline

◆ PushContext()

void FAutomationTestBase::PushContext ( const FString & Context )

inline

◆ RunTest()

virtual bool FAutomationTestBase::RunTest ( const FString & Parameters )

protectedpure virtual

Virtual call to execute the automation test.

Parameters

Parameters - Parameter list for the test (but it will be empty for simple tests)

Returns: TRUE if the test was run successfully; FALSE otherwise

Implemented in FAutomationSpecBase, and FBDDAutomationTestBase.

◆ SetTelemetryStorage()

void FAutomationTestBase::SetTelemetryStorage ( const FString & StorageName )

virtual

Set telemetry storage name

Parameters

StorageName Name of the data storage

◆ SetTestContext()

virtual void FAutomationTestBase::SetTestContext ( FString Context )

inlineprotectedvirtual

Sets the parameter context of the test.

◆ ShouldCaptureLogCategory()

virtual bool FAutomationTestBase::ShouldCaptureLogCategory ( const class FName & Category ) const

inlinevirtual

Should the log category be captured and surfaced as part of the test. If true will then go through the SuppressLogWarnings and SuppressLogErrors checks for if this should be suppressed further or not Recommend overriding with a virtual function that contains a static TSet to check for the categories you want.

Returns: true to allow a log category through.

◆ SuppressLogErrors()

virtual bool FAutomationTestBase::SuppressLogErrors ( )

inlinevirtual

If returns true then logging with a level of Error will not be recorded in test results

Returns: false to make errors errors

Reimplemented in FAutomationTestUObjectClassBase.

◆ SuppressLogs()

virtual bool FAutomationTestBase::SuppressLogs ( )

inlinevirtual

If true no logging will be included in test events

Returns: true to suppress logs

◆ SuppressLogWarnings()

virtual bool FAutomationTestBase::SuppressLogWarnings ( )

inlinevirtual

If returns true then logging with a level of Warning will not be recorded in test results

Returns: true to make warnings errors

Reimplemented in FAutomationTestUObjectClassBase.

◆ TestEqual() [1/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestEqual() [2/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		const FColor	Actual,
		const FColor	Expected
	)

inline

◆ TestEqual() [3/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestEqual() [4/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		const FRotator	Actual,
		const FRotator	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestEqual() [5/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		const FTransform	Actual,
		const FTransform	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestEqual() [6/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		const FVector	Actual,
		const FVector	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestEqual() [7/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		const int32	Actual,
		const int32	Expected
	)

inline

◆ TestEqual() [8/29]

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

inline

◆ TestEqual() [9/29]

template<typename ValueType >

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		const ValueType &	Actual,
		const ValueType &	Expected
	)

inline

◆ TestEqual() [10/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		FStringView	Actual,
		FStringView	Expected
	)

inline

◆ TestEqual() [11/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		FStringView	Actual,
		FUtf8StringView	Expected
	)

inline

◆ TestEqual() [12/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		FUtf8StringView	Actual,
		FStringView	Expected
	)

inline

◆ TestEqual() [13/29]

bool FAutomationTestBase::TestEqual	(	const FString &	What,
		FUtf8StringView	Actual,
		FUtf8StringView	Expected
	)

inline

◆ TestEqual() [14/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestEqual() [15/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const FColor	Actual,
		const FColor	Expected
	)

◆ TestEqual() [16/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const FLinearColor	Actual,
		const FLinearColor	Expected
	)

◆ TestEqual() [17/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestEqual() [18/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const FName	Actual,
		const FName	Expected
	)

◆ TestEqual() [19/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const FRotator	Actual,
		const FRotator	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestEqual() [20/29]

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

inline

◆ TestEqual() [21/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const FText	Actual,
		const FText	Expected
	)

◆ TestEqual() [22/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const FTransform	Actual,
		const FTransform	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestEqual() [23/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const FVector	Actual,
		const FVector	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestEqual() [24/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const int32	Actual,
		const int32	Expected
	)

◆ TestEqual() [25/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const int64	Actual,
		const int64	Expected
	)

◆ TestEqual() [26/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		const TCHAR *	Actual,
		const TCHAR *	Expected
	)

◆ TestEqual() [27/29]

template<typename ValueType >

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

inline

Logs an error if the two values are not equal.

Parameters

What	- Description text for the test.
A	- The first value.
B	- The second value.

See also: TestNotEqual

◆ TestEqual() [28/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		FStringView	Actual,
		FStringView	Expected
	)

◆ TestEqual() [29/29]

bool FAutomationTestBase::TestEqual	(	const TCHAR *	What,
		FUtf8StringView	Actual,
		FUtf8StringView	Expected
	)

◆ TestEqualInsensitive() [1/3]

bool FAutomationTestBase::TestEqualInsensitive	(	const TCHAR *	What,
		const TCHAR *	Actual,
		const TCHAR *	Expected
	)

◆ TestEqualInsensitive() [2/3]

bool FAutomationTestBase::TestEqualInsensitive	(	const TCHAR *	What,
		FStringView	Actual,
		FStringView	Expected
	)

◆ TestEqualInsensitive() [3/3]

bool FAutomationTestBase::TestEqualInsensitive	(	const TCHAR *	What,
		FUtf8StringView	Actual,
		FUtf8StringView	Expected
	)

◆ TestEqualSensitive() [1/9]

bool FAutomationTestBase::TestEqualSensitive	(	const FString &	What,
		const TCHAR *	Actual,
		const TCHAR *	Expected
	)

inline

◆ TestEqualSensitive() [2/9]

bool FAutomationTestBase::TestEqualSensitive	(	const FString &	What,
		FStringView	Actual,
		FStringView	Expected
	)

inline

◆ TestEqualSensitive() [3/9]

bool FAutomationTestBase::TestEqualSensitive	(	const FString &	What,
		FStringView	Actual,
		FUtf8StringView	Expected
	)

inline

◆ TestEqualSensitive() [4/9]

bool FAutomationTestBase::TestEqualSensitive	(	const FString &	What,
		FUtf8StringView	Actual,
		FStringView	Expected
	)

inline

◆ TestEqualSensitive() [5/9]

bool FAutomationTestBase::TestEqualSensitive	(	const FString &	What,
		FUtf8StringView	Actual,
		FUtf8StringView	Expected
	)

inline

◆ TestEqualSensitive() [6/9]

bool FAutomationTestBase::TestEqualSensitive	(	const TCHAR *	What,
		const FString &	Actual,
		const FString &	Expected
	)

inline

◆ TestEqualSensitive() [7/9]

bool FAutomationTestBase::TestEqualSensitive	(	const TCHAR *	What,
		const TCHAR *	Actual,
		const TCHAR *	Expected
	)

◆ TestEqualSensitive() [8/9]

bool FAutomationTestBase::TestEqualSensitive	(	const TCHAR *	What,
		FStringView	Actual,
		FStringView	Expected
	)

◆ TestEqualSensitive() [9/9]

bool FAutomationTestBase::TestEqualSensitive	(	const TCHAR *	What,
		FUtf8StringView	Actual,
		FUtf8StringView	Expected
	)

◆ TestFalse() [1/2]

bool FAutomationTestBase::TestFalse	(	const FString &	What,
		bool	Value
	)

inline

◆ TestFalse() [2/2]

bool FAutomationTestBase::TestFalse	(	const TCHAR *	What,
		bool	Value
	)

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

Parameters

What	- Description text for the test.
Value	- The value to test.

See also: TestTrue

◆ TestGreaterEqual() [1/8]

bool FAutomationTestBase::TestGreaterEqual	(	const FString &	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestGreaterEqual() [2/8]

bool FAutomationTestBase::TestGreaterEqual	(	const FString &	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestGreaterEqual() [3/8]

bool FAutomationTestBase::TestGreaterEqual	(	const FString &	What,
		const int32	Actual,
		const int32	Expected
	)

inline

◆ TestGreaterEqual() [4/8]

bool FAutomationTestBase::TestGreaterEqual	(	const FString &	What,
		const int64	Actual,
		const int64	Expected
	)

inline

◆ TestGreaterEqual() [5/8]

bool FAutomationTestBase::TestGreaterEqual	(	const TCHAR *	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestGreaterEqual() [6/8]

bool FAutomationTestBase::TestGreaterEqual	(	const TCHAR *	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestGreaterEqual() [7/8]

bool FAutomationTestBase::TestGreaterEqual	(	const TCHAR *	What,
		const int32	Actual,
		const int32	Expected
	)

◆ TestGreaterEqual() [8/8]

bool FAutomationTestBase::TestGreaterEqual	(	const TCHAR *	What,
		const int64	Actual,
		const int64	Expected
	)

◆ TestGreaterThan() [1/8]

bool FAutomationTestBase::TestGreaterThan	(	const FString &	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestGreaterThan() [2/8]

bool FAutomationTestBase::TestGreaterThan	(	const FString &	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestGreaterThan() [3/8]

bool FAutomationTestBase::TestGreaterThan	(	const FString &	What,
		const int32	Actual,
		const int32	Expected
	)

inline

◆ TestGreaterThan() [4/8]

bool FAutomationTestBase::TestGreaterThan	(	const FString &	What,
		const int64	Actual,
		const int64	Expected
	)

inline

◆ TestGreaterThan() [5/8]

bool FAutomationTestBase::TestGreaterThan	(	const TCHAR *	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestGreaterThan() [6/8]

bool FAutomationTestBase::TestGreaterThan	(	const TCHAR *	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestGreaterThan() [7/8]

bool FAutomationTestBase::TestGreaterThan	(	const TCHAR *	What,
		const int32	Actual,
		const int32	Expected
	)

◆ TestGreaterThan() [8/8]

bool FAutomationTestBase::TestGreaterThan	(	const TCHAR *	What,
		const int64	Actual,
		const int64	Expected
	)

◆ TestInvalid() [1/2]

template<typename ValueType >

bool FAutomationTestBase::TestInvalid	(	const FString &	Description,
		const ValueType &	Value
	)

inline

◆ TestInvalid() [2/2]

template<typename ValueType >

bool FAutomationTestBase::TestInvalid	(	const TCHAR *	Description,
		const ValueType &	Value
	)

inline

Logs an error if the given object tests true when calling its IsValid member.

Parameters

Description	- Description text for the test.
Value	- The value to test.

See also: TestValid

◆ TestLessEqual() [1/8]

bool FAutomationTestBase::TestLessEqual	(	const FString &	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestLessEqual() [2/8]

bool FAutomationTestBase::TestLessEqual	(	const FString &	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestLessEqual() [3/8]

bool FAutomationTestBase::TestLessEqual	(	const FString &	What,
		const int32	Actual,
		const int32	Expected
	)

inline

◆ TestLessEqual() [4/8]

bool FAutomationTestBase::TestLessEqual	(	const FString &	What,
		const int64	Actual,
		const int64	Expected
	)

inline

◆ TestLessEqual() [5/8]

bool FAutomationTestBase::TestLessEqual	(	const TCHAR *	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestLessEqual() [6/8]

bool FAutomationTestBase::TestLessEqual	(	const TCHAR *	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestLessEqual() [7/8]

bool FAutomationTestBase::TestLessEqual	(	const TCHAR *	What,
		const int32	Actual,
		const int32	Expected
	)

◆ TestLessEqual() [8/8]

bool FAutomationTestBase::TestLessEqual	(	const TCHAR *	What,
		const int64	Actual,
		const int64	Expected
	)

◆ TestLessThan() [1/8]

bool FAutomationTestBase::TestLessThan	(	const FString &	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestLessThan() [2/8]

bool FAutomationTestBase::TestLessThan	(	const FString &	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestLessThan() [3/8]

bool FAutomationTestBase::TestLessThan	(	const FString &	What,
		const int32	Actual,
		const int32	Expected
	)

inline

◆ TestLessThan() [4/8]

bool FAutomationTestBase::TestLessThan	(	const FString &	What,
		const int64	Actual,
		const int64	Expected
	)

inline

◆ TestLessThan() [5/8]

bool FAutomationTestBase::TestLessThan	(	const TCHAR *	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestLessThan() [6/8]

bool FAutomationTestBase::TestLessThan	(	const TCHAR *	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestLessThan() [7/8]

bool FAutomationTestBase::TestLessThan	(	const TCHAR *	What,
		const int32	Actual,
		const int32	Expected
	)

◆ TestLessThan() [8/8]

bool FAutomationTestBase::TestLessThan	(	const TCHAR *	What,
		const int64	Actual,
		const int64	Expected
	)

◆ TestNearlyEqual() [1/10]

bool FAutomationTestBase::TestNearlyEqual	(	const FString &	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestNearlyEqual() [2/10]

bool FAutomationTestBase::TestNearlyEqual	(	const FString &	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestNearlyEqual() [3/10]

bool FAutomationTestBase::TestNearlyEqual	(	const FString &	What,
		const FRotator	Actual,
		const FRotator	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestNearlyEqual() [4/10]

bool FAutomationTestBase::TestNearlyEqual	(	const FString &	What,
		const FTransform	Actual,
		const FTransform	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestNearlyEqual() [5/10]

bool FAutomationTestBase::TestNearlyEqual	(	const FString &	What,
		const FVector	Actual,
		const FVector	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestNearlyEqual() [6/10]

bool FAutomationTestBase::TestNearlyEqual	(	const TCHAR *	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestNearlyEqual() [7/10]

bool FAutomationTestBase::TestNearlyEqual	(	const TCHAR *	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestNearlyEqual() [8/10]

bool FAutomationTestBase::TestNearlyEqual	(	const TCHAR *	What,
		const FRotator	Actual,
		const FRotator	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestNearlyEqual() [9/10]

bool FAutomationTestBase::TestNearlyEqual	(	const TCHAR *	What,
		const FTransform	Actual,
		const FTransform	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestNearlyEqual() [10/10]

bool FAutomationTestBase::TestNearlyEqual	(	const TCHAR *	What,
		const FVector	Actual,
		const FVector	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestNotEqual() [1/12]

template<typename ValueType >

bool FAutomationTestBase::TestNotEqual	(	const FString &	Description,
		const ValueType &	Actual,
		const ValueType &	Expected
	)

inline

◆ TestNotEqual() [2/12]

bool FAutomationTestBase::TestNotEqual	(	const FString &	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestNotEqual() [3/12]

bool FAutomationTestBase::TestNotEqual	(	const FString &	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

inline

◆ TestNotEqual() [4/12]

template<typename ValueType >

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

inline

Logs an error if the two values are equal.

Parameters

Description	- Description text for the test.
A	- The first value.
B	- The second value.

See also: TestEqual

◆ TestNotEqual() [5/12]

bool FAutomationTestBase::TestNotEqual	(	const TCHAR *	What,
		const double	Actual,
		const double	Expected,
		double	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestNotEqual() [6/12]

bool FAutomationTestBase::TestNotEqual	(	const TCHAR *	What,
		const float	Actual,
		const float	Expected,
		float	Tolerance = `UE_KINDA_SMALL_NUMBER`
	)

◆ TestNotEqual() [7/12]

bool FAutomationTestBase::TestNotEqual	(	const TCHAR *	What,
		const FName	Actual,
		const FName	Expected
	)

◆ TestNotEqual() [8/12]

bool FAutomationTestBase::TestNotEqual	(	const TCHAR *	What,
		const FString &	Actual,
		const FString &	Expected
	)

inline

◆ TestNotEqual() [9/12]

bool FAutomationTestBase::TestNotEqual	(	const TCHAR *	What,
		const FText	Actual,
		const FText	Expected
	)

◆ TestNotEqual() [10/12]

bool FAutomationTestBase::TestNotEqual	(	const TCHAR *	What,
		const TCHAR *	Actual,
		const TCHAR *	Expected
	)

◆ TestNotEqual() [11/12]

bool FAutomationTestBase::TestNotEqual	(	const TCHAR *	What,
		FStringView	Actual,
		FStringView	Expected
	)

◆ TestNotEqual() [12/12]

bool FAutomationTestBase::TestNotEqual	(	const TCHAR *	What,
		FUtf8StringView	Actual,
		FUtf8StringView	Expected
	)

◆ TestNotEqualInsensitive() [1/3]

bool FAutomationTestBase::TestNotEqualInsensitive	(	const TCHAR *	What,
		const TCHAR *	Actual,
		const TCHAR *	Expected
	)

◆ TestNotEqualInsensitive() [2/3]

bool FAutomationTestBase::TestNotEqualInsensitive	(	const TCHAR *	What,
		FStringView	Actual,
		FStringView	Expected
	)

◆ TestNotEqualInsensitive() [3/3]

bool FAutomationTestBase::TestNotEqualInsensitive	(	const TCHAR *	What,
		FUtf8StringView	Actual,
		FUtf8StringView	Expected
	)

◆ TestNotEqualSensitive() [1/9]

bool FAutomationTestBase::TestNotEqualSensitive	(	const FString &	What,
		const TCHAR *	Actual,
		const TCHAR *	Expected
	)

inline

◆ TestNotEqualSensitive() [2/9]

bool FAutomationTestBase::TestNotEqualSensitive	(	const FString &	What,
		FStringView	Actual,
		FStringView	Expected
	)

inline

◆ TestNotEqualSensitive() [3/9]

bool FAutomationTestBase::TestNotEqualSensitive	(	const FString &	What,
		FStringView	Actual,
		FUtf8StringView	Expected
	)

inline

◆ TestNotEqualSensitive() [4/9]

bool FAutomationTestBase::TestNotEqualSensitive	(	const FString &	What,
		FUtf8StringView	Actual,
		FStringView	Expected
	)

inline

◆ TestNotEqualSensitive() [5/9]

bool FAutomationTestBase::TestNotEqualSensitive	(	const FString &	What,
		FUtf8StringView	Actual,
		FUtf8StringView	Expected
	)

inline

◆ TestNotEqualSensitive() [6/9]

bool FAutomationTestBase::TestNotEqualSensitive	(	const TCHAR *	What,
		const FString &	Actual,
		const FString &	Expected
	)

inline

◆ TestNotEqualSensitive() [7/9]

bool FAutomationTestBase::TestNotEqualSensitive	(	const TCHAR *	What,
		const TCHAR *	Actual,
		const TCHAR *	Expected
	)

◆ TestNotEqualSensitive() [8/9]

bool FAutomationTestBase::TestNotEqualSensitive	(	const TCHAR *	What,
		FStringView	Actual,
		FStringView	Expected
	)

◆ TestNotEqualSensitive() [9/9]

bool FAutomationTestBase::TestNotEqualSensitive	(	const TCHAR *	What,
		FUtf8StringView	Actual,
		FUtf8StringView	Expected
	)

◆ TestNotNull() [1/2]

template<typename ValueType >

bool FAutomationTestBase::TestNotNull	(	const FString &	What,
		const ValueType *	Pointer
	)

inline

◆ TestNotNull() [2/2]

template<typename ValueType >

bool FAutomationTestBase::TestNotNull	(	const TCHAR *	What,
		const ValueType *	Pointer
	)

inline

Logs an error if the specified pointer is NULL.

Parameters

What	- Description text for the test.
Pointer	- The pointer to test.

See also: TestNull

◆ TestNotSame() [1/2]

template<typename ValueType >

bool FAutomationTestBase::TestNotSame	(	const FString &	Description,
		const ValueType &	Actual,
		const ValueType &	Expected
	)

inline

◆ TestNotSame() [2/2]

template<typename ValueType >

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

inline

Logs an error if the two values reference the same object in memory.

Parameters

Description	- Description text for the test.
A	- The first reference.
B	- The second reference.

See also: TestSame, TestNotSamePtr

◆ TestNotSamePtr() [1/2]

template<typename ValueType >

bool FAutomationTestBase::TestNotSamePtr	(	const FString &	Description,
		const ValueType *	Actual,
		const ValueType *	Expected
	)

inline

◆ TestNotSamePtr() [2/2]

template<typename ValueType >

bool FAutomationTestBase::TestNotSamePtr	(	const TCHAR *	Description,
		const ValueType *	Actual,
		const ValueType *	Expected
	)

inline

Logs an error if the two pointers point to the same object in memory.

Parameters

Description	- Description text for the test.
A	- The first pointer.
B	- The second pointer.

See also: TestNotSamePtr, TestSame

◆ TestNull() [1/2]

bool FAutomationTestBase::TestNull	(	const FString &	What,
		const void *	Pointer
	)

inline

◆ TestNull() [2/2]

bool FAutomationTestBase::TestNull	(	const TCHAR *	What,
		const void *	Pointer
	)

Logs an error if the specified pointer is not NULL.

Parameters

Description	- Description text for the test.
Pointer	- The pointer to test.

See also: TestNotNull

◆ TestSame() [1/2]

template<typename ValueType >

bool FAutomationTestBase::TestSame	(	const FString &	Description,
		const ValueType &	Actual,
		const ValueType &	Expected
	)

inline

◆ TestSame() [2/2]

template<typename ValueType >

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

inline

Logs an error if the two values do not reference the same object in memory.

Parameters

Description	- Description text for the test.
Actual	- The actual reference.
Expected	- The expected reference.

See also: TestNotSame, TestSamePtr

◆ TestSamePtr() [1/2]

template<typename ValueType >

bool FAutomationTestBase::TestSamePtr	(	const FString &	Description,
		const ValueType *	Actual,
		const ValueType *	Expected
	)

inline

◆ TestSamePtr() [2/2]

template<typename ValueType >

bool FAutomationTestBase::TestSamePtr	(	const TCHAR *	Description,
		const ValueType *	Actual,
		const ValueType *	Expected
	)

inline

Logs an error if the two pointers do not point to the same object in memory.

Parameters

Description	- Description text for the test.
Actual	- The actual pointer.
Expected	- The expected pointer.

See also: TestNotSamePtr, TestNotSame

◆ TestTrue() [1/2]

bool FAutomationTestBase::TestTrue	(	const FString &	What,
		bool	Value
	)

inline

◆ TestTrue() [2/2]

bool FAutomationTestBase::TestTrue	(	const TCHAR *	What,
		bool	Value
	)

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

Parameters

Description	- Description text for the test.
Value	- The value to test.

See also: TestFalse

◆ TestValid() [1/2]

template<typename ValueType >

bool FAutomationTestBase::TestValid	(	const FString &	Description,
		const ValueType &	Value
	)

inline

◆ TestValid() [2/2]

template<typename ValueType >

bool FAutomationTestBase::TestValid	(	const TCHAR *	Description,
		const ValueType &	Value
	)

inline

Logs an error if the given object returns false when calling its IsValid member.

Parameters

Description	- Description text for the test.
Value	- The value to test.

See also: TestInvalid

Friends And Related Symbol Documentation

◆ FAutomationTestFramework

friend class FAutomationTestFramework

friend

Member Data Documentation

◆ bComplexTask

bool FAutomationTestBase::bComplexTask

protected

◆ bElevateLogWarningsToErrors

bool FAutomationTestBase::bElevateLogWarningsToErrors = false

static

◆ bRunOnSeparateThread

bool FAutomationTestBase::bRunOnSeparateThread

protected

◆ bSuppressLogErrors

bool FAutomationTestBase::bSuppressLogErrors = false

static

◆ bSuppressLogs

bool FAutomationTestBase::bSuppressLogs = false

protected

Flag to suppress logs

◆ bSuppressLogWarnings

bool FAutomationTestBase::bSuppressLogWarnings = false

static

Log flags

◆ ExecutionInfo

FAutomationTestExecutionInfo FAutomationTestBase::ExecutionInfo

protected

Info related to the last execution of this test

◆ SuppressedLogCategories

TArray< FString > FAutomationTestBase::SuppressedLogCategories

static

◆ TestName

FString FAutomationTestBase::TestName

protected

Name of the test

◆ TestParameterContext

FString FAutomationTestBase::TestParameterContext

protected

Context of the test

The documentation for this class was generated from the following files:

Engine/Source/Runtime/Core/Public/Misc/AutomationTest.h
Engine/Source/Runtime/Core/Private/Misc/AutomationTest.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ FAutomationTestBase()

◆ ~FAutomationTestBase()

Member Function Documentation

◆ AddAnalyticsItem()

◆ AddCommand() [1/2]

◆ AddCommand() [2/2]

◆ AddError()

◆ AddErrorIfFalse()

◆ AddErrorS()

◆ AddEvent()

◆ AddExpectedError()

◆ AddExpectedErrorPlain()

◆ AddExpectedMessage() [1/2]

◆ AddExpectedMessage() [2/2]

◆ AddExpectedMessagePlain() [1/2]

◆ AddExpectedMessagePlain() [2/2]

◆ AddInfo()

◆ AddTelemetryData() [1/2]

◆ AddTelemetryData() [2/2]

◆ AddWarning()

◆ AddWarningS()

◆ CanRunInEnvironment()

◆ ClearExecutionInfo()

◆ ElevateLogWarningsToErrors()

◆ ExtractAutomationTestFlags()

◆ GenerateTestNames()

◆ GetBeautifiedTestName()

◆ GetExecutionInfo()

◆ GetExpectedMessages() [1/2]

◆ GetExpectedMessages() [2/2]

◆ GetLastExecutionSuccessState()

◆ GetRequiredDeviceNum()

◆ GetSuppressedLogCategories()

◆ GetTestAssetPath()

◆ GetTestContext()

◆ GetTestFlags()

◆ GetTestFullName()

◆ GetTestName()

◆ GetTestOpenCommand()

◆ GetTests()

◆ GetTestSourceFileLine() [1/2]

◆ GetTestSourceFileLine() [2/2]

◆ GetTestSourceFileName() [1/2]

◆ GetTestSourceFileName() [2/2]

◆ HasAnyErrors()

◆ HasMetExpectedErrors()

◆ HasMetExpectedMessages()

◆ IsComplexTask()

◆ IsRanOnSeparateThread()

◆ LoadDefaultLogSettings()

◆ LogCategoryMatchesSeverityInclusive()

◆ PopContext()

◆ PushContext()

◆ RunTest()

◆ SetTelemetryStorage()

◆ SetTestContext()

◆ ShouldCaptureLogCategory()

◆ SuppressLogErrors()

◆ SuppressLogs()

◆ SuppressLogWarnings()

◆ TestEqual() [1/29]

◆ TestEqual() [2/29]

◆ TestEqual() [3/29]

◆ TestEqual() [4/29]

◆ TestEqual() [5/29]

◆ TestEqual() [6/29]

◆ TestEqual() [7/29]

◆ TestEqual() [8/29]

◆ TestEqual() [9/29]

◆ TestEqual() [10/29]

◆ TestEqual() [11/29]

◆ TestEqual() [12/29]