test - refactor

Adding a bit more coverage to the `ValidatedDisableddNetworkBehaviourWarning` test so it validates that when either a child GameObject is set inactive or the NetworkBehaviiour itself is disabled the warning message is generated and the network prefab still spawns and synchronizes.

Author: NoelStephensUnity

com.unity.netcode.gameobjects/Tests/Runtime/NetworkBehaviourGenericTests.cs

@@ -16,6 +16,8 @@ internal class NetworkBehaviourGenericTests : NetcodeIntegrationTest
 
         private bool m_AllowServerToStart;
 
+        private GameObject m_PrefabToSpawn;
+
         protected override bool CanStartServerAndClients()
         {
             return m_AllowServerToStart;
@@ -32,47 +34,88 @@ public override void OnNetworkDespawn()
             }
         }
 
+        protected override void OnServerAndClientsCreated()
+        {
+            m_PrefabToSpawn = CreateNetworkObjectPrefab("TestPrefab");
+
+            var childObject = new GameObject
+            {
+                name = "ChildObject"
+            };
+            childObject.transform.parent = m_PrefabToSpawn.transform;
+            childObject.AddComponent<NetworkTransform>();
+            base.OnServerAndClientsCreated();
+        }
+
         protected override IEnumerator OnSetup()
         {
             m_AllowServerToStart = false;
             return base.OnSetup();
         }
 
+
+        protected override void OnNewClientCreated(NetworkManager networkManager)
+        {
+            networkManager.NetworkConfig.Prefabs.Add(new NetworkPrefab()
+            {
+                Prefab = m_PrefabToSpawn,
+            });
+            base.OnNewClientCreated(networkManager);
+        }
+
+
         /// <summary>
-        /// This validates the fix for when a child GameObject with a NetworkBehaviour
+        /// This validates:
+        /// - The fix for when a child GameObject with a NetworkBehaviour
         /// is deleted while the parent GameObject with a NetworkObject is spawned and
         /// is not deleted until a later time would cause an exception due to the
         /// NetworkBehaviour not being removed from the NetworkObject.ChildNetworkBehaviours
         /// list.
+        /// - That when a child GameObject is deleted/disabled or a NetworkBehaviour is disabled
+        /// a message is logged and the NetworkObject still can be spawned and synchronized.
         /// </summary>
         [UnityTest]
-        public IEnumerator ValidatedDisableddNetworkBehaviourWarning()
+        public IEnumerator ValidatedDisableddNetworkBehaviourWarning([Values] bool disableGameObject)
         {
             m_AllowServerToStart = true;
 
-            yield return s_DefaultWaitForTick;
-
             // Now just start the Host
             yield return StartServerAndClients();
 
-            var parentObject = new GameObject();
-            var childObject = new GameObject
-            {
-                name = "ChildObject"
-            };
-            childObject.transform.parent = parentObject.transform;
-            var parentNetworkObject = parentObject.AddComponent<NetworkObject>();
-            var childBehaviour = childObject.AddComponent<NetworkTransform>();
-
-            // Set the child object to be inactive in the hierarchy
-            childObject.SetActive(false);
-
-            var expectedWarning = parentNetworkObject.GenerateDisabledNetworkBehaviourWarning(childBehaviour);
+            // Now join a new client to make sure a connected client spawns the instance.
+            yield return CreateAndStartNewClient();
 
+            // Adjust the prefab to either have the child GameObject completely disabled or the NetworkBehaviour
+            // disabled.
+            var childBehaviour = m_PrefabToSpawn.GetComponentInChildren<NetworkTransform>(true);
+            if (disableGameObject)
+            {
+                childBehaviour.enabled = true;
+                childBehaviour.gameObject.SetActive(false);
+            }
+            else
+            {
+                childBehaviour.enabled = false;
+                childBehaviour.gameObject.SetActive(true);
+            }
+            // Now create an instance of the prefab
+            var instance = Object.Instantiate(m_PrefabToSpawn);
+            var instanceNetworkObject = instance.GetComponent<NetworkObject>();
+            // Generate the expected warning message
+            var expectedWarning = instanceNetworkObject.GenerateDisabledNetworkBehaviourWarning(instanceNetworkObject.GetComponentInChildren<NetworkTransform>(true));
+            // Spawn the instance
+            SpawnObjectInstance(instanceNetworkObject, m_ServerNetworkManager);
             LogAssert.Expect(LogType.Warning, $"{expectedWarning}");
+            // Asure the connected client spawned the object first
+            yield return WaitForSpawnedOnAllOrTimeOut(instanceNetworkObject);
+            AssertOnTimeout($"Not all clients spawned {instanceNetworkObject.name}!");
 
-            parentNetworkObject.Spawn();
-            yield return s_DefaultWaitForTick;
+            // Now join a new client to make sure the client synchronizes with the disabled GameObject or NetworkBehaviour component.
+            yield return CreateAndStartNewClient();
+
+            // Asure the newly connected client synchronizes the spawned object correctly
+            yield return WaitForSpawnedOnAllOrTimeOut(instanceNetworkObject);
+            AssertOnTimeout($"Not all clients spawned {instanceNetworkObject.name}!");
         }
 
         /// <summary>