Merge pull request #1568 from peppy/attribute-descriptions

Move TestCase descriptions to attributes
2026-05-18 05:39:53 +08:00 · 2017-11-23 19:21:45 +09:00
parent 92e169eb71 52c971cd75
commit 103bf1ddc9
49 changed files with 27 additions and 100 deletions
@@ -26,8 +26,6 @@ namespace osu.Game.Rulesets.Mania.Tests
        private const double start_time = 500;
        private const double duration = 500;

-        public override string Description => @"Mania playfield";
-
        protected override double TimePerAction => 200;

        private RulesetInfo maniaRuleset;
@@ -30,8 +30,6 @@ namespace osu.Game.Rulesets.Taiko.Tests
        private const double default_duration = 1000;
        private const float scroll_time = 1000;

-        public override string Description => "Taiko playfield";
-
        protected override double TimePerAction => default_duration * 2;

        private readonly Random rng = new Random(1337);
@@ -5,6 +5,5 @@ namespace osu.Game.Tests.Visual
 {
    public class TestCaseAllPlayers : TestCasePlayer
    {
-        public override string Description => @"Showing everything to play the game.";
    }
 }
@@ -19,8 +19,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseBeatSyncedContainer : OsuTestCase
    {
-        public override string Description => @"Tests beat synced containers.";
-
        private readonly MusicController mc;

        public TestCaseBeatSyncedContainer()
@@ -9,10 +9,9 @@ using OpenTK;
 namespace osu.Game.Tests.Visual
 {
    [TestFixture]
+    [System.ComponentModel.Description("PlaySongSelect leaderboard/details area")]
    internal class TestCaseBeatmapDetailArea : OsuTestCase
    {
-        public override string Description => @"Beatmap details in song select";
-
        public TestCaseBeatmapDetailArea()
        {
            Add(new BeatmapDetailArea
@@ -23,4 +22,4 @@ namespace osu.Game.Tests.Visual
            });
        }
    }
-}
+}
@@ -1,6 +1,7 @@
 // Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System.ComponentModel;
 using System.Linq;
 using osu.Framework.Graphics;
 using osu.Game.Beatmaps;
