From 32a9c066dfd2a02c0cc40f5554417ab5bd8e8c97 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Wed, 22 Feb 2023 18:17:03 +0900
Subject: [PATCH] Add test coverage of bring-to-front / send-to-back operations

---
 .../Visual/Gameplay/TestSceneSkinEditor.cs    | 51 ++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)

diff --git a/osu.Game.Tests/Visual/Gameplay/TestSceneSkinEditor.cs b/osu.Game.Tests/Visual/Gameplay/TestSceneSkinEditor.cs
index 83609b9ae7..9690d00d4c 100644
--- a/osu.Game.Tests/Visual/Gameplay/TestSceneSkinEditor.cs
+++ b/osu.Game.Tests/Visual/Gameplay/TestSceneSkinEditor.cs
@@ -1,6 +1,7 @@
 // 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.Collections.Generic;
 using System.Linq;
 using NUnit.Framework;
 using osu.Framework.Allocation;
@@ -32,12 +33,14 @@ namespace osu.Game.Tests.Visual.Gameplay
         [Cached]
         public readonly EditorClipboard Clipboard = new EditorClipboard();
 
+        private SkinComponentsContainer targetContainer => Player.ChildrenOfType<SkinComponentsContainer>().First();
+
         [SetUpSteps]
         public override void SetUpSteps()
         {
             base.SetUpSteps();
 
-            AddUntilStep("wait for hud load", () => Player.ChildrenOfType<SkinComponentsContainer>().All(c => c.ComponentsLoaded));
+            AddUntilStep("wait for hud load", () => targetContainer.ComponentsLoaded);
 
             AddStep("reload skin editor", () =>
             {
@@ -49,6 +52,52 @@ namespace osu.Game.Tests.Visual.Gameplay
             AddUntilStep("wait for loaded", () => skinEditor.IsLoaded);
         }
 
+        [TestCase(false)]
+        [TestCase(true)]
+        public void TestBringToFront(bool alterSelectionOrder)
+        {
+            AddAssert("Ensure over three components available", () => targetContainer.Components.Count, () => Is.GreaterThan(3));
+
+            IEnumerable<ISerialisableDrawable> originalOrder = null!;
+
+            AddStep("Save order of components before operation", () => originalOrder = targetContainer.Components.Take(3).ToArray());
+
+            if (alterSelectionOrder)
+                AddStep("Select first three components in reverse order", () => skinEditor.SelectedComponents.AddRange(originalOrder.Reverse()));
+            else
+                AddStep("Select first three components", () => skinEditor.SelectedComponents.AddRange(originalOrder));
+
+            AddAssert("Components are not front-most", () => targetContainer.Components.TakeLast(3).ToArray(), () => Is.Not.EqualTo(skinEditor.SelectedComponents));
+
+            AddStep("Bring to front", () => skinEditor.BringSelectionToFront());
+            AddAssert("Ensure components are now front-most in original order", () => targetContainer.Components.TakeLast(3).ToArray(), () => Is.EqualTo(originalOrder));
+            AddStep("Bring to front again", () => skinEditor.BringSelectionToFront());
+            AddAssert("Ensure components are still front-most in original order", () => targetContainer.Components.TakeLast(3).ToArray(), () => Is.EqualTo(originalOrder));
+        }
+
+        [TestCase(false)]
+        [TestCase(true)]
+        public void TestSendToBack(bool alterSelectionOrder)
+        {
+            AddAssert("Ensure over three components available", () => targetContainer.Components.Count, () => Is.GreaterThan(3));
+
+            IEnumerable<ISerialisableDrawable> originalOrder = null!;
+
+            AddStep("Save order of components before operation", () => originalOrder = targetContainer.Components.TakeLast(3).ToArray());
+
+            if (alterSelectionOrder)
+                AddStep("Select last three components in reverse order", () => skinEditor.SelectedComponents.AddRange(originalOrder.Reverse()));
+            else
+                AddStep("Select last three components", () => skinEditor.SelectedComponents.AddRange(originalOrder));
+
+            AddAssert("Components are not back-most", () => targetContainer.Components.Take(3).ToArray(), () => Is.Not.EqualTo(skinEditor.SelectedComponents));
+
+            AddStep("Send to back", () => skinEditor.SendSelectionToBack());
+            AddAssert("Ensure components are now back-most in original order", () => targetContainer.Components.Take(3).ToArray(), () => Is.EqualTo(originalOrder));
+            AddStep("Send to back again", () => skinEditor.SendSelectionToBack());
+            AddAssert("Ensure components are still back-most in original order", () => targetContainer.Components.Take(3).ToArray(), () => Is.EqualTo(originalOrder));
+        }
+
         [Test]
         public void TestToggleEditor()
         {