test update

Added some additional script to ignore anything that is not converted to run against the CMB server or any test that is configured to use a client-server network topology.
Added OneTimeSetup to all non-NetcodeIntegrationTest derived tests that will also ignore the test until it is reviewed and determined it should be converted over or we do not need to run the test again since it will have already run multiple times on multiple platforms.

Author: NoelStephensUnity

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

@@ -96,13 +96,27 @@ public static void DeregisterNetworkObject(ulong localClientId, ulong networkObj
             }
         }
 
+        private int GetTotalClients()
+        {
+            if (m_DistributedAuthority)
+            {
+                // If not connecting to a CMB service then we are using a DAHost and we add 1 to this count.
+                return !UseCMBService() && m_UseHost ? m_NumberOfClients + 1 : m_NumberOfClients;
+            }
+            else
+            {
+                // If using a host then we add one to this count.
+                return m_UseHost ? m_NumberOfClients + 1 : m_NumberOfClients;
+            }
+        }
+
         /// <summary>
         /// Total number of clients that should be connected at any point during a test.
         /// </summary>
         /// <remarks>
         /// When using the CMB Service, we ignore if <see cref="m_UseHost"/> is true.
         /// </remarks>
-        protected int TotalClients => m_UseHost && !UseCMBService() ? m_NumberOfClients + 1 : m_NumberOfClients;
+        protected int TotalClients => GetTotalClients();
 
         protected const uint k_DefaultTickRate = 30;
 
@@ -212,7 +226,7 @@ protected NetworkManager GetNonAuthorityNetworkManager()
         protected Dictionary<ulong, Dictionary<ulong, NetworkObject>> m_PlayerNetworkObjects = new Dictionary<ulong, Dictionary<ulong, NetworkObject>>();
 
         protected bool m_UseHost = true;
-        protected bool m_DistributedAuthority;
+        protected bool m_DistributedAuthority => m_NetworkTopologyType == NetworkTopologyTypes.DistributedAuthority;
         protected NetworkTopologyTypes m_NetworkTopologyType = NetworkTopologyTypes.ClientServer;
 
         /// <summary>
@@ -233,14 +247,14 @@ protected NetworkManager GetNonAuthorityNetworkManager()
         /// check the environment variable once per test set.
         /// </remarks>
         /// <returns>true/false</returns>
-        private bool UseCMBServiceEnviromentVariableSet()
+        private bool GetServiceEnviromentVariable()
         {
             if (!m_UseCmbServiceEnv && m_UseCmbServiceEnvString == null)
             {
                 var useCmbService = Environment.GetEnvironmentVariable("USE_CMB_SERVICE") ?? "false";
                 if (bool.TryParse(useCmbService.ToLower(), out bool isTrue))
                 {
-                    m_UseCmbService = isTrue;
+                    m_UseCmbServiceEnv = isTrue;
                 }
                 else
                 {
@@ -261,7 +275,7 @@ protected virtual bool UseCMBService()
 #if USE_CMB_SERVICE
             return true;
 #else
-            return UseCMBServiceEnviromentVariableSet();
+            return m_UseCmbService;
 #endif
         }
 
@@ -408,6 +422,24 @@ protected virtual void OnOneTimeSetup()
 
         [OneTimeSetUp]
         public void OneTimeSetup()
+        {
+            // Only For CMB Server Tests:
+            // If the environment variable is set (i.e. doing a CMB server run) but UseCMBservice returns false, then ignore the test.
+            // Note: This will prevent us from re-running all of the non-DA integration tests that have already run multiple times on
+            // multiple platforms
+            if (GetServiceEnviromentVariable() && !UseCMBService())
+            {
+                Assert.Ignore("[CMB-Server Test Run] Skipping non-distributed authority test.");
+                return;
+            }
+            else
+            {
+                // Otherwise, continue with the test
+                InternalOnOneTimeSetup();
+            }
+        }
+
+        private void InternalOnOneTimeSetup()
         {
             Application.runInBackground = true;
             m_NumberOfClients = NumberOfClients;
@@ -515,7 +547,6 @@ public IEnumerator SetUp()
 
                 }
             }
-
             VerboseDebug($"Exiting {nameof(SetUp)}");
         }
 
@@ -1983,23 +2014,45 @@ public NetcodeIntegrationTest(HostOrServer hostOrServer)
             InitializeTestConfiguration(m_NetworkTopologyType, hostOrServer);
         }
 
