Navigation
API > API/Plugins > API/Plugins/AutomationTestToolset
Manages the automation controller lifecycle for the AutomationTestToolset.
Handles session discovery, worker communication, and test execution polling. The toolset's static tool functions delegate to this subsystem for state management.
| Name | UAutomationTestToolsetSubsystem |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Toolsets/AutomationTestToolset/Source/AutomationTestToolset/Public/AutomationTestToolsetSubsystem.h |
| Include Path | #include "AutomationTestToolsetSubsystem.h" |
Syntax
UCLASS (MinimalAPI)
class UAutomationTestToolsetSubsystem : public UEditorSubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEditorSubsystem → UAutomationTestToolsetSubsystem
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DiscoveryTimeoutSeconds | float | AutomationTestToolsetSubsystem.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AutomationController | IAutomationControllerManagerPtr | AutomationTestToolsetSubsystem.h | ||
| bControllerReady | bool | AutomationTestToolsetSubsystem.h | ||
| bDiscoveryRequested | bool | AutomationTestToolsetSubsystem.h | ||
| bRestoreFilterOnComplete | bool | AutomationTestToolsetSubsystem.h | ||
| bToolsetRegistered | bool | AutomationTestToolsetSubsystem.h | ||
| bWaitingForResults | bool | AutomationTestToolsetSubsystem.h | ||
| bWorkersRequested | bool | AutomationTestToolsetSubsystem.h | ||
| DiscoveryElapsedSeconds | float | AutomationTestToolsetSubsystem.h | ||
| PendingDiscoveryResult | TStrongObjectPtr< UToolCallAsyncResultString > | AutomationTestToolsetSubsystem.h | ||
| PendingRunResult | TStrongObjectPtr< UToolCallAsyncResultString > | AutomationTestToolsetSubsystem.h | ||
| RunningTestNames | TSet< FString > | AutomationTestToolsetSubsystem.h | ||
| SessionManager | TSharedPtr< ISessionManager > | AutomationTestToolsetSubsystem.h | ||
| TestsAvailableHandle | FDelegateHandle | AutomationTestToolsetSubsystem.h | ||
| TestsRefreshedHandle | FDelegateHandle | AutomationTestToolsetSubsystem.h | ||
| TickerHandle | FTSTicker::FDelegateHandle | AutomationTestToolsetSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnableRunResultPolling() |
Start polling for test completion. Call after RunTests() has started execution. | AutomationTestToolsetSubsystem.h | |
IAutomationControllerManagerPtr GetAutomationController() |
Get the automation controller. | AutomationTestToolsetSubsystem.h | |
UToolCallAsyncResultString * GetPendingRunResult() |
Get the pending run result, if any. | AutomationTestToolsetSubsystem.h | |
const TSet< FString > & GetRunningTestNames() |
Get the test names from the current or most recent run. | AutomationTestToolsetSubsystem.h | |
bool IsControllerReady() |
Whether workers have been found and the test list is populated. | AutomationTestToolsetSubsystem.h | |
void RequestWorkerDiscovery () |
Load SessionServices and begin polling for the local session. | AutomationTestToolsetSubsystem.h | |
void SetPendingDiscoveryResult
(
UToolCallAsyncResultString* InResult |
Store a pending async result that will resolve when test discovery completes. | AutomationTestToolsetSubsystem.h | |
void SetPendingRunResult
(
UToolCallAsyncResultString* InResult, |
Store a pending async result for the current test run. | AutomationTestToolsetSubsystem.h | |
void SetRestoreFilterOnComplete
(
bool bRestore |
Mark that the controller filter should be reset to empty and visible tests re-enabled when the current run completes. | AutomationTestToolsetSubsystem.h | |
void SetToolsetEnabled
(
bool bEnabled |
Register or unregister the toolset with UToolsetRegistry at runtime. | AutomationTestToolsetSubsystem.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
AutomationTestToolsetSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
AutomationTestToolsetSubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void CollectLeafReports
(
const TArray< TSharedPtr< IAutomationReport > >& Reports, |
Recursively collect leaf (runnable) reports from a report tree. | AutomationTestToolsetSubsystem.h | |
| Build a JSON results string for the given test names from the controller's report tree. | AutomationTestToolsetSubsystem.h |