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

#pragma once

#include "CoreTypes.h"

#include "Logging/LogMacros.h"

// TraceServices
#include "TraceServices/Model/TimingProfiler.h" // for TraceServices::EEventSortOrder

DECLARE_LOG_CATEGORY_EXTERN(TimingProfilerTests, Log, All);

class FAutomationTestBase;

////////////////////////////////////////////////////////////////////////////////////////////////////
/**
 * A class containing code for parametric tests for Insight functionality
 * Intended to be called from automatic or user triggered tests
 */
class TRACEINSIGHTS_API FTimingProfilerTests
{
public:
	struct FCheckValues
	{
		double TotalEventDuration = 0.0;
		uint64 EventCount = 0;
		uint32 SumDepth = 0;
		uint32 SumTimerIndex = 0;
		double SessionDuration = 0.0;
		double EnumerationDuration = 0.0;
	};

	struct FEnumerateTestParams
	{
		double Interval = 0.01;
		int32 NumEnumerations = 10000;
		TraceServices::EEventSortOrder SortOrder = TraceServices::EEventSortOrder::ByEndTime;
	};

	static void RunEnumerateBenchmark(const FEnumerateTestParams& InParams, FCheckValues& OutCheckValues);
	static void RunEnumerateAsyncBenchmark(const FEnumerateTestParams& InParams, FCheckValues& OutCheckValues);
	static void RunEnumerateAllTracksBenchmark(const FEnumerateTestParams& InParams, FCheckValues& OutCheckValues);
	static void RunEnumerateAsyncAllTracksBenchmark(const FEnumerateTestParams& InParams, FCheckValues& OutCheckValues);
	static bool RunEnumerateSyncAsyncComparisonTest(FAutomationTestBase& Test, const FEnumerateTestParams& InParam, bool bGameThreadOnly);

	static uint32 GetTimelineIndex(const TCHAR* InName);
	static void VerifyCheckValues(FAutomationTestBase& Test, FCheckValues First, FCheckValues Second);
};