Add ENSURE_CODEC_TESTS environment variable

Author: EmandM

.yamato/desktop-standalone-tests.yml

@@ -77,7 +77,12 @@ desktop_standalone_test_{{ project.name }}_{{ platform.name }}_{{ backend }}_{{
     image: {{ platform.image }}
     flavor: {{ platform.flavor }}
   variables:
+{% if platform.name != "win" %}
     ECHO_SERVER_PORT: "7788"
+    # 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:
 # Platform specific UTR setup
     - |
@@ -91,9 +96,8 @@ desktop_standalone_test_{{ project.name }}_{{ platform.name }}_{{ backend }}_{{
     - unity-downloader-cli -u {{ editor }} -c Editor {% if backend == "il2cpp" %} -c il2cpp {% endif %} --fast --wait
 
 # If ubuntu, run rust echo server
-{% if platform.name == "ubuntu" %}
-    - |
-      git clone https://github.com/Unity-Technologies/mps-common-multiplayer-backend.git
+{% if platform.name != "win" %}
+    - 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

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

@@ -16,6 +16,20 @@
 
 namespace Unity.Netcode.RuntimeTests
 {
+    /// <summary>
+    /// This class tests the NGO message codec between the C# SDK and the Rust runtime.
+    /// </summary>
+    /// <remarks>
+    /// These tests are run against a rust echo-server.
+    /// This server decodes incoming messages, and then re-encodes them before sending them back to the client.
+    /// Any errors in decoding or encoding messages will not echo the messages back, causing the tests to fail
+    /// No message handling logic is tested in these tests. They are only testing the codec.
+    /// The tests check if they can bind to a rust echo-server at the given address and port, if all tests are ignored.
+    /// The rust echo-server is run using `cargo run --example ngo_echo_server -- --port {port}`
+    /// The C# port can be configured using the environment variable "ECHO_SERVER_PORT"
+    /// The default behaviour when unity fails to connect to the echo-server is to ignore all tests in this class.
+    /// This can be overridden by setting the environment variable "ENSURE_CODEC_TESTS" to any value - then the tests will fail.
+    /// </remarks>
     internal class DistributedAuthorityCodecTests : NetcodeIntegrationTest
     {
         protected override int NumberOfClients => 1;
@@ -30,21 +44,25 @@ internal class DistributedAuthorityCodecTests : NetcodeIntegrationTest
         private NetworkManager Client => m_ClientNetworkManagers[0];
 
         private string m_TransportHost = Environment.GetEnvironmentVariable("NGO_HOST") ?? "127.0.0.1";
-        private static readonly ushort k_TransportPort = GetPortToBind(7777);
+        private static readonly ushort k_TransportPort = GetPortToBind();
         private const int k_ClientId = 0;
 
-        private static ushort GetPortToBind(ushort defaultPort)
+        /// <summary>
+        /// Configures the port to look for the rust echo-server.
+        /// </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("ECHO_SERVER_PORT");
-            return ushort.TryParse(value, out var configuredPort) ? configuredPort : defaultPort;
+            return ushort.TryParse(value, out var configuredPort) ? configuredPort : (ushort)7777;
         }
 
         private GameObject m_SpawnObject;
 
         internal class TestNetworkComponent : NetworkBehaviour
         {
             public NetworkList<int> MyNetworkList = new NetworkList<int>(new List<int> { 1, 2, 3 });
-            public NetworkVariable<int> MyNetworkVar = new NetworkVariable<int>(3);
+            public NetworkVariable<int> myNetworkVar = new NetworkVariable<int>(3);
 
             [Rpc(SendTo.Authority)]
             public void TestAuthorityRpc(byte[] _)
@@ -60,7 +78,15 @@ protected override void OnOneTimeSetup()
 #else
             if (!CanConnectToServer(m_TransportHost, k_TransportPort))
             {
-                Assert.Ignore($"ignoring DA codec tests because UTP transport cannot connect to the rust echo-server at ${m_TransportHost}:{k_TransportPort}");
+                var shouldFail = Environment.GetEnvironmentVariable("ENSURE_CODEC_TESTS");
+                if (!string.IsNullOrEmpty(shouldFail))
+                {
+                    Assert.Fail($"Failed to connect to the rust echo-server at {m_TransportHost}:{k_TransportPort}");
+                }
+                else
+                {
+                    Assert.Ignore($"ignoring DA codec tests because UTP transport cannot connect to the rust echo-server at {m_TransportHost}:{k_TransportPort}");
+                }
             }
 #endif
             base.OnOneTimeSetup();
@@ -234,9 +260,9 @@ public IEnumerator NetworkVariableDelta_WithValueUpdate()
             var component = instance.GetComponent<TestNetworkComponent>();
 
             var newValue = 5;
-            component.MyNetworkVar.Value = newValue;
+            component.myNetworkVar.Value = newValue;
             yield return m_ClientCodecHook.WaitForMessageReceived<NetworkVariableDeltaMessage>();
-            Assert.AreEqual(newValue, component.MyNetworkVar.Value);
+            Assert.AreEqual(newValue, component.myNetworkVar.Value);
         }
 
         [UnityTest]