FAutomationSpecBase

Windows
MacOS
Linux

Inheritance Hierarchy

FAutomationTestBase

TSharedFromThis

FAutomationSpecBase

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/AutomationTest.h

Include

#include "Misc/AutomationTest.h"

Syntax

class FAutomationSpecBase :
    public FAutomationTestBase ,
    public TSharedFromThis< FAutomationSpecBase >

Variables

Name Description

Protected variable

bool

 

bEnableSkipIfError

Whether or not BeforeEach and It blocks should skip execution if the test has already failed

Protected variable

FTimespan

 

DefaultTimeout

The timespan for how long a block should be allowed to execute before giving up and failing the test

Constructors

Name Description

Public function

FAutomationSpecBase

(
    const FString & InName,
    const bool bInComplexTask
)

Functions

Name Description

Public function

void

 

AfterEach

(
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ()> DoWork
)

Public function

void

 

AfterEach

(
    EAsyncExecution Execution,
    TFunction < void ()> DoWork
)

Public function

void

 

AfterEach

(
    TFunction < void ()> DoWork
)

Public function

void

 

BeforeEach

(
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ()> DoWork
)

Public function

void

 

BeforeEach

(
    TFunction < void ()> DoWork
)

Public function

void

 

BeforeEach

(
    EAsyncExecution Execution,
    TFunction < void ()> DoWork
)

Protected function

void

 

Define()

Public function

void

 

Describe

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

Protected function Const

void

 

EnsureDefinitions()

Public function Virtual Const

bool

 

IsStressTest()

Public function

void

 

It

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

Public function

void

 

It

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

Public function

void

 

It

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

Public function

void

 

LatentAfterEach

(
    TFunction < void ...
)

Public function

void

 

LatentAfterEach

(
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

LatentAfterEach

(
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

LatentAfterEach

(
    EAsyncExecution Execution,
    TFunction < void ...
)

Public function

void

 

LatentBeforeEach

(
    TFunction < void ...
)

Public function

void

 

LatentBeforeEach

(
    EAsyncExecution Execution,
    TFunction < void ...
)

Public function

void

 

LatentBeforeEach

(
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

LatentBeforeEach

(
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

LatentIt

(
    const FString & InDescription,
    TFunction < void ...
)

Public function

void

 

LatentIt

(
    const FString & InDescription,
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

LatentIt

(
    const FString & InDescription,
    EAsyncExecution Execution,
    TFunction < void ...
)

Public function

void

 

LatentIt

(
    const FString & InDescription,
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ...
)

Protected function

void

 

PostDefine()

Protected function

void

 

Redefine()

Public function

void

 

xAfterEach

(
    TFunction < void ()> DoWork
)

Public function

void

 

xAfterEach

(
    EAsyncExecution Execution,
    TFunction < void ()> DoWork
)

Public function

void

 

xAfterEach

(
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ()> DoWork
)

Public function

void

 

xBeforeEach

(
    TFunction < void ()> DoWork
)

Public function

void

 

xBeforeEach

(
    EAsyncExecution Execution,
    TFunction < void ()> DoWork
)

Public function

void

 

xBeforeEach

(
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ()> DoWork
)

Public function

void

 

xDescribe

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

Public function

void

 

xIt

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

Public function

void

 

xIt

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

Public function

void

 

xIt

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

Public function

void

 

xLatentAfterEach

(
    TFunction < void ...
)

Public function

void

 

xLatentAfterEach

(
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

xLatentAfterEach

(
    EAsyncExecution Execution,
    TFunction < void ...
)

Public function

void

 

xLatentAfterEach

(
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

xLatentBeforeEach

(
    TFunction < void ...
)

Public function

void

 

xLatentBeforeEach

(
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

xLatentBeforeEach

(
    EAsyncExecution Execution,
    TFunction < void ...
)

Public function

void

 

xLatentBeforeEach

(
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

xLatentIt

(
    const FString & InDescription,
    EAsyncExecution Execution,
    TFunction < void ...
)

Public function

void

 

xLatentIt

(
    const FString & InDescription,
    TFunction < void ...
)

Public function

void

 

xLatentIt

(
    const FString & InDescription,
    const FTimespan & Timeout,
    TFunction < void ...
)

Public function

void

 

xLatentIt

(
    const FString & InDescription,
    EAsyncExecution Execution,
    const FTimespan & Timeout,
    TFunction < void ...
)

Overridden from FAutomationTestBase

Name Description

Public function Virtual Const

uint32

 

GetRequiredDeviceNum()

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

Public function Virtual Const

void

 

GetTests

(
    TArray < FString >& OutBeautifiedNa...,
    TArray < FString >& OutTestCommands
)

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)\

Public function Virtual Const

int32

 

GetTestSourceFileLine

(
    const FString & InTestName
)

Gets the line number where this test was defined.

Public function Virtual Const

FString

 

GetTestSourceFileName

(
    const FString & InTestName
)

Gets the filename where this test was defined.

Public function Virtual

bool

 

RunTest

(
    const FString & Parameters
)

Virtual call to execute the automation test.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback