UUnitTest

Whether or not the unit test has aborted execution

Whether or not the unit test has completed

Whether or not developer-mode has been enabled for this unit test (prevents it from ending execution)

Whether it's the first time this unit test has run, i.e. whether prior memory stats exist (

Not set until first tick)

Whether or not this unit test is obsolete - i.e. based on code no longer present in the game/engine

Whether or not this unit test is unreliable, i.e. prone to giving incorrect/unexpected results, requiring multiple runs

Whether or not this unit test is a 'work in progress', and should not be included in automated tests

The current realtime memory usage of the unit test

The unit test result we expect for each games codebase, i.e. whether we expect that the problem is fixed yet or not

The amount of time it took to execute the unit test the last time it was run

The time of the last NetTick event

The last time that the unit test timeout was reset

Every timeout reset specifies a string to identify/describe the event that triggered it, for tracking

The log window associated with this unit test

Config variables Stores stats on the highest-ever reported memory usage, for this unit test - for estimating memory usage

The time at which execution of the unit test started

Collects unit test status logs, that have been printed to the summary window

The time at which the unit test timeout will expire

The amount of time it takes to reach 'PeakMemoryUsage' (or within 90% of its value)

The log file for outputting all log information for the current unit test

The log directory for this unit test

UnitTask's which must be run before different stages of the unit test can execute

Marks the state of met unit task requirement flags and active unit task blocking flags

The bug tracking identifiers related to this unit test (e.g. TTP numbers)

Source control changelists relevant to this unit test

The date this unit test was added to the project (for ordering in help command)

Variables which should be specified by every subclass The name/command for this unit test (N.B. Must be set in class constructor)

The amount of time (in seconds), before the unit test should timeout and be marked as broken

The type of unit test this is (e.g. bug/exploit) (N.B. Must be set in class constructor)

Whether or not the success or failure of the current unit test has been verified

UUnitTest

Aborts execution of the unit test, part-way through

Adds a UnitTask to the unit test, during its configuration stage - to be completed before executing the unit test

Whether or not this unit test supports resetting

Cleans up all items needing destruction, and removes the unit test from tracking, before deleting the unit test itself

Called upon completion of the unit test (may not happen during same tick), for tearing down created worlds/connections/etc.

Executes the main unit test

Outputs the list of console command contexts, that this unit test supports (which can include custom contexts in subclasses)

Returns the type of log entries that this unit expects to output, for setting up log window filters (only needs to return values which affect what tabs are shown)

Returns the expected result for the current game

Returns the list of supported games, for this unit test

Returns the date this unit test was first added to the code

Returns the name/command, for the current unit test

Returns the value of UnitTestTimeout

Returns the type of unit test (e.g. bug/exploit)

Whether or not the unit test has started

Finishes initializing unit test settings, that rely upon the current unit test environment being loaded

Sets up the log directory and log output device instances.

Returns whether or not this is the first time the unit test has been run/collecting-stats

Determines whether or not a UnitTask is blocking the specified event

Triggered upon unit test completion, for outputting that the unit test has completed - plus other unit test state information

Notifies that there was a request to execute a console command for the unit test, which can occur in a specific context, e.g. for a unit test server, for a local minimal-client (within the unit test), or for a separate unit test client process

Notifies that there was a request to enable/disable developer mode

Triggered when a UnitTask fails unrecoverably during execution

Resets the unit test timeout code - should be used liberally, within every unit test, when progress is made during execution

Resets the unit test to its initial state, allowing it to restart from scratch

When events that were pending but blocked by a UnitTask, are unblocked, this function triggers them.

Validate that the unit test settings/flags specified for this unit test, are compatible with one another, and that the engine settings/environment, support running the unit test.

Must override in subclasses, that need ticking.

Tick function that runs at a tickrate of ~60 fps, for interacting with netcode (high UnitTick tickrate, can lead to net buffer overflows)

For cleanup actions that should occur after the primary tick function is called

Tick function for checking if the unit test is completed (happens after all above tick events)

Main tick function for the unit test

Whether or not this log interface is the source of a UNetConnection - used for deciding where to direct, UNetConnection log hooks

Whether or not this log interface is the source of an FTimerManager delegate object, used for hooking logs triggered during global timer manager delegates.

For implementation in subclasses, for helping to track local log entries related to a unit test.

As above, except for log entries directed towards the Unit Test Status window.

The null unit test environment - for unit tests which support all games, due to requiring no game-specific features

Runtime variables The unit test environment (not set until the current games unit test module is loaded - not set at all, if no such module)