Add basic setup switching for the tournament client

osu.Game.Tests/NonVisual/CustomDataDirectoryTest.cs

@@ -111,6 +111,7 @@ public void TestMigration()
 
                     var osu = LoadOsuIntoHost(host);
                     var storage = osu.Dependencies.Get<Storage>();
+                    var osuStorage = storage as MigratableStorage;
 
                     // Store the current storage's path. We'll need to refer to this for assertions in the original directory after the migration completes.
                     string originalDirectory = storage.GetFullPath(".");
@@ -137,13 +138,15 @@ public void TestMigration()
                     Assert.That(!Directory.Exists(Path.Combine(originalDirectory, "test-nested", "cache")));
                     Assert.That(storage.ExistsDirectory(Path.Combine("test-nested", "cache")));
 
-                    foreach (var file in OsuStorage.IGNORE_FILES)
+                    Assert.That(osuStorage, Is.Not.Null);
+
+                    foreach (var file in osuStorage.IgnoreFiles)
                     {
                         Assert.That(File.Exists(Path.Combine(originalDirectory, file)));
                         Assert.That(storage.Exists(file), Is.False);
                     }
 
-                    foreach (var dir in OsuStorage.IGNORE_DIRECTORIES)
+                    foreach (var dir in osuStorage.IgnoreDirectories)
                     {
                         Assert.That(Directory.Exists(Path.Combine(originalDirectory, dir)));
                         Assert.That(storage.ExistsDirectory(dir), Is.False);

osu.Game.Tournament.Tests/NonVisual/CustomTourneyDirectoryTest.cs

@@ -0,0 +1,171 @@
+// 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.IO;
+using System.Threading;
+using System.Threading.Tasks;
+using NUnit.Framework;
+using osu.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Platform;
+using osu.Game.Tournament.Configuration;
+using osu.Game.Tests;
+
+namespace osu.Game.Tournament.Tests.NonVisual
+{
+    [TestFixture]
+    public class CustomTourneyDirectoryTest
+    {
+        [Test]
+        public void TestDefaultDirectory()
+        {
+            using (HeadlessGameHost host = new CleanRunHeadlessGameHost(nameof(TestDefaultDirectory)))
+            {
+                try
+                {
+                    var osu = loadOsu(host);
+                    var storage = osu.Dependencies.Get<Storage>();
+                    var defaultStorage = Path.Combine(tournamentBasePath(nameof(TestDefaultDirectory)), "default");
+                    Assert.That(storage.GetFullPath("."), Is.EqualTo(defaultStorage));
+                }
+                finally
+                {
+                    host.Exit();
+                }
+            }
+        }
+
+        [Test]
+        public void TestCustomDirectory()
+        {
+            using (HeadlessGameHost host = new HeadlessGameHost(nameof(TestCustomDirectory)))
+            {
+                string osuDesktopStorage = basePath(nameof(TestCustomDirectory));
+                const string custom_tournament = "custom";
+
+                // need access before the game has constructed its own storage yet.
+                Storage storage = new DesktopStorage(osuDesktopStorage, host);
+                // manual cleaning so we can prepare a config file.
+                storage.DeleteDirectory(string.Empty);
+
+                using (var storageConfig = new TournamentStorageManager(storage))
+                    storageConfig.Set(StorageConfig.CurrentTournament, custom_tournament);
+
+                try
+                {
+                    var osu = loadOsu(host);
+
+                    storage = osu.Dependencies.Get<Storage>();
+
+                    Assert.That(storage.GetFullPath("."), Is.EqualTo(Path.Combine(tournamentBasePath(nameof(TestCustomDirectory)), custom_tournament)));
+                }
+                finally
+                {
+                    host.Exit();
+                }
+            }
+        }
+
+        [Test]
+        public void TestMigration()
+        {
+            using (HeadlessGameHost host = new HeadlessGameHost(nameof(TestMigration)))
+            {
+                string osuRoot = basePath(nameof(TestMigration));
+                string configFile = Path.Combine(osuRoot, "tournament.ini");
+
+                if (File.Exists(configFile))
+                    File.Delete(configFile);
+
+                // Recreate the old setup that uses "tournament" as the base path.
+                string oldPath = Path.Combine(osuRoot, "tournament");
+
+                string videosPath = Path.Combine(oldPath, "videos");
+                string modsPath = Path.Combine(oldPath, "mods");
+                string flagsPath = Path.Combine(oldPath, "flags");
+
+                Directory.CreateDirectory(videosPath);
+                Directory.CreateDirectory(modsPath);
+                Directory.CreateDirectory(flagsPath);
+
+                // Define testing files corresponding to the specific file migrations that are needed
+                string bracketFile = Path.Combine(osuRoot, "bracket.json");
+
+                string drawingsConfig = Path.Combine(osuRoot, "drawings.ini");
+                string drawingsFile = Path.Combine(osuRoot, "drawings.txt");
+                string drawingsResult = Path.Combine(osuRoot, "drawings_results.txt");
+
+                // Define sample files to test recursive copying
+                string videoFile = Path.Combine(videosPath, "video.mp4");
+                string modFile = Path.Combine(modsPath, "mod.png");
+                string flagFile = Path.Combine(flagsPath, "flag.png");
+
+                File.WriteAllText(bracketFile, "{}");
+                File.WriteAllText(drawingsConfig, "test");
+                File.WriteAllText(drawingsFile, "test");
+                File.WriteAllText(drawingsResult, "test");
+                File.WriteAllText(videoFile, "test");
+                File.WriteAllText(modFile, "test");
+                File.WriteAllText(flagFile, "test");
+
+                try
+                {
+                    var osu = loadOsu(host);
+
+                    var storage = osu.Dependencies.Get<Storage>();
+
+                    var migratedPath = Path.Combine(tournamentBasePath(nameof(TestMigration)), "default");
+
+                    videosPath = Path.Combine(migratedPath, "videos");
+                    modsPath = Path.Combine(migratedPath, "mods");
+                    flagsPath = Path.Combine(migratedPath, "flags");
+
+                    videoFile = Path.Combine(videosPath, "video.mp4");
+                    modFile = Path.Combine(modsPath, "mod.png");
+                    flagFile = Path.Combine(flagsPath, "flag.png");
+
+                    Assert.That(storage.GetFullPath("."), Is.EqualTo(migratedPath));
+
+                    Assert.True(storage.Exists("bracket.json"));
+                    Assert.True(storage.Exists("drawings.txt"));
+                    Assert.True(storage.Exists("drawings_results.txt"));
+
+                    Assert.True(storage.Exists("drawings.ini"));
+
+                    Assert.True(storage.Exists(videoFile));
+                    Assert.True(storage.Exists(modFile));
+                    Assert.True(storage.Exists(flagFile));
+                }
+                finally
+                {
+                    host.Storage.Delete("tournament.ini");
+                    host.Storage.DeleteDirectory("tournaments");
+                    host.Exit();
+                }
+            }
+        }
+
+        private TournamentGameBase loadOsu(GameHost host)
+        {
+            var osu = new TournamentGameBase();
+            Task.Run(() => host.Run(osu));
+            waitForOrAssert(() => osu.IsLoaded, @"osu! failed to start in a reasonable amount of time");
+            return osu;
+        }
+
+        private static void waitForOrAssert(Func<bool> result, string failureMessage, int timeout = 90000)
+        {
+            Task task = Task.Run(() =>
+            {
+                while (!result()) Thread.Sleep(200);
+            });
+
+            Assert.IsTrue(task.Wait(timeout), failureMessage);
+        }
+
+        private string basePath(string testInstance) => Path.Combine(RuntimeInfo.StartupDirectory, "headless", testInstance);
+
+        private string tournamentBasePath(string testInstance) => Path.Combine(basePath(testInstance), "tournaments");
+    }
+}

osu.Game.Tournament/Components/TourneyVideo.cs

@@ -7,8 +7,10 @@
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
 using osu.Framework.Graphics.Video;
+using osu.Framework.Platform;
 using osu.Framework.Timing;
 using osu.Game.Graphics;
+using osu.Game.Tournament.IO;
 
 namespace osu.Game.Tournament.Components
 {
@@ -17,7 +19,6 @@ public class TourneyVideo : CompositeDrawable
         private readonly string filename;
         private readonly bool drawFallbackGradient;
         private Video video;
-
         private ManualClock manualClock;
 
         public TourneyVideo(string filename, bool drawFallbackGradient = false)
@@ -27,9 +28,9 @@ public TourneyVideo(string filename, bool drawFallbackGradient = false)
         }
 
         [BackgroundDependencyLoader]
-        private void load(TournamentStorage storage)
+        private void load(Storage storage)
         {
-            var stream = storage.GetStream($@"videos/{filename}");
+            var stream = (storage as TournamentStorage)?.VideoStore.GetStream(filename);
 
             if (stream != null)
             {

osu.Game.Tournament/Configuration/TournamentStorageManager.cs

@@ -0,0 +1,23 @@
+// 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 osu.Framework.Configuration;
+using osu.Framework.Platform;
+
+namespace osu.Game.Tournament.Configuration
+{
+    public class TournamentStorageManager : IniConfigManager<StorageConfig>
+    {
+        protected override string Filename => "tournament.ini";
+
+        public TournamentStorageManager(Storage storage)
+            : base(storage)
+        {
+        }
+    }
+
+    public enum StorageConfig
+    {
+        CurrentTournament,
+    }
+}

osu.Game.Tournament/IO/TournamentStorage.cs

@@ -0,0 +1,69 @@
+// 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 osu.Framework.Logging;
+using osu.Framework.Platform;
+using osu.Game.IO;
+using System.IO;
+using osu.Game.Tournament.Configuration;
+
+namespace osu.Game.Tournament.IO
+{
+    public class TournamentStorage : MigratableStorage
+    {
+        private const string default_tournament = "default";
+        private readonly Storage storage;
+        private readonly TournamentStorageManager storageConfig;
+        public TournamentVideoResourceStore VideoStore { get; }
+
+        public TournamentStorage(Storage storage)
+            : base(storage.GetStorageForDirectory("tournaments"), string.Empty)
+        {
+            this.storage = storage;
+
+            storageConfig = new TournamentStorageManager(storage);
+
+            if (storage.Exists("tournament.ini"))
+            {
+                ChangeTargetStorage(UnderlyingStorage.GetStorageForDirectory(storageConfig.Get<string>(StorageConfig.CurrentTournament)));
+            }
+            else
+                Migrate(UnderlyingStorage.GetStorageForDirectory(default_tournament));
+
+            VideoStore = new TournamentVideoResourceStore(this);
+            Logger.Log("Using tournament storage: " + GetFullPath(string.Empty));
+        }
+
+        public override void Migrate(Storage newStorage)
+        {
+            var source = new DirectoryInfo(storage.GetFullPath("tournament"));
+            var destination = new DirectoryInfo(newStorage.GetFullPath("."));
+
+            if (source.Exists)
+            {
+                Logger.Log("Migrating tournament assets to default tournament storage.");
+                CopyRecursive(source, destination);
+                DeleteRecursive(source);
+            }
+
+            moveFileIfExists("bracket.json", destination);
+            moveFileIfExists("drawings.txt", destination);
+            moveFileIfExists("drawings_results.txt", destination);
+            moveFileIfExists("drawings.ini", destination);
+            ChangeTargetStorage(newStorage);
+            storageConfig.Set(StorageConfig.CurrentTournament, default_tournament);
+            storageConfig.Save();
+        }
+
+        private void moveFileIfExists(string file, DirectoryInfo destination)
+        {
+            if (!storage.Exists(file))
+                return;
+
+            Logger.Log($"Migrating {file} to default tournament storage.");
+            var fileInfo = new System.IO.FileInfo(storage.GetFullPath(file));
+            AttemptOperation(() => fileInfo.CopyTo(Path.Combine(destination.FullName, fileInfo.Name), true));
+            fileInfo.Delete();
+        }
+    }
+}

osu.Game.Tournament/TournamentStorage.cs → osu.Game.Tournament/IO/TournamentVideoResourceStore.cs

@@ -4,12 +4,12 @@
 using osu.Framework.IO.Stores;
 using osu.Framework.Platform;
 
-namespace osu.Game.Tournament
+namespace osu.Game.Tournament.IO
 {
-    internal class TournamentStorage : NamespacedResourceStore<byte[]>
+    public class TournamentVideoResourceStore : NamespacedResourceStore<byte[]>
     {
-        public TournamentStorage(Storage storage)
-            : base(new StorageBackedResourceStore(storage), "tournament")
+        public TournamentVideoResourceStore(Storage storage)
+            : base(new StorageBackedResourceStore(storage), "videos")
         {
             AddExtension("m4v");
             AddExtension("avi");

osu.Game.Tournament/TournamentGameBase.cs

@@ -8,11 +8,12 @@
 using osu.Framework.Allocation;
 using osu.Framework.Graphics.Textures;
 using osu.Framework.Input;
-using osu.Framework.IO.Stores;
 using osu.Framework.Platform;
+using osu.Framework.IO.Stores;
 using osu.Game.Beatmaps;
 using osu.Game.Online.API.Requests;
 using osu.Game.Tournament.IPC;
+using osu.Game.Tournament.IO;
 using osu.Game.Tournament.Models;
 using osu.Game.Users;
 using osuTK.Input;
@@ -23,13 +24,8 @@ namespace osu.Game.Tournament
     public class TournamentGameBase : OsuGameBase
     {
         private const string bracket_filename = "bracket.json";
-
         private LadderInfo ladder;
-
-        private Storage storage;
-
-        private TournamentStorage tournamentStorage;
-
+        private TournamentStorage storage;
         private DependencyContainer dependencies;
         private FileBasedIPC ipc;
 
@@ -39,15 +35,13 @@ protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnl
         }
 
         [BackgroundDependencyLoader]
-        private void load(Storage storage)
+        private void load(Storage baseStorage)
         {
             Resources.AddStore(new DllResourceStore(typeof(TournamentGameBase).Assembly));
 
-            dependencies.CacheAs(tournamentStorage = new TournamentStorage(storage));
-
-            Textures.AddStore(new TextureLoaderStore(tournamentStorage));
+            dependencies.CacheAs<Storage>(storage = new TournamentStorage(baseStorage));
 
-            this.storage = storage;
+            Textures.AddStore(new TextureLoaderStore(storage.VideoStore));
 
             readBracket();