// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.

#pragma once


/**
 * Interface for automation test results modules.
 */
class FAutomationReport
	: public IAutomationReport
{
public:

	FAutomationReport(FAutomationTestInfo& TestInfo, bool bIsParent = false);

public:

	// IAutomationReport Interface

	virtual void Empty() override;
	virtual FString GetAssetName() const override;
	virtual FString GetCommand() const override;
	virtual const FString& GetDisplayName() const override;
	virtual FString GetDisplayNameWithDecoration() const override;
	virtual int32 GetTotalNumChildren() const override;
	virtual int32 GetEnabledTestsNum() const override;
	virtual void GetEnabledTestNames(TArray<FString>& OutEnabledTestNames, FString CurrentPath) const override;
	virtual void SetEnabledTests(const TArray<FString>& EnabledTests, FString CurrentPath) override;
	virtual bool IsEnabled() const override;
	virtual void SetEnabled(bool bShouldBeEnabled) override;
	virtual void SetSupport(const int32 ClusterIndex) override;
	virtual bool IsSupported(const int32 ClusterIndex) const override;
	virtual void SetTestType( const uint8 TestType ) override;
	virtual uint8 GetTestType( ) const override;
	virtual const bool IsParent( ) override;
	virtual const bool IsSmokeTest( ) override;
	virtual bool SetFilter( TSharedPtr< AutomationFilterCollection > InFilter, const bool ParentPassedFilter = false ) override;
	virtual TArray<TSharedPtr<IAutomationReport> >& GetFilteredChildren() override;
	virtual TArray<TSharedPtr<IAutomationReport> >& GetChildReports() override;
	virtual void ClustersUpdated(const int32 NumClusters) override;
	virtual void ResetForExecution(const int32 NumTestPasses) override;
	virtual void SetResults( const int32 ClusterIndex, const int32 PassIndex, const FAutomationTestResults& InResults ) override;
	virtual void GetCompletionStatus(const int32 ClusterIndex, const int32 PassIndex, FAutomationCompleteState& OutCompletionState) override;
	virtual EAutomationState::Type GetState(const int32 ClusterIndex, const int32 PassIndex) const override;
	virtual const FAutomationTestResults& GetResults( const int32 ClusterIndex, const int32 PassIndex ) override;
	virtual const int32 GetNumResults( const int32 ClusterIndex ) override;
	virtual const int32 GetCurrentPassIndex( const int32 ClusterIndex ) override;
	virtual FString GetGameInstanceName( const int32 ClusterIndex ) override;
	virtual TSharedPtr<IAutomationReport> EnsureReportExists(FAutomationTestInfo& TestInfo, const int32 ClusterIndex, const int32 NumPasses) override;
	virtual TSharedPtr<IAutomationReport> GetNextReportToExecute(bool& bOutAllTestsComplete, const int32 ClusterIndex, const int32 PassIndex, const int32 NumDevicesInCluster) override;
	virtual const bool HasErrors() override;
	virtual const bool HasWarnings() override;
	virtual const bool GetDurationRange(float& OutMinTime, float& OutMaxTime) override;
	virtual const int32 GetNumDevicesRunningTest() const override;
	virtual const int32 GetNumParticipantsRequired() const override;
	virtual void SetNumParticipantsRequired( const int32 NewCount ) override;
	virtual bool IncrementNetworkCommandResponses() override;
	virtual void ResetNetworkCommandResponses() override;
	virtual const bool ExpandInUI() const override;
	virtual void StopRunningTest() override;
	virtual void TrackHistory(const bool bShouldTrack, const int32 NumReportsToTrack) override;
	virtual const TArray<TSharedPtr<FAutomationHistoryItem>>& GetHistory() const override;
	
private:

	/** Export the current report as part of it's tracked history. */
	void AddToHistory();

	/** Load this reports tracked history. */
	void LoadHistory();

	/** Update what is tracked for this reports history. */
	void MaintainHistory(TArray<FString> &InLogFiles);

private:

	/** True if this test should be executed */
	bool bEnabled;

	/** True if this test is a parent */
	bool bIsParent;

	/** True if this report should be expanded in the UI */
	bool bNodeExpandInUI;

	/** True if this report has passed the filter and should be highlighted in the UI */
	bool bSelfPassesFilter;

	/** List of bits that represents which device types requested this test */
	uint32 SupportFlags;

	/** Number of responses from network commands */
	uint32 NumberNetworkResponsesReceived;

	/** Number of required devices for this test */
	uint32 RequiredDeviceCount;
	
	/** All child tests */
	TArray<TSharedPtr<IAutomationReport> >ChildReports;

	/** Map of all Report Name hashes to avoid iterating all items to test for existance*/
	TMap<uint32, uint32> ChildReportNameHashes;

	/** Filtered child tests */
	TArray<TSharedPtr<IAutomationReport> >FilteredChildReports;

	/** Results from execution of the test (per cluster) */
	TArray< TArray<FAutomationTestResults> > Results;

	/** Structure holding the test info */
	FAutomationTestInfo TestInfo;

	/** Flag to determine whether this report should track it's history */
	bool bTrackingHistory;

	/** Flag to determine how many history items to keep */
	int32 NumRecordsToKeep;

	/** The collection of history items which holds the results of previous runs. */
	TArray<TSharedPtr<FAutomationHistoryItem> > HistoryItems;
};