UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAutomationSpecBase Class Referenceabstract

#include <AutomationTest.h>

+ Inheritance diagram for FAutomationSpecBase:

Public Member Functions

 FAutomationSpecBase (const FString &InName, const bool bInComplexTask)
 
virtual bool RunTest (const FString &InParameters) override
 
virtual bool IsStressTest () const
 
virtual uint32 GetRequiredDeviceNum () const override
 
virtual FString GetTestSourceFileName (const FString &InTestName) const override
 
virtual int32 GetTestSourceFileLine (const FString &InTestName) const override
 
virtual void GetTests (TArray< FString > &OutBeautifiedNames, TArray< FString > &OutTestCommands) const override
 
void xDescribe (const FString &InDescription, TFunction< void()> DoWork)
 
void Describe (const TArray< FString > InDescriptions, TFunction< void(int32)> DoWork)
 
void Describe (const FString &InDescription, TFunction< void()> DoWork)
 
void xIt (const FString &InDescription, TFunction< void()> DoWork)
 
void xIt (const FString &InDescription, EAsyncExecution Execution, TFunction< void()> DoWork)
 
void xIt (const FString &InDescription, EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void()> DoWork)
 
void xLatentIt (const FString &InDescription, TFunction< void(const FDoneDelegate &)> DoWork)
 
