Class ReportingManager
Inheritance
ReportingManager
Syntax
public static class ReportingManager : object
Properties
CurrentTestName
Declaration
public static string CurrentTestName { get; set; }
Property Value
ReportData
Declaration
public static ReportingManager.TestRunData ReportData { get; set; }
Property Value
ReportFileNameWithoutExtension
Declaration
public static string ReportFileNameWithoutExtension { get; }
Property Value
ReportingMonitor
Declaration
public static GameObject ReportingMonitor { get; set; }
Property Value
| Type |
Description |
| GameObject |
|
ReportSaveDirectory
Declaration
public static string ReportSaveDirectory { get; }
Property Value
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
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
Returns
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()
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
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 |
|
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 |
|