From 21d60231b6eecb087d5d10873e80aaf208115c36 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= <dach.bartlomiej@gmail.com>
Date: Mon, 20 Jun 2022 22:10:25 +0200
Subject: [PATCH] Add limited test coverage of `osu://` scheme link IPC flow

---
 .../TestSceneInterProcessCommunication.cs     | 86 +++++++++++++++++++
 osu.Game/Tests/Visual/OsuGameTestScene.cs     |  2 +-
 2 files changed, 87 insertions(+), 1 deletion(-)
 create mode 100644 osu.Game.Tests/Visual/Navigation/TestSceneInterProcessCommunication.cs

diff --git a/osu.Game.Tests/Visual/Navigation/TestSceneInterProcessCommunication.cs b/osu.Game.Tests/Visual/Navigation/TestSceneInterProcessCommunication.cs
new file mode 100644
index 0000000000..f5af077696
--- /dev/null
+++ b/osu.Game.Tests/Visual/Navigation/TestSceneInterProcessCommunication.cs
@@ -0,0 +1,86 @@
+// 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 System.Linq;
+using NUnit.Framework;
+using osu.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Extensions;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Platform;
+using osu.Framework.Testing;
+using osu.Game.IPC;
+using osu.Game.Online.API;
+using osu.Game.Online.API.Requests;
+using osu.Game.Online.API.Requests.Responses;
+using osu.Game.Overlays;
+
+namespace osu.Game.Tests.Visual.Navigation
+{
+    [TestFixture]
+    [Ignore("This test cannot be run headless, as it requires the game host running the nested game to have IPC bound.")]
+    public class TestSceneInterProcessCommunication : OsuGameTestScene
+    {
+        private HeadlessGameHost ipcSenderHost = null!;
+
+        private OsuSchemeLinkIPCChannel osuSchemeLinkIPCReceiver = null!;
+        private OsuSchemeLinkIPCChannel osuSchemeLinkIPCSender = null!;
+
+        private const int requested_beatmap_set_id = 1;
+
+        [Resolved]
+        private GameHost gameHost { get; set; } = null!;
+
+        public override void SetUpSteps()
+        {
+            base.SetUpSteps();
+            AddStep("set up request handling", () =>
+            {
+                ((DummyAPIAccess)API).HandleRequest = request =>
+                {
+                    switch (request)
+                    {
+                        case GetBeatmapSetRequest gbr:
+
+                            var apiBeatmapSet = CreateAPIBeatmapSet();
+                            apiBeatmapSet.OnlineID = requested_beatmap_set_id;
+                            apiBeatmapSet.Beatmaps = apiBeatmapSet.Beatmaps.Append(new APIBeatmap
+                            {
+                                DifficultyName = "Target difficulty",
+                                OnlineID = 75,
+                            }).ToArray();
+                            gbr.TriggerSuccess(apiBeatmapSet);
+                            return true;
+                    }
+
+                    return false;
+                };
+            });
+            AddStep("create IPC receiver channel", () => osuSchemeLinkIPCReceiver = new OsuSchemeLinkIPCChannel(gameHost, Game));
+            AddStep("create IPC sender channel", () =>
+            {
+                ipcSenderHost = new HeadlessGameHost(gameHost.Name, new HostOptions { BindIPC = true });
+                osuSchemeLinkIPCSender = new OsuSchemeLinkIPCChannel(ipcSenderHost);
+            });
+        }
+
+        [Test]
+        public void TestOsuSchemeLinkIPCChannel()
+        {
+            AddStep("open beatmap via IPC", () => osuSchemeLinkIPCSender.HandleLinkAsync($@"osu://s/{requested_beatmap_set_id}").WaitSafely());
+            AddUntilStep("beatmap overlay displayed", () => Game.ChildrenOfType<BeatmapSetOverlay>().FirstOrDefault()?.State.Value == Visibility.Visible);
+            AddUntilStep("beatmap overlay showing content", () => Game.ChildrenOfType<BeatmapSetOverlay>().FirstOrDefault()?.Header.BeatmapSet.Value.OnlineID == requested_beatmap_set_id);
+        }
+
+        public override void TearDownSteps()
+        {
+            AddStep("dispose IPC receiver", () => osuSchemeLinkIPCReceiver.Dispose());
+            AddStep("dispose IPC sender", () =>
+            {
+                osuSchemeLinkIPCReceiver.Dispose();
+                ipcSenderHost.Dispose();
+            });
+            base.TearDownSteps();
+        }
+    }
+}
diff --git a/osu.Game/Tests/Visual/OsuGameTestScene.cs b/osu.Game/Tests/Visual/OsuGameTestScene.cs
index df0bdb0a50..b9f6183869 100644
--- a/osu.Game/Tests/Visual/OsuGameTestScene.cs
+++ b/osu.Game/Tests/Visual/OsuGameTestScene.cs
@@ -75,7 +75,7 @@ namespace osu.Game.Tests.Visual
         }
 
         [TearDownSteps]
-        public void TearDownSteps()
+        public virtual void TearDownSteps()
         {
             if (DebugUtils.IsNUnitRunning && Game != null)
             {