Add filter control tests

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

@@ -1,22 +1,231 @@
 // 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;
 using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Sprites;
+using osu.Framework.Graphics.UserInterface;
+using osu.Framework.Platform;
+using osu.Framework.Testing;
+using osu.Game.Beatmaps;
+using osu.Game.Collections;
+using osu.Game.Graphics.UserInterface;
+using osu.Game.Rulesets;
 using osu.Game.Screens.Select;
+using osu.Game.Tests.Resources;
+using osuTK.Input;
 
 namespace osu.Game.Tests.Visual.SongSelect
 {
-    public class TestSceneFilterControl : OsuTestScene
+    public class TestSceneFilterControl : OsuManualInputManagerTestScene
     {
+        protected override Container<Drawable> Content => content;
+        private readonly Container content;
+
+        [Cached]
+        private readonly BeatmapCollectionManager collectionManager;
+
+        private RulesetStore rulesets;
+        private BeatmapManager beatmapManager;
+
+        private FilterControl control;
+
         public TestSceneFilterControl()
         {
-            Child = new FilterControl
+            base.Content.AddRange(new Drawable[]
+            {
+                collectionManager = new BeatmapCollectionManager(LocalStorage),
+                content = new Container { RelativeSizeAxes = Axes.Both }
+            });
+        }
+
+        protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
+        {
+            var dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
+            dependencies.Cache(collectionManager);
+            return dependencies;
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(GameHost host)
+        {
+            Dependencies.Cache(rulesets = new RulesetStore(ContextFactory));
+            Dependencies.Cache(beatmapManager = new BeatmapManager(LocalStorage, ContextFactory, rulesets, null, Audio, host, Beatmap.Default));
+
+            beatmapManager.Import(TestResources.GetTestBeatmapForImport()).Wait();
+        }
+
+        [SetUp]
+        public void SetUp() => Schedule(() =>
+        {
+            collectionManager.Collections.Clear();
+
+            Child = control = new FilterControl
             {
                 Anchor = Anchor.Centre,
                 Origin = Anchor.Centre,
                 RelativeSizeAxes = Axes.X,
                 Height = FilterControl.HEIGHT,
             };
+        });
+
+        [Test]
+        public void TestEmptyCollectionFilterContainsAllBeatmaps()
+        {
+            assertCollectionDropdownContains("All beatmaps");
+            assertCollectionHeaderDisplays("All beatmaps");
         }
+
+        [Test]
+        public void TestCollectionAddedToDropdown()
+        {
+            AddStep("add collection", () => collectionManager.Collections.Add(new BeatmapCollection { Name = { Value = "1" } }));
+            AddStep("add collection", () => collectionManager.Collections.Add(new BeatmapCollection { Name = { Value = "2" } }));
+            assertCollectionDropdownContains("1");
+            assertCollectionDropdownContains("2");
+        }
+
+        [Test]
+        public void TestCollectionRemovedFromDropdown()
+        {
+            AddStep("add collection", () => collectionManager.Collections.Add(new BeatmapCollection { Name = { Value = "1" } }));
+            AddStep("add collection", () => collectionManager.Collections.Add(new BeatmapCollection { Name = { Value = "2" } }));
+            AddStep("remove collection", () => collectionManager.Collections.RemoveAt(0));
+
+            assertCollectionDropdownContains("1", false);
+            assertCollectionDropdownContains("2");
+        }
+
+        [Test]
+        public void TestCollectionRenamed()
+        {
+            AddStep("add collection", () => collectionManager.Collections.Add(new BeatmapCollection { Name = { Value = "1" } }));
+            AddStep("select collection", () =>
+            {
+                var dropdown = control.ChildrenOfType<CollectionFilterDropdown>().Single();
+                dropdown.Current.Value = dropdown.ItemSource.ElementAt(1);
+            });
+
+            AddStep("expand header", () =>
+            {
+                InputManager.MoveMouseTo(control.ChildrenOfType<CollectionFilterDropdown.CollectionDropdownHeader>().Single());
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddStep("change name", () => collectionManager.Collections[0].Name.Value = "First");
+
+            assertCollectionDropdownContains("First");
+            assertCollectionHeaderDisplays("First");
+        }
+
+        [Test]
+        public void TestAllBeatmapFilterDoesNotHaveAddButton()
+        {
+            AddAssert("'All beatmaps' filter does not have add button", () => !getCollectionDropdownItems().First().ChildrenOfType<IconButton>().Single().IsPresent);
+        }
+
+        [Test]
+        public void TestCollectionFilterHasAddButton()
+        {
+            AddStep("expand header", () =>
+            {
+                InputManager.MoveMouseTo(control.ChildrenOfType<CollectionFilterDropdown.CollectionDropdownHeader>().Single());
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddStep("add collection", () => collectionManager.Collections.Add(new BeatmapCollection { Name = { Value = "1" } }));
+            AddAssert("collection has add button", () => !getAddOrRemoveButton(0).IsPresent);
+        }
+
+        [Test]
+        public void TestButtonDisabledAndEnabledWithBeatmapChanges()
+        {
+            AddStep("expand header", () =>
+            {
+                InputManager.MoveMouseTo(control.ChildrenOfType<CollectionFilterDropdown.CollectionDropdownHeader>().Single());
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddStep("add collection", () => collectionManager.Collections.Add(new BeatmapCollection { Name = { Value = "1" } }));
+            AddAssert("button disabled", () => !getAddOrRemoveButton(1).Enabled.Value);
+
+            AddStep("select available beatmap", () => Beatmap.Value = beatmapManager.GetWorkingBeatmap(beatmapManager.GetAllUsableBeatmapSets().First().Beatmaps[0]));
+            AddAssert("button enabled", () => getAddOrRemoveButton(1).Enabled.Value);
+
+            AddStep("set dummy beatmap", () => Beatmap.SetDefault());
+            AddAssert("button enabled", () => !getAddOrRemoveButton(1).Enabled.Value);
+        }
+
+        [Test]
+        public void TestButtonChangesWhenAddedAndRemovedFromCollection()
+        {
+            AddStep("expand header", () =>
+            {
+                InputManager.MoveMouseTo(control.ChildrenOfType<CollectionFilterDropdown.CollectionDropdownHeader>().Single());
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddStep("select available beatmap", () => Beatmap.Value = beatmapManager.GetWorkingBeatmap(beatmapManager.GetAllUsableBeatmapSets().First().Beatmaps[0]));
+
+            AddStep("add collection", () => collectionManager.Collections.Add(new BeatmapCollection { Name = { Value = "1" } }));
+            AddAssert("button is plus", () => getAddOrRemoveButton(1).Icon.Equals(FontAwesome.Regular.PlusSquare));
+
+            AddStep("add beatmap to collection", () => collectionManager.Collections[0].Beatmaps.Add(Beatmap.Value.BeatmapInfo));
+            AddAssert("button is minus", () => getAddOrRemoveButton(1).Icon.Equals(FontAwesome.Regular.MinusSquare));
+
+            AddStep("remove beatmap from collection", () => collectionManager.Collections[0].Beatmaps.Clear());
+            AddAssert("button is plus", () => getAddOrRemoveButton(1).Icon.Equals(FontAwesome.Regular.PlusSquare));
+        }
+
+        [Test]
+        public void TestButtonAddsAndRemovesBeatmap()
+        {
+            AddStep("expand header", () =>
+            {
+                InputManager.MoveMouseTo(control.ChildrenOfType<CollectionFilterDropdown.CollectionDropdownHeader>().Single());
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddStep("select available beatmap", () => Beatmap.Value = beatmapManager.GetWorkingBeatmap(beatmapManager.GetAllUsableBeatmapSets().First().Beatmaps[0]));
+
+            AddStep("add collection", () => collectionManager.Collections.Add(new BeatmapCollection { Name = { Value = "1" } }));
+            AddAssert("button is plus", () => getAddOrRemoveButton(1).Icon.Equals(FontAwesome.Regular.PlusSquare));
+
+            addClickAddOrRemoveButtonStep(1);
+            AddAssert("collection contains beatmap", () => collectionManager.Collections[0].Beatmaps.Contains(Beatmap.Value.BeatmapInfo));
+            AddAssert("button is minus", () => getAddOrRemoveButton(1).Icon.Equals(FontAwesome.Regular.MinusSquare));
+
+            addClickAddOrRemoveButtonStep(1);
+            AddAssert("collection does not contain beatmap", () => !collectionManager.Collections[0].Beatmaps.Contains(Beatmap.Value.BeatmapInfo));
+            AddAssert("button is plus", () => getAddOrRemoveButton(1).Icon.Equals(FontAwesome.Regular.PlusSquare));
+        }
+
+        private void assertCollectionHeaderDisplays(string collectionName, bool shouldDisplay = true)
+            => AddAssert($"collection dropdown header displays '{collectionName}'",
+                () => shouldDisplay == (control.ChildrenOfType<CollectionFilterDropdown.CollectionDropdownHeader>().Single().ChildrenOfType<SpriteText>().First().Text == collectionName));
+
+        private void assertCollectionDropdownContains(string collectionName, bool shouldContain = true) =>
+            AddAssert($"collection dropdown {(shouldContain ? "contains" : "does not contain")} '{collectionName}'",
+                // A bit of a roundabout way of going about this, see: https://github.com/ppy/osu-framework/issues/3871 + https://github.com/ppy/osu-framework/issues/3872
+                () => shouldContain == (getCollectionDropdownItems().Any(i => i.ChildrenOfType<FillFlowContainer>().OfType<IHasText>().First().Text == collectionName)));
+
+        private IconButton getAddOrRemoveButton(int index)
+            => getCollectionDropdownItems().ElementAt(index).ChildrenOfType<IconButton>().Single();
+
+        private void addClickAddOrRemoveButtonStep(int index)
+        {
+            AddStep("click add or remove button", () =>
+            {
+                InputManager.MoveMouseTo(getAddOrRemoveButton(index));
+                InputManager.Click(MouseButton.Left);
+            });
+        }
+
+        private IEnumerable<Dropdown<CollectionFilter>.DropdownMenu.DrawableDropdownMenuItem> getCollectionDropdownItems()
+            => control.ChildrenOfType<CollectionFilterDropdown>().Single().ChildrenOfType<Dropdown<CollectionFilter>.DropdownMenu.DrawableDropdownMenuItem>();
     }
 }

osu.Game/Screens/Select/CollectionFilterDropdown.cs

@@ -98,7 +98,7 @@ namespace osu.Game.Screens.Select
 
         protected override DropdownMenu CreateMenu() => new CollectionDropdownMenu();
 
-        private class CollectionDropdownHeader : OsuDropdownHeader
+        public class CollectionDropdownHeader : OsuDropdownHeader
         {
             public readonly Bindable<CollectionFilter> SelectedItem = new Bindable<CollectionFilter>();
             private readonly Bindable<string> collectionName = new Bindable<string>();
@@ -126,7 +126,10 @@ namespace osu.Game.Screens.Select
             private void updateBindable()
             {
                 collectionName.UnbindAll();
-                collectionName.BindTo(SelectedItem.Value.CollectionName);
+
+                if (SelectedItem.Value != null)
+                    collectionName.BindTo(SelectedItem.Value.CollectionName);
+
                 collectionName.BindValueChanged(_ => updateText(), true);
             }
 
@@ -174,17 +177,14 @@ namespace osu.Game.Screens.Select
             [BackgroundDependencyLoader]
             private void load()
             {
-                AddRangeInternal(new Drawable[]
+                AddInternal(addOrRemoveButton = new IconButton
                 {
-                    addOrRemoveButton = new IconButton
+                    Anchor = Anchor.CentreRight,
-                    {
+                    Origin = Anchor.CentreRight,
-                        Anchor = Anchor.CentreRight,
+                    X = -OsuScrollContainer.SCROLL_BAR_HEIGHT,
-                        Origin = Anchor.CentreRight,
+                    Scale = new Vector2(0.75f),
-                        X = -OsuScrollContainer.SCROLL_BAR_HEIGHT,
+                    Alpha = collectionBeatmaps == null ? 0 : 1,
-                        Scale = new Vector2(0.75f),
+                    Action = addOrRemove
-                        Alpha = collectionBeatmaps == null ? 0 : 1,
-                        Action = addOrRemove
-                    }
                 });
             }
 
@@ -211,12 +211,12 @@ namespace osu.Game.Screens.Select
 
                 if (collectionBeatmaps.Contains(beatmap.Value.BeatmapInfo))
                 {
-                    addOrRemoveButton.Icon = FontAwesome.Solid.MinusSquare;
+                    addOrRemoveButton.Icon = FontAwesome.Regular.MinusSquare;
                     addOrRemoveButton.IconColour = colours.Red;
                 }
                 else
                 {
-                    addOrRemoveButton.Icon = FontAwesome.Solid.PlusSquare;
+                    addOrRemoveButton.Icon = FontAwesome.Regular.PlusSquare;
                     addOrRemoveButton.IconColour = colours.Green;
                 }
             }