1. Epic GamesDeveloper
  3. AFunctionalTest

AFunctionalTest

API > API/Developer > API/Developer/FunctionalTesting

Inheritance Hierarchy

References

   
Module FunctionalTesting
Header /Engine/Source/Developer/FunctionalTesting/Classes/FunctionalTest.h
Include #include "FunctionalTest.h"

Syntax

class AFunctionalTest : public AActor

Variables

  Type Name Description
Public variable FString Author The owner is the group or person responsible for the test.
Public variable TArray< TObjectPtr< AActor > > AutoDestroyActors  
Protected variable uint32: 1 bIsEnabled Allows a test to be disabled.
Public variable bool bIsRunning AG TEMP - solving a compile issue in a temp way to unblock the bui.d.
Public variable FName CurrentRerunCause Cause of the current rerun if we're in a named rerun.
Public variable FString Description A description of the test, like what is this test trying to determine.
Public variable FString FailureMessage  
Protected variable EFunctionalTestLogHandling LogErrorHandling Determines how LogErrors are handled during this test.
Protected variable EFunctionalTestLogHandling LogWarningHandling Determines how LogWarnings are handled during this test.
Protected variable TObjectPtr< AActor > ObservationPoint Allows you to specify another actor to view the test from.
Public variable FFunctionalTestEventSignature OnTestFinished Called when the test is finished. Use it to clean up
Public variable FFunctionalTestEventSignature OnTestPrepare Called when the test is ready to prepare
Public variable FFunctionalTestEventSignature OnTestStart Called when the test is started
Public variable float PreparationTimeLimit The Test's time limit for preparation, this is the time it has to return true when checking IsReady().
Protected variable FRandomStream RandomNumbersStream A random number stream that you can use during testing.
Public variable TObjectPtr< class UFuncTestRenderingComponent > RenderComp  
Public variable TArray< FName > RerunCauses List of causes we need a re-run.
Public variable EFunctionalTestResult Result  
Public variable uint32 RunFrame  
Public variable float RunTime  
Public variable uint32 StartFrame  
Public variable float StartTime  
Public variable TArray< FString > Steps  
Public variable FFunctionalTestDoneSignature TestFinishedObserver  
Public variable FString TestLabel  
Public variable TObjectPtr< class UTextRenderComponent > TestName  
Public variable float TimeLimit Test's time limit. '0' means no limit
Public variable FText TimesUpMessage  
Public variable EFunctionalTestResult TimesUpResult If test is limited by time this is the result that will be returned when time runs out
Public variable float TotalTime  

Constructors

  Type Name Description
Public function  

AFunctionalTest ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

AddError ( const FString& Message
)

  
Public function Virtual void

AddInfo ( const FString& Message
)

  
Public function void

AddRerun ( FName Reason
)

 Causes the test to be rerun for a specific named reason.
Public function void

AddWarning ( const FString& Message
)

  
Public function Virtual bool

AssertEqual_Bool ( bool Actual,
bool Expected,
const FString& What,
const UObject* ContextObject
)

 Assert that two bools are equal
Public function Virtual bool

