UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAutomationTestUObjectClassBase Class Reference

#include <UObjectTestUtils.h>

+ Inheritance diagram for FAutomationTestUObjectClassBase:

Public Member Functions

 FAutomationTestUObjectClassBase (const FString &InName, const bool bInComplexTask)
 
virtual bool SuppressLogErrors () override
 
virtual bool SuppressLogWarnings () override
 
virtual bool ElevateLogWarningsToErrors () override
 
template<typename UEnumType UE_REQUIRES>
bool TestEqual (const TCHAR *What, const UEnumType Actual, const UEnumType Expected, const FAutomationTestBase &InTestInstance)
 
template<typename UEnumType UE_REQUIRES>
bool TestNotEqual (const TCHAR *What, const UEnumType Actual, const UEnumType Expected, const FAutomationTestBase &InTestInstance)
 
- 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
 
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 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)
 

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
 
- Protected Member Functions inherited from FAutomationTestBase
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 inherited from FAutomationTestBase
bool bComplexTask
 
bool bRunOnSeparateThread
 
bool bSuppressLogs = false
 
FString TestName
 
FString TestParameterContext
 
FAutomationTestExecutionInfo ExecutionInfo
 

Constructor & Destructor Documentation

◆ FAutomationTestUObjectClassBase()

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

Member Function Documentation

◆ ElevateLogWarningsToErrors()

virtual bool FAutomationTestUObjectClassBase::ElevateLogWarningsToErrors ( )
inlineoverridevirtual

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

Returns
true to make warnings errors

Reimplemented from FAutomationTestBase.

◆ SuppressLogErrors()

virtual bool FAutomationTestUObjectClassBase::SuppressLogErrors ( )
inlineoverridevirtual

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

Returns
false to make errors errors

Reimplemented from FAutomationTestBase.

◆ SuppressLogWarnings()

virtual bool FAutomationTestUObjectClassBase::SuppressLogWarnings ( )
inlineoverridevirtual

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

Returns
true to make warnings errors

Reimplemented from FAutomationTestBase.

◆ TestEqual()

template<typename UEnumType UE_REQUIRES>
bool FAutomationTestUObjectClassBase::TestEqual ( const TCHAR What,
const UEnumType  Actual,
const UEnumType  Expected,
const FAutomationTestBase InTestInstance 
)
inline

◆ TestNotEqual()

template<typename UEnumType UE_REQUIRES>
bool FAutomationTestUObjectClassBase::TestNotEqual ( const TCHAR What,
const UEnumType  Actual,
const UEnumType  Expected,
const FAutomationTestBase InTestInstance 
)
inline

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