Get more information on test failures

Author: EmandM

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

@@ -1635,12 +1635,6 @@ public static IEnumerator WaitForConditionOrTimeOut(IConditionalPredicate condit
                 throw new ArgumentNullException($"checkForCondition cannot be null!");
             }
 
-            // If none is provided we use the default global time out helper
-            if (timeOutHelper == null)
-            {
-                timeOutHelper = s_GlobalTimeoutHelper;
-            }
-
             conditionalPredicate.Started();
             yield return WaitForConditionOrTimeOut(conditionalPredicate.HasConditionBeenReached, timeOutHelper);
             conditionalPredicate.Finished(timeOutHelper.TimedOut);
@@ -1669,6 +1663,19 @@ public bool WaitForConditionOrTimeOutWithTimeTravel(IConditionalPredicate condit
             return success;
         }
 
+        public IEnumerator WaitForConditionOrAssert(Func<bool> checkForCondition, string timeoutErrorMessage, TimeoutHelper timeOutHelper = null)
+        {
+            yield return WaitForConditionOrTimeOut(checkForCondition, timeOutHelper);
+            AssertOnTimeout(timeoutErrorMessage, timeOutHelper);
+        }
+
+        public IEnumerator WaitForConditionOrAssert(Func<StringBuilder, bool> checkForCondition, string timeoutErrorMessage, TimeoutHelper timeOutHelper = null)
+        {
+            var errorBuilder = new StringBuilder();
+            yield return WaitForConditionOrTimeOut(() => checkForCondition(errorBuilder), timeOutHelper);
+            AssertOnTimeout($"{timeoutErrorMessage}\n{errorBuilder.ToString()}", timeOutHelper);
+        }
+
         /// <summary>
         /// Validates that all remote clients (i.e. non-server) detect they are connected
         /// to the server and that the server reflects the appropriate number of clients

testproject/Assets/Tests/Runtime/NetworkSceneManager/OnSceneEventCallbackTests.cs

@@ -1,6 +1,7 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text;
 using NUnit.Framework;
 using Unity.Netcode;
 using Unity.Netcode.TestHelpers.Runtime;
@@ -105,8 +106,7 @@ private IEnumerator RunSceneEventCallbackTest(ClientType clientType, Action acti
                 // Load the scene initially
                 authority.SceneManager.LoadScene(k_SceneToLoad, LoadSceneMode.Additive);
 
-                yield return WaitForConditionOrTimeOut(ValidateSceneIsLoaded);
-                AssertOnTimeout($"Timed out waiting for client to load the scene {k_SceneToLoad}!");
+                yield return WaitForConditionOrAssert(ValidateSceneIsLoaded, $"[Setup] Timed out waiting for client to load the scene {k_SceneToLoad}!");
 
                 // Wait for any pending messages to be processed
                 yield return null;
@@ -179,16 +179,14 @@ private IEnumerator RunSceneEventCallbackTest(ClientType clientType, Action acti
             {
                 Assert.That(authority.SceneManager.LoadScene(loadCall, LoadSceneMode.Additive) == SceneEventProgressStatus.Started);
 
-                yield return WaitForConditionOrTimeOut(ValidateSceneIsLoaded);
-                AssertOnTimeout($"Timed out waiting for client to load the scene {k_SceneToLoad}!");
+                yield return WaitForConditionOrAssert(ValidateSceneIsLoaded, $"[Test] Timed out waiting for client to load the scene {k_SceneToLoad}!");
             }
             else
             {
                 Assert.That(loadedScene.name, Is.EqualTo(k_SceneToLoad), "scene was not loaded!");
                 Assert.That(authority.SceneManager.UnloadScene(loadedScene) == SceneEventProgressStatus.Started);
 
-                yield return WaitForConditionOrTimeOut(ValidateSceneIsUnloaded);
-                AssertOnTimeout($"Timed out waiting for client to unload the scene {k_SceneToLoad}!");
+                yield return WaitForConditionOrAssert(ValidateSceneIsUnloaded, $"[Test] Timed out waiting for client to unload the scene {k_SceneToLoad}!");
             }
 
             // Wait for all messages to process
@@ -202,19 +200,21 @@ private IEnumerator RunSceneEventCallbackTest(ClientType clientType, Action acti
             managerToTest.SceneManager.OnSceneEvent -= OnSceneEvent;
         }
 
-        private bool ValidateSceneIsLoaded()
+        private bool ValidateSceneIsLoaded(StringBuilder errorBuilder)
         {
             foreach (var manager in m_NetworkManagers)
             {
                 // default will have isLoaded as false so we can get the scene or default and test on isLoaded
                 var loadedScene = manager.SceneManager.ScenesLoaded.Values.FirstOrDefault(scene => scene.name == k_SceneToLoad);
                 if (!loadedScene.isLoaded)
                 {
+                    errorBuilder.AppendLine($"[ValidateIsLoaded] Scene {loadedScene.name} exists but is not loaded!");
                     return false;
                 }
 
                 if (manager.SceneManager.SceneEventProgressTracking.Count > 0)
                 {
+                    errorBuilder.AppendLine($"[ValidateIsLoaded] NetworkManager {manager.name} still has progress tracking events.");
                     return false;
                 }
             }