Merge pull request #8806 from peppy/fix-keybinding-defaults

Fix DatabasedKeyBindingContainer not using defaults for non-databased ruleset

osu.Game.Tests/Visual/Gameplay/TestSceneKeyBindings.cs

@@ -0,0 +1,98 @@
+// 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 NUnit.Framework;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Input.Bindings;
+using osu.Framework.Testing;
+using osu.Game.Beatmaps;
+using osu.Game.Input.Bindings;
+using osu.Game.Rulesets;
+using osu.Game.Rulesets.Difficulty;
+using osu.Game.Rulesets.Mods;
+using osu.Game.Rulesets.UI;
+using osuTK.Input;
+
+namespace osu.Game.Tests.Visual.Gameplay
+{
+    [HeadlessTest]
+    public class TestSceneKeyBindings : OsuManualInputManagerTestScene
+    {
+        private readonly ActionReceiver receiver;
+
+        public TestSceneKeyBindings()
+        {
+            Add(new TestKeyBindingContainer
+            {
+                Child = receiver = new ActionReceiver()
+            });
+        }
+
+        [Test]
+        public void TestDefaultsWhenNotDatabased()
+        {
+            AddStep("fire key", () =>
+            {
+                InputManager.PressKey(Key.A);
+                InputManager.ReleaseKey(Key.A);
+            });
+
+            AddAssert("received key", () => receiver.ReceivedAction);
+        }
+
+        private class TestRuleset : Ruleset
+        {
+            public override IEnumerable<Mod> GetModsFor(ModType type) =>
+                throw new System.NotImplementedException();
+
+            public override DrawableRuleset CreateDrawableRulesetWith(IBeatmap beatmap, IReadOnlyList<Mod> mods = null) =>
+                throw new System.NotImplementedException();
+
+            public override IBeatmapConverter CreateBeatmapConverter(IBeatmap beatmap) =>
+                throw new System.NotImplementedException();
+
+            public override DifficultyCalculator CreateDifficultyCalculator(WorkingBeatmap beatmap) =>
+                throw new System.NotImplementedException();
+
+            public override IEnumerable<KeyBinding> GetDefaultKeyBindings(int variant = 0)
+            {
+                return new[]
+                {
+                    new KeyBinding(InputKey.A, TestAction.Down),
+                };
+            }
+
+            public override string Description => "test";
+            public override string ShortName => "test";
+        }
+
+        private enum TestAction
+        {
+            Down,
+        }
+
+        private class TestKeyBindingContainer : DatabasedKeyBindingContainer<TestAction>
+        {
+            public TestKeyBindingContainer()
+                : base(new TestRuleset().RulesetInfo, 0)
+            {
+            }
+        }
+
+        private class ActionReceiver : CompositeDrawable, IKeyBindingHandler<TestAction>
+        {
+            public bool ReceivedAction;
+
+            public bool OnPressed(TestAction action)
+            {
+                ReceivedAction = action == TestAction.Down;
+                return true;
+            }
+
+            public void OnReleased(TestAction action)
+            {
+            }
+        }
+    }
+}

osu.Game/Input/Bindings/DatabasedKeyBindingContainer.cs

@@ -62,6 +62,14 @@ namespace osu.Game.Input.Bindings
                 store.KeyBindingChanged -= ReloadMappings;
         }
 
-        protected override void ReloadMappings() => KeyBindings = store.Query(ruleset?.ID, variant).ToList();
+        protected override void ReloadMappings()
+        {
+            if (ruleset != null && !ruleset.ID.HasValue)
+                // if the provided ruleset is not stored to the database, we have no way to retrieve custom bindings.
+                // fallback to defaults instead.
+                KeyBindings = DefaultKeyBindings;
+            else
+                KeyBindings = store.Query(ruleset?.ID, variant).ToList();
+        }
     }
 }