test: Perf tests part 4. Adding example of performance test with spawning x network objects at once (#925)

Adding a first example of performance tests.
This was used a test bench for multiprocess testing tools in Part 1-3.
These tests will be skipped for normal CI as they need additional setup steps for device orchestration.
They will spawn x number of objects server side, wait to see them client side and report on the number of failures, number of spawned objects per frame, etc.
These tests create GC allocs before and after the tests. During the tests, the only allocs I could find were MLAPI related, which is kind of the point for these tests :)

Author: SamuelBellomo

testproject/Assets/Scenes/MultiprocessTestScene.unity

@@ -743,7 +743,7 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 068bf11ceb1344667af4cc40950f44f4, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
-  referencedPrefab: {fileID: 5637023994061915634, guid: b0952a471c5a147cb92f6afcdb648f8a,
+  ReferencedPrefab: {fileID: 5637023994061915634, guid: b0952a471c5a147cb92f6afcdb648f8a,
     type: 3}
 --- !u!114 &1211923378
 MonoBehaviour:
@@ -817,8 +817,6 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: ef1240e0784f84eadb77fe822e2e03c7, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
-  isRegistering: 0
-  hasRegistered: 0
 --- !u!1 &1674777071
 GameObject:
   m_ObjectHideFlags: 0

testproject/Assets/Scripts/ScriptsForAutomatedTesting.meta

@@ -0,0 +1,23 @@
+using UnityEngine;
+
+/// <summary>
+/// Serves as access point from code to a prefab
+/// </summary>
+public class PrefabReference : MonoBehaviour
+{
+    [SerializeField]
+    public GameObject ReferencedPrefab;
+
+    public static PrefabReference Instance { get; private set; }
+
+    public void Awake()
+    {
+        if (Instance != null)
+        {
+            Destroy(gameObject);
+            return;
+        }
+
+        Instance = this;
+    }
+}

testproject/Assets/Scripts/ScriptsForAutomatedTesting/PrefabReference.cs

@@ -0,0 +1,17 @@
+{
+    "name": "ScriptsForAutomatedTesting",
+    "rootNamespace": "",
+    "references": [
+        "GUID:753245531f1b64a6ea7491ec63a5947c",
+        "GUID:1491147abca9d7d4bb7105af628b223e"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

testproject/Assets/Scripts/ScriptsForAutomatedTesting/PrefabReference.cs.meta

@@ -6,91 +6,118 @@
 #endif
 using UnityEngine;
 
-/// <summary>
-/// This is needed as Unity throws "An abnormal situation has occurred: the PlayerLoop internal function has been called recursively. Please contact Customer Support with a sample project so that we can reproduce the problem and troubleshoot it."
-/// when trying to build from Setup() steps in tests.
-/// </summary>
-public static class BuildMultiprocessTestPlayer
+namespace MLAPI.MultiprocessRuntimeTests
 {
-    public const string MultiprocessBaseMenuName = "MLAPI/Multiprocess Test";
-    public const string BuildAndExecuteMenuName = MultiprocessBaseMenuName + "/Build Test Player #t";
-    public const string MainSceneName = "MultiprocessTestScene";
-    private static string BuildPathDirectory => Path.Combine(Path.GetDirectoryName(Application.dataPath), "Builds", "MultiprocessTests");
-    public static string BuildPath => Path.Combine(BuildPathDirectory, "MultiprocessTestPlayer");
+    /// <summary>
+    /// This is needed as Unity throws "An abnormal situation has occurred: the PlayerLoop internal function has been called recursively. Please contact Customer Support with a sample project so that we can reproduce the problem and troubleshoot it."
+    /// when trying to build from Setup() steps in tests.
+    /// </summary>
+    public static class BuildMultiprocessTestPlayer
+    {
+        public const string MultiprocessBaseMenuName = "MLAPI/Multiprocess Test";
+        public const string BuildAndExecuteMenuName = MultiprocessBaseMenuName + "/Build Test Player #t";
+        public const string MainSceneName = "MultiprocessTestScene";
+
+        public const string BuildInfoFileName = "buildInfo.json";
+
+        private static string BuildPathDirectory => Path.Combine(Path.GetDirectoryName(Application.dataPath), "Builds", "MultiprocessTests");
+        public static string BuildPath => Path.Combine(BuildPathDirectory, "MultiprocessTestPlayer");
 
 #if UNITY_EDITOR
-    [MenuItem(BuildAndExecuteMenuName)]
-    public static void BuildRelease()
-    {
-        var report = BuildPlayer();
-        if (report.summary.result != BuildResult.Succeeded)
+        [MenuItem(BuildAndExecuteMenuName)]
+        public static void BuildRelease()
         {
-            throw new Exception($"Build failed! {report.summary.totalErrors} errors");
+            var report = BuildPlayer();
+            if (report.summary.result != BuildResult.Succeeded)
+            {
+                throw new Exception($"Build failed! {report.summary.totalErrors} errors");
+            }
         }
-    }
 
-    [MenuItem(MultiprocessBaseMenuName + "/Build Test Player (Debug)")]
-    public static void BuildDebug()
-    {
-        var report = BuildPlayer(true);
-        if (report.summary.result != BuildResult.Succeeded)
+        [MenuItem(MultiprocessBaseMenuName + "/Build Test Player (Debug)")]
+        public static void BuildDebug()
         {
-            throw new Exception($"Build failed! {report.summary.totalErrors} errors");
+            var report = BuildPlayer(true);
+            if (report.summary.result != BuildResult.Succeeded)
+            {
+                throw new Exception($"Build failed! {report.summary.totalErrors} errors");
+            }
         }
-    }
 
-    [MenuItem(MultiprocessBaseMenuName + "/Delete Test Build")]
-    public static void DeleteBuild()
-    {
-        if (Directory.Exists(BuildPathDirectory))
+        [MenuItem(MultiprocessBaseMenuName + "/Delete Test Build")]
+        public static void DeleteBuild()
         {
-            Directory.Delete(BuildPathDirectory, recursive: true);
+            if (Directory.Exists(BuildPathDirectory))
+            {
+                Directory.Delete(BuildPathDirectory, recursive: true);
+            }
+            else
+            {
+                Debug.Log($"[{nameof(BuildMultiprocessTestPlayer)}] build directory does not exist ({BuildPathDirectory}) not deleting anything");
+            }
         }
-        else
+
+        /// <summary>
+        /// Needs a separate build than the standalone test builds since we don't want the player to try to connect to the editor to do test
+        /// reporting. We only want to main node to do that, worker nodes should be dumb
+        /// </summary>
+        /// <returns></returns>
+        private static BuildReport BuildPlayer(bool isDebug = false)
         {
-            Debug.Log($"[{nameof(BuildMultiprocessTestPlayer)}] build directory does not exist ({BuildPathDirectory}) not deleting anything");
-        }
-    }
+            // Save standalone build path to file so we can read it from standalone tests (that are not running from editor)
+            SaveBuildInfo(new BuildInfo() { BuildPath = BuildPath, IsDebug = isDebug });
 
-    /// <summary>
-    /// Needs a separate build than the standalone test builds since we don't want the player to try to connect to the editor to do test
-    /// reporting. We only want to main node to do that, worker nodes should be dumb
-    /// </summary>
-    /// <returns></returns>
-    private static BuildReport BuildPlayer(bool isDebug = false)
-    {
-        // Save standalone build path to file so we can read it from standalone tests (that are not running from editor)
-        File.WriteAllText(Path.Combine(Application.streamingAssetsPath, MultiprocessOrchestration.BuildInfoFileName), BuildPath);
+            // deleting so we don't end up testing on outdated builds if there's a build failure
+            DeleteBuild();
 
-        // deleting so we don't end up testing on outdated builds if there's a build failure
-        DeleteBuild();
+            var buildOptions = BuildOptions.None;
+            buildOptions |= BuildOptions.IncludeTestAssemblies;
+            buildOptions |= BuildOptions.StrictMode;
+            if (isDebug)
+            {
+                buildOptions |= BuildOptions.Development;
+                buildOptions |= BuildOptions.AllowDebugging; // enable this if you want to debug your players. Your players
 
-        var buildOptions = BuildOptions.None;
-        buildOptions |= BuildOptions.IncludeTestAssemblies;
-        buildOptions |= BuildOptions.StrictMode;
-        if (isDebug)
-        {
-            buildOptions |= BuildOptions.Development;
-            buildOptions |= BuildOptions.AllowDebugging; // enable this if you want to debug your players. Your players
-            // will have more connection permission popups when launching though
+                // will have more connection permission popups when launching though
+            }
+
+            var buildPathToUse = BuildPath;
+            if (Application.platform == RuntimePlatform.WindowsPlayer || Application.platform == RuntimePlatform.WindowsEditor)
+            {
+                buildPathToUse += ".exe";
+            }
+
+            Debug.Log($"Starting multiprocess player build using path {buildPathToUse}");
+
+            buildOptions &= ~BuildOptions.AutoRunPlayer;
+            var buildReport = BuildPipeline.BuildPlayer(
+                new[] { $"Assets/Scenes/{MainSceneName}.unity" },
+                buildPathToUse,
+                EditorUserBuildSettings.activeBuildTarget,
+                buildOptions);
+
+            Debug.Log("Build finished");
+            return buildReport;
         }
+#endif
 
-        var buildPathToUse = BuildPath;
-        if (Application.platform == RuntimePlatform.WindowsPlayer || Application.platform == RuntimePlatform.WindowsEditor)
+        [Serializable]
+        public struct BuildInfo
         {
-            buildPathToUse += ".exe";
+            public string BuildPath;
+            public bool IsDebug;
         }
-        Debug.Log($"Starting multiprocess player build using path {buildPathToUse}");
 
-        buildOptions &= ~BuildOptions.AutoRunPlayer;
-        var buildReport = BuildPipeline.BuildPlayer(
-            new[] { $"Assets/Scenes/{MainSceneName}.unity" },
-            buildPathToUse,
-            EditorUserBuildSettings.activeBuildTarget,
-            buildOptions);
+        public static BuildInfo ReadBuildInfo()
+        {
+            var jsonString = File.ReadAllText(Path.Combine(Application.streamingAssetsPath, BuildInfoFileName));
+            return JsonUtility.FromJson<BuildInfo>(jsonString);
+        }
 
-        Debug.Log("Build finished");
-        return buildReport;
+        public static void SaveBuildInfo(BuildInfo toSave)
+        {
+            var buildInfoJson = JsonUtility.ToJson(toSave);
+            File.WriteAllText(Path.Combine(Application.streamingAssetsPath, BuildInfoFileName), buildInfoJson);
+        }
     }
-#endif
 }

testproject/Assets/Scripts/ScriptsForAutomatedTesting/ScriptsForAutomatedTesting.asmdef

@@ -0,0 +1,47 @@
+using System;
+using UnityEngine;
+using MLAPI.Spawning;
+
+namespace MLAPI.MultiprocessRuntimeTests
+{
+    public class CustomPrefabSpawnerForPerformanceTests<T> : INetworkPrefabInstanceHandler, IDisposable where T : NetworkBehaviour
+    {
+        private GameObjectPool<T> m_ObjectPool;
+        private Action<T> m_SetupSpawnedObject;
+        private Action<T> m_OnRelease;
+
+        public CustomPrefabSpawnerForPerformanceTests(T prefabToSpawn, int maxObjectsToSpawn, Action<T> setupSpawnedObject, Action<T> onRelease)
+        {
+            m_ObjectPool = new GameObjectPool<T>();
+            m_ObjectPool.Initialize(maxObjectsToSpawn, prefabToSpawn);
+            m_SetupSpawnedObject = setupSpawnedObject;
+            m_OnRelease = onRelease;
+        }
+
+        public NetworkObject HandleNetworkPrefabSpawn(ulong ownerClientId, Vector3 position, Quaternion rotation)
+        {
+            var netBehaviour = m_ObjectPool.Get();
+            var networkObject = netBehaviour.NetworkObject;
+            Transform netTransform = networkObject.transform;
+            netTransform.position = position;
+            netTransform.rotation = rotation;
+            m_SetupSpawnedObject(netBehaviour);
+            return networkObject;
+        }
+
+        public void HandleNetworkPrefabDestroy(NetworkObject networkObject)
+        {
+            var behaviour = networkObject.gameObject.GetComponent<T>(); // todo expensive, only used in teardown for now, should optimize eventually
+            m_OnRelease(behaviour);
+            Transform netTransform = networkObject.transform;
+            netTransform.position = Vector3.zero;
+            netTransform.rotation = Quaternion.identity;
+            m_ObjectPool.Release(behaviour);
+        }
+
+        public void Dispose()
+        {
+            m_ObjectPool.Dispose();
+        }
+    }
+}