From 4f6b85e5ea19381ab19a2ebdab80336bcf4a59e0 Mon Sep 17 00:00:00 2001
From: Salman Ahmed <email@iisalman.me>
Date: Thu, 12 Dec 2019 00:32:39 +0300
Subject: [PATCH] Add test ensuring correct break lightening behaviour

---
 .../Background/TestSceneUserDimContainer.cs   | 82 +++++++++++++++++++
 .../Graphics/Containers/UserDimContainer.cs   |  5 +-
 2 files changed, 86 insertions(+), 1 deletion(-)
 create mode 100644 osu.Game.Tests/Visual/Background/TestSceneUserDimContainer.cs

diff --git a/osu.Game.Tests/Visual/Background/TestSceneUserDimContainer.cs b/osu.Game.Tests/Visual/Background/TestSceneUserDimContainer.cs
new file mode 100644
index 0000000000..0aad9bed75
--- /dev/null
+++ b/osu.Game.Tests/Visual/Background/TestSceneUserDimContainer.cs
@@ -0,0 +1,82 @@
+// 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.Bindables;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Shapes;
+using osu.Game.Configuration;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Containers;
+using osuTK.Graphics;
+
+namespace osu.Game.Tests.Visual.Background
+{
+    public class TestSceneUserDimContainer : OsuTestScene
+    {
+        private readonly TestUserDimContainer container;
+        private readonly BindableBool isBreakTime = new BindableBool();
+        private readonly Bindable<bool> lightenDuringBreaks = new Bindable<bool>();
+
+        public TestSceneUserDimContainer()
+        {
+            Add(container = new TestUserDimContainer
+            {
+                RelativeSizeAxes = Axes.Both,
+                Child = new Box
+                {
+                    Colour = Color4.White,
+                    RelativeSizeAxes = Axes.Both,
+                },
+            });
+
+            container.IsBreakTime.BindTo(isBreakTime);
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(OsuConfigManager config)
+        {
+            config.BindWith(OsuSetting.LightenDuringBreaks, lightenDuringBreaks);
+        }
+
+        [SetUp]
+        public void SetUp()
+        {
+            isBreakTime.Value = false;
+            lightenDuringBreaks.Value = false;
+        }
+
+        [TestCase(0.6f, 0.3f)]
+        [TestCase(0.2f, 0.0f)]
+        [TestCase(0.0f, 0.0f)]
+        public void TestBreakLightening(float userDim, float expectedBreakDim)
+        {
+            AddStep($"set dim level {userDim}", () => container.UserDimLevel.Value = userDim);
+
+            AddStep("set break", () => isBreakTime.Value = true);
+            AddWaitStep("wait for dim", 3);
+            AddAssert($"is current dim {userDim}", () => container.DimEqual(userDim));
+
+            AddStep("set lighten during break", () => lightenDuringBreaks.Value = true);
+            AddWaitStep("wait for dim", 3);
+            AddAssert($"is current dim {expectedBreakDim}", () => container.DimEqual(expectedBreakDim));
+
+            AddStep("clear lighten during break", () => lightenDuringBreaks.Value = false);
+            AddWaitStep("wait for dim", 3);
+            AddAssert($"is current dim {userDim}", () => container.DimEqual(userDim));
+
+            AddStep("clear break", () => isBreakTime.Value = false);
+            AddStep("set lighten during break", () => lightenDuringBreaks.Value = true);
+            AddWaitStep("wait for dim", 3);
+            AddAssert($"is current dim {userDim}", () => container.DimEqual(userDim));
+        }
+
+        private class TestUserDimContainer : UserDimContainer
+        {
+            public bool DimEqual(float expectedDimLevel) => Content.Colour == OsuColour.Gray(1f - expectedDimLevel);
+
+            public new Bindable<double> UserDimLevel => base.UserDimLevel;
+        }
+    }
+}
diff --git a/osu.Game/Graphics/Containers/UserDimContainer.cs b/osu.Game/Graphics/Containers/UserDimContainer.cs
index 20f5a4fd83..dcc8a52e9d 100644
--- a/osu.Game/Graphics/Containers/UserDimContainer.cs
+++ b/osu.Game/Graphics/Containers/UserDimContainer.cs
@@ -16,6 +16,9 @@ namespace osu.Game.Graphics.Containers
     /// </summary>
     public abstract class UserDimContainer : Container
     {
+        /// <summary>
+        /// Amount of lightening to apply to current dim level during break times.
+        /// </summary>
         private const float break_lighten_amount = 0.3f;
 
         protected const double BACKGROUND_FADE_DURATION = 800;
@@ -34,7 +37,7 @@ namespace osu.Game.Graphics.Containers
         /// Whether player is in break time.
         /// Must be bound to <see cref="BreakOverlay.IsBreakTime"/> to allow for dim adjustments in gameplay.
         /// </summary>
-        internal readonly IBindable<bool> IsBreakTime = new Bindable<bool>();
+        public readonly IBindable<bool> IsBreakTime = new Bindable<bool>();
 
         /// <summary>
         /// Whether the content of this container is currently being displayed.