fix

Fixing some issues with DistributedAuthorityCodecTests creating prefabs after having started the NetworkManager and issues with NetworkBehaviourTests having some bad/legacy technical debt in the initial design for those tests (particularly how it was checking if clients spawned objects).

Author: NoelStephensUnity

com.unity.netcode.gameobjects/TestHelpers/Runtime/NetcodeIntegrationTest.cs

@@ -218,6 +218,23 @@ protected NetworkManager GetNonAuthorityNetworkManager()
         /// <remarks>Can only be true if <see cref="UseCMBService"/> returns true.</remarks>
         protected bool m_UseCmbService { get; private set; }
 
+        private string m_UseCmbServiceEnvString = null;
+        private bool m_UseCmbServiceEnv;
+
+        /// <summary>
+        /// Will set itself once and if already set then return true
+        /// </summary>
+        /// <returns>true/false</returns>
+        internal bool UseCMBServiceEnviromentVariableSet()
+        {
+            if (!m_UseCmbServiceEnv && m_UseCmbServiceEnvString == null)
+            {
+                var useCmbService = Environment.GetEnvironmentVariable("USE_CMB_SERVICE") ?? "unset";
+                m_UseCmbServiceEnv = useCmbService.ToLower() == "true";
+            }
+            return m_UseCmbServiceEnv;
+        }
+
         /// <summary>
         /// Indicates whether a hosted CMB service is available.
         /// </summary>
@@ -228,8 +245,7 @@ protected virtual bool UseCMBService()
 #if USE_CMB_SERVICE
             return true;
 #else
-            var useCmbService = Environment.GetEnvironmentVariable("USE_CMB_SERVICE") ?? "unset";
-            return useCmbService.ToLower() == "true";
+            return UseCMBServiceEnviromentVariableSet();
 #endif
         }
 
@@ -1438,6 +1454,8 @@ public void OneTimeTearDown()
 #endif
 
             IsRunning = false;
+            m_UseCmbServiceEnvString = null;
+            m_UseCmbServiceEnv = false;
         }
 
         /// <summary>

com.unity.netcode.gameobjects/Tests/Runtime/DistributedAuthority/DistributedAuthorityCodecTests.cs

@@ -45,6 +45,8 @@ internal class DistributedAuthorityCodecTests : NetcodeIntegrationTest
         private static readonly ushort k_TransportPort = GetPortToBind();
         private const int k_ClientId = 0;
 
+        private GameObject m_TestPrefab;
+
         /// <summary>
         /// Configures the port to look for the rust echo-server.
         /// </summary>
