feat: test utilities script including Playmode test helpers

Assets/BossRoom/Scripts/Editor/SceneBootstrapper.cs

@@ -1,6 +1,7 @@
 using UnityEditor;
 using UnityEditor.SceneManagement;
 using UnityEngine;
+using UnityEngine.SceneManagement;
 
 namespace Unity.Multiplayer.Samples.BossRoom.Editor
 {
@@ -99,6 +100,15 @@ static void DisableDoNotLoadBootstrapSceneOnPlay()
 
         static void EditorApplicationOnplayModeStateChanged(PlayModeStateChange obj)
         {
+            // detects whether playmode has been initiated by a TestRunner Playmode test; if so disable Boostrap loading
+            for (int i = 0; i < SceneManager.sceneCount; i++)
+            {
+                if (SceneManager.GetSceneAt(i).name.Contains("InitTestScene"))
+                {
+                    return;
+                }
+            }
+
             if (!LoadBootstrapScene)
             {
                 return;

Packages/com.unity.multiplayer.samples.coop/Tests/Editor/unity.multiplayer.samples.coop.tests.Editor.asmdef

@@ -0,0 +1,23 @@
+{
+    "name": "Unity.Multiplayer.Samples.Coop.Tests.Editor",
+    "rootNamespace": "",
+    "references": [
+        "UnityEngine.TestRunner",
+        "UnityEditor.TestRunner"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": true,
+    "precompiledReferences": [
+        "nunit.framework.dll"
+    ],
+    "autoReferenced": false,
+    "defineConstraints": [
+        "UNITY_INCLUDE_TESTS"
+    ],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Packages/com.unity.multiplayer.samples.coop/Tests/Runtime/RuntimeExampleTest.cs

@@ -3,7 +3,7 @@
 using NUnit.Framework;
 using System.Collections;
 
-namespace Tests
+namespace Unity.Multiplayer.Samples.Coop.Tests.Runtime
 {
     public class RuntimeExampleTest
     {

Packages/com.unity.multiplayer.samples.coop/Tests/Runtime/com.unity.multiplayer.samples.coop.tests.runtime.asmdef

@@ -0,0 +1,21 @@
+{
+    "name": "Unity.Multiplayer.Samples.Coop.Tests.Runtime",
+    "rootNamespace": "",
+    "references": [
+        "UnityEngine.TestRunner",
+        "UnityEditor.TestRunner"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": true,
+    "precompiledReferences": [
+        "nunit.framework.dll"
+    ],
+    "autoReferenced": false,
+    "defineConstraints": [
+        "UNITY_INCLUDE_TESTS"
+    ],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Packages/com.unity.multiplayer.samples.coop/Utilities/Testing/TestUtilities.cs

@@ -0,0 +1,88 @@
+using System.Collections;
+using UnityEngine;
+using NUnit.Framework;
+using UnityEngine.EventSystems;
+using UnityEngine.SceneManagement;
+using UnityEngine.UI;
+
+namespace Unity.Multiplayer.Samples.Utilities
+{
+    public abstract class TestUtils
+    {
+        /// <summary>
+        /// Finds an active Button GameObject by name. If Button component is present on GameObject, it will be clicked.
+        /// </summary>
+        /// <param name="name"> Name of Button GameObject </param>
+        public static void ClickButtonByName(string name)
+        {
+            var buttonGameObject = GameObject.Find(name);
+
+            Assert.IsNotNull(buttonGameObject,
+                $"Button GameObject with name {name} not found in scene!");
+
+            EventSystem.current.SetSelectedGameObject(buttonGameObject);
+
+            var buttonComponent = buttonGameObject.GetComponent<Button>();
+
+            Assert.IsNotNull(buttonComponent, $"Button component not found on {buttonGameObject.name}!");
+
+            buttonComponent.onClick.Invoke();
+        }
+
+        /// <summary>
+        /// Helper wrapper method for asserting the completion of a scene load to be used inside Playmode tests. A scene
+        /// is either loaded successfully, or the loading process has timed out.
+        /// </summary>
+        /// <param name="sceneName"> Name of scene </param>
+        /// <returns></returns>
+        public static IEnumerator AssertIsSceneLoaded(string sceneName)
+        {
+            var waitUntilSceneLoaded = new WaitForSceneLoad(sceneName);
+
+            yield return waitUntilSceneLoaded;
+
+            Assert.That(!waitUntilSceneLoaded.timedOut);
+        }
+    }
+
+    /// <summary>
+    /// Custom IEnumerator class to validate the loading of a Scene by name. If a scene load lasts longer than
+    /// k_MaxSceneLoadDuration it is considered a timeout.
+    /// </summary>
+    public class WaitForSceneLoad : CustomYieldInstruction
+    {
+        const float k_MaxSceneLoadDuration = 10f;
+
+        string m_SceneName;
+
+        float m_LoadSceneStart;
+
+        float m_MaxLoadDuration;
+
+        public bool timedOut { get; private set; }
+
+        public override bool keepWaiting
+        {
+            get
+            {
+                var scene = SceneManager.GetSceneByName(m_SceneName);
+
+                var isSceneLoaded = scene.IsValid() && scene.isLoaded;
+
+                if (Time.time - m_LoadSceneStart >= m_MaxLoadDuration)
+                {
+                    timedOut = true;
+                }
+
+                return !isSceneLoaded && !timedOut;
+            }
+        }
+
+        public WaitForSceneLoad(string sceneName, float maxLoadDuration = k_MaxSceneLoadDuration)
+        {
+            m_LoadSceneStart = Time.time;
+            m_SceneName = sceneName;
+            m_MaxLoadDuration = maxLoadDuration;
+        }
+    }
+}

Packages/com.unity.multiplayer.samples.coop/Utilities/Testing/com.unity.multiplayer.samples.utilities.testing.asmdef

@@ -0,0 +1,16 @@
+{
+    "name": "Unity.Multiplayer.Samples.Utilities.Testing",
+    "rootNamespace": "",
+    "references": [],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": true,
+    "precompiledReferences": [
+        "nunit.framework.dll"
+    ],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}