Centralise screen exit logic to ScreenTestScene

osu.Game.Tests/Visual/Gameplay/TestSceneAllRulesetPlayers.cs

@@ -2,30 +2,52 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System.Linq;
+using NUnit.Framework;
 using osu.Framework.Allocation;
 using osu.Framework.Screens;
 using osu.Game.Configuration;
 using osu.Game.Rulesets;
+using osu.Game.Rulesets.Catch;
+using osu.Game.Rulesets.Mania;
 using osu.Game.Rulesets.Mods;
+using osu.Game.Rulesets.Osu;
+using osu.Game.Rulesets.Taiko;
 using osu.Game.Screens.Play;
 
-namespace osu.Game.Tests.Visual
+namespace osu.Game.Tests.Visual.Gameplay
 {
     /// <summary>
     /// A base class which runs <see cref="Player"/> test for all available rulesets.
     /// Steps to be run for each ruleset should be added via <see cref="AddCheckSteps"/>.
     /// </summary>
-    public abstract class AllPlayersTestScene : RateAdjustedBeatmapTestScene
+    public abstract class TestSceneAllRulesetPlayers : RateAdjustedBeatmapTestScene
     {
         protected Player Player;
 
         [BackgroundDependencyLoader]
         private void load(RulesetStore rulesets)
         {
-            foreach (var r in rulesets.AvailableRulesets)
+            OsuConfigManager manager;
+            Dependencies.Cache(manager = new OsuConfigManager(LocalStorage));
+            manager.GetBindable<double>(OsuSetting.DimLevel).Value = 1.0;
+        }
+
+        [Test]
+        public void TestOsu() => runForRuleset(new OsuRuleset().RulesetInfo);
+
+        [Test]
+        public void TestTaiko() => runForRuleset(new TaikoRuleset().RulesetInfo);
+
+        [Test]
+        public void TestCatch() => runForRuleset(new CatchRuleset().RulesetInfo);
+
+        [Test]
+        public void TestMania() => runForRuleset(new ManiaRuleset().RulesetInfo);
+
+        private void runForRuleset(RulesetInfo ruleset)
         {
             Player p = null;
-                AddStep(r.Name, () => p = loadPlayerFor(r));
+            AddStep($"load {ruleset.Name} player", () => p = loadPlayerFor(ruleset));
             AddUntilStep("player loaded", () =>
             {
                 if (p?.IsLoaded == true)
@@ -40,11 +62,6 @@ namespace osu.Game.Tests.Visual
             AddCheckSteps();
         }
 
-            OsuConfigManager manager;
-            Dependencies.Cache(manager = new OsuConfigManager(LocalStorage));
-            manager.GetBindable<double>(OsuSetting.DimLevel).Value = 1.0;
-        }
-
         protected abstract void AddCheckSteps();
 
         private Player loadPlayerFor(RulesetInfo rulesetInfo)

osu.Game.Tests/Visual/Gameplay/TestSceneAutoplay.cs

@@ -12,7 +12,7 @@ using osu.Game.Storyboards;
 namespace osu.Game.Tests.Visual.Gameplay
 {
     [Description("Player instantiated with an autoplay mod.")]
-    public class TestSceneAutoplay : AllPlayersTestScene
+    public class TestSceneAutoplay : TestSceneAllRulesetPlayers
     {
         private ClockBackedTestWorkingBeatmap.TrackVirtualManual track;
 

osu.Game.Tests/Visual/Gameplay/TestSceneFailAnimation.cs

@@ -10,7 +10,7 @@ using osu.Game.Screens.Play;
 
 namespace osu.Game.Tests.Visual.Gameplay
 {
-    public class TestSceneFailAnimation : AllPlayersTestScene
+    public class TestSceneFailAnimation : TestSceneAllRulesetPlayers
     {
         protected override Player CreatePlayer(Ruleset ruleset)
         {
@@ -20,7 +20,7 @@ namespace osu.Game.Tests.Visual.Gameplay
 
         public override IReadOnlyList<Type> RequiredTypes => new[]
         {
-            typeof(AllPlayersTestScene),
+            typeof(TestSceneAllRulesetPlayers),
             typeof(TestPlayer),
             typeof(Player),
         };

osu.Game.Tests/Visual/Gameplay/TestSceneFailJudgement.cs

@@ -10,7 +10,7 @@ using osu.Game.Screens.Play;
 
 namespace osu.Game.Tests.Visual.Gameplay
 {
-    public class TestSceneFailJudgement : AllPlayersTestScene
+    public class TestSceneFailJudgement : TestSceneAllRulesetPlayers
     {
         protected override Player CreatePlayer(Ruleset ruleset)
         {

osu.Game.Tests/Visual/Gameplay/TestScenePause.cs

@@ -36,6 +36,7 @@ namespace osu.Game.Tests.Visual.Gameplay
         public override void SetUpSteps()
         {
             base.SetUpSteps();
+
             AddStep("resume player", () => Player.GameplayClockContainer.Start());
             confirmClockRunning(true);
         }

osu.Game.Tests/Visual/Gameplay/TestScenePlayerReferenceLeaking.cs

@@ -10,7 +10,7 @@ using osu.Game.Storyboards;
 
 namespace osu.Game.Tests.Visual.Gameplay
 {
-    public class TestScenePlayerReferenceLeaking : AllPlayersTestScene
+    public class TestScenePlayerReferenceLeaking : TestSceneAllRulesetPlayers
     {
         private readonly WeakList<WorkingBeatmap> workingWeakReferences = new WeakList<WorkingBeatmap>();
 

osu.Game.Tests/Visual/Gameplay/TestSceneReplay.cs

@@ -13,7 +13,7 @@ using osu.Game.Screens.Play;
 namespace osu.Game.Tests.Visual.Gameplay
 {
     [Description("Player instantiated with a replay.")]
-    public class TestSceneReplay : AllPlayersTestScene
+    public class TestSceneReplay : TestSceneAllRulesetPlayers
     {
         protected override Player CreatePlayer(Ruleset ruleset)
         {

osu.Game.Tests/Visual/SongSelect/TestScenePlaySongSelect.cs

@@ -79,12 +79,17 @@ namespace osu.Game.Tests.Visual.SongSelect
 
         private OsuConfigManager config;
 
-        [SetUp]
+        [SetUpSteps]
-        public virtual void SetUp() => Schedule(() =>
+        public override void SetUpSteps()
+        {
+            base.SetUpSteps();
+
+            AddStep("delete all beatmaps", () =>
             {
                 Ruleset.Value = new OsuRuleset().RulesetInfo;
                 manager?.Delete(manager.GetAllUsableBeatmapSets());
             });
+        }
 
         [Test]
         public void TestSingleFilterOnEnter()
@@ -120,9 +125,6 @@ namespace osu.Game.Tests.Visual.SongSelect
 
             AddUntilStep("wait for not current", () => !songSelect.IsCurrentScreen());
             AddAssert("ensure selection changed", () => selected != Beatmap.Value);
-
-            AddUntilStep("wait for return to song select", () => songSelect.IsCurrentScreen());
-            AddUntilStep("bindable lease returned", () => !Beatmap.Disabled);
         }
 
         [Test]
@@ -148,9 +150,6 @@ namespace osu.Game.Tests.Visual.SongSelect
 
             AddUntilStep("wait for not current", () => !songSelect.IsCurrentScreen());
             AddAssert("ensure selection didn't change", () => selected == Beatmap.Value);
-
-            AddUntilStep("wait for return to song select", () => songSelect.IsCurrentScreen());
-            AddUntilStep("bindable lease returned", () => !Beatmap.Disabled);
         }
 
         [Test]
@@ -180,9 +179,6 @@ namespace osu.Game.Tests.Visual.SongSelect
 
             AddUntilStep("wait for not current", () => !songSelect.IsCurrentScreen());
             AddAssert("ensure selection changed", () => selected != Beatmap.Value);
-
-            AddUntilStep("wait for return to song select", () => songSelect.IsCurrentScreen());
-            AddUntilStep("bindable lease returned", () => !Beatmap.Disabled);
         }
 
         [Test]
@@ -213,9 +209,6 @@ namespace osu.Game.Tests.Visual.SongSelect
 
             AddUntilStep("wait for not current", () => !songSelect.IsCurrentScreen());
             AddAssert("ensure selection didn't change", () => selected == Beatmap.Value);
-
-            AddUntilStep("wait for return to song select", () => songSelect.IsCurrentScreen());
-            AddUntilStep("bindable lease returned", () => !Beatmap.Disabled);
         }
 
         [Test]

osu.Game/Screens/Play/Player.cs

@@ -39,6 +39,8 @@ namespace osu.Game.Screens.Play
 
         public override float BackgroundParallaxAmount => 0.1f;
 
+        public override bool DisallowExternalBeatmapRulesetChanges => true;
+
         public override bool HideOverlaysOnEnter => true;
 
         public override OverlayActivation InitialOverlayActivationMode => OverlayActivation.UserTriggered;

osu.Game/Tests/Visual/PlayerTestScene.cs

@@ -33,8 +33,10 @@ namespace osu.Game.Tests.Visual
         }
 
         [SetUpSteps]
-        public virtual void SetUpSteps()
+        public override void SetUpSteps()
         {
+            base.SetUpSteps();
+
             AddStep(ruleset.RulesetInfo.Name, loadPlayer);
             AddUntilStep("player loaded", () => Player.IsLoaded && Player.Alpha == 1);
         }

osu.Game/Tests/Visual/ScreenTestScene.cs

@@ -3,6 +3,7 @@
 
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
+using osu.Framework.Testing;
 using osu.Game.Screens;
 
 namespace osu.Game.Tests.Visual
@@ -27,11 +28,24 @@ namespace osu.Game.Tests.Visual
             });
         }
 
-        protected void LoadScreen(OsuScreen screen)
+        protected void LoadScreen(OsuScreen screen) => Stack.Push(screen);
+
+        [SetUpSteps]
+        public virtual void SetUpSteps() => addExitAllScreensStep();
+
+        // pending framework update.
+        //[TearDownSteps]
+        //public void TearDownSteps() => addExitAllScreensStep();
+
+        private void addExitAllScreensStep()
         {
-            if (Stack.CurrentScreen != null)
+            AddUntilStep("exit all screens", () =>
+            {
+                if (Stack.CurrentScreen == null) return true;
+
                 Stack.Exit();
-            Stack.Push(screen);
+                return false;
+            });
         }
     }
 }