Class ReportingManager

Inheritance

Object

ReportingManager

Namespace: Global Namespace

Syntax

public static class ReportingManager : object

Fields

CurrentTestName

Declaration

public static string CurrentTestName

Field Value

Type	Description
String

IsPlaybackStartedFromEditorWindow

Declaration

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

IsCrawler

Declaration

public static bool IsCrawler { get; set; }

Property Value

Type	Description
Boolean

IsTestWithoutRecordingFile

Declaration

public static bool IsTestWithoutRecordingFile { 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

Methods

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

EncodeCharactersForJson(String)

Prepares string for json insertion.

Declaration

public static string EncodeCharactersForJson(string val)

Parameters

Type	Name	Description
String	val

Returns

Type	Description
String

FinalizeReport()

Set final run data and generate all reports.

Declaration

public static void FinalizeReport()

FinalizeTestData()

Current recording or Unity test is complete. Finalize data in preperation for next test or end of run.

Declaration

public static void FinalizeTestData()

GenerateHtmlReport()

Declaration

public static void GenerateHtmlReport()

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

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()

OpenReportFile(ReportingManager.ReportType)

Declaration

public static void OpenReportFile(ReportingManager.ReportType reportType)

Parameters

Type	Name	Description
ReportingManager.ReportType	reportType

RecordLog(String, String, LogType)

Record logs from Unity console and add them to most recently-generated step.

Declaration

public static void RecordLog(string message, string stackTrace, LogType type)

Parameters

Type	Name	Description
String	message
String	stackTrace
LogType	type

Reset()

Reset the ReportingManager for next test.

Declaration

public static void Reset()

SampleFramerate(Single)

Record the current framerate.

Declaration

public static void SampleFramerate(float avgFps)

Parameters

Type	Name	Description
Single	avgFps

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 = null)

Parameters

Type	Name	Description
Vector2	CoordinatesOfPress