fix: refactor integration test infra, re-enable testproject-tools-integration, fix flaky tests on desktop & console platforms

.yamato/project.metafile

@@ -45,9 +45,9 @@ projects:
       - 2021.2
       - 2020.3
       - trunk
-#  - name: testproject-tools-integration
-#    path: testproject-tools-integration
-#    validate: false
-#    test_editors:
-#      - 2021.2
-#      - trunk
+  - name: testproject-tools-integration
+    path: testproject-tools-integration
+    validate: false
+    test_editors:
+      - 2021.2
+      - trunk

com.unity.netcode.adapter.utp/Editor/com.unity.netcode.adapter.utp.editor.asmdef

@@ -1,22 +1,14 @@
 {
-  "name": "Unity.Netcode.Adapter.UTP.Editor",
-  "rootNamespace": "",
-  "references": [
-    "Unity.Collections",
-    "Unity.Jobs",
-    "Unity.Burst",
-    "Unity.Netcode.Runtime",
-    "Unity.Networking.Transport"
-  ],
-  "includePlatforms": [
-    "Editor"
-  ],
-  "excludePlatforms": [],
-  "allowUnsafeCode": true,
-  "overrideReferences": true,
-  "precompiledReferences": [],
-  "autoReferenced": true,
-  "defineConstraints": [],
-  "versionDefines": [],
-  "noEngineReferences": false
+    "name": "Unity.Netcode.Adapter.UTP.Editor",
+    "rootNamespace": "Unity.Netcode.Adapter.UTP.Editor",
+    "references": [
+        "Unity.Collections",
+        "Unity.Jobs",
+        "Unity.Burst",
+        "Unity.Netcode.Runtime",
+        "Unity.Networking.Transport"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ]
 }

com.unity.netcode.adapter.utp/Runtime/com.unity.netcode.adapter.utp.asmdef

@@ -1,20 +1,14 @@
 {
     "name": "Unity.Netcode.Adapter.UTP",
-    "rootNamespace": "Unity.Netcode.UTP",
+    "rootNamespace": "Unity.Netcode.Adapter.UTP",
     "references": [
         "Unity.Collections",
         "Unity.Jobs",
         "Unity.Burst",
         "Unity.Netcode.Runtime",
         "Unity.Networking.Transport"
     ],
-    "includePlatforms": [],
-    "excludePlatforms": [],
     "allowUnsafeCode": true,
-    "overrideReferences": false,
-    "precompiledReferences": [],
-    "autoReferenced": true,
-    "defineConstraints": [],
     "versionDefines": [
         {
             "name": "com.unity.multiplayer.tools",
@@ -26,6 +20,5 @@
             "expression": "1.0.0-pre.4",
             "define": "MULTIPLAYER_TOOLS_1_0_0_PRE_4"
         }
-    ],
-    "noEngineReferences": false
+    ]
 }

com.unity.netcode.adapter.utp/Tests/Runtime/com.unity.netcode.adapter.utp.runtimetests.asmdef

@@ -4,22 +4,9 @@
     "references": [
         "Unity.Netcode.Runtime",
         "Unity.Networking.Transport",
-        "UnityEngine.TestRunner",
-        "UnityEditor.TestRunner",
         "Unity.Netcode.Adapter.UTP"
     ],
-    "includePlatforms": [],
-    "excludePlatforms": [],
-    "allowUnsafeCode": false,
-    "overrideReferences": true,
-    "precompiledReferences": [
-        "nunit.framework.dll"
-    ],
-    "autoReferenced": false,
-    "defineConstraints": [
-        "UNITY_INCLUDE_TESTS",
-        "UNITY_INCLUDE_TESTS"
-    ],
-    "versionDefines": [],
-    "noEngineReferences": false
+    "optionalUnityReferences": [
+        "TestAssemblies"
+    ]
 }

com.unity.netcode.gameobjects/Components/com.unity.netcode.components.asmdef

@@ -5,13 +5,5 @@
         "Unity.Netcode.Runtime",
         "Unity.Collections"
     ],
