chore: Add a DA service unit test

Author: EmandM

.yamato/desktop-standalone-tests.yml

@@ -4,7 +4,7 @@
 # DESCRIPTION--------------------------------------------------------------------------
   # This job is responsible for Desktop platform test validation.
   # Those tests cover both PlayMode and EditMode tests from package test assemblies.
-  
+
 # CONFIGURATION STRUCTURE--------------------------------------------------------------
   # Jobs are generated using nested loops (separate build phase and run phase). Worth noting that run phase uses the build as dependency:
     # 1. For all desktop platform (Windows, macOS, Ubuntu)
@@ -17,17 +17,17 @@
     # 1. Build Phase: Creates standalone players for desktop platforms
     # 2. Run Phase: Executes runtime tests on actual desktop devices
   # The Run phase uses build job as dependency
-  
+
   # Note: More of a Unity specific but test assemblies need to be included in the build phase command
   # Note: All builds can be made on x64 machines since those are compatible with ARM64 target devices
 
 # QUALITY THOUGHTS--------------------------------------------------------------------
   # TODO: consider adding all projects that have tests
   # To see where this job is included (in trigger job definitions) look into _triggers.yml file
-  
+
 #-----------------------------------------------------------------------------------
-  
-  
+
+
 # BUILD PHASE CONFIGURATION------------------------------------------------------------------------------------
 {% for project in projects.default -%}
 {% for platform in test_platforms.desktop -%}