+        /// <summary>
+        /// Override this virtual method to execute script that runs before the base class constructor has finished executing.<br />
+        /// </summary>
+        /// <remarks>
+        /// ***NOTE***
+        /// When this method is invoked there will have been no properties set (i.e. nothing is configured). <br />
+        /// Primarily this is to set things like environemnt variables or other more external configurations that could
+        /// determine how the <see cref="NetcodeIntegrationTest"/> is configured.
+        /// </remarks>
+        protected virtual void OnPreInitializeConfiguration()
+        {
+        }
+
         private void InitializeTestConfiguration(NetworkTopologyTypes networkTopologyType, HostOrServer? hostOrServer)
         {
-            if (!hostOrServer.HasValue)
-            {
-                // Always default to hosting, set the type of host based on the topology type
-                hostOrServer = networkTopologyType == NetworkTopologyTypes.DistributedAuthority ? HostOrServer.DAHost : HostOrServer.Host;
-            }
+            OnPreInitializeConfiguration();
 
             NetworkMessageManager.EnableMessageOrderConsoleLog = false;
 
+            // Set m_NetworkTopologyType first because m_DistributedAuthority is calculated from it.
             m_NetworkTopologyType = networkTopologyType;
-            m_DistributedAuthority = m_NetworkTopologyType == NetworkTopologyTypes.DistributedAuthority;
+
+            if (!hostOrServer.HasValue)
+            {
+                // Always default to hosting, set the type of host based on the topology type.
+                // Note: For m_DistributedAuthority to be true, the m_NetworkTopologyType must be set to NetworkTopologyTypes.DistributedAuthority
+                hostOrServer = m_DistributedAuthority ? HostOrServer.DAHost : HostOrServer.Host;
+            }
             m_UseHost = hostOrServer == HostOrServer.Host || hostOrServer == HostOrServer.DAHost;
 
-            if (UseCMBService())
+            // If we are using a distributed authority network topology and the environment variable
+            // to use the CMBService is set, then perform the m_UseCmbService check.
+            if (m_DistributedAuthority && GetServiceEnviromentVariable())
             {
-                m_UseCmbService = m_DistributedAuthority && hostOrServer == HostOrServer.DAHost;
+                m_UseCmbService = hostOrServer == HostOrServer.DAHost;
+                // In the event UseCMBService is overridden, we apply the value returned.
+                // If it is, then whatever UseCMBService returns is the setting for m_UseCmbService.
+                // If it is not, then it will return whatever m_UseCmbService's setting is from the above check.
+                m_UseCmbService = UseCMBService();
             }
         }
 

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

@@ -172,6 +172,18 @@ public static void RegisterHandlers(NetworkManager networkManager, bool serverSi
             }
         }
 
+        /// <summary>
+        /// Use for non <see cref="NetcodeIntegrationTest"/> derived integration tests to automatically ignore the
+        /// test is the USE_CMB_SERVICE is set. 
+        /// </summary>
+        internal static void IgnoreIfServiceEnviromentVariableSet()
+        {
+            if (bool.TryParse(Environment.GetEnvironmentVariable("USE_CMB_SERVICE") ?? "false", out bool isTrue) ? isTrue : false)
+            {
+                Assert.Ignore("[CMB-Server Test Run] Skipping non-distributed authority test.");
+            }
+        }
+
         private static readonly string k_TransportHost = GetAddressToBind();
         private static readonly ushort k_TransportPort = GetPortToBind();
 

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

@@ -15,6 +15,13 @@ internal class ClientOnlyConnectionTests
         private bool m_WasDisconnected;
         private TimeoutHelper m_TimeoutHelper;
 
