Give UntilStepButton a proper stacktrace

ppy · Nov 11, 2024 · 42a01b9 · 42a01b9
1 parent 94bd9c2
commit 42a01b9
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 17 deletions.
diff --git a/osu.Framework.Tests/Visual/Testing/TestSceneStepButton.cs b/osu.Framework.Tests/Visual/Testing/TestSceneStepButton.cs
@@ -55,7 +55,8 @@ public TestSceneStepButton()
                     {
                         Text = nameof(UntilStepButton),
                         IsSetupStep = false,
-                        Assertion = () => true
+                        Assertion = () => true,
+                        CallStack = new StackTrace()
                     },
                     new StepSlider<int>(nameof(StepSlider<int>), 0, 10, 5),
                 }

diff --git a/osu.Framework/Testing/Drawables/Steps/AssertButton.cs b/osu.Framework/Testing/Drawables/Steps/AssertButton.cs
@@ -4,7 +4,6 @@
 using System;
 using System.Diagnostics;
 using System.Text;
-using NUnit.Framework;
 using osuTK.Graphics;
 
 namespace osu.Framework.Testing.Drawables.Steps
@@ -44,18 +43,5 @@ private void checkAssert()
         }
 
         public override string ToString() => "Assert: " + base.ToString();
-
-        private class TracedException : AssertionException
-        {
-            private readonly StackTrace trace;
-
-            public TracedException(string description, StackTrace trace)
-                : base(description)
-            {
-                this.trace = trace;
-            }
-
-            public override string StackTrace => trace.ToString();
-        }
     }
 }
diff --git a/osu.Framework/Testing/Drawables/Steps/TracedException.cs b/osu.Framework/Testing/Drawables/Steps/TracedException.cs
@@ -0,0 +1,21 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System.Diagnostics;
+using NUnit.Framework;
+
+namespace osu.Framework.Testing.Drawables.Steps
+{
+    internal class TracedException : AssertionException
+    {
+        private readonly StackTrace trace;
+
+        public TracedException(string description, StackTrace trace)
+            : base(description)
+        {
+            this.trace = trace;
+        }
+
+        public override string StackTrace => trace.ToString();
+    }
+}
diff --git a/osu.Framework/Testing/Drawables/Steps/UntilStepButton.cs b/osu.Framework/Testing/Drawables/Steps/UntilStepButton.cs
@@ -4,7 +4,6 @@
 using System;
 using System.Diagnostics;
 using System.Text;
-using NUnit.Framework;
 using osu.Framework.Graphics;
 using osuTK.Graphics;
 
@@ -14,6 +13,7 @@ public partial class UntilStepButton : StepButton
     {
         private static readonly int max_attempt_milliseconds = FrameworkEnvironment.NoTestTimeout ? int.MaxValue : 10000;
 
+        public required StackTrace CallStack { get; init; }
         public required Func<bool> Assertion { get; init; }
         public Func<string>? GetFailureMessage { get; init; }
         public new Action? Action { get; set; }
@@ -60,7 +60,7 @@ private void checkAssert()
                 if (GetFailureMessage != null)
                     builder.Append($": {GetFailureMessage()}");
 
-                throw new AssertionException(builder.ToString());
+                throw new TracedException(builder.ToString(), CallStack);
             }
 
             Action?.Invoke();

diff --git a/osu.Framework/Testing/TestScene.cs b/osu.Framework/Testing/TestScene.cs
@@ -331,6 +331,7 @@ protected void AddUntilStep([CanBeNull] string description, [NotNull] Func<bool>
             {
                 Text = description ?? @"Until",
                 IsSetupStep = addStepsAsSetupSteps,
+                CallStack = new StackTrace(1),
                 Assertion = waitUntilTrueDelegate,
             });
         }
@@ -343,6 +344,7 @@ protected void AddUntilStep<T>([CanBeNull] string description, [NotNull] ActualV
             {
                 Text = description ?? @"Until",
                 IsSetupStep = addStepsAsSetupSteps,
+                CallStack = new StackTrace(1),
                 Assertion = () =>
                 {
                     lastResult = constraint().Resolve().ApplyTo(actualValue());