@@ -58,10 +58,10 @@ desktop_standalone_build_{{ project.name }}_{{ platform.name }}_{{ backend }}_{{
 {% endfor -%}
 {% endfor -%}
 {% endfor -%}
-  
-  
-  
-  
+
+
+
+
 # RUN PHASE CONFIGURATION------------------------------------------------------------------------------------
 {% for project in projects.default -%}
 {% for platform in test_platforms.desktop -%}
@@ -81,21 +81,16 @@ desktop_standalone_test_{{ project.name }}_{{ platform.name }}_{{ backend }}_{{
 {% if platform.name != "win" %} # Issues with win and mac are tracked in MTT-11606
   variables:
     ECHO_SERVER_PORT: "7788"
+    COMB_SERVER_PORT: "7789"
     # Set this to ensure the DA codec tests will fail if they cannot connect to the echo-server
     # The default is to ignore the codec tests if the echo-server fails to connect
     ENSURE_CODEC_TESTS: "true"
 {% endif %}
 
   commands:
-# If ubuntu, run rust echo server (This is needed ONLY for NGOv2.X because relates to Distributed Authority)
+# If not windows, run rust echo server (This is needed ONLY for NGOv2.X because relates to Distributed Authority)
 {% if platform.name != "win" %} # Issues with win and mac are tracked in MTT-11606
-    - git clone https://github.com/Unity-Technologies/mps-common-multiplayer-backend.git
-    # Install rust
-    - curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
-    # Build the echo server
-    - cd ./mps-common-multiplayer-backend/runtime && $HOME/.cargo/bin/cargo build --example ngo_echo_server
-    # Run the echo server in the background - this will reuse the artifacts from the build
-    - cd ./mps-common-multiplayer-backend/runtime && $HOME/.cargo/bin/cargo run --example ngo_echo_server -- --port $ECHO_SERVER_PORT &
+    - ./Tools/CI/rust.sh
 {% endif %}
 
     - unity-downloader-cli --fast --wait -u {{ editor }} -c Editor {% if backend == "il2cpp" %} -c il2cpp {% endif %} {% if platform.name == "mac" %} --arch arm64 {% endif %} # For macOS we use ARM64 models

Tools/CI/rust.sh

@@ -0,0 +1,27 @@
+# clone the latest rust repo
+git clone https://github.com/Unity-Technologies/mps-common-multiplayer-backend.git
+cd ./mps-common-multiplayer-backend/runtime
+
+# Install rust
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+export PATH="$HOME/.cargo/bin:$PATH"
+
+# Build the echo server
+cargo build --example ngo_echo_server
+
+# Run the echo server in the background - this will reuse the artifacts from the build
+cargo run --example ngo_echo_server -- --port $ECHO_SERVER_PORT &
+
+# Build the standalone server
+cargo build
+
+# Run the standalone server loop in the background
+runstandalone &
+
+# Use a function to run the standalone server in a loop, when it exits, it will always restart
+runstandalone() {
+  while :; do
+    # loop infinitely
+    cargo run -- --metrics-port 5000 standalone --port $COMB_SERVER_PORT -t 10m
+  done
+}

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

@@ -522,7 +522,8 @@ protected virtual bool ShouldWaitForNewClientToConnect(NetworkManager networkMan
         /// <returns>An IEnumerator to be used in a coroutine for asynchronous execution.</returns>
         protected IEnumerator CreateAndStartNewClient()
         {
-            var networkManager = NetcodeIntegrationTestHelpers.CreateNewClient(m_ClientNetworkManagers.Length, m_EnableTimeTravel);
+            bool useCmbService = UseCMBService() && m_DistributedAuthority;
+            var networkManager = NetcodeIntegrationTestHelpers.CreateNewClient(m_ClientNetworkManagers.Length, m_EnableTimeTravel, useCmbService);
             networkManager.NetworkConfig.PlayerPrefab = m_PlayerPrefab;
             SetDistributedAuthorityProperties(networkManager);
 
@@ -576,14 +577,15 @@ private bool AllPlayerObjectClonesSpawned(NetworkManager joinedClient)
 
             // Continue to populate the PlayerObjects list until all player object (local and clone) are found
             ClientNetworkManagerPostStart(joinedClient);
-            var playerObjectRelative = m_ServerNetworkManager.SpawnManager.PlayerObjects.Where((c) => c.OwnerClientId == joinedClient.LocalClientId).FirstOrDefault();
-            if (playerObjectRelative == null)
-            {
-                m_InternalErrorLog.Append($"[AllPlayerObjectClonesSpawned][Server-Side] Joining Client-{joinedClient.LocalClientId} was not populated in the {nameof(NetworkSpawnManager.PlayerObjects)} list!");
-                return false;
-            }
-            else
+            if (!(UseCMBService() && m_DistributedAuthority))
             {
+                var playerObjectRelative = m_ServerNetworkManager.SpawnManager.PlayerObjects.Where((c) => c.OwnerClientId == joinedClient.LocalClientId).FirstOrDefault();
+                if (playerObjectRelative == null)
+                {
+                    m_InternalErrorLog.Append($"[AllPlayerObjectClonesSpawned][Server-Side] Joining Client-{joinedClient.LocalClientId} was not populated in the {nameof(NetworkSpawnManager.PlayerObjects)} list!");
+                    return false;
+                }
+
                 // Go ahead and create an entry for this new client
                 if (!m_PlayerNetworkObjects[m_ServerNetworkManager.LocalClientId].ContainsKey(joinedClient.LocalClientId))
                 {
@@ -598,19 +600,17 @@ private bool AllPlayerObjectClonesSpawned(NetworkManager joinedClient)
                     continue;
                 }
 
-                playerObjectRelative = clientNetworkManager.SpawnManager.PlayerObjects.Where((c) => c.OwnerClientId == joinedClient.LocalClientId).FirstOrDefault();
+                var playerObjectRelative = clientNetworkManager.SpawnManager.PlayerObjects.Where((c) => c.OwnerClientId == joinedClient.LocalClientId).FirstOrDefault();
                 if (playerObjectRelative == null)
                 {
                     m_InternalErrorLog.Append($"[AllPlayerObjectClonesSpawned][Client-{clientNetworkManager.LocalClientId}] Client-{joinedClient.LocalClientId} was not populated in the {nameof(NetworkSpawnManager.PlayerObjects)} list!");
                     return false;
                 }
-                else
+
+                // Go ahead and create an entry for this new client
+                if (!m_PlayerNetworkObjects[clientNetworkManager.LocalClientId].ContainsKey(joinedClient.LocalClientId))
                 {
-                    // Go ahead and create an entry for this new client
-                    if (!m_PlayerNetworkObjects[clientNetworkManager.LocalClientId].ContainsKey(joinedClient.LocalClientId))
-                    {
-                        m_PlayerNetworkObjects[clientNetworkManager.LocalClientId].Add(joinedClient.LocalClientId, playerObjectRelative);
-                    }
+                    m_PlayerNetworkObjects[clientNetworkManager.LocalClientId].Add(joinedClient.LocalClientId, playerObjectRelative);
                 }
             }
             return true;
@@ -722,7 +722,8 @@ protected void CreateServerAndClients(int numberOfClients)
             }
 
             // Create multiple NetworkManager instances
-            if (!NetcodeIntegrationTestHelpers.Create(numberOfClients, out NetworkManager server, out NetworkManager[] clients, m_TargetFrameRate, m_CreateServerFirst, m_EnableTimeTravel))
+            var useCmbService = UseCMBService() && m_DistributedAuthority;
+            if (!NetcodeIntegrationTestHelpers.Create(numberOfClients, out NetworkManager server, out NetworkManager[] clients, m_TargetFrameRate, m_CreateServerFirst, m_EnableTimeTravel, useCmbService))
             {
                 Debug.LogError("Failed to create instances");
                 Assert.Fail("Failed to create instances");
@@ -939,8 +940,9 @@ protected IEnumerator StartServerAndClients()
                     if (m_UseHost || m_ServerNetworkManager.IsHost)
                     {
 #if UNITY_2023_1_OR_NEWER
+                        var manager = startServer ? m_ServerNetworkManager : m_ClientNetworkManagers[0];
                         // Add the server player instance to all m_ClientSidePlayerNetworkObjects entries
-                        var serverPlayerClones = Object.FindObjectsByType<NetworkObject>(FindObjectsSortMode.None).Where((c) => c.IsPlayerObject && c.OwnerClientId == m_ServerNetworkManager.LocalClientId);
+                        var serverPlayerClones = Object.FindObjectsByType<NetworkObject>(FindObjectsSortMode.None).Where((c) => c.IsPlayerObject && c.OwnerClientId == manager.LocalClientId);
 #else
                         // Add the server player instance to all m_ClientSidePlayerNetworkObjects entries
                         var serverPlayerClones = Object.FindObjectsOfType<NetworkObject>().Where((c) => c.IsPlayerObject && c.OwnerClientId == m_ServerNetworkManager.LocalClientId);
@@ -952,7 +954,10 @@ protected IEnumerator StartServerAndClients()
                                 m_PlayerNetworkObjects.Add(playerNetworkObject.NetworkManager.LocalClientId, new Dictionary<ulong, NetworkObject>());
                             }
 
-                            m_PlayerNetworkObjects[playerNetworkObject.NetworkManager.LocalClientId].Add(m_ServerNetworkManager.LocalClientId, playerNetworkObject);
+                            if (startServer)
+                            {
+                                m_PlayerNetworkObjects[playerNetworkObject.NetworkManager.LocalClientId].Add(m_ServerNetworkManager.LocalClientId, playerNetworkObject);
+                            }
                         }
                     }
                     if (m_DistributedAuthority)
@@ -967,7 +972,7 @@ protected IEnumerator StartServerAndClients()
                                 AssertOnTimeout($"{nameof(CreateAndStartNewClient)} timed out waiting for all sessions to spawn Client-{networkManager.LocalClientId}'s player object!\n {m_InternalErrorLog}");
                             }
                         }
-                        if (m_ServerNetworkManager != null)
+                        if (m_ServerNetworkManager != null && startServer)
                         {
                             yield return WaitForConditionOrTimeOut(() => AllPlayerObjectClonesSpawned(m_ServerNetworkManager));
                             AssertOnTimeout($"{nameof(CreateAndStartNewClient)} timed out waiting for all sessions to spawn Client-{m_ServerNetworkManager.LocalClientId}'s player object!\n {m_InternalErrorLog}");
@@ -1534,8 +1539,10 @@ private bool CheckClientsConnected(NetworkManager[] clientsToCheck)
                     m_InternalErrorLog.AppendLine($"[Client-{i + 1}] Client is not connected!");
                 }
             }
-            var expectedCount = m_ServerNetworkManager.IsHost ? clientsToCheck.Length + 1 : clientsToCheck.Length;
-            var currentCount = m_ServerNetworkManager.ConnectedClients.Count;
+
+            var manager = UseCMBService() ? m_ClientNetworkManagers[0] : m_ServerNetworkManager;
+            var expectedCount = manager.IsHost ? clientsToCheck.Length + 1 : clientsToCheck.Length;
+            var currentCount = manager.ConnectedClients.Count;
 
             if (currentCount != expectedCount)
             {

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

@@ -170,7 +170,20 @@ public static void RegisterHandlers(NetworkManager networkManager, bool serverSi
             }
         }
 
-        private static void AddUnityTransport(NetworkManager networkManager)
+        private static readonly string k_TransportHost = Environment.GetEnvironmentVariable("NGO_HOST") ?? "127.0.0.1";
+        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>
+        private static ushort GetPortToBind()
+        {
+            var value = Environment.GetEnvironmentVariable("CMB_SERVICE_PORT");
+            return ushort.TryParse(value, out var configuredPort) ? configuredPort : (ushort)7789;
+        }
+
+        private static void AddUnityTransport(NetworkManager networkManager, bool useCmbService = false)
         {
             // Create transport
             var unityTransport = networkManager.gameObject.AddComponent<UnityTransport>();
@@ -181,6 +194,12 @@ private static void AddUnityTransport(NetworkManager networkManager)
             // Allow 4 connection attempts that each will time out after 500ms
             unityTransport.MaxConnectAttempts = 4;
             unityTransport.ConnectTimeoutMS = 500;
+            if (useCmbService)
+            {
+                unityTransport.ConnectionData.Address = Dns.GetHostAddresses(k_TransportHost).First().ToString();
+                unityTransport.ConnectionData.Port = k_TransportPort;
+                Debug.Log($"Using CmbService: {k_TransportHost}:{k_TransportPort}");
+            }
 
             // Set the NetworkConfig
             networkManager.NetworkConfig ??= new NetworkConfig();
@@ -196,7 +215,7 @@ private static void AddMockTransport(NetworkManager networkManager)
             networkManager.NetworkConfig.NetworkTransport = mockTransport;
         }
 
-        public static NetworkManager CreateServer(bool mockTransport = false)
+        public static NetworkManager CreateServer(bool mockTransport = false, bool useCmbService = false)
         {
             // Create gameObject
             var go = new GameObject("NetworkManager - Server");
@@ -210,7 +229,7 @@ public static NetworkManager CreateServer(bool mockTransport = false)
             }
             else
             {
-                AddUnityTransport(server);
+                AddUnityTransport(server, useCmbService);
             }
             return server;
         }
