From 15ce7bacf1fcc319916f9365643f5ef1e73f26d6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= <dach.bartlomiej@gmail.com>
Date: Sat, 5 Dec 2020 14:12:15 +0100
Subject: [PATCH] Add test coverage for confine functionality

Due to growing levels of complexity around confine logic.
---
 .../Input/ConfineMouseTrackerTest.cs          | 114 ++++++++++++++++++
 1 file changed, 114 insertions(+)
 create mode 100644 osu.Game.Tests/Input/ConfineMouseTrackerTest.cs

diff --git a/osu.Game.Tests/Input/ConfineMouseTrackerTest.cs b/osu.Game.Tests/Input/ConfineMouseTrackerTest.cs
new file mode 100644
index 0000000000..42f5209643
--- /dev/null
+++ b/osu.Game.Tests/Input/ConfineMouseTrackerTest.cs
@@ -0,0 +1,114 @@
+// 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 NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Configuration;
+using osu.Framework.Input;
+using osu.Framework.Testing;
+using osu.Game.Configuration;
+using osu.Game.Input;
+using osu.Game.Tests.Visual.Navigation;
+
+namespace osu.Game.Tests.Input
+{
+    [HeadlessTest]
+    public class ConfineMouseTrackerTest : OsuGameTestScene
+    {
+        [Resolved]
+        private FrameworkConfigManager frameworkConfigManager { get; set; }
+
+        [Resolved]
+        private OsuConfigManager osuConfigManager { get; set; }
+
+        [TestCase(WindowMode.Windowed)]
+        [TestCase(WindowMode.Borderless)]
+        public void TestDisableConfining(WindowMode windowMode)
+        {
+            setWindowModeTo(windowMode);
+            setGameSideModeTo(OsuConfineMouseMode.Never);
+
+            gameSideConfineModeDisabled(false);
+
+            setLocalUserPlayingTo(false);
+            frameworkSideModeIs(ConfineMouseMode.Never);
+
+            setLocalUserPlayingTo(true);
+            frameworkSideModeIs(ConfineMouseMode.Never);
+        }
+
+        [TestCase(WindowMode.Windowed)]
+        [TestCase(WindowMode.Borderless)]
+        public void TestConfiningDuringGameplay(WindowMode windowMode)
+        {
+            setWindowModeTo(windowMode);
+            setGameSideModeTo(OsuConfineMouseMode.DuringGameplay);
+
+            gameSideConfineModeDisabled(false);
+
+            setLocalUserPlayingTo(false);
+            frameworkSideModeIs(ConfineMouseMode.Never);
+
+            setLocalUserPlayingTo(true);
+            frameworkSideModeIs(ConfineMouseMode.Always);
+        }
+
+        [TestCase(WindowMode.Windowed)]
+        [TestCase(WindowMode.Borderless)]
+        public void TestConfineAlwaysUserSetting(WindowMode windowMode)
+        {
+            setWindowModeTo(windowMode);
+            setGameSideModeTo(OsuConfineMouseMode.Always);
+
+            gameSideConfineModeDisabled(false);
+
+            setLocalUserPlayingTo(false);
+            frameworkSideModeIs(ConfineMouseMode.Always);
+
+            setLocalUserPlayingTo(true);
+            frameworkSideModeIs(ConfineMouseMode.Always);
+        }
+
+        [Test]
+        public void TestConfineAlwaysInFullscreen()
+        {
+            setGameSideModeTo(OsuConfineMouseMode.Never);
+
+            setWindowModeTo(WindowMode.Fullscreen);
+            gameSideConfineModeDisabled(true);
+
+            setLocalUserPlayingTo(false);
+            frameworkSideModeIs(ConfineMouseMode.Always);
+
+            setLocalUserPlayingTo(true);
+            frameworkSideModeIs(ConfineMouseMode.Always);
+
+            setWindowModeTo(WindowMode.Windowed);
+
+            // old state is restored
+            gameSideModeIs(OsuConfineMouseMode.Never);
+            frameworkSideModeIs(ConfineMouseMode.Never);
+            gameSideConfineModeDisabled(false);
+        }
+
+        private void setWindowModeTo(WindowMode mode)
+            // needs to go through .GetBindable().Value instead of .Set() due to default overrides
+            => AddStep($"make window {mode}", () => frameworkConfigManager.GetBindable<WindowMode>(FrameworkSetting.WindowMode).Value = mode);
+
+        private void setGameSideModeTo(OsuConfineMouseMode mode)
+            => AddStep($"set {mode} game-side", () => Game.LocalConfig.Set(OsuSetting.ConfineMouseMode, mode));
+
+        private void setLocalUserPlayingTo(bool playing)
+            => AddStep($"local user {(playing ? "playing" : "not playing")}", () => Game.LocalUserPlaying.Value = playing);
+
+        private void gameSideModeIs(OsuConfineMouseMode mode)
+            => AddAssert($"mode is {mode} game-side", () => Game.LocalConfig.Get<OsuConfineMouseMode>(OsuSetting.ConfineMouseMode) == mode);
+
+        private void frameworkSideModeIs(ConfineMouseMode mode)
+            => AddAssert($"mode is {mode} framework-side", () => frameworkConfigManager.Get<ConfineMouseMode>(FrameworkSetting.ConfineMouseMode) == mode);
+
+        private void gameSideConfineModeDisabled(bool disabled)
+            => AddAssert($"game-side confine mode {(disabled ? "disabled" : "enabled")}",
+                () => Game.LocalConfig.GetBindable<OsuConfineMouseMode>(OsuSetting.ConfineMouseMode).Disabled == disabled);
+    }
+}