@@ -8,10 +9,9 @@ using osu.Game.Screens.Select;

 namespace osu.Game.Tests.Visual
 {
+    [Description("PlaySongSelect beatmap details")]
    internal class TestCaseBeatmapDetails : OsuTestCase
    {
-        public override string Description => "BeatmapDetails tab of BeatmapDetailArea";
-
        public TestCaseBeatmapDetails()
        {
            BeatmapDetails details;
@@ -1,6 +1,7 @@
 // Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System.ComponentModel;
 using osu.Game.Graphics;
 using osu.Game.Screens.Select.Options;
 using OpenTK.Graphics;
@@ -8,10 +9,9 @@ using OpenTK.Input;

 namespace osu.Game.Tests.Visual
 {
+    [Description("bottom beatmap details")]
    internal class TestCaseBeatmapOptionsOverlay : OsuTestCase
    {
-        public override string Description => @"Beatmap options in song select";
-
        public TestCaseBeatmapOptionsOverlay()
        {
            var overlay = new BeatmapOptionsOverlay();
@@ -3,7 +3,6 @@

 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
 using osu.Framework.MathUtils;
 using osu.Game.Graphics;
@@ -14,13 +13,13 @@ using osu.Game.Rulesets.Osu.Mods;
 using osu.Game.Rulesets.Scoring;
 using osu.Game.Users;
 using System.Collections.Generic;
+using osu.Framework.Graphics.Containers;

 namespace osu.Game.Tests.Visual
 {
+    [System.ComponentModel.Description("in BeatmapOverlay")]
    public class TestCaseBeatmapScoresContainer : OsuTestCase
    {
-        public override string Description => "BeatmapOverlay scores container";
-
        private readonly IEnumerable<OnlineScore> scores;
        private readonly IEnumerable<OnlineScore> anotherScores;
        private readonly OnlineScore topScore;
@@ -14,8 +14,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseBeatmapSetOverlay : OsuTestCase
    {
-        public override string Description => @"view online beatmap sets";
-
        private readonly BeatmapSetOverlay overlay;

        public TestCaseBeatmapSetOverlay()
@@ -8,8 +8,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseBreadcrumbs : OsuTestCase
    {
-        public override string Description => @"breadcrumb > control";
-
        public TestCaseBreadcrumbs()
        {
            BreadcrumbControl<BreadcrumbTab> c;
@@ -10,8 +10,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseBreakOverlay : OsuTestCase
    {
-        public override string Description => @"Tests breaks behavior";
-
        private readonly BreakOverlay breakOverlay;

        public TestCaseBreakOverlay()
@@ -88,4 +86,4 @@ namespace osu.Game.Tests.Visual
            };
        }
    }
-}
+}
@@ -1,15 +1,15 @@
 // Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System.ComponentModel;
 using osu.Framework.Graphics.Containers;
 using osu.Game.Overlays;

 namespace osu.Game.Tests.Visual
 {
+    [Description("Testing chat api and overlay")]
    internal class TestCaseChatDisplay : OsuTestCase
    {
-        public override string Description => @"Testing chat api and overlay";
-
        public TestCaseChatDisplay()
        {
            Add(new ChatOverlay
@@ -15,8 +15,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseContextMenu : OsuTestCase
    {
-        public override string Description => @"Menu visible on right click";
-
        private const int start_time = 0;
        private const int duration = 1000;

@@ -9,8 +9,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseDialogOverlay : OsuTestCase
    {
-        public override string Description => @"Display dialogs";
-
        public TestCaseDialogOverlay()
        {
            DialogOverlay overlay;
@@ -11,8 +11,6 @@ namespace osu.Game.Tests.Visual
 {
    public class TestCaseDirect : OsuTestCase
    {
-        public override string Description => @"osu!direct overlay";
-
        private DirectOverlay direct;
        private RulesetStore rulesets;

@@ -14,8 +14,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseDrawableRoom : OsuTestCase
    {
-        public override string Description => @"Select your favourite room";
-
        private RulesetStore rulesets;

        protected override void LoadComplete()
@@ -2,15 +2,15 @@
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

 using System.Collections.Generic;
+using System.ComponentModel;
 using osu.Game.Screens.Tournament;
 using osu.Game.Screens.Tournament.Teams;

 namespace osu.Game.Tests.Visual
 {
+    [Description("for tournament use")]
    internal class TestCaseDrawings : OsuTestCase
    {
-        public override string Description => "Tournament drawings";
-
        public TestCaseDrawings()
        {
            Add(new Drawings
@@ -7,8 +7,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseGamefield : OsuTestCase
    {
-        public override string Description => @"Showing hitobjects and what not.";
-
        protected override void LoadComplete()
        {
            base.LoadComplete();
@@ -10,8 +10,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseGraph : OsuTestCase
    {
-        public override string Description => "graph";
-
        public TestCaseGraph()
        {
            BarGraph graph;
@@ -36,4 +34,4 @@ namespace osu.Game.Tests.Visual
            AddStep("Right to left", () => graph.Direction = BarDirection.RightToLeft);
        }
    }
-}
+}
@@ -14,8 +14,6 @@ namespace osu.Game.Tests.Visual
 {
    public class TestCaseIconButton : OsuTestCase
    {
-        public override string Description => "Various display modes of icon buttons";
-
        public TestCaseIconButton()
        {
            Child = new FillFlowContainer
@@ -9,8 +9,6 @@ namespace osu.Game.Tests.Visual
    {
        private readonly KeyBindingOverlay overlay;

-        public override string Description => @"Key configuration";
-
        public TestCaseKeyConfiguration()
        {
            Child = overlay = new KeyBindingOverlay();
@@ -10,8 +10,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseKeyCounter : OsuTestCase
    {
-        public override string Description => @"Tests key counter";
-
        public TestCaseKeyCounter()
        {
            KeyCounterCollection kc = new KeyCounterCollection
@@ -1,6 +1,7 @@
 // Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System.ComponentModel;
 using osu.Framework.Graphics;
 using osu.Game.Rulesets.Scoring;
 using osu.Game.Screens.Select.Leaderboards;
@@ -9,10 +10,9 @@ using OpenTK;

 namespace osu.Game.Tests.Visual
 {
+    [Description("PlaySongSelect leaderboard")]
    internal class TestCaseLeaderboard : OsuTestCase
    {
-        public override string Description => @"From song select";
-
        private readonly Leaderboard leaderboard;

        private void newScores()
@@ -11,8 +11,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseMedalOverlay : OsuTestCase
    {
-        public override string Description => @"medal get!";
-
        public override IReadOnlyList<Type> RequiredTypes => new[]
        {
            typeof(MedalOverlay),
@@ -1,6 +1,7 @@
 // Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System.ComponentModel;
 using osu.Framework.Graphics.Colour;
 using osu.Framework.Graphics.Shapes;
 using osu.Game.Screens.Menu;
@@ -8,10 +9,9 @@ using OpenTK.Graphics;

 namespace osu.Game.Tests.Visual
 {
+    [Description("main menu")]
    internal class TestCaseMenuButtonSystem : OsuTestCase
    {
-        public override string Description => @"Main menu button system";
-
        public TestCaseMenuButtonSystem()
        {
            Add(new Box
@@ -1,16 +1,16 @@
 // Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System.ComponentModel;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Logging;
 using osu.Game.Screens.Play;

 namespace osu.Game.Tests.Visual
 {
+    [Description("player pause/fail screens")]
    internal class TestCaseMenuOverlays : OsuTestCase
    {
-        public override string Description => @"Tests pause and fail overlays";
-
        public TestCaseMenuOverlays()
        {
            FailOverlay failOverlay;
@@ -1,6 +1,7 @@
 // Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System.ComponentModel;
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
 using osu.Game.Overlays.Mods;
@@ -10,10 +11,9 @@ using OpenTK;

 namespace osu.Game.Tests.Visual
 {
+    [Description("mod select and icon display")]
    internal class TestCaseMods : OsuTestCase
    {
-        public override string Description => @"Mod select overlay and in-game display";
-
        private ModSelectOverlay modSelect;
        private ModDisplay modDisplay;

@@ -13,8 +13,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseMusicController : OsuTestCase
    {
-        public override string Description => @"Tests music controller ui.";
-
        private readonly Bindable<WorkingBeatmap> beatmapBacking = new Bindable<WorkingBeatmap>();

        public TestCaseMusicController()
@@ -15,8 +15,6 @@ namespace osu.Game.Tests.Visual
    [TestFixture]
    internal class TestCaseNotificationOverlay : OsuTestCase
    {
-        public override string Description => @"I handle notifications";
-
        private readonly NotificationOverlay manager;

        public TestCaseNotificationOverlay()
@@ -12,8 +12,6 @@ namespace osu.Game.Tests.Visual
        private FrameworkConfigManager config;
        private Bindable<FrameSync> frameSyncMode;

-        public override string Description => @"Make it easier to see setting changes";
-
        protected override void LoadComplete()
        {
            base.LoadComplete();
@@ -22,8 +22,6 @@ namespace osu.Game.Tests.Visual
    {
        private BeatmapManager manager;

-        public override string Description => @"with fake data";
-
        private RulesetStore rulesets;

        private DependencyContainer dependencies;
@@ -10,8 +10,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseReplay : TestCasePlayer
    {
-        public override string Description => @"Testing replay playback.";
-
        protected override Player CreatePlayer(WorkingBeatmap beatmap, Ruleset ruleset)
        {
            beatmap.Mods.Value = beatmap.Mods.Value.Concat(new[] { ruleset.GetAutoplayMod() });
@@ -10,8 +10,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseReplaySettingsOverlay : OsuTestCase
    {
-        public override string Description => @"Settings visible in replay/auto";
-
        public TestCaseReplaySettingsOverlay()
        {
            ExampleContainer container;
@@ -15,8 +15,6 @@ namespace osu.Game.Tests.Visual
    {
        private BeatmapManager beatmaps;

-        public override string Description => @"Results after playing.";
-
        [BackgroundDependencyLoader]
        private void load(BeatmapManager beatmaps)
        {
@@ -13,8 +13,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseRoomInspector : OsuTestCase
    {
-        public override string Description => @"from the multiplayer lobby";
-
        private RulesetStore rulesets;

        protected override void LoadComplete()
@@ -12,8 +12,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseScoreCounter : OsuTestCase
    {
-        public override string Description => @"Tests multiple counters";
-
        public TestCaseScoreCounter()
        {
            int numerator = 0, denominator = 0;
@@ -7,8 +7,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseSettings : OsuTestCase
    {
-        public override string Description => @"Tests the settings overlay";
-
        private readonly SettingsOverlay settings;

        public TestCaseSettings()
@@ -7,8 +7,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseSkipButton : OsuTestCase
    {
-        public override string Description => @"Skip skip skippediskip";
-
        protected override void LoadComplete()
        {
            base.LoadComplete();
@@ -8,8 +8,6 @@ namespace osu.Game.Tests.Visual
 {
    public class TestCaseSocial : OsuTestCase
    {
-        public override string Description => @"social browser overlay";
-
        public TestCaseSocial()
        {
            SocialOverlay s = new SocialOverlay
@@ -12,8 +12,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseSongProgress : OsuTestCase
    {
-        public override string Description => @"With fake data";
-
        private readonly SongProgress progress;
        private readonly SongProgressGraph graph;

@@ -16,8 +16,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseStoryboard : OsuTestCase
    {
-        public override string Description => @"Tests storyboards.";
-
        private readonly Bindable<WorkingBeatmap> beatmapBacking = new Bindable<WorkingBeatmap>();

        private readonly Container<DrawableStoryboard> storyboardContainer;
@@ -1,6 +1,7 @@
 // Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System.ComponentModel;
 using osu.Framework.Graphics;
 using osu.Game.Graphics.Sprites;
 using osu.Game.Graphics.UserInterface;
@@ -9,10 +10,9 @@ using OpenTK;

 namespace osu.Game.Tests.Visual
 {
+    [Description("SongSelect filter control")]
    public class TestCaseTabControl : OsuTestCase
    {
-        public override string Description => @"Filter for song select";
-
        public TestCaseTabControl()
        {
            OsuSpriteText text;
@@ -12,8 +12,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseTextAwesome : OsuTestCase
    {
-        public override string Description => @"Tests display of icons";
-
        public TestCaseTextAwesome()
        {
            FillFlowContainer flow;
@@ -1,14 +1,14 @@
 // Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

+using System.ComponentModel;
 using osu.Game.Graphics.UserInterface;

 namespace osu.Game.Tests.Visual
 {
+    [Description("mostly back button")]
    internal class TestCaseTwoLayerButton : OsuTestCase
    {
-        public override string Description => @"Mostly back button";
-
        public TestCaseTwoLayerButton()
        {
            Add(new BackButton());
@@ -10,8 +10,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseUserPanel : OsuTestCase
    {
-        public override string Description => @"Panels for displaying a user's status";
-
        public TestCaseUserPanel()
        {
            UserPanel flyte;
@@ -10,8 +10,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseUserProfile : OsuTestCase
    {
-        public override string Description => "Tests user's profile page.";
-
        public TestCaseUserProfile()
        {
            var profile = new UserProfileOverlay();
@@ -15,8 +15,6 @@ namespace osu.Game.Tests.Visual
 {
    internal class TestCaseUserRanks : OsuTestCase
    {
-        public override string Description => "showing your latest achievements";
-
        public override IReadOnlyList<Type> RequiredTypes => new[] { typeof(DrawableScore), typeof(RanksSection) };

        public TestCaseUserRanks()
@@ -23,8 +23,6 @@ namespace osu.Game.Tests.Visual

        protected Player Player;

-        public override string Description => @"Showing everything to play the game.";
-
        /// <summary>
        /// Create a TestCase which runs through the Player screen.
        /// </summary>