[USDU-407] Add automated tests for Analytics #398
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| invalidFile |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| # if UNITY_2023_3_OR_NEWER | ||
|
|
||
| using System.Collections; | ||
| using NUnit.Framework; | ||
| using UnityEditor; | ||
| using UnityEngine; | ||
| using UnityEngine.TestTools; | ||
|
|
||
| namespace Unity.Formats.USD.Tests | ||
| { | ||
| public class EditorAnalyticsBaseFixture : BaseFixtureEditor | ||
| { | ||
| protected const string k_TestPrefabName = "TestPrefab"; | ||
| protected static string[] usdExtensions = new string[] { TestUtility.FileExtension.Usd, TestUtility.FileExtension.Usda, TestUtility.FileExtension.Usdc }; | ||
|
|
||
| protected struct UsdAnalyticsTypes | ||
| { | ||
| public const string Import = "editor.USDFileImport"; | ||
| public const string ReImport = "editor.USDFileReimport"; | ||
| public const string Export = "editor.USDFileExport"; | ||
| } | ||
|
|
||
| public enum ImportMethods | ||
| { | ||
| AsGameObject, | ||
| AsPrefab, | ||
| AsTimelineRecording | ||
| } | ||
|
|
||
| bool m_initialAnalyticsSetting; | ||
| bool m_initialRecordEventsSetting; | ||
| bool m_initialSendEventsImmediatelySetting; | ||
|
|
||
| [OneTimeSetUp] | ||
| public void SetEditorAnalyticsSettings() | ||
| { | ||
| m_initialAnalyticsSetting = EditorAnalytics.enabled; | ||
| m_initialRecordEventsSetting = EditorAnalytics.recordEventsEnabled; | ||
| m_initialSendEventsImmediatelySetting = EditorAnalytics.SendAnalyticsEventsImmediately; | ||
|
|
||
| EditorAnalytics.enabled = true; | ||
| EditorAnalytics.recordEventsEnabled = true; | ||
| EditorAnalytics.SendAnalyticsEventsImmediately = true; | ||
| } | ||
|
|
||
| [OneTimeTearDown] | ||
| public void RevertEditorAnalyticsSettings() | ||
| { | ||
| // Maybe implmeent a package clean up here | ||
|
|
||
| EditorAnalytics.enabled = m_initialAnalyticsSetting; | ||
| EditorAnalytics.recordEventsEnabled = m_initialRecordEventsSetting; | ||
| EditorAnalytics.SendAnalyticsEventsImmediately = m_initialSendEventsImmediatelySetting; | ||
| } | ||
|
|
||
| [SetUp] | ||
| public void ResetEventList() | ||
| { | ||
| DebuggerEventListHandler.ClearEventList(); | ||
| InitUsd.Initialize(); | ||
| } | ||
|
|
||
| public IEnumerator WaitForUsdAnalytics<T>(string expectedType, System.Action<T> actualEvent, float attemptTimeLimitMs = 1500) where T: UsdAnalyticsEvent | ||
| { | ||
| bool found = false; | ||
| var stopWatch = System.Diagnostics.Stopwatch.StartNew(); | ||
|
|
||
| while (!found && stopWatch.Elapsed.TotalMilliseconds < attemptTimeLimitMs) | ||
| { | ||
| T expectedAnalyticsEvent = null; | ||
| foreach (var concattedEvent in DebuggerEventListHandler.fetchEventList()) | ||
| { | ||
| if (!concattedEvent.Contains(expectedType)) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| var splitEvents = concattedEvent.Split("\n"); | ||
| var usdIndex = FindUsdAnalyticsIndex(expectedType, splitEvents); | ||
| var usdEvent = JsonUtility.FromJson<T>(splitEvents[usdIndex]); | ||
|
|
||
| if (usdEvent.type.Contains(expectedType)) | ||
| { | ||
| expectedAnalyticsEvent = usdEvent; | ||
|
|
||
| actualEvent(expectedAnalyticsEvent); | ||
| found = true; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| DebuggerEventListHandler.ClearEventList(); | ||
|
|
||
| yield return null; | ||
| } | ||
| } | ||
|
|
||
| private int FindUsdAnalyticsIndex(string expectedType, string[] splitEvents) | ||
| { | ||
| for (int index = 0; index < splitEvents.Length; index++) | ||
| { | ||
| if (splitEvents[index].Contains(expectedType)) | ||
| { | ||
| return index; | ||
| } | ||
| } | ||
|
|
||
| return -1; | ||
| } | ||
| } | ||
|
|
||
| public class UsdAnalyticsEvent | ||
| { | ||
| public string type; | ||
|
There was a problem hiding this comment. Am I understanding correctly that this actually stores the event name string eg There was a problem hiding this comment. nono its the former, its the event name, i'll change it to something like "name" or "eventName" There was a problem hiding this comment. actually i cant change this as the result json's variable is called "type" and as far as i know Unity's JsonUtility does not have something similar to |
||
| } | ||
|
|
||
| public class UsdAnalyticsEventImport: UsdAnalyticsEvent | ||
| { | ||
| public UsdEditorAnalytics.ImportAnalyticsData msg; | ||
| } | ||
|
|
||
| public class UsdAnalyticsEventReImport : UsdAnalyticsEvent | ||
| { | ||
| public UsdEditorAnalytics.ReimportAnalyticsData msg; | ||
| } | ||
|
|
||
| public class UsdAnalyticsEventExport : UsdAnalyticsEvent | ||
| { | ||
| public UsdEditorAnalytics.ExportAnalyticsData msg; | ||
| } | ||
| } | ||
| #endif | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we feed back further detail on the failure by also logging the exception?