Class ReportingManager

Inheritance

Object

ReportingManager

Namespace: Global Namespace

Syntax

public static class ReportingManager

Fields

CurrentTestName

Declaration

[SerializeField]
public static string CurrentTestName

Field Value

Type	Description
String

Disabled

Declaration

[SerializeField]
public static bool Disabled

Field Value

Type	Description
Boolean

IsCrawler

Declaration

[SerializeField]
public static bool IsCrawler

Field Value

Type	Description
Boolean

IsPlaybackStartedFromEditorWindow

Declaration

[SerializeField]
public static bool IsPlaybackStartedFromEditorWindow

Field Value

Type	Description
Boolean

Properties

EntryScene

Declaration

public static string EntryScene { get; set; }

Property Value

Type	Description
String

IsAutomatorTest

Declaration

public static bool IsAutomatorTest { get; set; }

Property Value

Type	Description
Boolean

IsCompositeRecording

Declaration

public static bool IsCompositeRecording { get; set; }

Property Value

Type	Description
Boolean

IsTestWithoutRecordingFile

Declaration

public static bool IsTestWithoutRecordingFile { get; set; }

Property Value

Type	Description
Boolean

IsUTRTest

Declaration

public static bool IsUTRTest { get; set; }

Property Value

Type	Description
Boolean

ReportData

Declaration

public static ReportingManager.TestRunData ReportData { get; set; }

Property Value

Type	Description
ReportingManager.TestRunData

ReportFileNameWithoutExtension

Declaration

public static string ReportFileNameWithoutExtension { get; }

Property Value

Type	Description
String

ReportingMonitorInstance

Declaration

public static GameObject ReportingMonitorInstance { get; set; }

Property Value

Type	Description
GameObject

ReportSaveDirectory

Declaration

public static string ReportSaveDirectory { get; }

Property Value

Type	Description
String

RunSaveDirectory

Declaration

public static string RunSaveDirectory { get; }

Property Value

Type	Description
String

Methods

AddRecordingData(RecordingInputModule.InputModuleRecordingData)

Declaration

public static void AddRecordingData(RecordingInputModule.InputModuleRecordingData recordingData)

Parameters

Type	Name	Description
RecordingInputModule.InputModuleRecordingData	recordingData

AddScreenshot(String)

A screenshot was recorded while executing a test, so associate its storage path the most recently-generated step.

Declaration

public static void AddScreenshot(string screenshotPath)

Parameters

Type	Name	Description
String	screenshotPath

AddStep(ReportingManager.StepData)

Creates a new step or action data point for the current test being executed.

Declaration

public static void AddStep(ReportingManager.StepData step)

Parameters

Type	Name	Description
ReportingManager.StepData	step

CreateMonitoringService()

Creates listener that checks for OnApplicationQuit and other hooks which represent the appropriate time to finalize and generate a report.

Declaration

public static void CreateMonitoringService()

DoesReportExist(ReportingManager.ReportType)

Declaration

public static bool DoesReportExist(ReportingManager.ReportType reportType)

Parameters

Type	Name	Description
ReportingManager.ReportType	reportType

Returns

Type	Description
Boolean

FinalizeReport()

Set final run data and generate all reports.

Declaration

public static void FinalizeReport()

GenerateHtmlReport(String, String)

Declaration

public static void GenerateHtmlReport(string json, string directory)

Parameters

Type	Name	Description
String	json
String	directory

GenerateXmlReport()

Declaration

public static void GenerateXmlReport()

GenerateXmlReport(List<ReportingManager.TestData>, String)

Declaration

public static void GenerateXmlReport(List<ReportingManager.TestData> tests, string outputPath)

Parameters

Type	Name	Description
List<ReportingManager.TestData>	tests
String	outputPath

GetCloudData()

For cloud runs, return results to deliver them to client.

Declaration

public static string GetCloudData()

Returns

Type	Description
String

InitializeDataForNewTest()

A new recording or Unity test is being launched. Prepare to capture related data.

Declaration

public static void InitializeDataForNewTest()

InitializeReport()

Get started capturing test data for test report.

Declaration

public static void InitializeReport()

IsReportingFinished()

Declaration

public static bool IsReportingFinished()

Returns

Type	Description
Boolean

OpenReportFile(ReportingManager.ReportType)

Declaration

public static void OpenReportFile(ReportingManager.ReportType reportType)

Parameters

Type	Name	Description
ReportingManager.ReportType	reportType

Reset()

Reset the ReportingManager for next test.

Declaration

public static void Reset()

SamplePerformance(Single)

Record the current framerate.

Declaration

public static void SamplePerformance(float avgFps)

Parameters

Type	Name	Description
Single	avgFps

SetCustomReportData(String, String)

Sets a custom key value data in the generated html report.

Declaration

public static void SetCustomReportData(string name, string value)

Parameters

Type	Name	Description
String	name
String	value

UpdateCurrentStep(Vector2)

A step is generated before the coordinates of a click or drag are performed. This allows for the coordinates to be recorded later in the execution of an action, and after a step is generated.

Declaration

public static void UpdateCurrentStep(Vector2 CoordinatesOfPress = default(Vector2))

Parameters

Type	Name	Description
Vector2	CoordinatesOfPress