void xLatentIt (const FString &InDescription, const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
void xLatentIt (const FString &InDescription, EAsyncExecution Execution, TFunction< void(const FDoneDelegate &)> DoWork)
 
void xLatentIt (const FString &InDescription, EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
void It (const FString &InDescription, TFunction< void()> DoWork, UE::FSourceLocation Location=UE::FSourceLocation::Current())
 
void It (const FString &InDescription, EAsyncExecution Execution, TFunction< void()> DoWork, UE::FSourceLocation Location=UE::FSourceLocation::Current())
 
void It (const FString &InDescription, EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void()> DoWork, UE::FSourceLocation Location=UE::FSourceLocation::Current())
 
void LatentIt (const FString &InDescription, TFunction< void(const FDoneDelegate &)> DoWork, UE::FSourceLocation Location=UE::FSourceLocation::Current())
 
void LatentIt (const FString &InDescription, const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork, UE::FSourceLocation Location=UE::FSourceLocation::Current())
 
void LatentIt (const FString &InDescription, EAsyncExecution Execution, TFunction< void(const FDoneDelegate &)> DoWork, UE::FSourceLocation Location=UE::FSourceLocation::Current())
 
void LatentIt (const FString &InDescription, EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork, UE::FSourceLocation Location=UE::FSourceLocation::Current())
 
void xBeforeEach (TFunction< void()> DoWork)
 
void xBeforeEach (EAsyncExecution Execution, TFunction< void()> DoWork)
 
void xBeforeEach (EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void()> DoWork)
 
void xLatentBeforeEach (TFunction< void(const FDoneDelegate &)> DoWork)
 
void xLatentBeforeEach (const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
void xLatentBeforeEach (EAsyncExecution Execution, TFunction< void(const FDoneDelegate &)> DoWork)
 
void xLatentBeforeEach (EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
void BeforeEach (TFunction< void()> DoWork)
 
void BeforeEach (EAsyncExecution Execution, TFunction< void()> DoWork)
 
void BeforeEach (EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void()> DoWork)
 
void LatentBeforeEach (TFunction< void(const FDoneDelegate &)> DoWork)
 
void LatentBeforeEach (const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
void LatentBeforeEach (EAsyncExecution Execution, TFunction< void(const FDoneDelegate &)> DoWork)
 
void LatentBeforeEach (EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
void xAfterEach (TFunction< void()> DoWork)
 
void xAfterEach (EAsyncExecution Execution, TFunction< void()> DoWork)
 
void xAfterEach (EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void()> DoWork)
 
void xLatentAfterEach (TFunction< void(const FDoneDelegate &)> DoWork)
 
void xLatentAfterEach (const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
void xLatentAfterEach (EAsyncExecution Execution, TFunction< void(const FDoneDelegate &)> DoWork)
 
void xLatentAfterEach (EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
void AfterEach (TFunction< void()> DoWork)
 
void AfterEach (EAsyncExecution Execution, TFunction< void()> DoWork)
 
void AfterEach (EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void()> DoWork)
 
void LatentAfterEach (TFunction< void(const FDoneDelegate &)> DoWork)
 
void LatentAfterEach (const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
void LatentAfterEach (EAsyncExecution Execution, TFunction< void(const FDoneDelegate &)> DoWork)
 
void LatentAfterEach (EAsyncExecution Execution, const FTimespan &Timeout, TFunction< void(const FDoneDelegate &)> DoWork)
 
- Public Member Functions inherited from FAutomationTestBase
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
 
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 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)
 
- Public Member Functions inherited from TSharedFromThis< FAutomationSpecBase >
TSharedRef< FAutomationSpecBase, Mode > AsShared ()
 
TSharedRef< FAutomationSpecBase const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FAutomationSpecBase, Mode > AsWeak ()
 
TWeakPtr< FAutomationSpecBase const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Member Functions

void EnsureDefinitions () const
 
virtual void Define ()=0
 
void PostDefine ()
 
void Redefine ()
 
- Protected Member Functions inherited from FAutomationTestBase
virtual void SetTestContext (FString Context)
 
CORE_API EAutomationTestFlags ExtractAutomationTestFlags (FString InTagNotation)
 
- Protected Member Functions inherited from TSharedFromThis< FAutomationSpecBase >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Protected Attributes

FTimespan DefaultTimeout
 
bool bEnableSkipIfError
 
- Protected Attributes inherited from FAutomationTestBase
bool bComplexTask
 
bool bRunOnSeparateThread
 
bool bSuppressLogs = false
 
FString TestName
 
FString TestParameterContext
 
FAutomationTestExecutionInfo ExecutionInfo
 

Additional Inherited Members

- Static Public Member Functions inherited from FAutomationTestBase
static CORE_API bool LogCategoryMatchesSeverityInclusive (ELogVerbosity::Type Actual, ELogVerbosity::Type MaximumVerbosity)
 
static CORE_API void LoadDefaultLogSettings ()
 
- Static Public Attributes inherited from FAutomationTestBase
static CORE_API bool bSuppressLogWarnings = false
 
static CORE_API bool bSuppressLogErrors = false
 
static CORE_API bool bElevateLogWarningsToErrors = false
 
static CORE_API TArray< FString > SuppressedLogCategories
 
- Static Protected Member Functions inherited from TSharedFromThis< FAutomationSpecBase >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Constructor & Destructor Documentation

◆ FAutomationSpecBase()

FAutomationSpecBase::FAutomationSpecBase ( const FString &  InName,
const bool  bInComplexTask 
)
inline

Member Function Documentation

◆ AfterEach() [1/3]

void FAutomationSpecBase::AfterEach ( EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void()>  DoWork 
)
inline

◆ AfterEach() [2/3]

void FAutomationSpecBase::AfterEach ( EAsyncExecution  Execution,
TFunction< void()>  DoWork 
)
inline

◆ AfterEach() [3/3]

void FAutomationSpecBase::AfterEach ( TFunction< void()>  DoWork)
inline

◆ BeforeEach() [1/3]

void FAutomationSpecBase::BeforeEach ( EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void()>  DoWork 
)
inline

◆ BeforeEach() [2/3]

void FAutomationSpecBase::BeforeEach ( EAsyncExecution  Execution,
TFunction< void()>  DoWork 
)
inline

◆ BeforeEach() [3/3]

void FAutomationSpecBase::BeforeEach ( TFunction< void()>  DoWork)
inline

◆ Define()

virtual void FAutomationSpecBase::Define ( )
protectedpure virtual

◆ Describe() [1/2]

void FAutomationSpecBase::Describe ( const FString &  InDescription,
TFunction< void()>  DoWork 
)
inline

◆ Describe() [2/2]

void FAutomationSpecBase::Describe ( const TArray< FString >  InDescriptions,
TFunction< void(int32)>  DoWork 
)
inline

◆ EnsureDefinitions()

void FAutomationSpecBase::EnsureDefinitions ( ) const
inlineprotected

◆ GetRequiredDeviceNum()

virtual uint32 FAutomationSpecBase::GetRequiredDeviceNum ( ) const
inlineoverridevirtual

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

Returns
Number of required participants

Implements FAutomationTestBase.

◆ GetTests()

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

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)

Implements FAutomationTestBase.

◆ GetTestSourceFileLine()

virtual int32 FAutomationSpecBase::GetTestSourceFileLine ( const FString &  InTestName) const
inlineoverridevirtual

Gets the line number where this test was defined.

Reimplemented from FAutomationTestBase.

◆ GetTestSourceFileName()

virtual FString FAutomationSpecBase::GetTestSourceFileName ( const FString &  InTestName) const
inlineoverridevirtual

Gets the filename where this test was defined.

Reimplemented from FAutomationTestBase.

◆ IsStressTest()

virtual bool FAutomationSpecBase::IsStressTest ( ) const
inlinevirtual

◆ It() [1/3]

void FAutomationSpecBase::It ( const FString &  InDescription,
EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void()>  DoWork,
UE::FSourceLocation  Location = UE::FSourceLocation::Current() 
)
inline

◆ It() [2/3]

void FAutomationSpecBase::It ( const FString &  InDescription,
EAsyncExecution  Execution,
TFunction< void()>  DoWork,
UE::FSourceLocation  Location = UE::FSourceLocation::Current() 
)
inline

◆ It() [3/3]

void FAutomationSpecBase::It ( const FString &  InDescription,
TFunction< void()>  DoWork,
UE::FSourceLocation  Location = UE::FSourceLocation::Current() 
)
inline

◆ LatentAfterEach() [1/4]

void FAutomationSpecBase::LatentAfterEach ( const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ LatentAfterEach() [2/4]

void FAutomationSpecBase::LatentAfterEach ( EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ LatentAfterEach() [3/4]

void FAutomationSpecBase::LatentAfterEach ( EAsyncExecution  Execution,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ LatentAfterEach() [4/4]

void FAutomationSpecBase::LatentAfterEach ( TFunction< void(const FDoneDelegate &)>  DoWork)
inline

◆ LatentBeforeEach() [1/4]

void FAutomationSpecBase::LatentBeforeEach ( const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ LatentBeforeEach() [2/4]

void FAutomationSpecBase::LatentBeforeEach ( EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ LatentBeforeEach() [3/4]

void FAutomationSpecBase::LatentBeforeEach ( EAsyncExecution  Execution,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ LatentBeforeEach() [4/4]

void FAutomationSpecBase::LatentBeforeEach ( TFunction< void(const FDoneDelegate &)>  DoWork)
inline

◆ LatentIt() [1/4]

void FAutomationSpecBase::LatentIt ( const FString &  InDescription,
const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork,
UE::FSourceLocation  Location = UE::FSourceLocation::Current() 
)
inline

◆ LatentIt() [2/4]

void FAutomationSpecBase::LatentIt ( const FString &  InDescription,
EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork,
UE::FSourceLocation  Location = UE::FSourceLocation::Current() 
)
inline

◆ LatentIt() [3/4]

void FAutomationSpecBase::LatentIt ( const FString &  InDescription,
EAsyncExecution  Execution,
TFunction< void(const FDoneDelegate &)>  DoWork,
UE::FSourceLocation  Location = UE::FSourceLocation::Current() 
)
inline

◆ LatentIt() [4/4]

void FAutomationSpecBase::LatentIt ( const FString &  InDescription,
TFunction< void(const FDoneDelegate &)>  DoWork,
UE::FSourceLocation  Location = UE::FSourceLocation::Current() 
)
inline

◆ PostDefine()

void FAutomationSpecBase::PostDefine ( )
inlineprotected

◆ Redefine()

void FAutomationSpecBase::Redefine ( )
inlineprotected

◆ RunTest()

virtual bool FAutomationSpecBase::RunTest ( const FString &  Parameters)
inlineoverridevirtual

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

Implements FAutomationTestBase.

◆ xAfterEach() [1/3]

void FAutomationSpecBase::xAfterEach ( EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void()>  DoWork 
)
inline

◆ xAfterEach() [2/3]

void FAutomationSpecBase::xAfterEach ( EAsyncExecution  Execution,
TFunction< void()>  DoWork 
)
inline

◆ xAfterEach() [3/3]

void FAutomationSpecBase::xAfterEach ( TFunction< void()>  DoWork)
inline

◆ xBeforeEach() [1/3]

void FAutomationSpecBase::xBeforeEach ( EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void()>  DoWork 
)
inline

◆ xBeforeEach() [2/3]

void FAutomationSpecBase::xBeforeEach ( EAsyncExecution  Execution,
TFunction< void()>  DoWork 
)
inline

◆ xBeforeEach() [3/3]

void FAutomationSpecBase::xBeforeEach ( TFunction< void()>  DoWork)
inline

◆ xDescribe()

void FAutomationSpecBase::xDescribe ( const FString &  InDescription,
TFunction< void()>  DoWork 
)
inline

◆ xIt() [1/3]

void FAutomationSpecBase::xIt ( const FString &  InDescription,
EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void()>  DoWork 
)
inline

◆ xIt() [2/3]

void FAutomationSpecBase::xIt ( const FString &  InDescription,
EAsyncExecution  Execution,
TFunction< void()>  DoWork 
)
inline

◆ xIt() [3/3]

void FAutomationSpecBase::xIt ( const FString &  InDescription,
TFunction< void()>  DoWork 
)
inline

◆ xLatentAfterEach() [1/4]

void FAutomationSpecBase::xLatentAfterEach ( const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ xLatentAfterEach() [2/4]

void FAutomationSpecBase::xLatentAfterEach ( EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ xLatentAfterEach() [3/4]

void FAutomationSpecBase::xLatentAfterEach ( EAsyncExecution  Execution,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ xLatentAfterEach() [4/4]

void FAutomationSpecBase::xLatentAfterEach ( TFunction< void(const FDoneDelegate &)>  DoWork)
inline

◆ xLatentBeforeEach() [1/4]

void FAutomationSpecBase::xLatentBeforeEach ( const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ xLatentBeforeEach() [2/4]

void FAutomationSpecBase::xLatentBeforeEach ( EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ xLatentBeforeEach() [3/4]

void FAutomationSpecBase::xLatentBeforeEach ( EAsyncExecution  Execution,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ xLatentBeforeEach() [4/4]

void FAutomationSpecBase::xLatentBeforeEach ( TFunction< void(const FDoneDelegate &)>  DoWork)
inline

◆ xLatentIt() [1/4]

void FAutomationSpecBase::xLatentIt ( const FString &  InDescription,
const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ xLatentIt() [2/4]

void FAutomationSpecBase::xLatentIt ( const FString &  InDescription,
EAsyncExecution  Execution,
const FTimespan Timeout,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ xLatentIt() [3/4]

void FAutomationSpecBase::xLatentIt ( const FString &  InDescription,
EAsyncExecution  Execution,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

◆ xLatentIt() [4/4]

void FAutomationSpecBase::xLatentIt ( const FString &  InDescription,
TFunction< void(const FDoneDelegate &)>  DoWork 
)
inline

Member Data Documentation

◆ bEnableSkipIfError

bool FAutomationSpecBase::bEnableSkipIfError
protected

◆ DefaultTimeout

FTimespan FAutomationSpecBase::DefaultTimeout
protected

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