+        [OneTimeSetUp]
+        public void OneTimeSetup()
+        {
+            // TODO: [CmbServiceTests] if this test is deemed needed to test against the CMB server then update this test.
+            NetcodeIntegrationTestHelpers.IgnoreIfServiceEnviromentVariableSet();
+        }
+
         [SetUp]
         public void Setup()
         {

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

@@ -1,4 +1,5 @@
 using NUnit.Framework;
+using Unity.Netcode.TestHelpers.Runtime;
 using Unity.Netcode.Transports.UTP;
 using UnityEngine;
 using UnityEngine.TestTools;
@@ -8,6 +9,13 @@ namespace Unity.Netcode.RuntimeTests
 {
     internal class NestedNetworkManagerTests
     {
+        [OneTimeSetUp]
+        public void OneTimeSetup()
+        {
+            // TODO: [CmbServiceTests] if this test is deemed needed to test against the CMB server then update this test.
+            NetcodeIntegrationTestHelpers.IgnoreIfServiceEnviromentVariableSet();
+        }
+
         [Test]
         public void CheckNestedNetworkManager()
         {

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

@@ -17,6 +17,13 @@ internal class NetworkManagerEventsTests
         private bool m_Instantiated;
         private bool m_Destroyed;
 
+        [OneTimeSetUp]
+        public void OneTimeSetup()
+        {
+            // TODO: [CmbServiceTests] if this test is deemed needed to test against the CMB server then update this test.
+            NetcodeIntegrationTestHelpers.IgnoreIfServiceEnviromentVariableSet();
+        }
+
         /// <summary>
         /// Validates the <see cref="NetworkManager.OnInstantiated"/> and <see cref="NetworkManager.OnDestroying"/> event notifications
         /// </summary>

com.unity.netcode.gameobjects/Tests/Runtime/Prefabs/NetworkPrefabHandlerTests.cs

@@ -16,6 +16,12 @@ namespace Unity.Netcode.RuntimeTests
     /// </summary>
     internal class NetworkPrefabHandlerTests
     {
+        [OneTimeSetUp]
+        public void OneTimeSetup()
+        {
+            // TODO: [CmbServiceTests] if this test is deemed needed to test against the CMB server then update this test.
+            NetcodeIntegrationTestHelpers.IgnoreIfServiceEnviromentVariableSet();
+        }
 
         private const string k_TestPrefabObjectName = "NetworkPrefabTestObject";
         private uint m_ObjectId = 1;
@@ -28,6 +34,8 @@ private GameObject MakeValidNetworkPrefab()
             return validPrefab.gameObject;
         }
 
+
+
         /// <summary>
         /// Tests the NetwokConfig NetworkPrefabsList initialization during NetworkManager's Init method to make sure that
         /// it will still initialize but remove the invalid prefabs

com.unity.netcode.gameobjects/Tests/Runtime/Profiling/NetworkVariableNameTests.cs

@@ -8,6 +8,13 @@ internal sealed class NetworkVariableNameTests
     {
         private NetworkVariableNameComponent m_NetworkVariableNameComponent;
 
+        [OneTimeSetUp]
+        public void OneTimeSetup()
+        {
+            // TODO: [CmbServiceTests] if this test is deemed needed to test against the CMB server then update this test.
+            NetcodeIntegrationTestHelpers.IgnoreIfServiceEnviromentVariableSet();
+        }
+
         [SetUp]
         public void SetUp()
         {

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

@@ -15,6 +15,13 @@ namespace Unity.Netcode.RuntimeTests
     /// </summary>
     internal class RpcQueueTests
     {
+        [OneTimeSetUp]
+        public void OneTimeSetup()
+        {
+            // TODO: [CmbServiceTests] if this test is deemed needed to test against the CMB server then update this test.
+            NetcodeIntegrationTestHelpers.IgnoreIfServiceEnviromentVariableSet();
+        }
+
         [SetUp]
         public void Setup()
         {

com.unity.netcode.gameobjects/Tests/Runtime/Serialization/NetworkBehaviourReferenceTests.cs

@@ -15,6 +15,13 @@ namespace Unity.Netcode.RuntimeTests
     /// </summary>
     internal class NetworkBehaviourReferenceTests : IDisposable
     {
+        [OneTimeSetUp]
+        public void OneTimeSetup()
+        {
+            // TODO: [CmbServiceTests] if this test is deemed needed to test against the CMB server then update this test.
+            NetcodeIntegrationTestHelpers.IgnoreIfServiceEnviromentVariableSet();
+        }
+
         private class TestNetworkBehaviour : NetworkBehaviour
         {
             public static bool ReceivedRPC;

com.unity.netcode.gameobjects/Tests/Runtime/Serialization/NetworkObjectReferenceTests.cs

@@ -17,6 +17,13 @@ namespace Unity.Netcode.RuntimeTests
     /// </summary>
     internal class NetworkObjectReferenceTests : IDisposable
     {
+        [OneTimeSetUp]
+        public void OneTimeSetup()
+        {
+            // TODO: [CmbServiceTests] if this test is deemed needed to test against the CMB server then update this test.
+            NetcodeIntegrationTestHelpers.IgnoreIfServiceEnviromentVariableSet();
+        }
+
         private class TestNetworkBehaviour : NetworkBehaviour
         {
             public static bool ReceivedRPC;