-    "includePlatforms": [],
-    "excludePlatforms": [],
-    "allowUnsafeCode": true,
-    "overrideReferences": false,
-    "precompiledReferences": [],
-    "autoReferenced": true,
-    "defineConstraints": [],
-    "versionDefines": [],
-    "noEngineReferences": false
+    "allowUnsafeCode": true
 }

com.unity.netcode.gameobjects/Editor/NetworkManagerHelper.cs

@@ -12,7 +12,7 @@ public class NetworkManagerHelper : NetworkManager.INetworkManagerHelper
     {
         internal static NetworkManagerHelper Singleton;
 
-        // This is primarily to handle multiInstance scenarios where more than 1 NetworkManager could exist
+        // This is primarily to handle IntegrationTest scenarios where more than 1 NetworkManager could exist
         private static Dictionary<NetworkManager, Transform> s_LastKnownNetworkManagerParents = new Dictionary<NetworkManager, Transform>();
 
         /// <summary>

com.unity.netcode.gameobjects/Editor/com.unity.netcode.editor.asmdef

@@ -8,18 +8,11 @@
     "includePlatforms": [
         "Editor"
     ],
-    "excludePlatforms": [],
-    "allowUnsafeCode": false,
-    "overrideReferences": false,
-    "precompiledReferences": [],
-    "autoReferenced": true,
-    "defineConstraints": [],
     "versionDefines": [
         {
             "name": "com.unity.multiplayer.tools",
             "expression": "",
             "define": "MULTIPLAYER_TOOLS"
         }
-    ],
-    "noEngineReferences": false
+    ]
 }

com.unity.netcode.gameobjects/Runtime/AssemblyInfo.cs

@@ -5,9 +5,10 @@
 [assembly: InternalsVisibleTo("Unity.Netcode.Editor.CodeGen")]
 [assembly: InternalsVisibleTo("Unity.Netcode.Editor")]
 [assembly: InternalsVisibleTo("TestProject.EditorTests")]
-[assembly: InternalsVisibleTo("TestProject.ToolsIntegration.RuntimeTests")]
 #endif
+[assembly: InternalsVisibleTo("TestProject.ToolsIntegration.RuntimeTests")]
 [assembly: InternalsVisibleTo("TestProject.RuntimeTests")]
 [assembly: InternalsVisibleTo("Unity.Netcode.RuntimeTests")]
+[assembly: InternalsVisibleTo("Unity.Netcode.TestHelpers.Runtime")]
 [assembly: InternalsVisibleTo("Unity.Netcode.Adapter.UTP")]
 

com.unity.netcode.gameobjects/Runtime/SceneManagement/NetworkSceneManager.cs

@@ -1845,7 +1845,7 @@ private void PopulateScenePlacedObjects(Scene sceneToFilterBy, bool clearScenePl
             // at the end of scene loading we use this list to soft synchronize all in-scene placed NetworkObjects
             foreach (var networkObjectInstance in networkObjects)
             {
-                // We check to make sure the NetworkManager instance is the same one to be "MultiInstanceHelpers" compatible and filter the list on a per scene basis (additive scenes)
+                // We check to make sure the NetworkManager instance is the same one to be "NetcodeIntegrationTestHelpers" compatible and filter the list on a per scene basis (additive scenes)
                 if (networkObjectInstance.IsSceneObject == null && networkObjectInstance.NetworkManager == m_NetworkManager && networkObjectInstance.gameObject.scene == sceneToFilterBy &&
                     networkObjectInstance.gameObject.scene.handle == sceneToFilterBy.handle)
                 {

com.unity.netcode.gameobjects/Runtime/com.unity.netcode.runtime.asmdef

@@ -12,13 +12,7 @@
         "Unity.Multiplayer.Tools.NetworkSolutionInterface",
         "Unity.Collections"
     ],
-    "includePlatforms": [],
-    "excludePlatforms": [],
     "allowUnsafeCode": true,
-    "overrideReferences": false,
-    "precompiledReferences": [],
-    "autoReferenced": true,
-    "defineConstraints": [],
     "versionDefines": [
         {
             "name": "com.unity.multiplayer.tools",
@@ -35,6 +29,5 @@
             "expression": "1.0.0-pre.4",
             "define": "MULTIPLAYER_TOOLS_1_0_0_PRE_4"
         }
-    ],
-    "noEngineReferences": false
+    ]
 }

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

