#include <AutomationTest.h>

Inheritance diagram for FBDDAutomationTestBase:

Collaboration diagram for FBDDAutomationTestBase:

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

virtual bool	RunTest (const FString &Parameters) override

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

bool	IsDiscoveryMode () const

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

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

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

void	It (const FString &InDescription, TFunction< void()> DoWork)

void	BeforeEach (TFunction< void()> DoWork)

void	AfterEach (TFunction< void()> DoWork)

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

virtual	~FAutomationTestBase ()

virtual uint32	GetTestFlags () const =0

FString	GetTestName () const

FString	GetTestContext () const

virtual FString	GetTestFullName () const

virtual uint32	GetRequiredDeviceNum () const =0

void	ClearExecutionInfo ()

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

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

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

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

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

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

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

virtual void	AddAnalyticsItem (const FString &InAnalyticsItem)

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

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

virtual void	SetTelemetryStorage (const FString &StorageName)

bool	HasAnyErrors () const

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

bool	HasMetExpectedErrors ()

bool	GetLastExecutionSuccessState ()

void	SetSuccessState (bool bSuccessful)

bool	GetSuccessState ()

void	GetExecutionInfo (FAutomationTestExecutionInfo &OutInfo) const

void	GenerateTestNames (TArray< FAutomationTestInfo > &TestInfo) const

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

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

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

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

const bool	IsComplexTask () const

const bool	IsRanOnSeparateThread () const

virtual bool	SuppressLogs ()

virtual bool	SuppressLogErrors ()

virtual bool	SuppressLogWarnings ()

virtual bool	ElevateLogWarningsToErrors ()

FORCEINLINE void	AddCommand (IAutomationLatentCommand *NewCommand)

FORCEINLINE 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 ()

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

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

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

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

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

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

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

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

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

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

bool	TestEqualInsensitive (const TCHAR What, const TCHAR Actual, const TCHAR *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 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 TCHAR What, const FString &Actual, const TCHAR Expected)

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

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

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

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

bool	TestEqual (const FString &What, const FString &Actual, const FString &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)

bool	TestFalse (const TCHAR *What, bool Value)

bool	TestFalse (const FString &What, bool Value)

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

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

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)

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)

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)

bool	TestTrue (const TCHAR *What, bool Value)

bool	TestTrue (const FString &What, bool Value)

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

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

Private Member Functions
void	PushDescription (const FString &InDescription)

void	PopDescription (const FString &InDescription)

FString	GetDescription () const

Private Attributes
FString	TestIdToExecute

TArray< FString >	Description

TArray< TFunction< void()> >	BeforeEachStack

TArray< TFunction< void()> >	AfterEachStack

TArray< FString >	BeautifiedNames

TArray< FString >	TestCommands

bool	bIsDiscoveryMode

bool	bBaseRunTestRan

Additional Inherited Members
Static Public Member Functions inherited from FAutomationTestBase
static bool	LogCategoryMatchesSeverityInclusive (ELogVerbosity::Type Actual, ELogVerbosity::Type MaximumVerbosity)

Protected Member Functions inherited from FAutomationTestBase
virtual FString	GetBeautifiedTestName () const =0

virtual void	SetTestContext (FString Context)

uint32	ExtractAutomationTestFlags (FString InTagNotation)

Protected Attributes inherited from FAutomationTestBase
bool	bComplexTask

bool	bRunOnSeparateThread

bool	bSuppressLogs = false

FString	TestName

FString	TestParameterContext

FAutomationTestExecutionInfo	ExecutionInfo

Detailed Description

Definition at line 1945 of file AutomationTest.h.

Constructor & Destructor Documentation

◆ FBDDAutomationTestBase()

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

inline

Definition at line 1948 of file AutomationTest.h.

Here is the call graph for this function:

Member Function Documentation

◆ AfterEach()

void FBDDAutomationTestBase::AfterEach ( TFunction< void()> DoWork )

inline

Definition at line 2056 of file AutomationTest.h.

◆ BeforeEach()

void FBDDAutomationTestBase::BeforeEach ( TFunction< void()> DoWork )

inline

Definition at line 2051 of file AutomationTest.h.

◆ Describe()

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

inline

Definition at line 1987 of file AutomationTest.h.

Here is the call graph for this function:

◆ GetDescription()

FString FBDDAutomationTestBase::GetDescription ( ) const

inlineprivate

Definition at line 2073 of file AutomationTest.h.

◆ GetTests()

virtual void FBDDAutomationTestBase::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.

Definition at line 1962 of file AutomationTest.h.

Here is the call graph for this function:

◆ IsDiscoveryMode()

bool FBDDAutomationTestBase::IsDiscoveryMode ( ) const

inline

Definition at line 1976 of file AutomationTest.h.

◆ It()

void FBDDAutomationTestBase::It	(	const FString &	InDescription,
		TFunction< void()>	DoWork )

inline

Definition at line 2019 of file AutomationTest.h.

Here is the call graph for this function:

◆ PopDescription()

void FBDDAutomationTestBase::PopDescription ( const FString & InDescription )

inlineprivate

Definition at line 2068 of file AutomationTest.h.

Here is the caller graph for this function:

◆ PushDescription()

void FBDDAutomationTestBase::PushDescription ( const FString & InDescription )

inlineprivate

Definition at line 2063 of file AutomationTest.h.

Here is the caller graph for this function:

◆ RunTest()

virtual bool FBDDAutomationTestBase::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.

Definition at line 1954 of file AutomationTest.h.

Here is the caller graph for this function:

◆ xDescribe()

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

inline

Definition at line 1981 of file AutomationTest.h.

◆ xIt()

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

inline

Definition at line 2013 of file AutomationTest.h.

Member Data Documentation

◆ AfterEachStack

TArray<TFunction<void()> > FBDDAutomationTestBase::AfterEachStack

private

Definition at line 2119 of file AutomationTest.h.

◆ bBaseRunTestRan

bool FBDDAutomationTestBase::bBaseRunTestRan

mutableprivate

Definition at line 2124 of file AutomationTest.h.

◆ BeautifiedNames

TArray<FString> FBDDAutomationTestBase::BeautifiedNames

private

Definition at line 2121 of file AutomationTest.h.

◆ BeforeEachStack

TArray<TFunction<void()> > FBDDAutomationTestBase::BeforeEachStack

private

Definition at line 2118 of file AutomationTest.h.

◆ bIsDiscoveryMode

bool FBDDAutomationTestBase::bIsDiscoveryMode

mutableprivate

Definition at line 2123 of file AutomationTest.h.

◆ Description

TArray<FString> FBDDAutomationTestBase::Description

private

Definition at line 2117 of file AutomationTest.h.

◆ TestCommands

TArray<FString> FBDDAutomationTestBase::TestCommands

private

Definition at line 2122 of file AutomationTest.h.

◆ TestIdToExecute

FString FBDDAutomationTestBase::TestIdToExecute

private

Definition at line 2116 of file AutomationTest.h.

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

C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/AutomationTest.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBDDAutomationTestBase()

Member Function Documentation

◆ AfterEach()

◆ BeforeEach()

◆ Describe()

◆ GetDescription()

◆ GetTests()

◆ IsDiscoveryMode()

◆ It()

◆ PopDescription()

◆ PushDescription()

◆ RunTest()

◆ xDescribe()

◆ xIt()

Member Data Documentation

◆ AfterEachStack

◆ bBaseRunTestRan

◆ BeautifiedNames

◆ BeforeEachStack

◆ bIsDiscoveryMode

◆ Description

◆ TestCommands

◆ TestIdToExecute