Merge remote-tracking branch 'refs/remotes/ppy/master' into overlay-header-refactor

osu.Game.Rulesets.Catch.Tests/TestSceneLegacyBeatmapSkin.cs

@@ -0,0 +1,151 @@
+// 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.Allocation;
+using osu.Framework.Audio;
+using osu.Framework.Testing;
+using osu.Game.Beatmaps;
+using osu.Game.Configuration;
+using osu.Game.Rulesets.Catch.Objects;
+using osu.Game.Rulesets.Catch.Skinning;
+using osu.Game.Skinning;
+using osu.Game.Tests.Beatmaps;
+using osuTK.Graphics;
+
+namespace osu.Game.Rulesets.Catch.Tests
+{
+    public class TestSceneLegacyBeatmapSkin : LegacyBeatmapSkinColourTest
+    {
+        [Resolved]
+        private AudioManager audio { get; set; }
+
+        [BackgroundDependencyLoader]
+        private void load(OsuConfigManager config)
+        {
+            config.BindWith(OsuSetting.BeatmapSkins, BeatmapSkins);
+            config.BindWith(OsuSetting.BeatmapColours, BeatmapColours);
+        }
+
+        [TestCase(true, true)]
+        [TestCase(true, false)]
+        [TestCase(false, true)]
+        [TestCase(false, false)]
+        public override void TestBeatmapComboColours(bool userHasCustomColours, bool useBeatmapSkin)
+        {
+            TestBeatmap = new CatchCustomSkinWorkingBeatmap(audio, true);
+            base.TestBeatmapComboColours(userHasCustomColours, useBeatmapSkin);
+            AddAssert("is beatmap skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(TestBeatmapSkin.Colours));
+        }
+
+        [TestCase(true)]
+        [TestCase(false)]
+        public override void TestBeatmapComboColoursOverride(bool useBeatmapSkin)
+        {
+            TestBeatmap = new CatchCustomSkinWorkingBeatmap(audio, true);
+            base.TestBeatmapComboColoursOverride(useBeatmapSkin);
+            AddAssert("is user custom skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(TestSkin.Colours));
+        }
+
+        [TestCase(true)]
+        [TestCase(false)]
+        public override void TestBeatmapComboColoursOverrideWithDefaultColours(bool useBeatmapSkin)
+        {
+            TestBeatmap = new CatchCustomSkinWorkingBeatmap(audio, true);
+            base.TestBeatmapComboColoursOverrideWithDefaultColours(useBeatmapSkin);
+            AddAssert("is default user skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(SkinConfiguration.DefaultComboColours));
+        }
+
+        [TestCase(true, true)]
+        [TestCase(false, true)]
+        [TestCase(true, false)]
+        [TestCase(false, false)]
+        public override void TestBeatmapNoComboColours(bool useBeatmapSkin, bool useBeatmapColour)
+        {
+            TestBeatmap = new CatchCustomSkinWorkingBeatmap(audio, false);
+            base.TestBeatmapNoComboColours(useBeatmapSkin, useBeatmapColour);
+            AddAssert("is default user skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(SkinConfiguration.DefaultComboColours));
+        }
+
+        [TestCase(true, true)]
+        [TestCase(false, true)]
+        [TestCase(true, false)]
+        [TestCase(false, false)]
+        public override void TestBeatmapNoComboColoursSkinOverride(bool useBeatmapSkin, bool useBeatmapColour)
+        {
+            TestBeatmap = new CatchCustomSkinWorkingBeatmap(audio, false);
+            base.TestBeatmapNoComboColoursSkinOverride(useBeatmapSkin, useBeatmapColour);
+            AddAssert("is custom user skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(TestSkin.Colours));
+        }
+
+        [TestCase(true)]
+        [TestCase(false)]
+        public void TestBeatmapHyperDashColours(bool useBeatmapSkin)
+        {
+            TestBeatmap = new CatchCustomSkinWorkingBeatmap(audio, true);
+            ConfigureTest(useBeatmapSkin, true, true);
+            AddAssert("is custom hyper dash colours", () => ((CatchExposedPlayer)TestPlayer).UsableHyperDashColour == TestBeatmapSkin.HYPER_DASH_COLOUR);
+            AddAssert("is custom hyper dash after image colours", () => ((CatchExposedPlayer)TestPlayer).UsableHyperDashAfterImageColour == TestBeatmapSkin.HYPER_DASH_AFTER_IMAGE_COLOUR);
+            AddAssert("is custom hyper dash fruit colours", () => ((CatchExposedPlayer)TestPlayer).UsableHyperDashFruitColour == TestBeatmapSkin.HYPER_DASH_FRUIT_COLOUR);
+        }
+
+        [TestCase(true)]
+        [TestCase(false)]
+        public void TestBeatmapHyperDashColoursOverride(bool useBeatmapSkin)
+        {
+            TestBeatmap = new CatchCustomSkinWorkingBeatmap(audio, true);
+            ConfigureTest(useBeatmapSkin, false, true);
+            AddAssert("is custom hyper dash colours", () => ((CatchExposedPlayer)TestPlayer).UsableHyperDashColour == TestSkin.HYPER_DASH_COLOUR);
+            AddAssert("is custom hyper dash after image colours", () => ((CatchExposedPlayer)TestPlayer).UsableHyperDashAfterImageColour == TestSkin.HYPER_DASH_AFTER_IMAGE_COLOUR);
+            AddAssert("is custom hyper dash fruit colours", () => ((CatchExposedPlayer)TestPlayer).UsableHyperDashFruitColour == TestSkin.HYPER_DASH_FRUIT_COLOUR);
+        }
+
+        protected override ExposedPlayer CreateTestPlayer(bool userHasCustomColours) => new CatchExposedPlayer(userHasCustomColours);
+
+        private class CatchExposedPlayer : ExposedPlayer
+        {
+            public CatchExposedPlayer(bool userHasCustomColours)
+                : base(userHasCustomColours)
+            {
+            }
+
+            public Color4 UsableHyperDashColour =>
+                GameplayClockContainer.ChildrenOfType<BeatmapSkinProvidingContainer>()
+                                      .First()
+                                      .GetConfig<SkinCustomColourLookup, Color4>(new SkinCustomColourLookup(CatchSkinColour.HyperDash))?
+                                      .Value ?? Color4.Red;
+
+            public Color4 UsableHyperDashAfterImageColour =>
+                GameplayClockContainer.ChildrenOfType<BeatmapSkinProvidingContainer>()
+                                      .First()
+                                      .GetConfig<SkinCustomColourLookup, Color4>(new SkinCustomColourLookup(CatchSkinColour.HyperDashAfterImage))?
+                                      .Value ?? Color4.Red;
+
+            public Color4 UsableHyperDashFruitColour =>
+                GameplayClockContainer.ChildrenOfType<BeatmapSkinProvidingContainer>()
+                                      .First()
+                                      .GetConfig<SkinCustomColourLookup, Color4>(new SkinCustomColourLookup(CatchSkinColour.HyperDashFruit))?
+                                      .Value ?? Color4.Red;
+        }
+
+        private class CatchCustomSkinWorkingBeatmap : CustomSkinWorkingBeatmap
+        {
+            public CatchCustomSkinWorkingBeatmap(AudioManager audio, bool hasColours)
+                : base(createBeatmap(), audio, hasColours)
+            {
+            }
+
+            private static IBeatmap createBeatmap() =>
+                new Beatmap
+                {
+                    BeatmapInfo =
+                    {
+                        BeatmapSet = new BeatmapSetInfo(),
+                        Ruleset = new CatchRuleset().RulesetInfo
+                    },
+                    HitObjects = { new Fruit { StartTime = 1816, X = 56, NewCombo = true } }
+                };
+        }
+    }
+}

osu.Game.Rulesets.Osu.Tests/TestSceneLegacyBeatmapSkin.cs

@@ -1,107 +1,91 @@
 // 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;
-using System.Collections.Generic;
 using System.Linq;
 using NUnit.Framework;
 using osu.Framework.Allocation;
 using osu.Framework.Audio;
-using osu.Framework.IO.Stores;
-using osu.Framework.Testing;
 using osu.Game.Beatmaps;
+using osu.Game.Configuration;
 using osu.Game.Rulesets.Osu.Objects;
-using osu.Game.Screens.Play;
 using osu.Game.Skinning;
-using osu.Game.Tests.Visual;
+using osu.Game.Tests.Beatmaps;
 using osuTK;
-using osuTK.Graphics;
 
 namespace osu.Game.Rulesets.Osu.Tests
 {
-    public class TestSceneLegacyBeatmapSkin : ScreenTestScene
+    public class TestSceneLegacyBeatmapSkin : LegacyBeatmapSkinColourTest
     {
         [Resolved]
         private AudioManager audio { get; set; }
 
+        [BackgroundDependencyLoader]
+        private void load(OsuConfigManager config)
+        {
+            config.BindWith(OsuSetting.BeatmapSkins, BeatmapSkins);
+            config.BindWith(OsuSetting.BeatmapColours, BeatmapColours);
+        }
+
+        [TestCase(true, true)]
+        [TestCase(true, false)]
+        [TestCase(false, true)]
+        [TestCase(false, false)]
+        public override void TestBeatmapComboColours(bool userHasCustomColours, bool useBeatmapSkin)
+        {
+            TestBeatmap = new OsuCustomSkinWorkingBeatmap(audio, true);
+            base.TestBeatmapComboColours(userHasCustomColours, useBeatmapSkin);
+            AddAssert("is beatmap skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(TestBeatmapSkin.Colours));
+        }
+
         [TestCase(true)]
         [TestCase(false)]
-        public void TestBeatmapComboColours(bool customSkinColoursPresent)
+        public override void TestBeatmapComboColoursOverride(bool useBeatmapSkin)
         {
-            ExposedPlayer player = null;
+            TestBeatmap = new OsuCustomSkinWorkingBeatmap(audio, true);
-
+            base.TestBeatmapComboColoursOverride(useBeatmapSkin);
-            AddStep("load coloured beatmap", () => player = loadBeatmap(customSkinColoursPresent, true));
+            AddAssert("is user custom skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(TestSkin.Colours));
-            AddUntilStep("wait for player", () => player.IsLoaded);
-
-            AddAssert("is beatmap skin colours", () => player.UsableComboColours.SequenceEqual(TestBeatmapSkin.Colours));
         }
 
-        [Test]
+        [TestCase(true)]
-        public void TestBeatmapNoComboColours()
+        [TestCase(false)]
+        public override void TestBeatmapComboColoursOverrideWithDefaultColours(bool useBeatmapSkin)
         {
-            ExposedPlayer player = null;
+            TestBeatmap = new OsuCustomSkinWorkingBeatmap(audio, true);
-
+            base.TestBeatmapComboColoursOverrideWithDefaultColours(useBeatmapSkin);
-            AddStep("load no-colour beatmap", () => player = loadBeatmap(false, false));
+            AddAssert("is default user skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(SkinConfiguration.DefaultComboColours));
-            AddUntilStep("wait for player", () => player.IsLoaded);
-
-            AddAssert("is default user skin colours", () => player.UsableComboColours.SequenceEqual(SkinConfiguration.DefaultComboColours));
         }
 
-        [Test]
+        [TestCase(true, true)]
-        public void TestBeatmapNoComboColoursSkinOverride()
+        [TestCase(false, true)]
+        [TestCase(true, false)]
+        [TestCase(false, false)]
+        public override void TestBeatmapNoComboColours(bool useBeatmapSkin, bool useBeatmapColour)
         {
-            ExposedPlayer player = null;
+            TestBeatmap = new OsuCustomSkinWorkingBeatmap(audio, false);
-
+            base.TestBeatmapNoComboColours(useBeatmapSkin, useBeatmapColour);
-            AddStep("load custom-skin colour", () => player = loadBeatmap(true, false));
+            AddAssert("is default user skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(SkinConfiguration.DefaultComboColours));
-            AddUntilStep("wait for player", () => player.IsLoaded);
-
-            AddAssert("is custom user skin colours", () => player.UsableComboColours.SequenceEqual(TestSkin.Colours));
         }
 
-        private ExposedPlayer loadBeatmap(bool userHasCustomColours, bool beatmapHasColours)
+        [TestCase(true, true)]
+        [TestCase(false, true)]
+        [TestCase(true, false)]
+        [TestCase(false, false)]
+        public override void TestBeatmapNoComboColoursSkinOverride(bool useBeatmapSkin, bool useBeatmapColour)
         {
-            ExposedPlayer player;
+            TestBeatmap = new OsuCustomSkinWorkingBeatmap(audio, false);
-
+            base.TestBeatmapNoComboColoursSkinOverride(useBeatmapSkin, useBeatmapColour);
-            Beatmap.Value = new CustomSkinWorkingBeatmap(audio, beatmapHasColours);
+            AddAssert("is custom user skin colours", () => TestPlayer.UsableComboColours.SequenceEqual(TestSkin.Colours));
-
-            LoadScreen(player = new ExposedPlayer(userHasCustomColours));
-
-            return player;
         }
 
-        private class ExposedPlayer : Player
+        private class OsuCustomSkinWorkingBeatmap : CustomSkinWorkingBeatmap
         {
-            private readonly bool userHasCustomColours;
+            public OsuCustomSkinWorkingBeatmap(AudioManager audio, bool hasColours)
-
+                : base(createBeatmap(), audio, hasColours)
-            public ExposedPlayer(bool userHasCustomColours)
-                : base(new PlayerConfiguration
-                {
-                    AllowPause = false,
-                    ShowResults = false,
-                })
             {
-                this.userHasCustomColours = userHasCustomColours;
             }
 
-            protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
+            private static IBeatmap createBeatmap() =>
-            {
+                new Beatmap
-                var dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
-                dependencies.CacheAs<ISkinSource>(new TestSkin(userHasCustomColours));
-                return dependencies;
-            }
-
-            public IReadOnlyList<Color4> UsableComboColours =>
-                GameplayClockContainer.ChildrenOfType<BeatmapSkinProvidingContainer>()
-                                      .First()
-                                      .GetConfig<GlobalSkinColours, IReadOnlyList<Color4>>(GlobalSkinColours.ComboColours)?.Value;
-        }
-
-        private class CustomSkinWorkingBeatmap : ClockBackedTestWorkingBeatmap
-        {
-            private readonly bool hasColours;
-
-            public CustomSkinWorkingBeatmap(AudioManager audio, bool hasColours)
-                : base(new Beatmap
                 {
                     BeatmapInfo =
                     {
@@ -109,50 +93,7 @@ namespace osu.Game.Rulesets.Osu.Tests
                         Ruleset = new OsuRuleset().RulesetInfo,
                     },
                     HitObjects = { new HitCircle { Position = new Vector2(256, 192) } }
-                }, null, null, audio)
+                };
-            {
-                this.hasColours = hasColours;
-            }
-
-            protected override ISkin GetSkin() => new TestBeatmapSkin(BeatmapInfo, hasColours);
-        }
-
-        private class TestBeatmapSkin : LegacyBeatmapSkin
-        {
-            public static Color4[] Colours { get; } =
-            {
-                new Color4(50, 100, 150, 255),
-                new Color4(40, 80, 120, 255),
-            };
-
-            public TestBeatmapSkin(BeatmapInfo beatmap, bool hasColours)
-                : base(beatmap, new ResourceStore<byte[]>(), null)
-            {
-                if (hasColours)
-                    Configuration.AddComboColours(Colours);
-            }
-        }
-
-        private class TestSkin : LegacySkin, ISkinSource
-        {
-            public static Color4[] Colours { get; } =
-            {
-                new Color4(150, 100, 50, 255),
-                new Color4(20, 20, 20, 255),
-            };
-
-            public TestSkin(bool hasCustomColours)
-                : base(new SkinInfo(), null, null, string.Empty)
-            {
-                if (hasCustomColours)
-                    Configuration.AddComboColours(Colours);
-            }
-
-            public event Action SourceChanged
-            {
-                add { }
-                remove { }
-            }
         }
     }
 }

osu.Game.Rulesets.Osu.Tests/TestSceneSkinFallbacks.cs

@@ -52,6 +52,31 @@ namespace osu.Game.Rulesets.Osu.Tests
             checkNextHitObject(null);
         }
 
+        [Test]
+        public void TestBeatmapColourDefault()
+        {
+            AddStep("enable user provider", () => testUserSkin.Enabled = true);
+
+            AddStep("enable beatmap skin", () => LocalConfig.Set<bool>(OsuSetting.BeatmapSkins, true));
+            AddStep("enable beatmap colours", () => LocalConfig.Set<bool>(OsuSetting.BeatmapColours, true));
+            checkNextHitObject("beatmap");
+
+            AddStep("enable beatmap skin", () => LocalConfig.Set<bool>(OsuSetting.BeatmapSkins, true));
+            AddStep("disable beatmap colours", () => LocalConfig.Set<bool>(OsuSetting.BeatmapColours, false));
+            checkNextHitObject("beatmap");
+
+            AddStep("disable beatmap skin", () => LocalConfig.Set<bool>(OsuSetting.BeatmapSkins, false));
+            AddStep("enable beatmap colours", () => LocalConfig.Set<bool>(OsuSetting.BeatmapColours, true));
+            checkNextHitObject("user");
+
+            AddStep("disable beatmap skin", () => LocalConfig.Set<bool>(OsuSetting.BeatmapSkins, false));
+            AddStep("disable beatmap colours", () => LocalConfig.Set<bool>(OsuSetting.BeatmapColours, false));
+            checkNextHitObject("user");
+
+            AddStep("disable user provider", () => testUserSkin.Enabled = false);
+            checkNextHitObject(null);
+        }
+
         private void checkNextHitObject(string skin) =>
             AddUntilStep($"check skin from {skin}", () =>
             {

osu.Game/Configuration/OsuConfigManager.cs

@@ -84,6 +84,7 @@ namespace osu.Game.Configuration
 
             Set(OsuSetting.ShowStoryboard, true);
             Set(OsuSetting.BeatmapSkins, true);
+            Set(OsuSetting.BeatmapColours, true);
             Set(OsuSetting.BeatmapHitsounds, true);
 
             Set(OsuSetting.CursorRotation, true);
@@ -252,6 +253,7 @@ namespace osu.Game.Configuration
         ScreenshotCaptureMenuCursor,
         SongSelectRightMouseScroll,
         BeatmapSkins,
+        BeatmapColours,
         BeatmapHitsounds,
         IncreaseFirstObjectVisibility,
         ScoreDisplayMode,

osu.Game/Overlays/Settings/Sections/SkinSection.cs

@@ -70,6 +70,11 @@ namespace osu.Game.Overlays.Settings.Sections
                     Current = config.GetBindable<bool>(OsuSetting.BeatmapSkins)
                 },
                 new SettingsCheckbox
+                {
+                    LabelText = "Beatmap colours",
+                    Current = config.GetBindable<bool>(OsuSetting.BeatmapColours)
+                },
+                new SettingsCheckbox
                 {
                     LabelText = "Beatmap hitsounds",
                     Current = config.GetBindable<bool>(OsuSetting.BeatmapHitsounds)

osu.Game/Screens/Play/PlayerSettings/VisualSettings.cs

@@ -14,6 +14,7 @@ namespace osu.Game.Screens.Play.PlayerSettings
         private readonly PlayerSliderBar<double> blurSliderBar;
         private readonly PlayerCheckbox showStoryboardToggle;
         private readonly PlayerCheckbox beatmapSkinsToggle;
+        private readonly PlayerCheckbox beatmapColorsToggle;
         private readonly PlayerCheckbox beatmapHitsoundsToggle;
 
         public VisualSettings()
@@ -43,6 +44,7 @@ namespace osu.Game.Screens.Play.PlayerSettings
                 },
                 showStoryboardToggle = new PlayerCheckbox { LabelText = "Storyboard / Video" },
                 beatmapSkinsToggle = new PlayerCheckbox { LabelText = "Beatmap skins" },
+                beatmapColorsToggle = new PlayerCheckbox { LabelText = "Beatmap colours" },
                 beatmapHitsoundsToggle = new PlayerCheckbox { LabelText = "Beatmap hitsounds" }
             };
         }
@@ -54,6 +56,7 @@ namespace osu.Game.Screens.Play.PlayerSettings
             blurSliderBar.Current = config.GetBindable<double>(OsuSetting.BlurLevel);
             showStoryboardToggle.Current = config.GetBindable<bool>(OsuSetting.ShowStoryboard);
             beatmapSkinsToggle.Current = config.GetBindable<bool>(OsuSetting.BeatmapSkins);
+            beatmapColorsToggle.Current = config.GetBindable<bool>(OsuSetting.BeatmapColours);
             beatmapHitsoundsToggle.Current = config.GetBindable<bool>(OsuSetting.BeatmapHitsounds);
         }
     }

osu.Game/Skinning/BeatmapSkinProvidingContainer.cs

@@ -15,6 +15,7 @@ namespace osu.Game.Skinning
     public class BeatmapSkinProvidingContainer : SkinProvidingContainer
     {
         private Bindable<bool> beatmapSkins;
+        private Bindable<bool> beatmapColours;
         private Bindable<bool> beatmapHitsounds;
 
         protected override bool AllowConfigurationLookup
@@ -28,6 +29,17 @@ namespace osu.Game.Skinning
             }
         }
 
+        protected override bool AllowColourLookup
+        {
+            get
+            {
+                if (beatmapColours == null)
+                    throw new InvalidOperationException($"{nameof(BeatmapSkinProvidingContainer)} needs to be loaded before being consumed.");
+
+                return beatmapColours.Value;
+            }
+        }
+
         protected override bool AllowDrawableLookup(ISkinComponent component)
         {
             if (beatmapSkins == null)
@@ -62,6 +74,7 @@ namespace osu.Game.Skinning
             var config = parent.Get<OsuConfigManager>();
 
             beatmapSkins = config.GetBindable<bool>(OsuSetting.BeatmapSkins);
+            beatmapColours = config.GetBindable<bool>(OsuSetting.BeatmapColours);
             beatmapHitsounds = config.GetBindable<bool>(OsuSetting.BeatmapHitsounds);
 
             return base.CreateChildDependencies(parent);
@@ -71,6 +84,7 @@ namespace osu.Game.Skinning
         private void load()
         {
             beatmapSkins.BindValueChanged(_ => TriggerSourceChanged());
+            beatmapColours.BindValueChanged(_ => TriggerSourceChanged());
             beatmapHitsounds.BindValueChanged(_ => TriggerSourceChanged());
         }
     }

osu.Game/Skinning/SkinProvidingContainer.cs

@@ -32,6 +32,8 @@ namespace osu.Game.Skinning
 
         protected virtual bool AllowConfigurationLookup => true;
 
+        protected virtual bool AllowColourLookup => true;
+
         public SkinProvidingContainer(ISkin skin)
         {
             this.skin = skin;
@@ -68,7 +70,20 @@ namespace osu.Game.Skinning
 
         public IBindable<TValue> GetConfig<TLookup, TValue>(TLookup lookup)
         {
-            if (AllowConfigurationLookup && skin != null)
+            if (skin != null)
+            {
+                if (lookup is GlobalSkinColours || lookup is SkinCustomColourLookup)
+                    return lookupWithFallback<TLookup, TValue>(lookup, AllowColourLookup);
+
+                return lookupWithFallback<TLookup, TValue>(lookup, AllowConfigurationLookup);
+            }
+
+            return fallbackSource?.GetConfig<TLookup, TValue>(lookup);
+        }
+
+        private IBindable<TValue> lookupWithFallback<TLookup, TValue>(TLookup lookup, bool canUseSkinLookup)
+        {
+            if (canUseSkinLookup)
             {
                 var bindable = skin.GetConfig<TLookup, TValue>(lookup);
                 if (bindable != null)

osu.Game/Tests/Beatmaps/LegacyBeatmapSkinColourTest.cs

@@ -0,0 +1,169 @@
+// 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;
+using System.Collections.Generic;
+using System.Linq;
+using osu.Framework.Allocation;
+using osu.Framework.Audio;
+using osu.Framework.Bindables;
+using osu.Framework.IO.Stores;
+using osu.Framework.Testing;
+using osu.Game.Beatmaps;
+using osu.Game.Screens.Play;
+using osu.Game.Skinning;
+using osu.Game.Tests.Visual;
+using osuTK.Graphics;
+
+namespace osu.Game.Tests.Beatmaps
+{
+    public class LegacyBeatmapSkinColourTest : ScreenTestScene
+    {
+        protected readonly Bindable<bool> BeatmapSkins = new Bindable<bool>();
+        protected readonly Bindable<bool> BeatmapColours = new Bindable<bool>();
+        protected ExposedPlayer TestPlayer;
+        protected WorkingBeatmap TestBeatmap;
+
+        public virtual void TestBeatmapComboColours(bool userHasCustomColours, bool useBeatmapSkin) => ConfigureTest(useBeatmapSkin, true, userHasCustomColours);
+
+        public virtual void TestBeatmapComboColoursOverride(bool useBeatmapSkin) => ConfigureTest(useBeatmapSkin, false, true);
+
+        public virtual void TestBeatmapComboColoursOverrideWithDefaultColours(bool useBeatmapSkin) => ConfigureTest(useBeatmapSkin, false, false);
+
+        public virtual void TestBeatmapNoComboColours(bool useBeatmapSkin, bool useBeatmapColour) => ConfigureTest(useBeatmapSkin, useBeatmapColour, false);
+
+        public virtual void TestBeatmapNoComboColoursSkinOverride(bool useBeatmapSkin, bool useBeatmapColour) => ConfigureTest(useBeatmapSkin, useBeatmapColour, true);
+
+        protected virtual void ConfigureTest(bool useBeatmapSkin, bool useBeatmapColours, bool userHasCustomColours)
+        {
+            configureSettings(useBeatmapSkin, useBeatmapColours);
+            AddStep($"load {(((CustomSkinWorkingBeatmap)TestBeatmap).HasColours ? "coloured " : "")} beatmap", () => TestPlayer = LoadBeatmap(userHasCustomColours));
+            AddUntilStep("wait for player load", () => TestPlayer.IsLoaded);
+        }
+
+        private void configureSettings(bool beatmapSkins, bool beatmapColours)
+        {
+            AddStep($"{(beatmapSkins ? "enable" : "disable")} beatmap skins", () =>
+            {
+                BeatmapSkins.Value = beatmapSkins;
+            });
+            AddStep($"{(beatmapColours ? "enable" : "disable")} beatmap colours", () =>
+            {
+                BeatmapColours.Value = beatmapColours;
+            });
+        }
+
+        protected virtual ExposedPlayer LoadBeatmap(bool userHasCustomColours)
+        {
+            ExposedPlayer player;
+
+            Beatmap.Value = TestBeatmap;
+
+            LoadScreen(player = CreateTestPlayer(userHasCustomColours));
+
+            return player;
+        }
+
+        protected virtual ExposedPlayer CreateTestPlayer(bool userHasCustomColours) => new ExposedPlayer(userHasCustomColours);
+
+        protected class ExposedPlayer : Player
+        {
+            protected readonly bool UserHasCustomColours;
+
+            public ExposedPlayer(bool userHasCustomColours)
+                : base(new PlayerConfiguration
+                {
+                    AllowPause = false,
+                    ShowResults = false,
+                })
+            {
+                UserHasCustomColours = userHasCustomColours;
+            }
+
+            protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
+            {
+                var dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
+                dependencies.CacheAs<ISkinSource>(new TestSkin(UserHasCustomColours));
+                return dependencies;
+            }
+
+            public IReadOnlyList<Color4> UsableComboColours =>
+                GameplayClockContainer.ChildrenOfType<BeatmapSkinProvidingContainer>()
+                                      .First()
+                                      .GetConfig<GlobalSkinColours, IReadOnlyList<Color4>>(GlobalSkinColours.ComboColours)?.Value;
+        }
+
+        protected class CustomSkinWorkingBeatmap : ClockBackedTestWorkingBeatmap
+        {
+            public readonly bool HasColours;
+
+            public CustomSkinWorkingBeatmap(IBeatmap beatmap, AudioManager audio, bool hasColours)
+                : base(beatmap, null, null, audio)
+            {
+                HasColours = hasColours;
+            }
+
+            protected override ISkin GetSkin() => new TestBeatmapSkin(BeatmapInfo, HasColours);
+        }
+
+        protected class TestBeatmapSkin : LegacyBeatmapSkin
+        {
+            public static Color4[] Colours { get; } =
+            {
+                new Color4(50, 100, 150, 255),
+                new Color4(40, 80, 120, 255),
+            };
+
+            public static readonly Color4 HYPER_DASH_COLOUR = Color4.DarkBlue;
+
+            public static readonly Color4 HYPER_DASH_AFTER_IMAGE_COLOUR = Color4.DarkCyan;
+
+            public static readonly Color4 HYPER_DASH_FRUIT_COLOUR = Color4.DarkGoldenrod;
+
+            public TestBeatmapSkin(BeatmapInfo beatmap, bool hasColours)
+                : base(beatmap, new ResourceStore<byte[]>(), null)
+            {
+                if (hasColours)
+                {
+                    Configuration.AddComboColours(Colours);
+                    Configuration.CustomColours.Add("HyperDash", HYPER_DASH_COLOUR);
+                    Configuration.CustomColours.Add("HyperDashAfterImage", HYPER_DASH_AFTER_IMAGE_COLOUR);
+                    Configuration.CustomColours.Add("HyperDashFruit", HYPER_DASH_FRUIT_COLOUR);
+                }
+            }
+        }
+
+        protected class TestSkin : LegacySkin, ISkinSource
+        {
+            public static Color4[] Colours { get; } =
+            {
+                new Color4(150, 100, 50, 255),
+                new Color4(20, 20, 20, 255),
+            };
+
+            public static readonly Color4 HYPER_DASH_COLOUR = Color4.LightBlue;
+
+            public static readonly Color4 HYPER_DASH_AFTER_IMAGE_COLOUR = Color4.LightCoral;
+
+            public static readonly Color4 HYPER_DASH_FRUIT_COLOUR = Color4.LightCyan;
+
+            public TestSkin(bool hasCustomColours)
+                : base(new SkinInfo(), new ResourceStore<byte[]>(), null, string.Empty)
+            {
+                if (hasCustomColours)
+                {
+                    Configuration.AddComboColours(Colours);
+                    Configuration.CustomColours.Add("HyperDash", HYPER_DASH_COLOUR);
+                    Configuration.CustomColours.Add("HyperDashAfterImage", HYPER_DASH_AFTER_IMAGE_COLOUR);
+                    Configuration.CustomColours.Add("HyperDashFruit", HYPER_DASH_FRUIT_COLOUR);
+                }
+            }
+
+            public event Action SourceChanged
+            {
+                add { }
+                remove { }
+            }
+        }
+    }
+}