1. Epic GamesDeveloper
  3. FUnitTestEnvironment

FUnitTestEnvironment

Class for handling per-game implementation of unit test environmental defaults

Unreal Engine C++ API Reference > Plugins > NetcodeUnitTest

Inheritance Hierarchy

References

   
Module NetcodeUnitTest
Header /Engine/Plugins/NetcodeUnitTest/NetcodeUnitTest/Source/NetcodeUnitTest/Public/UnitTestEnvironment.h
Include #include "UnitTestEnvironment.h"

Syntax

class FUnitTestEnvironment

Remarks

Class for handling per-game implementation of unit test environmental defaults

Variables

  Type Name Description
Protected variable UUnitTest * UnitTest The unit test being initialized using the current environment (WARNING: Will be nullptr for legacy unit tests)

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static void Adds a new environment to the unit test environment list
Public function void

GetClientProgressLogs ( const TArray< FString >*& OutTimeoutResetLogs
)

 Returns client log messages, for the current game, that indicate progress logs for resetting unit test timeout
Public function Virtual FString Returns the default URL that minimal clients should use, when connecting to a server, for the current game
Public function FString Returns the default parameters for launched clients
Public function Virtual FString

GetDefaultMap ( EUnitTestFlags UnitTestFlags
)

 Returns the default map name, that should be used with unit tests, for the current game
Public function FString

GetDefaultServerParameters ( FString InLogCmds,
FString InExecCmds
)

 Returns the default parameters for launched servers
Public function Virtual uint32 Returns the default/minimum timeout that unit tests should use, for the current game
Public function void

GetProgressBlockingProcesses ( const TArray< FString >*& OutBlockingProcesses
)

 Returns child process names, that indicate progress blockers in starting up (e.g. shader compiler) All child processes, including server/client child processes (and their children) are checked.
Public function void

GetServerProgressLogs ( const TArray< FString >*& OutStartProgressLogs,
const TArray< FString >*& OutReadyLogs,
const TArray< FString >*& OutTimeoutResetLogs
)

 Returns server log messages, for the current game, that indicate progress in starting up
Public function Virtual void Executes game-specific handling, upon client unit tests initializing the client PlayerController
Public function Virtual void

InitializeClientProgressLogs ( TArray< FString >& TimeoutResetLogs
)

 Called when initializing the static arrays, containing the client progress logs
Public function Virtual void Called when initializing the static arrays, containing the progress blocking processes
Public function Virtual void

InitializeServerProgressLogs ( TArray< FString >& StartProgressLogs,
TArray< FString >& ReadyLogs,
TArray< FString >& TimeoutResetLogs
)

 Called when initializing the static arrays, containing the server progress logs
Public function Virtual void If the game environment requires special/complex setup (e.g. player auth before join), then UnitTask's for handling complex setup, are added here.
Public function Static void Registers the unit test environment, with the environment list IMPORTANT: This MUST be implemented in every subclass, and the subclass version MUST called, within your modules 'StartupModule'
Public function Virtual void Sets up the default client parameters, specifying a (potentially already modified) commandline for modification
Public function Virtual void

SetupDefaultServerParameters ( FString& OutCommandline,
FString& OutLogCmds,
FString& OutExecCmds
)

 Sets up the default server parameters, specifying commandline and '-*Cmds=x' separately (combined within parent function above)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page