FFunctionalTestBase

Base class for Functional test cases.

Windows
MacOS
Linux

Inheritance Hierarchy

FAutomationTestBase

FFunctionalTestBase

References

Module

FunctionalTesting

Header

/Engine/Source/Developer/FunctionalTesting/Classes/FunctionalTestBase.h

Include

#include "FunctionalTestBase.h"

Syntax

class FFunctionalTestBase : public FAutomationTestBase

Remarks

Base class for Functional test cases.

Variables

Name Description

Protected variable

bool

 

bElevateLogWarningsToErrors

Protected variable

bool

 

bSuppressLogErrors

Protected variable

bool

 

bSuppressLogs

Protected variable

bool

 

bSuppressLogWarnings

Constructors

Name Description

Public function

FFunctionalTestBase

(
    const FString& InName,
    const bool bInComplexTask
)

Functions

Name Description

Public function Static

FString

 

GetRunningTestName()

Returns the name of the running functional test. Empty if no test is running

Public function Static

bool

 

IsFunctionalTestRunning()

Returns true if a functional test is running (does not include map setup)

Public function

void

 

SetFunctionalTestComplete

(
    const FString& InName
)

Marks us as no longer running a test

Public function

void

 

SetFunctionalTestRunning

(
    const FString& InName
)

Marks us as actively running a functional test

Public function

void

 

SetLogErrorAndWarningHandling

(
    TOptional< bool > InSuppressErrors,
    TOptional< bool > InSuppressWarning...,
    TOptional< bool > InWarningsAreErro...
)

Specify how log errors & warnings should be handled during tests.

Protected function

void

 

SetLogErrorAndWarningHandlingToDefault()

Overridden from FAutomationTestBase

Name Description

Public function Virtual

bool

 

ElevateLogWarningsToErrors()

Determines if Warning logs should be treated as errors

Public function Virtual

bool

 

SuppressLogErrors()

Determines if Error logs should be suppressed from test results

Public function Virtual

bool

 

SuppressLogs()

If true logs will not be included in test events

Public function Virtual

bool

 

SuppressLogWarnings()

Determines if Warning logs should be suppressed from test results

Constants

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss