chore: legacy cleanup with some test adjustments (#2816)

* update

Move multiprocess tests out of test project assets into legacy folder so it is no longer included with our tests.

* test

Adjusting three tests to prevent inconclusive results.

Author: NoelStephensUnity

com.unity.netcode.gameobjects/Tests/Runtime/NetworkTransform/NetworkTransformTests.cs

@@ -1,3 +1,4 @@
+using System.Collections;
 using NUnit.Framework;
 using UnityEngine;
 
@@ -41,6 +42,24 @@ protected override uint GetTickRate()
             return k_TickRate;
         }
 
+        private bool m_UseParentingThreshold;
+        private const float k_ParentingThreshold = 0.25f;
+
+        protected override float GetDeltaVarianceThreshold()
+        {
+            if (m_UseParentingThreshold)
+            {
+                return k_ParentingThreshold;
+            }
+            return base.GetDeltaVarianceThreshold();
+        }
+
+        protected override IEnumerator OnSetup()
+        {
+            m_UseParentingThreshold = false;
+            return base.OnSetup();
+        }
+
         /// <summary>
         /// Handles validating the local space values match the original local space values.
         /// If not, it generates a message containing the axial values that did not match
@@ -77,6 +96,7 @@ private void AllChildrenLocalTransformValuesMatch(bool useSubChild, ChildrenTran
         [Test]
         public void ParentedNetworkTransformTest([Values] Interpolation interpolation, [Values] bool worldPositionStays, [Values(0.5f, 1.0f, 5.0f)] float scale)
         {
+            m_UseParentingThreshold = true;
             // Get the NetworkManager that will have authority in order to spawn with the correct authority
             var isServerAuthority = m_Authority == Authority.ServerAuthority;
             var authorityNetworkManager = m_ServerNetworkManager;

testproject/Assets/Tests/Runtime/DontDestroyOnLoadTests.cs

@@ -1,4 +1,5 @@
 using System.Collections;
+using System.Text;
 using NUnit.Framework;
 using TestProject.ManualTests;
 using Unity.Netcode;
@@ -8,151 +9,69 @@
 
 namespace TestProject.RuntimeTests
 {
-    public class DontDestroyOnLoadTests
+    public class DontDestroyOnLoadTests : NetcodeIntegrationTest
     {
-        private NetworkManager m_ServerNetworkManager;
-        private NetworkManager[] m_ClientNetworkManagers;
-        private GameObject m_PlayerPrefab;
+        private const int k_ClientsToConnect = 4;
+        protected override int NumberOfClients => 0;
         private GameObject m_DontDestroyOnLoadObject;
 
-
-        [UnitySetUp]
-        public IEnumerator Setup()
+        protected override void OnServerAndClientsCreated()
         {
-            // Create multiple NetworkManager instances
-            if (!NetcodeIntegrationTestHelpers.Create(4, out NetworkManager server, out NetworkManager[] clients, 60))
-            {
-                Debug.LogError("Failed to create instances");
-                Assert.Fail("Failed to create instances");
-            }
-
-            m_PlayerPrefab = new GameObject("Player");
-            var playerNetworkObject = m_PlayerPrefab.AddComponent<NetworkObject>();
-
-            // Make it a prefab
-            NetcodeIntegrationTestHelpers.MakeNetworkObjectTestPrefab(playerNetworkObject);
-
-            m_DontDestroyOnLoadObject = new GameObject("DontDestroyOnLoadObject");
-            var dontDestroyOnLoadNetworkObject = m_DontDestroyOnLoadObject.AddComponent<NetworkObject>();
+            m_DontDestroyOnLoadObject = CreateNetworkObjectPrefab("DDOLObject");
             m_DontDestroyOnLoadObject.AddComponent<ObjectToNotDestroyBehaviour>();
-            // Make it a prefab
-            NetcodeIntegrationTestHelpers.MakeNetworkObjectTestPrefab(dontDestroyOnLoadNetworkObject);
-
-            // Set the player prefab
-            server.NetworkConfig.PlayerPrefab = m_PlayerPrefab;
-            // Add our test NetworkObject to be moved into the DontDestroyOnLoad scene
-            server.NetworkConfig.Prefabs.Add(new NetworkPrefab() { Override = NetworkPrefabOverride.None, Prefab = m_DontDestroyOnLoadObject });
-
-            // Apply the same settings for the clients
-            for (int i = 0; i < clients.Length; i++)
-            {
-                clients[i].NetworkConfig.PlayerPrefab = m_PlayerPrefab;
-                clients[i].NetworkConfig.Prefabs.Add(new NetworkPrefab() { Override = NetworkPrefabOverride.None, Prefab = m_DontDestroyOnLoadObject });
-            }
-
-            m_ServerNetworkManager = server;
-            m_ClientNetworkManagers = clients;
-
-            yield return null;
+            base.OnServerAndClientsCreated();
         }
 
-        [UnityTearDown]
-        public IEnumerator Teardown()
+        protected override void OnNewClientCreated(NetworkManager networkManager)
         {
-            NetcodeIntegrationTestHelpers.CleanUpHandlers();
-
-            m_ServerNetworkManager.Shutdown();
-            foreach (var networkManager in m_ClientNetworkManagers)
-            {
-                networkManager.Shutdown();
-            }
-            int nextFrameNumber = Time.frameCount + 4;
-            yield return new WaitUntil(() => Time.frameCount >= nextFrameNumber);
-            Object.Destroy(m_PlayerPrefab);
-            Object.Destroy(m_DontDestroyOnLoadObject);
-            Object.Destroy(m_ServerNetworkManager);
-            foreach (var networkManager in m_ClientNetworkManagers)
-            {
-                Object.Destroy(networkManager);
-            }
-
-            m_ServerNetworkManager = null;
-            m_ClientNetworkManagers = null;
+            networkManager.NetworkConfig.Prefabs = m_ServerNetworkManager.NetworkConfig.Prefabs;
+            base.OnNewClientCreated(networkManager);
+        }
 
-#if UNITY_2023_1_OR_NEWER
-            var networkObjects = Object.FindObjectsByType<NetworkObject>(FindObjectsSortMode.InstanceID);
-#else
-            var networkObjects = Object.FindObjectsOfType<NetworkObject>();
-#endif
+        private ulong m_SpawnedNetworkObjectId;
+        private StringBuilder m_ErrorLog = new StringBuilder();
 
-            foreach (var netObject in networkObjects)
+        private bool AllClientsSpawnedObjectIntoDDOL()
+        {
+            var passed = true;
+            m_ErrorLog.Clear();
+            foreach (var client in m_ClientNetworkManagers)
             {
-                Object.DestroyImmediate(netObject);
+                if (!client.SpawnManager.SpawnedObjects.ContainsKey(m_SpawnedNetworkObjectId))
+                {
+                    m_ErrorLog.AppendLine($"[Client-{client.LocalClientId}] Has not spanwed NetworkObjectId: {m_SpawnedNetworkObjectId}!");
+                    passed = false;
+                    continue;
+                }
+
+                var spawnedObject = client.SpawnManager.SpawnedObjects[m_SpawnedNetworkObjectId];
+                if (spawnedObject.NetworkManager == client && spawnedObject.gameObject.scene.name != "DontDestroyOnLoad")
+                {
+                    m_ErrorLog.AppendLine($"[Client-{client.LocalClientId}] {spawnedObject.name} is not in DDOL scene but is in scene {spawnedObject.gameObject.scene.name}");
+                    passed = false;
+                    continue;
+                }
             }
-            yield return null;
+            return passed;
         }
 
-
         [UnityTest]
         public IEnumerator ValidateNetworkObjectSynchronization()
         {
-            m_ServerNetworkManager.StartHost();
-            NetcodeIntegrationTestHelpers.RegisterHandlers(m_ServerNetworkManager);
-            var objectInstance = Object.Instantiate(m_DontDestroyOnLoadObject);
-            var instanceNetworkObject = objectInstance.GetComponent<NetworkObject>();
-            instanceNetworkObject.NetworkManagerOwner = m_ServerNetworkManager;
-            instanceNetworkObject.Spawn();
-            var serverobjectToNotDestroyBehaviour = objectInstance.GetComponent<ObjectToNotDestroyBehaviour>();
-            var waitForTick = new WaitForSeconds(1.0f / m_ServerNetworkManager.NetworkConfig.TickRate);
-            yield return waitForTick;
+            var objectInstance = SpawnObject(m_DontDestroyOnLoadObject, m_ServerNetworkManager);
+            m_SpawnedNetworkObjectId = objectInstance.GetComponent<NetworkObject>().NetworkObjectId;
+            // Wait a tick for the object to be automatically migrated into the DDOL
+            yield return s_DefaultWaitForTick;
 
             Assert.IsTrue(objectInstance.scene.name == "DontDestroyOnLoad");
 
-            foreach (var networkManager in m_ClientNetworkManagers)
+            for (int i = 0; i < k_ClientsToConnect; i++)
             {
-                networkManager.StartClient();
-                NetcodeIntegrationTestHelpers.RegisterHandlers(networkManager);
+                yield return CreateAndStartNewClient();
             }
 
-            yield return NetcodeIntegrationTestHelpers.WaitForClientsConnected(m_ClientNetworkManagers);
-
-            yield return waitForTick;
-            var timeOut = Time.realtimeSinceStartup + 2.0f;
-            var timedOut = false;
-            while (!timedOut)
-            {
-                var allClientConditionsHaveBeenReached = true;
-                foreach (var networkManager in m_ClientNetworkManagers)
-                {
-                    foreach (var spawnedObject in networkManager.SpawnManager.SpawnedObjectsList)
-                    {
-                        if (spawnedObject.NetworkManager == networkManager && spawnedObject.gameObject.name.Contains("DontDestroyOnLoadObject"))
-                        {
-                            if (spawnedObject.gameObject.scene.name != "DontDestroyOnLoad")
-                            {
-                                allClientConditionsHaveBeenReached = false;
-                                break;
-                            }
-                            var objectToNotDestroyBehaviour = spawnedObject.gameObject.GetComponent<ObjectToNotDestroyBehaviour>();
-                            if (objectToNotDestroyBehaviour.CurrentPing == 0 || serverobjectToNotDestroyBehaviour.CurrentPing != objectToNotDestroyBehaviour.CurrentPing)
-                            {
-                                allClientConditionsHaveBeenReached = false;
-                                break;
-                            }
-                        }
-                    }
-                }
-
-                if (allClientConditionsHaveBeenReached)
-                {
-                    break;
-                }
-
-                yield return waitForTick;
-
-                timedOut = timeOut < Time.realtimeSinceStartup;
-            }
-            Assert.False(timedOut, "Timed out while waiting for all client conditions to be reached!");
+            yield return WaitForConditionOrTimeOut(AllClientsSpawnedObjectIntoDDOL);
+            AssertOnTimeout($"[DDOL Test Failure] Reason for failure:\n {m_ErrorLog}");
         }
     }
 }

testproject/Assets/Tests/Runtime/ObjectParenting/ParentingInSceneObjectsTests.cs

@@ -14,7 +14,7 @@ public class ParentingInSceneObjectsTests : IntegrationTestWithApproximation
         private const string k_BaseSceneToLoad = "UnitTestBaseScene";
         private const string k_TestSceneToLoad = "ParentingInSceneObjects";
         private const int k_NumIterationsDeparentReparent = 100;
-        private const float k_AproximateThresholdValue = 0.001f;
+        private const float k_AproximateThresholdValue = 0.1f;
 
         private bool m_InitialClientsLoadedScene;
         private StringBuilder m_ErrorValidationLog = new StringBuilder(0x2000);
@@ -71,7 +71,7 @@ private void GeneratePositionDoesNotMatch(InSceneParentChildHandler serverHandle
 
         private void GenerateRotationDoesNotMatch(InSceneParentChildHandler serverHandler, InSceneParentChildHandler clientHandler)
         {
-            m_ErrorValidationLog.Append($"[Client-{clientHandler.NetworkManager.LocalClientId}] {nameof(NetworkObject)}-{clientHandler.NetworkObjectId}'s rotation {clientHandler.transform.eulerAngles} does not equal the server-side scale {serverHandler.transform.eulerAngles}");
+            m_ErrorValidationLog.Append($"[Client-{clientHandler.NetworkManager.LocalClientId}] {nameof(NetworkObject)}-{clientHandler.NetworkObjectId}'s rotation {clientHandler.transform.eulerAngles} does not equal the server-side rotation {serverHandler.transform.eulerAngles}");
         }
 
         private void GenerateScaleDoesNotMatch(InSceneParentChildHandler serverHandler, InSceneParentChildHandler clientHandler)