EM_Task/TraceInsights/Private/Insights/Tests/InsightsTestRunner.cpp

// Copyright Epic Games, Inc. All Rights Reserved.

#include "InsightsTestRunner.h"

#if !UE_BUILD_SHIPPING && !WITH_EDITOR

#include "Misc/App.h"
#include "Misc/AutomationTest.h"
#include "IAutomationControllerModule.h"
#include "IAutomationWindowModule.h"
#include "IAutomationWorkerModule.h"
#include "ISessionManager.h"
#include "ISessionServicesModule.h"

// Insights
#include "Insights/Common/InsightsMenuBuilder.h"
#include "Insights/InsightsManager.h"
#include "Insights/Tests/UITests.h"
#include "Insights/InsightsStyle.h"

#include "Widgets/Docking/SDockTab.h"

////////////////////////////////////////////////////////////////////////////////////////////////////

DEFINE_LOG_CATEGORY(InsightsTestRunner);

#define LOCTEXT_NAMESPACE "InsightsTestRunner"

////////////////////////////////////////////////////////////////////////////////////////////////////

TSharedPtr<FInsightsTestRunner> FInsightsTestRunner::Instance;

const TCHAR* FInsightsTestRunner::AutoQuitMsgOnComplete = TEXT("Application is closing because it was started with the AutoQuit parameter and session analysis is complete and all scheduled tests have completed.");

////////////////////////////////////////////////////////////////////////////////////////////////////

void FInsightsTestRunner::ScheduleCommand(const FString& InCmd)
{
    FString ActualCmd = InCmd.Replace(TEXT("\""), TEXT(""));
    if (!ActualCmd.StartsWith(TEXT("Automation RunTests")))
    {
        UE_LOG(InsightsTestRunner, Warning, TEXT("[InsightsTestRunner] Command %s does not start with Automation RunTests. Command will be ignored."), *InCmd);

        return;
    }

    CommandToExecute = ActualCmd;
}

////////////////////////////////////////////////////////////////////////////////////////////////////

void FInsightsTestRunner::Initialize(IUnrealInsightsModule& InsightsModule)
{
    if (bInitAutomationModules)
    {
        FApp::SetSessionName(TEXT("UnrealInsights"));
        ISessionServicesModule& SessionServicesModule = FModuleManager::LoadModuleChecked<ISessionServicesModule>("SessionServices");
        auto SessionService                           = SessionServicesModule.GetSessionService();
        SessionService->Start();

        // Create Session Manager
        SessionServicesModule.GetSessionManager();

        IAutomationControllerModule& AutomationControllerModule = FModuleManager::LoadModuleChecked<IAutomationControllerModule>(TEXT("AutomationController"));
        AutomationControllerModule.Init();

        FModuleManager::Get().LoadModule("AutomationWindow");
        FModuleManager::Get().LoadModule("AutomationWorker");
    }

    SessionAnalysisCompletedHandle = FInsightsManager::Get()->GetSessionAnalysisCompletedEvent().AddSP(this, &FInsightsTestRunner::OnSessionAnalysisCompleted);

    // Register tick functions.
    OnTick       = FTickerDelegate::CreateSP(this, &FInsightsTestRunner::Tick);
    OnTickHandle = FTicker::GetCoreTicker().AddTicker(OnTick, 1.0f);
}

////////////////////////////////////////////////////////////////////////////////////////////////////

void FInsightsTestRunner::Shutdown()
{
    FTicker::GetCoreTicker().RemoveTicker(OnTickHandle);
}

////////////////////////////////////////////////////////////////////////////////////////////////////

void FInsightsTestRunner::RegisterMajorTabs(IUnrealInsightsModule& InsightsModule)
{
    if (bInitAutomationModules)
    {
        const FInsightsMajorTabConfig& AutomationInfoConfig = InsightsModule.FindMajorTabConfig(FInsightsManagerTabs::AutomationWindowTabId);
        if (AutomationInfoConfig.bIsAvailable)
        {
            // Register tab spawner for the Session Info.
            FTabSpawnerEntry& TabSpawnerEntry = FGlobalTabmanager::Get()->RegisterNomadTabSpawner(FInsightsManagerTabs::AutomationWindowTabId,
                                                                                                  FOnSpawnTab::CreateRaw(this, &FInsightsTestRunner::SpawnAutomationWindowTab))
                                                    .SetDisplayName(AutomationInfoConfig.TabLabel.IsSet() ? AutomationInfoConfig.TabLabel.GetValue() : LOCTEXT("AutomationTab", "Automation"))
                                                    .SetTooltipText(AutomationInfoConfig.TabTooltip.IsSet() ? AutomationInfoConfig.TabTooltip.GetValue() : LOCTEXT("AutomationTooltipText", "Open the automation tab."))
                                                    .SetIcon(AutomationInfoConfig.TabIcon.IsSet() ? AutomationInfoConfig.TabIcon.GetValue() : FSlateIcon(FInsightsStyle::GetStyleSetName(), "SessionInfo.Icon.Small"));

            TSharedRef<FWorkspaceItem> Group = AutomationInfoConfig.WorkspaceGroup.IsValid() ? AutomationInfoConfig.WorkspaceGroup.ToSharedRef() : FInsightsManager::Get()->GetInsightsMenuBuilder()->GetWindowsGroup();
            TabSpawnerEntry.SetGroup(Group);
        }
    }
}

