1. Epic GamesDeveloper
  3. FAutomationTestFramework

FAutomationTestFramework

Class representing the main framework for running automation tests

Unreal Engine C++ API Reference > Runtime > Core > Misc

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/AutomationTest.h
Include #include "Misc/AutomationTest.h"

Syntax

class FAutomationTestFramework

Remarks

Class representing the main framework for running automation tests

Variables

  Type Name Description
Public variable FOnPerformanceDataRetrieved OnPerformanceDataRetrieved Called when the performance data is retrieved.
Public variable FOnTestScreenshotComparisonComplete OnScreenshotCompared Called when a screenshot comparison completes.
Public variable FSimpleMulticastDelegate OnScreenshotTakenAndCompared The final call related to screenshots, after they've been taken, and after they've been compared (or not if automation isn't running).
Public variable FOnTestDataRetrieved OnTestDataRetrieved Called when the test data is retrieved.
Public variable FOnTestEvent OnTestEndEvent Called when each automated test is ending
Public variable FOnTestEvent OnTestStartEvent Called when each automated test is starting
Public variable FSimpleMulticastDelegate PostTestingEvent Called after all automated tests have completed
Public variable FSimpleMulticastDelegate PreTestingEvent Called right before automated test is about to begin

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

  Type Name Description
Public function void

AddAnalyticsItemToCurrentTest ( const FString& AnalyticsItem
)

 Adds a analytics string to the current test to be parsed later.
Public function Const bool

CanRunTestInEnvironment ( const FString& InTestToRun,
FString* OutReason,
bool* OutWarn
)

 Internal helper method designed to check if the given test is able to run in the current environment.
Public function Const bool

ContainsTest ( const FString& InTestName
)

 Checks if a provided test is contained within the framework.
Public function void Dequeue all latent and network commands
Public function void Enqueues a latent command for execution on a subsequent frame
Public function void Enqueues a network command for execution in accordance with this workers role
Public function bool Execute all latent functions that complete during update
Public function bool Execute the next network command if you match the role, otherwise just dequeue
Public function Static FAutomationTestFramework &

Get ()

 Return the singleton instance of the framework.
Public function Const bool  
Public function Const FAutomationTestBase * Returns the actively executing test or null if there isn't one
Public function Static FAutomationTestFramework &  
Public function Const FString Gets a scratch space location outside of the project and saved directories.
Public function Const void Populates the provided array with the names of all tests in the framework that are valid to run for the current application settings.
Public function Const bool Whether there is no latent command in queue
Public function void Load any modules that are not loaded by default and have test classes in them
Public function Static bool Whether to output blueprint functional test metadata to the log when test is running
Public function Static bool Whether to skip stack walk while iterating for listing the tests
Public function void

NotifyPerformanceDataRetrieved ( bool bSuccess,
const FString& ErrorMessage
)

  
Public function void  
Public function void  
Public function void

NotifyTestDataRetrieved ( bool bWasNew,
const FString& JsonData
)

  
Public function FOnTestScreenshotAndTraceCaptured & Accessor for delegate called when a png screenshot is captured and a frame trace
Public function FOnTestScreenshotCaptured & Accessor for delegate called when a png screenshot is captured
Public function bool

RegisterAutomationTest ( const FString& InTestNameToRegister,
FAutomationTestBase* InTestToRegister
)

 Register a automation test into the framework.
Public function void Reset status of worker (delete local files, etc)
Public function bool Attempt to run all fast smoke tests that are valid for the current application configuration.
Public function void

SetCaptureStack ( bool bCapture
)

 Used to disabled stack capture when an error or warning event is triggered.
Public function void

SetDeveloperDirectoryIncluded ( const bool bInDeveloperDirectoryIncluded
)

 Sets whether we want to include content in developer directories in automation testing
Public function void

SetForceSmokeTests ( const bool bInForceSmokeTests
)

 Sets forcing smoke tests.
Public function void

SetRequestedTestFilter ( const uint32 InRequestedTestFlags
)

 Sets which set of tests to pull from.
Public function Const bool

ShouldTestContent ( const FString& Path
)

 Whether the testing framework should allow content to be tested or not.
Public function void

StartTestByName ( const FString& InTestToRun,
const int32 InRoleIndex
)

 Attempt to start the specified test.
Public function bool

StopTest ( FAutomationTestExecutionInfo& OutExecutionInfo
)

 Stop the current test and return the results of execution
Public function bool

UnregisterAutomationTest ( const FString& InTestNameToUnregister
)

 Unregister a automation test with the provided name from the framework.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page