lets go

Author: EmandM

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

@@ -171,19 +171,30 @@ public static void RegisterHandlers(NetworkManager networkManager, bool serverSi
             }
         }
 
-        private static readonly string k_TransportHost = Environment.GetEnvironmentVariable("NGO_HOST") ?? "127.0.0.1";
+        private static readonly string k_TransportHost = GetAddressToBind();
         private static readonly ushort k_TransportPort = GetPortToBind();
 
         /// <summary>
         /// Configures the port to look for the rust service.
         /// </summary>
-        /// <returns>The port from the environment variable "ECHO_SERVER_PORT" if it is set and valid; otherwise uses port 7777</returns>
+        /// <returns>The port from the environment variable "CMB_SERVICE_PORT" if it is set and valid; otherwise uses port 7789</returns>
         private static ushort GetPortToBind()
         {
             var value = Environment.GetEnvironmentVariable("CMB_SERVICE_PORT");
             return ushort.TryParse(value, out var configuredPort) ? configuredPort : (ushort)7789;
         }
 
+        /// <summary>
+        /// Configures the address to look for the rust service.
+        /// </summary>
+        /// <returns>The address from the environment variable "NGO_HOST" if it is set and valid; otherwise uses "127.0.0.1"</returns>
+        private static string GetAddressToBind()
+        {
+            var value = Environment.GetEnvironmentVariable("NGO_HOST") ?? "127.0.0.1";
+            return Dns.GetHostAddresses(value).First().ToString();
+        }
+
+
         private static void AddUnityTransport(NetworkManager networkManager, bool useCmbService = false)
         {
             // Create transport
@@ -197,7 +208,7 @@ private static void AddUnityTransport(NetworkManager networkManager, bool useCmb
             unityTransport.ConnectTimeoutMS = 500;
             if (useCmbService)
             {
-                unityTransport.ConnectionData.Address = Dns.GetHostAddresses(k_TransportHost).First().ToString();
+                unityTransport.ConnectionData.Address = k_TransportHost;
                 unityTransport.ConnectionData.Port = k_TransportPort;
                 Debug.Log($"Using CmbService: {k_TransportHost}:{k_TransportPort}");
             }
@@ -1005,9 +1016,24 @@ private static IEnumerator ExecuteWaitForHook(MessageHandleCheckWithResult check
             result.Result = res;
         }
 
-        public static uint GetGlobalObjectIdHash(NetworkObject networkObject)
+
+        private static bool s_PreviousWasCmbServiceTest;
+
+        /// <summary>
+        /// Waits for a second if the previous and current tests are using the hosted CMB Service.
+        /// This is necessary as the CMB Service does not restart fast enough when running multiple tests.
+        /// </summary>
+        /// <param name="isCmbServiceTest"></param>
+        /// <returns>An <see cref="IEnumerator"/> that will wait for a second</returns>
+        public static IEnumerator WaitBetweenCmbServiceTests(bool isCmbServiceTest)
         {
-            return networkObject.GlobalObjectIdHash;
+            if (isCmbServiceTest && s_PreviousWasCmbServiceTest)
+            {
+                Debug.Log("Waiting for CMB service to be shut down during test setup.");
+                yield return new WaitForSeconds(1f);
+            }
+
+            s_PreviousWasCmbServiceTest = isCmbServiceTest;
         }
 
 #if UNITY_EDITOR

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

@@ -17,6 +17,12 @@ internal class ClientConnectionTests : IntegrationTestWithApproximation
         private HashSet<ulong> m_ServerCallbackCalled = new HashSet<ulong>();
         private HashSet<ulong> m_ClientCallbackCalled = new HashSet<ulong>();
 
+        // TODO: [CmbServiceTests] Enable once the cmb service sceneManagementEnabled OnClientConnected flow is fixed
+        protected override bool UseCMBService()
+        {
+            return false;
+        }
+
         public ClientConnectionTests(SceneManagementState sceneManagementState, NetworkTopologyTypes networkTopologyType) : base(networkTopologyType)
         {
             m_SceneManagementEnabled = sceneManagementState == SceneManagementState.SceneManagementEnabled;

com.unity.netcode.gameobjects/Tests/Runtime/Connection/ClientConnectionTests.cs

@@ -18,6 +18,12 @@ internal class DeferredDespawningTests : IntegrationTestWithApproximation
         private List<GameObject> m_DaisyChainedDespawnObjects = new List<GameObject>();
         private List<ulong> m_HasReachedEnd = new List<ulong>();
 
+        // TODO: [CmbServiceTests] Adapt to run with the service
+        protected override bool UseCMBService()
+        {
+            return false;
+        }
+
         public enum SetDestroyGameObject
         {
             DestroyGameObject,

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

@@ -26,6 +26,7 @@ internal class DistributeObjectsTests : IntegrationTestWithApproximation
         private const int k_LateJoinClientCount = 4;
         protected override int NumberOfClients => 0;
 
+
         public DistributeObjectsTests() : base(HostOrServer.DAHost)
         {
         }
@@ -38,9 +39,13 @@ protected override IEnumerator OnSetup()
 
         protected override void OnServerAndClientsCreated()
         {
-            var serverTransport = m_ServerNetworkManager.NetworkConfig.NetworkTransport as UnityTransport;
-            // I hate having to add time to our tests, but in case a VM is running slow the disconnect timeout needs to be reasonably high
-            serverTransport.DisconnectTimeoutMS = 1000;
+            if (!m_UseCmbService)
+            {
+                var serverTransport = m_ServerNetworkManager.NetworkConfig.NetworkTransport as UnityTransport;
+                // I hate having to add time to our tests, but in case a VM is running slow the disconnect timeout needs to be reasonably high
+                serverTransport.DisconnectTimeoutMS = 1000;
+            }
+
             m_DistributeObject = CreateNetworkObjectPrefab("DisObject");
             m_DistributeObject.AddComponent<DistributeObjectsTestHelper>();
             m_DistributeObject.AddComponent<DistributeTestTransform>();
@@ -52,13 +57,6 @@ protected override void OnServerAndClientsCreated()
             base.OnServerAndClientsCreated();
         }
 
-        protected override IEnumerator OnServerAndClientsConnected()
-        {
-            m_ServerNetworkManager.SpawnManager.EnableDistributeLogging = m_EnableVerboseDebug;
-            m_ServerNetworkManager.ConnectionManager.EnableDistributeLogging = m_EnableVerboseDebug;
-            return base.OnServerAndClientsConnected();
-        }
-
         private NetworkObject m_ObjectToValidate;
 
         private bool ValidateObjectSpawnedOnAllClients()
@@ -67,17 +65,11 @@ private bool ValidateObjectSpawnedOnAllClients()
 
             var networkObjectId = m_ObjectToValidate.NetworkObjectId;
             var name = m_ObjectToValidate.name;
-            if (!UseCMBService() && !m_ServerNetworkManager.SpawnManager.SpawnedObjects.ContainsKey(networkObjectId))
+            foreach (var manager in m_NetworkManagers)
             {
-                m_ErrorLog.Append($"Client-{m_ServerNetworkManager.LocalClientId} has not spawned {name}!");
-                return false;
-            }
-
-            foreach (var client in m_ClientNetworkManagers)
-            {
-                if (!client.SpawnManager.SpawnedObjects.ContainsKey(networkObjectId))
+                if (!manager.SpawnManager.SpawnedObjects.ContainsKey(networkObjectId))
                 {
-                    m_ErrorLog.Append($"Client-{client.LocalClientId} has not spawned {name}!");
+                    m_ErrorLog.Append($"Client-{manager.LocalClientId} has not spawned {name}!");
                     return false;
                 }
             }
@@ -89,7 +81,7 @@ private bool ValidateObjectSpawnedOnAllClients()
         private bool ValidateDistributedObjectsSpawned(bool lateJoining)
         {
             m_ErrorLog.Clear();
-            var hostId = m_ServerNetworkManager.LocalClientId;
+            var hostId = GetAuthorityNetworkManager().LocalClientId;
             if (!DistributeObjectsTestHelper.DistributedObjects.ContainsKey(hostId))
             {
                 m_ErrorLog.AppendLine($"[Client-{hostId}] Does not have an entry in the root of the {nameof(DistributeObjectsTestHelper.DistributedObjects)} table!");
@@ -106,11 +98,11 @@ private bool ValidateDistributedObjectsSpawned(bool lateJoining)
             var expected = 0;
             if (lateJoining)
             {
-                expected = k_ObjectCount / (m_ClientNetworkManagers.Count() + 1);
+                expected = k_ObjectCount / m_NetworkManagers.Length;
             }
             else
             {
-                expected = k_ObjectCount / (m_ClientNetworkManagers.Where((c) => c.IsConnectedClient).Count() + 1);
+                expected = k_ObjectCount / m_NetworkManagers.Count(c => c.IsConnectedClient);
             }
 
             // It should theoretically be the expected or...
@@ -140,8 +132,8 @@ private bool ValidateDistributedObjectsSpawned(bool lateJoining)
         private bool ValidateOwnershipTablesMatch()
         {
             m_ErrorLog.Clear();
-            var hostId = m_ServerNetworkManager.LocalClientId;
-            var expectedEntries = m_ClientNetworkManagers.Where((c) => c.IsListening && c.IsConnectedClient).Count() + 1;
+            var hostId = GetAuthorityNetworkManager().LocalClientId;
+            var expectedEntries = m_NetworkManagers.Count(c => c.IsListening && c.IsConnectedClient);
             // Make sure all clients have an table created
             if (DistributeObjectsTestHelper.DistributedObjects.Count < expectedEntries)
             {
@@ -160,7 +152,7 @@ private bool ValidateOwnershipTablesMatch()
                 m_ErrorLog.AppendLine($"[Client-{hostId}] Does not have a local an entry in the {nameof(DistributeObjectsTestHelper.DistributedObjects)} table!");
                 return false;
             }
-            var clients = m_ServerNetworkManager.ConnectedClientsIds.ToList();
+            var clients = GetAuthorityNetworkManager().ConnectedClientsIds.ToList();
             clients.Remove(0);
 
             // Cycle through each client's entry on the DAHost to run a comparison
@@ -206,9 +198,9 @@ private bool ValidateOwnershipTablesMatch()
         private bool ValidateTransformsMatch()
         {
             m_ErrorLog.Clear();
-            var hostId = m_ServerNetworkManager.LocalClientId;
+            var hostId = GetAuthorityNetworkManager().LocalClientId;
             var daHostEntries = DistributeObjectsTestHelper.DistributedObjects[hostId];
-            var clients = m_ServerNetworkManager.ConnectedClientsIds.ToList();
+            var clients = GetAuthorityNetworkManager().ConnectedClientsIds.ToList();
             foreach (var clientOwner in daHostEntries.Keys)
             {
                 // Cycle through the owner's objects
@@ -238,16 +230,9 @@ private bool ValidateTransformsMatch()
         private bool SpawnCountsMatch()
         {
             var passed = true;
-            var spawnCount = 0;
             m_ErrorLog.Clear();
-            if (!UseCMBService())
-            {
-                spawnCount = m_ServerNetworkManager.SpawnManager.SpawnedObjects.Count;
-            }
-            else
-            {
-                spawnCount = m_ClientNetworkManagers[0].SpawnManager.SpawnedObjects.Count;
-            }
+
+            var spawnCount = GetAuthorityNetworkManager().SpawnManager.SpawnedObjects.Count;
             foreach (var client in m_ClientNetworkManagers)
             {
                 var clientCount = client.SpawnManager.SpawnedObjects.Count;
@@ -272,7 +257,7 @@ public IEnumerator DistributeNetworkObjects()
         {
             for (int i = 0; i < k_ObjectCount; i++)
             {
-                SpawnObject(m_DistributeObject, m_ServerNetworkManager);
+                SpawnObject(m_DistributeObject, GetAuthorityNetworkManager());
             }
 
             // Validate NetworkObjects get redistributed properly when a client joins
@@ -321,8 +306,10 @@ public IEnumerator DistributeNetworkObjects()
                 yield return WaitForConditionOrTimeOut(ValidateTransformsMatch);
                 AssertOnTimeout($"[Client-{j + 1}][Transform Mismatch] {m_ErrorLog}");
 
-                // DANGO-TODO: Make this tied to verbose mode once we know the CMB Service integration works properly
-                DisplayOwnership();
+                if (m_EnableVerboseDebug)
+                {
+                    DisplayOwnership();
+                }
 
                 yield return WaitForConditionOrTimeOut(SpawnCountsMatch);
                 AssertOnTimeout($"[Spawn Count Mismatch] {m_ErrorLog}");
@@ -332,8 +319,9 @@ public IEnumerator DistributeNetworkObjects()
         private void DisplayOwnership()
         {
             m_ErrorLog.Clear();
-            var daHostEntries = DistributeObjectsTestHelper.DistributedObjects[0];
 
+            var authorityId = GetAuthorityNetworkManager().LocalClientId;
+            var daHostEntries = DistributeObjectsTestHelper.DistributedObjects[authorityId];
             foreach (var entry in daHostEntries)
             {
                 m_ErrorLog.AppendLine($"[Client-{entry.Key}][Owned Objects: {entry.Value.Count}]");

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

@@ -18,19 +18,20 @@ public class ExtendedNetworkShowAndHideTests : NetcodeIntegrationTest
         private NetworkManager m_LateJoinClient;
         private NetworkManager m_SpawnOwner;
 
+        // TODO: [CmbServiceTests] Adapt to run with the service (can't control who becomes the session owner, needs a logic rework)
+        protected override bool UseCMBService()
+        {
+            return false;
+        }
+
         public ExtendedNetworkShowAndHideTests(HostOrServer hostOrServer, bool enableSceneManagement) : base(hostOrServer)
         {
             m_EnableSceneManagement = enableSceneManagement;
         }
 
         protected override void OnServerAndClientsCreated()
         {
-            if (!UseCMBService())
-            {
-                m_ServerNetworkManager.NetworkConfig.EnableSceneManagement = m_EnableSceneManagement;
-            }
-
-            foreach (var client in m_ClientNetworkManagers)
+            foreach (var client in m_NetworkManagers)
             {
                 client.NetworkConfig.EnableSceneManagement = m_EnableSceneManagement;
             }
@@ -43,19 +44,7 @@ protected override void OnServerAndClientsCreated()
 
         private bool AllClientsSpawnedObject()
         {
-            if (!UseCMBService())
-            {
-                if (!s_GlobalNetworkObjects.ContainsKey(m_ServerNetworkManager.LocalClientId))
-                {
-                    return false;
-                }
-                if (!s_GlobalNetworkObjects[m_ServerNetworkManager.LocalClientId].ContainsKey(m_SpawnedObject.NetworkObjectId))
-                {
-                    return false;
-                }
-            }
-
-            foreach (var client in m_ClientNetworkManagers)
+            foreach (var client in m_NetworkManagers)
             {
                 if (!s_GlobalNetworkObjects.ContainsKey(client.LocalClientId))
                 {
@@ -71,15 +60,7 @@ private bool AllClientsSpawnedObject()
 
         private bool IsClientPromotedToSessionOwner()
         {
-            if (!UseCMBService())
-            {
-                if (m_ServerNetworkManager.CurrentSessionOwner != m_ClientToHideFrom.LocalClientId)
-                {
-                    return false;
-                }
-            }
-
-            foreach (var client in m_ClientNetworkManagers)
+            foreach (var client in m_NetworkManagers)
             {
                 if (!client.IsConnectedClient)
                 {
@@ -112,9 +93,9 @@ protected override void OnNewClientCreated(NetworkManager networkManager)
         public IEnumerator HiddenObjectPromotedSessionOwnerNewClientSynchronizes()
         {
             // Get the test relative session owner
-            var sessionOwner = UseCMBService() ? m_ClientNetworkManagers[0] : m_ServerNetworkManager;
-            m_SpawnOwner = UseCMBService() ? m_ClientNetworkManagers[1] : m_ClientNetworkManagers[0];
-            m_ClientToHideFrom = UseCMBService() ? m_ClientNetworkManagers[NumberOfClients - 1] : m_ClientNetworkManagers[1];
+            var sessionOwner = GetAuthorityNetworkManager();
+            m_SpawnOwner = m_UseCmbService ? m_ClientNetworkManagers[1] : m_ClientNetworkManagers[0];
+            m_ClientToHideFrom = m_UseCmbService ? m_ClientNetworkManagers[NumberOfClients - 1] : m_ClientNetworkManagers[1];
             m_ObjectToSpawn.SetActive(true);
 
             // Spawn the object with a non-session owner client
@@ -129,7 +110,7 @@ public IEnumerator HiddenObjectPromotedSessionOwnerNewClientSynchronizes()
             AssertOnTimeout($"{m_SpawnedObject.name} was not hidden from Client-{m_ClientToHideFrom.LocalClientId}!");
 
             // Promoted a new session owner (DAHost promotes while CMB Session we disconnect the current session owner)
-            if (!UseCMBService())
+            if (!m_UseCmbService)
             {
                 m_ServerNetworkManager.PromoteSessionOwner(m_ClientToHideFrom.LocalClientId);
             }