@@ -223,20 +242,21 @@ public static NetworkManager CreateServer(bool mockTransport = false)
         /// <param name="clients">The clients NetworkManagers</param>
         /// <param name="targetFrameRate">The targetFrameRate of the Unity engine to use while the multi instance helper is running. Will be reset on shutdown.</param>
         /// <param name="serverFirst">This determines if the server or clients will be instantiated first (defaults to server first)</param>
-        public static bool Create(int clientCount, out NetworkManager server, out NetworkManager[] clients, int targetFrameRate = 60, bool serverFirst = true, bool useMockTransport = false)
+        /// <param name="useCmbService">If true, the server transport will use a mock transport, and the clients will be created with a connection to a locally hosted da service</param>
+        public static bool Create(int clientCount, out NetworkManager server, out NetworkManager[] clients, int targetFrameRate = 60, bool serverFirst = true, bool useMockTransport = false, bool useCmbService = false)
         {
             s_NetworkManagerInstances = new List<NetworkManager>();
             server = null;
             if (serverFirst)
             {
-                server = CreateServer(useMockTransport);
+                server = CreateServer(useMockTransport || useCmbService);
             }
 
-            CreateNewClients(clientCount, out clients, useMockTransport);
+            CreateNewClients(clientCount, out clients, useMockTransport, useCmbService);
 
             if (!serverFirst)
             {
-                server = CreateServer(useMockTransport);
+                server = CreateServer(useMockTransport || useCmbService);
             }
 
             s_OriginalTargetFrameRate = Application.targetFrameRate;
@@ -245,7 +265,7 @@ public static bool Create(int clientCount, out NetworkManager server, out Networ
             return true;
         }
 
-        internal static NetworkManager CreateNewClient(int identifier, bool mockTransport = false)
+        internal static NetworkManager CreateNewClient(int identifier, bool mockTransport = false, bool useCmbService = false)
         {
             // Create gameObject
             var go = new GameObject("NetworkManager - Client - " + identifier);
@@ -257,7 +277,7 @@ internal static NetworkManager CreateNewClient(int identifier, bool mockTranspor
             }
             else
             {
-                AddUnityTransport(networkManager);
+                AddUnityTransport(networkManager, useCmbService);
             }
             return networkManager;
         }
@@ -269,13 +289,14 @@ internal static NetworkManager CreateNewClient(int identifier, bool mockTranspor
         /// <param name="clientCount">The amount of clients</param>
         /// <param name="clients">Output array containing the created NetworkManager instances</param>
         /// <param name="useMockTransport">When true, uses mock transport for testing, otherwise uses real transport. Default value is false</param>
-        public static bool CreateNewClients(int clientCount, out NetworkManager[] clients, bool useMockTransport = false)
+        /// <param name="useCmbService">If true, each client will be created with transport configured to connect to a locally hosted da service</param>
+        public static bool CreateNewClients(int clientCount, out NetworkManager[] clients, bool useMockTransport = false, bool useCmbService = false)
         {
             clients = new NetworkManager[clientCount];
             for (int i = 0; i < clientCount; i++)
             {
                 // Create networkManager component
-                clients[i] = CreateNewClient(i, useMockTransport);
+                clients[i] = CreateNewClient(i, useMockTransport, useCmbService);
             }
 
             NetworkManagerInstances.AddRange(clients);
@@ -486,15 +507,15 @@ public static bool Start(bool host, NetworkManager server, NetworkManager[] clie
                 callback?.Invoke();
             }
 
-            for (int i = 0; i < clients.Length; i++)
+            foreach (var client in clients)
             {
-                clients[i].StartClient();
+                client.StartClient();
                 hooks = new MultiInstanceHooks();
-                clients[i].ConnectionManager.MessageManager.Hook(hooks);
-                s_Hooks[clients[i]] = hooks;
+                client.ConnectionManager.MessageManager.Hook(hooks);
+                s_Hooks[client] = hooks;
 
                 // if set, then invoke this for the client
-                RegisterHandlers(clients[i]);
+                RegisterHandlers(client);
             }
 
             return true;