////////////////////////////////////////////////////////////////////////////////////////////////////

void FInsightsTestRunner::UnregisterMajorTabs()
{
    FGlobalTabmanager::Get()->UnregisterNomadTabSpawner(FInsightsManagerTabs::AutomationWindowTabId);
}

////////////////////////////////////////////////////////////////////////////////////////////////////

TSharedPtr<FInsightsTestRunner> FInsightsTestRunner::CreateInstance()
{
    ensure(!FInsightsTestRunner::Instance.IsValid());
    if (FInsightsTestRunner::Instance.IsValid())
    {
        FInsightsTestRunner::Instance.Reset();
    }

    FInsightsTestRunner::Instance = MakeShared<FInsightsTestRunner>();

    return FInsightsTestRunner::Instance;
}

////////////////////////////////////////////////////////////////////////////////////////////////////

TSharedPtr<FInsightsTestRunner> FInsightsTestRunner::Get()
{
    return FInsightsTestRunner::Instance;
}

////////////////////////////////////////////////////////////////////////////////////////////////////

void FInsightsTestRunner::RunTests()
{
    if (CommandToExecute.IsEmpty())
    {
        return;
    }

    IAutomationControllerModule& AutomationControllerModule     = FModuleManager::LoadModuleChecked<IAutomationControllerModule>(TEXT("AutomationController"));
    IAutomationControllerManagerRef AutomationControllerManager = AutomationControllerModule.GetAutomationController();

    bool& bIsRunningTestsLocal                                  = bIsRunningTests;
    AutomationControllerManager->OnTestsComplete().AddLambda([&bIsRunningTestsLocal]()
                                                             {
                                                                 bIsRunningTestsLocal = false;
                                                             });

    StaticExec(NULL, *CommandToExecute);
    bIsRunningTests = true;
}

////////////////////////////////////////////////////////////////////////////////////////////////////

FInsightsTestRunner::~FInsightsTestRunner()
{
}

////////////////////////////////////////////////////////////////////////////////////////////////////

void FInsightsTestRunner::OnSessionAnalysisCompleted()
{
    RunTests();

    bIsAnalysisComplete = true;

    FInsightsManager::Get()->GetSessionAnalysisCompletedEvent().Remove(SessionAnalysisCompletedHandle);
}

////////////////////////////////////////////////////////////////////////////////////////////////////

TSharedRef<SDockTab> FInsightsTestRunner::SpawnAutomationWindowTab(const FSpawnTabArgs& Args)
{
    const TSharedRef<SDockTab> DockTab = SNew(SDockTab)
                                             .TabRole(ETabRole::NomadTab);

    IAutomationWindowModule& AutomationWindowModule         = FModuleManager::LoadModuleChecked<IAutomationWindowModule>("AutomationWindow");
    IAutomationControllerModule& AutomationControllerModule = FModuleManager::LoadModuleChecked<IAutomationControllerModule>(TEXT("AutomationController"));
    IAutomationControllerManagerPtr AutomationController    = AutomationControllerModule.GetAutomationController();
    ISessionServicesModule& SessionServicesModule           = FModuleManager::LoadModuleChecked<ISessionServicesModule>("SessionServices");

    auto SessionManager                                     = SessionServicesModule.GetSessionManager();

    auto TabWidget                                          = AutomationWindowModule.CreateAutomationWindow(
        AutomationController.ToSharedRef(),
        SessionManager.ToSharedRef());

    DockTab->SetContent(TabWidget);

    TArray<TSharedPtr<ISessionInfo>> OutSessions;
    SessionManager->GetSessions(OutSessions);
    for (auto Session: OutSessions)
    {
        if (Session->GetSessionName() == TEXT("UnrealInsights"))
        {
            SessionManager->SelectSession(OutSessions[0]);
            TArray<TSharedPtr<ISessionInstanceInfo>> OutSessionsInstances;
            OutSessions[0]->GetInstances(OutSessionsInstances);

            SessionManager->SetInstanceSelected(OutSessionsInstances[0].ToSharedRef(), true);
        }
    }
    return DockTab;
}

////////////////////////////////////////////////////////////////////////////////////////////////////

bool FInsightsTestRunner::Tick(float DeltaTime)
{
    if (bAutoQuit && bIsAnalysisComplete && !bIsRunningTests)
    {
        RequestEngineExit(AutoQuitMsgOnComplete);
    }

    IAutomationWorkerModule& AutomationWorkerModule         = FModuleManager::LoadModuleChecked<IAutomationWorkerModule>("AutomationWorker");
    IAutomationControllerModule& AutomationControllerModule = FModuleManager::LoadModuleChecked<IAutomationControllerModule>(TEXT("AutomationController"));

    AutomationControllerModule.Tick();
    AutomationWorkerModule.Tick();

    return true;
}

////////////////////////////////////////////////////////////////////////////////////////////////////

#undef LOCTEXT_NAMESPACE

#endif  // UE_BUILD_SHIPPING && !WITH_EDITOR