Choose your operating system:
Windows
macOS
Linux
| FUnitTestEnvironment
|
Module |
|
Header |
/Engine/Plugins/NetcodeUnitTest/NetcodeUnitTest/Source/NetcodeUnitTest/Public/UnitTestEnvironment.h |
Include |
#include "UnitTestEnvironment.h" |
class FUnitTestEnvironment
Class for handling per-game implementation of unit test environmental defaults
Name | Description | ||
---|---|---|---|
|
UnitTest |
The unit test being initialized using the current environment (WARNING: Will be nullptr for legacy unit tests) |
Name | Description | |
---|---|---|
|
FUnitTestEnvironment() |
Name | Description | |
---|---|---|
|
~FUnitTestEnvironment() |
Name | Description | ||
---|---|---|---|
|
AddUnitTestEnvironment ( |
Adds a new environment to the unit test environment list |
|
|
GetClientProgressLogs |
Returns client log messages, for the current game, that indicate progress logs for resetting unit test timeout |
|
|
GetDefaultClientConnectURL() |
Returns the default URL that minimal clients should use, when connecting to a server, for the current game |
|
|
GetDefaultClientParameters() |
Returns the default parameters for launched clients |
|
|
GetDefaultMap ( |
Returns the default map name, that should be used with unit tests, for the current game |
|
|
GetDefaultServerParameters |
Returns the default parameters for launched servers |
|
|
GetDefaultUnitTestTimeout() |
Returns the default/minimum timeout that unit tests should use, for the current game |
|
|
GetProgressBlockingProcesses |
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. |
|
|
GetServerProgressLogs |
Returns server log messages, for the current game, that indicate progress in starting up |
|
|
HandleClientPlayer ( |
Executes game-specific handling, upon client unit tests initializing the client PlayerController |
|
|
InitializeClientProgressLogs |
Called when initializing the static arrays, containing the client progress logs |
|
|
InitializeProgressBlockingProcesses |
Called when initializing the static arrays, containing the progress blocking processes |
|
|
InitializeServerProgressLogs |
Called when initializing the static arrays, containing the server progress logs |
|
|
InitializeUnitTasks() |
If the game environment requires special/complex setup (e.g. player auth before join), then UnitTask's for handling complex setup, are added here. |
|
|
Register() |
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' |
|
|
SetupDefaultClientParameters ( |
Sets up the default client parameters, specifying a (potentially already modified) commandline for modification |
|
|
SetupDefaultServerParameters |
Sets up the default server parameters, specifying commandline and '-*Cmds=x' separately (combined within parent function above) |