From 5c15704c819ab25868c48f511a26b417a2bb96d0 Mon Sep 17 00:00:00 2001
From: smoogipoo <smoogipoo@smgi.me>
Date: Mon, 2 Mar 2020 10:28:39 +0900
Subject: [PATCH] Improve abstract structure for testability

---
 osu.Game/Tests/Visual/ModSandboxTestScene.cs | 96 ++++++--------------
 osu.Game/Tests/Visual/TestReplayPlayer.cs    | 24 +++++
 2 files changed, 50 insertions(+), 70 deletions(-)
 create mode 100644 osu.Game/Tests/Visual/TestReplayPlayer.cs

diff --git a/osu.Game/Tests/Visual/ModSandboxTestScene.cs b/osu.Game/Tests/Visual/ModSandboxTestScene.cs
index bb872123c5..84bab6a9b9 100644
--- a/osu.Game/Tests/Visual/ModSandboxTestScene.cs
+++ b/osu.Game/Tests/Visual/ModSandboxTestScene.cs
@@ -4,15 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Reflection;
-using osu.Framework.Allocation;
-using osu.Framework.Bindables;
-using osu.Framework.Graphics;
-using osu.Framework.Graphics.Containers;
-using osu.Framework.Testing;
-using osu.Game.Configuration;
-using osu.Game.Graphics.UserInterface;
-using osu.Game.Overlays.Mods;
+using osu.Game.Beatmaps;
 using osu.Game.Rulesets;
 using osu.Game.Rulesets.Mods;
 using osu.Game.Screens.Play;
@@ -26,83 +18,47 @@ namespace osu.Game.Tests.Visual
             typeof(ModSandboxTestScene)
         };
 
-        protected Mod Mod;
-        private readonly TriangleButton button;
-
-        protected ModSandboxTestScene(Ruleset ruleset, Mod mod = null)
+        protected ModSandboxTestScene(Ruleset ruleset)
             : base(ruleset)
         {
-            Mod = mod ?? new SandboxMod();
-
-            var props = Mod.GetType().GetProperties(BindingFlags.GetProperty | BindingFlags.Public | BindingFlags.Instance);
-            var hasSettings = props.Any(prop => prop.GetCustomAttribute<SettingSourceAttribute>(true) != null);
-
-            Child = new FillFlowContainer
-            {
-                RelativeSizeAxes = Axes.X,
-                AutoSizeAxes = Axes.Y,
-                Direction = FillDirection.Vertical,
-                Padding = new MarginPadding(50),
-                Margin = new MarginPadding { Bottom = 20 },
-                Width = 0.4f,
-                Anchor = Anchor.BottomLeft,
-                Origin = Anchor.BottomLeft,
-                Children = new Drawable[]
-                {
-                    new ModControlSection(Mod, Mod.CreateSettingsControls()),
-                    button = new TriangleButton
-                    {
-                        RelativeSizeAxes = Axes.X,
-                        Width = 0.5f,
-                        Text = "Start",
-                        Action = () =>
-                        {
-                            button.Text = hasSettings ? "Apply Settings" : "Restart";
-                            LoadPlayer();
-                        }
-                    }
-                }
-            };
         }
 
-        [SetUpSteps]
+        private ModTestCaseData currentTest;
+
         public override void SetUpSteps()
         {
+            foreach (var testCase in CreateTestCases())
+            {
+                AddStep("set test case", () => currentTest = testCase);
+                base.SetUpSteps();
+            }
         }
 
-        [BackgroundDependencyLoader]
-        private void load()
-        {
-            LocalConfig.GetBindable<bool>(OsuSetting.KeyOverlay).Value = true;
-        }
+        protected override IBeatmap CreateBeatmap(RulesetInfo ruleset) => currentTest.Beatmap;
 
         protected override Player CreatePlayer(Ruleset ruleset)
         {
-            SelectedMods.Value = SelectedMods.Value.Append(Mod).ToArray();
+            SelectedMods.Value = SelectedMods.Value.Append(currentTest.Mod).ToArray();
+
+            if (currentTest.Autoplay)
+            {
+                // We're simulating an auto-play via a replay so that the auto-play mod does not interfere
+                var beatmap = Beatmap.Value.GetPlayableBeatmap(ruleset.RulesetInfo, SelectedMods.Value);
+                var score = ruleset.GetAutoplayMod().CreateReplayScore(beatmap);
+
+                return new TestReplayPlayer(score, false, false);
+            }
 
             return base.CreatePlayer(ruleset);
         }
 
-        protected class SandboxMod : Mod
+        protected abstract ModTestCaseData[] CreateTestCases();
+
+        protected class ModTestCaseData
         {
-            public override string Name => "Sandbox Test";
-            public override string Acronym => "ST";
-            public override double ScoreMultiplier => 1.0;
-
-            [SettingSource("Test Setting")]
-            public Bindable<bool> TestSetting1 { get; } = new BindableBool
-            {
-                Default = true,
-                Value = true
-            };
-
-            [SettingSource("Test Setting 2")]
-            public Bindable<float> TestSetting2 { get; } = new BindableFloat
-            {
-                Precision = 0.1f,
-                MinValue = 0,
-                MaxValue = 20
-            };
+            public Mod Mod;
+            public bool Autoplay;
+            public IBeatmap Beatmap;
         }
     }
 }
diff --git a/osu.Game/Tests/Visual/TestReplayPlayer.cs b/osu.Game/Tests/Visual/TestReplayPlayer.cs
new file mode 100644
index 0000000000..e99fcc1e37
--- /dev/null
+++ b/osu.Game/Tests/Visual/TestReplayPlayer.cs
@@ -0,0 +1,24 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using osu.Game.Rulesets.UI;
+using osu.Game.Scoring;
+using osu.Game.Screens.Play;
+
+namespace osu.Game.Tests.Visual
+{
+    public class TestReplayPlayer : ReplayPlayer
+    {
+        protected override bool PauseOnFocusLost { get; }
+
+        public new DrawableRuleset DrawableRuleset => base.DrawableRuleset;
+
+        public new GameplayClockContainer GameplayClockContainer => base.GameplayClockContainer;
+
+        public TestReplayPlayer(Score score, bool allowPause = true, bool showResults = true, bool pauseOnFocusLost = false)
+            : base(score, allowPause, showResults)
+        {
+            PauseOnFocusLost = pauseOnFocusLost;
+        }
+    }
+}