AutomationWorkerModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "IMessageContext.h"
#include "Misc/AutomationTest.h"
 
#include "IAutomationWorkerModule.h"
 
class FMessageEndpoint;
 
struct FAutomationWorkerFindWorkers;
struct FAutomationWorkerImageComparisonResults;
struct FAutomationWorkerTestDataResponse;
struct FAutomationWorkerPerformanceDataResponse;
struct FAutomationWorkerNextNetworkCommandReply;
struct FAutomationWorkerPing;
struct FAutomationWorkerRequestTests;
struct FAutomationWorkerStartTestSession;
struct FAutomationWorkerStopTestSession;
struct FAutomationWorkerRunTests;
struct FMessageAddress;
struct FAutomationWorkerMessageBase;
 
 
class FAutomationWorkerModule
    : public IAutomationWorkerModule
{
public:
 
    //~ IModuleInterface interface
 
    virtual void StartupModule() override;
    virtual void ShutdownModule() override;
    virtual bool SupportsDynamicReloading() override;
 
public:
 
    //~ IAutomationWorkerModule interface
 
    virtual void Tick() override;
 
protected:
 
    bool ExecuteLatentCommands();
 
    bool ExecuteNetworkCommands();
 
    void Initialize();
 
    void ReportNetworkCommandComplete();
 
    void ReportTestComplete();
 
    void SendTests(const FMessageAddress& ControllerAddress);
 
    void SendMessage(FAutomationWorkerMessageBase* Message, UScriptStruct* TypeInfo, const FMessageAddress& ControllerAddress);
 
private:
 
    void HandleFindWorkersMessage(const FAutomationWorkerFindWorkers& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void SendWorkerFound(const FMessageAddress& ControllerAddress);
 
    void HandleMessageEndpointShutdown();
 
    void HandleNextNetworkCommandReplyMessage(const FAutomationWorkerNextNetworkCommandReply& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandlePingMessage(const FAutomationWorkerPing& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandleStartTestSession(const FAutomationWorkerStartTestSession& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandleStopTestSession(const FAutomationWorkerStopTestSession& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandleRequestTestsMessage(const FAutomationWorkerRequestTests& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandleRunTestsMessage(const FAutomationWorkerRunTests& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandleStopTestsMessage(const struct FAutomationWorkerStopTests& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandleScreenShotCompared(const FAutomationWorkerImageComparisonResults& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandleTestDataRetrieved(const FAutomationWorkerTestDataResponse& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandlePerformanceDataRetrieved(const FAutomationWorkerPerformanceDataResponse& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void HandleTelemetryData(const FString& StorageName, const FString& InTestName, const TArray<FAutomationTelemetryData>& InItems);
 
    void HandlePreTestingEvent();
 
    void HandlePostTestingEvent();
 
#if WITH_ENGINE
    void HandleScreenShotCapturedWithName(const TArray<FColor>& RawImageData, const FAutomationScreenshotData& Data);
 
    void HandleScreenShotAndTraceCapturedWithName(const TArray<FColor>& RawImageData, const TArray<uint8>& CapturedFrameTrace, const FAutomationScreenshotData& Data);
 
    void HandleScreenShotComparisonReport(const FAutomationScreenshotCompareResults& Results);
#endif
 
    void SendAnalyticsEvents(TArray<FString>& InAnalyticsItems);
 
    void RecordPerformanceAnalytics(const FAutomationPerformanceSnapshot& PerfSnapshot);
 
    bool IsTestExcluded(const FString& InTestToRun, FString* OutReason, bool* OutWarn) const;
 
    void TriggerSectionNotifications();
 
private:
 
    TArray<FAutomationTestInfo> TestInfo;
 
private:
 
    TSharedPtr<FMessageEndpoint, ESPMode::ThreadSafe> MessageEndpoint;
 
    FMessageAddress TestRequesterAddress;
 
    uint32 ExecutionCount;
 
    FString TestName;
 
    FString BeautifiedTestName;
 
    FString FullTestPath;
 
    bool bSendAnalytics;
 
    bool bPruneLogsOnSuccess;
 
    bool bExecuteNextNetworkCommand;
 
    bool bExecutingNetworkCommandResults;
 
    FStopTestEvent StopTestEvent;
 
    FString DeviceTag;
 
    FString ActiveSection;
 
    FGuid ActiveScreenshotComparisonId;
};