AssertEqual_Box2D ( FBox2D Actual,
FBox2D Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that two two-component boxes are (memberwise) equal within a small tolerance.
Public function bool

AssertEqual_Double ( double Actual,
double Expected,
const FString& What,
double Tolerance,
const UObject* ContextObject
)

 Assert that two double are equal within tolerance between two doubles.
Public function Virtual bool

AssertEqual_Float ( float Actual,
float Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that two floats are equal within tolerance between two floats.
Public function Virtual bool

AssertEqual_Int ( int Actual,
int Expected,
const FString& What,
const UObject* ContextObject
)

 Assert that two ints are equal
Public function Virtual bool

AssertEqual_Matrix ( FMatrix Actual,
FMatrix Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that two 4x4 matrices are (memberwise) equal within a small tolerance.
Public function Virtual bool

AssertEqual_Name ( FName Actual,
FName Expected,
const FString& What,
const UObject* ContextObject
)

 Assert that two FNames are equal
Public function Virtual bool

AssertEqual_Object ( UObject* Actual,
UObject* Expected,
const FString& What,
const UObject* ContextObject
)

 Assert that two Objects are equal
Public function Virtual bool

AssertEqual_Plane ( FPlane Actual,
FPlane Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that two planes are (memberwise) equal within a small tolerance.
Public function Virtual bool

AssertEqual_Quat ( FQuat Actual,
FQuat Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that two quats are (memberwise) equal within a small tolerance.
Public function Virtual bool

AssertEqual_Rotator ( FRotator Actual,
FRotator Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that the component angles of two rotators are all equal within a small tolerance.
Public function Virtual bool

AssertEqual_String ( FString Actual,
FString Expected,
const FString& What,
const UObject* ContextObject
)

 Assert that two Strings are equal.
Public function Virtual bool

AssertEqual_TraceQueryResults ( const UTraceQueryTestResults* Actual,
const UTraceQueryTestResults* Expected,
const FString& What,
const UObject* ContextObject
)

 Assert that two TraceQueryResults are equal.
Public function Virtual bool

AssertEqual_Transform ( const FTransform& Actual,
const FTransform& Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that two transforms are (components memberwise - translation, rotation, scale) equal within a small tolerance.
Public function Virtual bool

AssertEqual_Vector ( FVector Actual,
FVector Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that two vectors are (memberwise) equal within a small tolerance.
Public function Virtual bool

AssertEqual_Vector2D ( FVector2D Actual,
FVector2D Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that two two-component vectors are (memberwise) equal within a small tolerance.
Public function Virtual bool

AssertEqual_Vector4 ( FVector4 Actual,
FVector4 Expected,
const FString& What,
float Tolerance,
const UObject* ContextObject
)

 Assert that two four-component vectors are (memberwise) equal within a small tolerance.
Public function Virtual bool

AssertFalse ( bool Condition,
const FString& Message,
const UObject* ContextObject
)

 Assert that a boolean value is false.
Public function Virtual bool

AssertIsValid ( UObject* Object,
const FString& Message,
const UObject* ContextObject
)

 Assert that a UObject is valid
Public function Virtual bool

AssertNotEqual_Box2D ( FBox2D Actual,
FBox2D NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that two two-component boxes are (memberwise) not equal within a small tolerance.
Public function Virtual bool

AssertNotEqual_Matrix ( FMatrix Actual,
FMatrix NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that two 4x4 matrices are (memberwise) not equal within a small tolerance.
Public function Virtual bool

AssertNotEqual_Plane ( FPlane Actual,
FPlane NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that two planes are (memberwise) not equal within a small tolerance.
Public function Virtual bool

AssertNotEqual_Quat ( FQuat Actual,
FQuat NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that two quats are (memberwise) not equal within a small tolerance.
Public function Virtual bool

AssertNotEqual_Rotator ( FRotator Actual,
FRotator NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that the component angles of two rotators are all not equal within a small tolerance.
Public function Virtual bool

AssertNotEqual_String ( FString Actual,
FString NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that two Strings are not equal.
Public function Virtual bool

AssertNotEqual_Transform ( const FTransform& Actual,
const FTransform& NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that two transforms are (components memberwise - translation, rotation, scale) not equal within a small tolerance.
Public function Virtual bool

AssertNotEqual_Vector ( FVector Actual,
FVector NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that two vectors are (memberwise) not equal within a small tolerance.
Public function Virtual bool

AssertNotEqual_Vector2D ( FVector2D Actual,
FVector2D NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that two two-component vectors are (memberwise) not equal within a small tolerance.
Public function Virtual bool

AssertNotEqual_Vector4 ( FVector4 Actual,
FVector4 NotExpected,
const FString& What,
const UObject* ContextObject
)

 Assert that two four-component vectors are (memberwise) not equal within a small tolerance.
Public function Virtual bool

AssertTrue ( bool Condition,
const FString& Message,
const UObject* ContextObject
)

 Assert that a boolean value is true.
Public function Virtual bool

AssertValue_DateTime ( FDateTime Actual,
EComparisonMethod ShouldBe,
FDateTime Expected,
const FString& What,
const UObject* ContextObject
)

 Assert on a relationship between two DateTimes.
Public function bool

AssertValue_Double ( double Actual,
EComparisonMethod ShouldBe,
double Expected,
const FString& What,
const UObject* ContextObject
)

 Assert on a relationship between two doubles.
Public function Virtual bool

AssertValue_Float ( float Actual,
EComparisonMethod ShouldBe,
float Expected,
const FString& What,
const UObject* ContextObject
)

 Assert on a relationship between two floats.
Public function Virtual bool

AssertValue_Int ( int32 Actual,
EComparisonMethod ShouldBe,
int32 Expected,
const FString& What,
const UObject* ContextObject
)

 Assert on a relationship between two integers.
Public function Virtual void

CleanUp ()

 Called to clean up when tests is removed from the list of active tests after finishing execution.
Public function Const TArray< AActor * > Used by debug drawing to gather actors this test is using and point at them on the level to better understand test's setup
Public function void  
Public function Virtual void

FinishTest ( EFunctionalTestResult TestResult,
const FString& Message
)

  
Public function Virtual Const void

GatherRelevantActors ( TArray< AActor* >& OutActors
)

  
Public function Virtual Const FString  
Public function Const FName Returns the current re-run reason if we're in a named re-run.
Public function Const FString  
Public function Virtual Const FString  
Public function UBillboardComponent * Returns SpriteComponent subobject
Protected function void Goto an observation location.
Public function Const bool  
Public function Const bool  
Protected function bool

IsReady ()

 IsReady() is called once per frame after a test is run, until it returns true.
Protected function Virtual bool  
Public function Const bool  
Public function Virtual void

LogMessage ( const FString& Message
)

  
Public function void

LogStep ( ELogVerbosity::Type Verbosity,
const FString& Message
)

 Protected:
Public function Const FString  
Public function Static void

OnSelectObject ( UObject* NewSelection
)

  
Protected function Virtual void  
Public function Const bool Retrieves information whether test wants to have another run just after finishing
Protected function Virtual void Prepare Test is fired once the test starts up, before the test IsReady() and thus before Start Test is called.
Protected function void Prepare Test is fired once the test starts up, before the test IsReady() and thus before Start Test is called.
Protected function void Called once the IsReady() check for the test returns true.
Public function Virtual void

RegisterAutoDestroyActor ( AActor* ActorToAutoDestroy
)

 Actors registered this way will be automatically destroyed (by limiting their lifespan) on test finish
Public function Virtual bool

RunTest ( const TArray< FString >& Params
)

  
Public function void

SetConsoleVariable ( const FString& Name,
const FString& InValue
)

 Sets the CVar from the given input. Variable gets reset after the test.
Public function void

SetConsoleVariableFromBoolean ( const FString& Name,
const bool InValue
)

 Sets the CVar from the given input. Variable gets reset after the test.
Public function void

SetConsoleVariableFromFloat ( const FString& Name,
const float InValue
)

 Sets the CVar from the given input. Variable gets reset after the test.
Public function void

SetConsoleVariableFromInteger ( const FString& Name,
const int32 InValue
)

 Sets the CVar from the given input. Variable gets reset after the test.
Public function Virtual void

SetTimeLimit ( float NewTimeLimit,
EFunctionalTestResult ResultWhenTimeRunsOut
)

  
Public function void

StartStep ( const FString& StepName
)

  
Protected function Virtual void Called once the IsReady() check for the test returns true.
Public function Virtual Const bool  

Overridden from AActor

  Type Name Description
Public function Virtual Const bool Returns true if this actor allows changing the spatially loaded flag.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Public function Virtual Const bool DataLayers functions.
Public function Virtual void

OnConstruction ( const FTransform& Transform
)

 Called when an instance of this class is placed (in editor) or spawned.
Public function Virtual void

Tick ( float DeltaSeconds
)

 Function called every frame on this Actor.

Overridden from UObject

  Type Name Description
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page