@@ -0,0 +1,6 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("TestProject.EditorTests")]
+[assembly: InternalsVisibleTo("TestProject.RuntimeTests")]
+[assembly: InternalsVisibleTo("TestProject.ToolsIntegration.RuntimeTests")]
+[assembly: InternalsVisibleTo("Unity.Netcode.RuntimeTests")]

com.unity.netcode.gameobjects/TestHelpers/Runtime/Components/ObjectNameIdentifier.cs

@@ -0,0 +1,93 @@
+
+namespace Unity.Netcode.TestHelpers.Runtime
+{
+    public class ObjectNameIdentifier : NetworkBehaviour
+    {
+        private ulong m_CurrentOwner;
+        private ulong m_CurrentNetworkObjectId;
+        private bool m_IsRegistered;
+
+        /// <summary>
+        /// Keep a reference to the assigned NetworkObject
+        /// <see cref="OnDestroy"/>
+        /// </summary>
+        private NetworkObject m_NetworkObject;
+
+        public override void OnNetworkSpawn()
+        {
+            RegisterAndLabelNetworkObject();
+        }
+
+        protected void RegisterAndLabelNetworkObject()
+        {
+            if (!m_IsRegistered)
+            {
+                // This is required otherwise it will try to continue to update the NetworkBehaviour even if
+                // it has been destroyed.
+                m_NetworkObject = NetworkObject;
+                m_CurrentOwner = OwnerClientId;
+                m_CurrentNetworkObjectId = NetworkObjectId;
+                var objectOriginalName = gameObject.name.Replace("(Clone)", "");
+                var serverOrClient = IsServer ? "Server" : "Client";
+                if (NetworkObject.IsPlayerObject)
+                {
+                    gameObject.name = NetworkManager.LocalClientId == OwnerClientId ? $"{objectOriginalName}({OwnerClientId})-Local{objectOriginalName}" :
+                        $"{objectOriginalName}({OwnerClientId})-On{serverOrClient}({NetworkManager.LocalClientId})";
+                }
+                else
+                {
+                    gameObject.name = $"{objectOriginalName}({NetworkObjectId})-On{serverOrClient}({NetworkManager.LocalClientId})";
+                }
+
+                // Don't add the player objects to the global list of NetworkObjects
+                if (!NetworkObject.IsPlayerObject)
+                {
+                    NetcodeIntegrationTest.RegisterNetworkObject(NetworkObject);
+                }
+                m_IsRegistered = true;
+            }
+        }
+
+        protected void DeRegisterNetworkObject()
+        {
+            if (m_IsRegistered)
+            {
+                NetcodeIntegrationTest.DeregisterNetworkObject(m_CurrentOwner, m_CurrentNetworkObjectId);
+                m_IsRegistered = false;
+            }
+        }
+
+        public override void OnLostOwnership()
+        {
+            DeRegisterNetworkObject();
+            RegisterAndLabelNetworkObject();
+        }
+
+        public override void OnGainedOwnership()
+        {
+            DeRegisterNetworkObject();
+            RegisterAndLabelNetworkObject();
+        }
+
+        public override void OnNetworkDespawn()
+        {
+            DeRegisterNetworkObject();
+        }
+
+        public override void OnDestroy()
+        {
+            if (m_NetworkObject != null)
+            {
+                DeRegisterNetworkObject();
+                // This is required otherwise it will try to continue to update the NetworkBehaviour even if
+                // it has been destroyed (most likely integration test specific)
+                if (m_NetworkObject.ChildNetworkBehaviours != null && m_NetworkObject.ChildNetworkBehaviours.Contains(this))
+                {
+                    NetworkObject.ChildNetworkBehaviours.Remove(this);
+                }
+                m_NetworkObject = null;
+            }
+            base.OnDestroy();
+        }
+    }
+}