@@ -247,9 +249,7 @@ public IEnumerator NetworkVariableDelta()
         [UnityTest]
         public IEnumerator NetworkVariableDelta_WithValueUpdate()
         {
-            var networkObj = CreateNetworkObjectPrefab("TestObject");
-            networkObj.AddComponent<TestNetworkComponent>();
-            var instance = SpawnObject(networkObj, Client);
+            var instance = SpawnObject(m_SpawnObject, Client);
             yield return m_ClientCodecHook.WaitForMessageReceived<CreateObjectMessage>();
             var component = instance.GetComponent<TestNetworkComponent>();
 
@@ -262,9 +262,7 @@ public IEnumerator NetworkVariableDelta_WithValueUpdate()
         [UnityTest]
         public IEnumerator NetworkListDelta_WithValueUpdate()
         {
-            var networkObj = CreateNetworkObjectPrefab("TestObject");
-            networkObj.AddComponent<TestNetworkComponent>();
-            var instance = SpawnObject(networkObj, Client);
+            var instance = SpawnObject(m_SpawnObject, Client);
             yield return m_ClientCodecHook.WaitForMessageReceived<CreateObjectMessage>();
             var component = instance.GetComponent<TestNetworkComponent>();
 

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

@@ -1,11 +1,11 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text;
 using NUnit.Framework;
 using Unity.Netcode.TestHelpers.Runtime;
 using UnityEngine;
 using UnityEngine.TestTools;
-using Object = UnityEngine.Object;
 
 namespace Unity.Netcode.RuntimeTests
 {
@@ -85,15 +85,6 @@ public void SetOwnerWrite()
             m_SeconValue = new NetworkVariable<int>(default, NetworkVariableReadPermission.Everyone, NetworkVariableWritePermission.Owner);
         }
 
-        public override void OnNetworkSpawn()
-        {
-            // Non-Authority will register each NetworkObject when it is spawned
-            if ((NetworkManager.DistributedAuthorityMode && !IsOwner) || (!NetworkManager.DistributedAuthorityMode && !IsServer))
-            {
-                NetworkBehaviourUpdaterTests.ClientSideNotifyObjectSpawned(gameObject);
-            }
-        }
-
         /// <summary>
         /// Server side only, sets the NetworkVariables being used to the ValueToSetNetVarTo
         /// that is pre-configured when the Network Prefab is created.
@@ -160,12 +151,14 @@ internal struct NetVarCombinationTypes
     internal class NetworkBehaviourUpdaterTests : NetcodeIntegrationTest
     {
         // Go ahead and create maximum number of clients (not all tests will use them)
-        protected override int NumberOfClients => m_NumberOfClients;
+        protected override int NumberOfClients => m_ClientCount;
         public const int NetVarValueToSet = 1;
-        private static List<GameObject> s_ClientSpawnedNetworkObjects = new List<GameObject>();
+        private List<ulong> m_SpawnedObjects = new List<ulong>();
         private GameObject m_PrefabToSpawn;
         private NetVarCombinationTypes m_NetVarCombinationTypes;
-        private int m_NumberOfClients = 0;
+        private int m_ClientCount = 0;
+
+        private StringBuilder m_ErrorLog = new StringBuilder();
 
         public NetworkBehaviourUpdaterTests(HostOrServer hostOrServer, int numberOfClients, NetVarContainer.NetVarsToCheck first, NetVarContainer.NetVarsToCheck second) : base(hostOrServer)
         {
@@ -174,25 +167,24 @@ public NetworkBehaviourUpdaterTests(HostOrServer hostOrServer, int numberOfClien
                 FirstType = first,
                 SecondType = second
             };
-            m_NumberOfClients = numberOfClients;
+            // Adjust the client count if connecting to the service.
+            m_ClientCount = UseCMBServiceEnviromentVariableSet() ? numberOfClients + 1 : numberOfClients;
         }
 
-        protected override IEnumerator OnSetup()
+        protected override bool UseCMBService()
         {
-            s_ClientSpawnedNetworkObjects.Clear();
-            return base.OnSetup();
+            return true;
         }
 
-        /// <summary>
-        /// Clients will call this when NetworkObjects are spawned on their end
-        /// </summary>
-        /// <param name="objectSpaned">the GameObject of the NetworkObject spawned</param>
-        public static void ClientSideNotifyObjectSpawned(GameObject objectSpaned)
+        protected override void OnOneTimeTearDown()
         {
-            if (!s_ClientSpawnedNetworkObjects.Contains(objectSpaned))
-            {
-                s_ClientSpawnedNetworkObjects.Add(objectSpaned);
-            }
+            base.OnOneTimeTearDown();
+        }
+
+        protected override IEnumerator OnSetup()
+        {
+            m_SpawnedObjects.Clear();
+            return base.OnSetup();
         }
 
         protected override void OnServerAndClientsCreated()
@@ -221,6 +213,31 @@ protected override void OnServerAndClientsCreated()
             base.OnServerAndClientsCreated();
         }
 
+        /// <summary>
+        /// Determines if all clients have spawned clone instances.
+        /// </summary>
+        /// <remarks>
+        /// <see cref="m_ErrorLog"/> will contain log entries of the
+        /// <see cref="NetworkManager"/> instances and NetworkObjects
+        /// that did not get spawned.
+        /// </remarks>
+        /// <returns>true(success) or false (failure)</returns>
+        private bool AllClientsSpawnedObjects()
+        {
+            m_ErrorLog.Clear();
+            foreach (var networkManager in m_NetworkManagers)
+            {
+                foreach (var networkObjectId in m_SpawnedObjects)
+                {
+                    if (!networkManager.SpawnManager.SpawnedObjects.ContainsKey(networkObjectId))
+                    {
+                        m_ErrorLog.AppendLine($"[{networkManager.name}] Has not spawned {nameof(NetworkObject)}-{networkObjectId}.");
+                    }
+                }
+            }
+            return m_ErrorLog.Length == 0;
+        }
+
         /// <summary>
         /// The updated BehaviourUpdaterAllTests was re-designed to replicate the same functionality being tested in the
         /// original version of this test with additional time out handling and a re-organization in the order of operations.
@@ -243,22 +260,19 @@ public IEnumerator BehaviourUpdaterAllTests([Values(1, 2)] int numToSpawn)
             // the appropriate number of NetworkObjects with the NetVarContainer behaviour
             var numberOfObjectsToSpawn = numToSpawn * NumberOfClients;
 
-            var authority = m_NetworkTopologyType == NetworkTopologyTypes.DistributedAuthority ? m_ClientNetworkManagers[0] : m_ServerNetworkManager;
+            var authority = GetAuthorityNetworkManager();
 
             // spawn the objects
             for (int i = 0; i < numToSpawn; i++)
             {
-                var spawnedObject = Object.Instantiate(m_PrefabToSpawn);
+                var spawnedObject = SpawnObject(m_PrefabToSpawn, authority);
                 spawnedPrefabs.Add(spawnedObject);
-                var networkSpawnedObject = spawnedObject.GetComponent<NetworkObject>();
-                networkSpawnedObject.NetworkManagerOwner = authority;
-                networkSpawnedObject.Spawn();
+                m_SpawnedObjects.Add(spawnedObject.GetComponent<NetworkObject>().NetworkObjectId);
             }
 
             // Waits for all clients to spawn the NetworkObjects
-            yield return WaitForConditionOrTimeOut(() => numberOfObjectsToSpawn == s_ClientSpawnedNetworkObjects.Count);
-            Assert.IsFalse(s_GlobalTimeoutHelper.TimedOut, $"Timed out waiting for clients to report spawning objects! " +
-                $"Total reported client-side spawned objects {s_ClientSpawnedNetworkObjects.Count}");
+            yield return WaitForConditionOrTimeOut(AllClientsSpawnedObjects);
+            AssertOnTimeout($"Timed out waiting for clients to report spawning objects!\n {m_ErrorLog}");
 
 
             // Once all clients have spawned the NetworkObjects, set the network variables for
@@ -287,12 +301,19 @@ public IEnumerator BehaviourUpdaterAllTests([Values(1, 2)] int numToSpawn)
 
             // Get a list of all NetVarContainer components on the client-side spawned NetworkObjects
             var clientSideNetVarContainers = new List<NetVarContainer>();
-            foreach (var clientSpawnedObjects in s_ClientSpawnedNetworkObjects)
+            foreach (var networkManager in m_NetworkManagers)
             {
-                var netVarContainers = clientSpawnedObjects.GetComponents<NetVarContainer>();
-                foreach (var netvarContiner in netVarContainers)
+                if (networkManager == authority)
                 {
-                    clientSideNetVarContainers.Add(netvarContiner);
+                    continue;
+                }
+                foreach (var networkObjectId in m_SpawnedObjects)
+                {
+                    var netVarContainers = networkManager.SpawnManager.SpawnedObjects[networkObjectId].GetComponents<NetVarContainer>();
+                    foreach (var netvarContiner in netVarContainers)
+                    {
+                        clientSideNetVarContainers.Add(netvarContiner);
+                    }
                 }
             }