mirror of https://github.com/ppy/osu
Remove obsoleted tournament migration flow
This commit is contained in:
parent
bdc6755ee2
commit
29f504ecc0
|
@ -49,7 +49,7 @@ public void TestCustomDirectory()
|
||||||
// manual cleaning so we can prepare a config file.
|
// manual cleaning so we can prepare a config file.
|
||||||
storage.DeleteDirectory(string.Empty);
|
storage.DeleteDirectory(string.Empty);
|
||||||
|
|
||||||
using (var storageConfig = new TournamentStorageManager(storage))
|
using (var storageConfig = new TournamentConfigManager(storage))
|
||||||
storageConfig.SetValue(StorageConfig.CurrentTournament, custom_tournament);
|
storageConfig.SetValue(StorageConfig.CurrentTournament, custom_tournament);
|
||||||
|
|
||||||
try
|
try
|
||||||
|
@ -66,82 +66,5 @@ public void TestCustomDirectory()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void TestMigration()
|
|
||||||
{
|
|
||||||
using (HeadlessGameHost host = new TestRunHeadlessGameHost(nameof(TestMigration), null)) // don't use clean run as we are writing test files for migration.
|
|
||||||
{
|
|
||||||
string osuRoot = Path.Combine(host.UserStoragePaths.First(), 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, TournamentGameBase.BRACKET_FILENAME);
|
|
||||||
|
|
||||||
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 = LoadTournament(host);
|
|
||||||
|
|
||||||
var storage = osu.Dependencies.Get<Storage>();
|
|
||||||
|
|
||||||
string migratedPath = Path.Combine(host.Storage.GetFullPath("."), "tournaments", "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(TournamentGameBase.BRACKET_FILENAME));
|
|
||||||
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.Exit();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -8,14 +8,23 @@
|
||||||
|
|
||||||
namespace osu.Game.Tournament.Configuration
|
namespace osu.Game.Tournament.Configuration
|
||||||
{
|
{
|
||||||
public class TournamentStorageManager : IniConfigManager<StorageConfig>
|
public class TournamentConfigManager : IniConfigManager<StorageConfig>
|
||||||
{
|
{
|
||||||
protected override string Filename => "tournament.ini";
|
protected override string Filename => "tournament.ini";
|
||||||
|
|
||||||
public TournamentStorageManager(Storage storage)
|
private const string default_tournament = "default";
|
||||||
|
|
||||||
|
public TournamentConfigManager(Storage storage)
|
||||||
: base(storage)
|
: base(storage)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected override void InitialiseDefaults()
|
||||||
|
{
|
||||||
|
base.InitialiseDefaults();
|
||||||
|
|
||||||
|
SetDefault(StorageConfig.CurrentTournament, default_tournament);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public enum StorageConfig
|
public enum StorageConfig
|
|
@ -1,10 +1,7 @@
|
||||||
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
// 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.
|
// See the LICENCE file in the repository root for full licence text.
|
||||||
|
|
||||||
#nullable disable
|
|
||||||
|
|
||||||
using System.Collections.Generic;
|
using System.Collections.Generic;
|
||||||
using System.IO;
|
|
||||||
using osu.Framework.Bindables;
|
using osu.Framework.Bindables;
|
||||||
using osu.Framework.Logging;
|
using osu.Framework.Logging;
|
||||||
using osu.Framework.Platform;
|
using osu.Framework.Platform;
|
||||||
|
@ -13,35 +10,28 @@
|
||||||
|
|
||||||
namespace osu.Game.Tournament.IO
|
namespace osu.Game.Tournament.IO
|
||||||
{
|
{
|
||||||
public class TournamentStorage : MigratableStorage
|
public class TournamentStorage : WrappedStorage
|
||||||
{
|
{
|
||||||
private const string default_tournament = "default";
|
|
||||||
private readonly Storage storage;
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// The storage where all tournaments are located.
|
/// The storage where all tournaments are located.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public readonly Storage AllTournaments;
|
public readonly Storage AllTournaments;
|
||||||
|
|
||||||
private readonly TournamentStorageManager storageConfig;
|
|
||||||
public readonly Bindable<string> CurrentTournament;
|
public readonly Bindable<string> CurrentTournament;
|
||||||
|
|
||||||
|
protected TournamentConfigManager TournamentConfigManager { get; }
|
||||||
|
|
||||||
public TournamentStorage(Storage storage)
|
public TournamentStorage(Storage storage)
|
||||||
: base(storage.GetStorageForDirectory("tournaments"), string.Empty)
|
: base(storage.GetStorageForDirectory("tournaments"), string.Empty)
|
||||||
{
|
{
|
||||||
this.storage = storage;
|
|
||||||
AllTournaments = UnderlyingStorage;
|
AllTournaments = UnderlyingStorage;
|
||||||
|
|
||||||
storageConfig = new TournamentStorageManager(storage);
|
TournamentConfigManager = new TournamentConfigManager(storage);
|
||||||
|
|
||||||
if (storage.Exists("tournament.ini"))
|
CurrentTournament = TournamentConfigManager.GetBindable<string>(StorageConfig.CurrentTournament);
|
||||||
{
|
|
||||||
ChangeTargetStorage(AllTournaments.GetStorageForDirectory(storageConfig.Get<string>(StorageConfig.CurrentTournament)));
|
ChangeTargetStorage(AllTournaments.GetStorageForDirectory(CurrentTournament.Value));
|
||||||
}
|
|
||||||
else
|
|
||||||
Migrate(AllTournaments.GetStorageForDirectory(default_tournament));
|
|
||||||
|
|
||||||
CurrentTournament = storageConfig.GetBindable<string>(StorageConfig.CurrentTournament);
|
|
||||||
Logger.Log("Using tournament storage: " + GetFullPath(string.Empty));
|
Logger.Log("Using tournament storage: " + GetFullPath(string.Empty));
|
||||||
|
|
||||||
CurrentTournament.BindValueChanged(updateTournament);
|
CurrentTournament.BindValueChanged(updateTournament);
|
||||||
|
@ -53,62 +43,6 @@ private void updateTournament(ValueChangedEvent<string> newTournament)
|
||||||
Logger.Log("Changing tournament storage: " + GetFullPath(string.Empty));
|
Logger.Log("Changing tournament storage: " + GetFullPath(string.Empty));
|
||||||
}
|
}
|
||||||
|
|
||||||
protected override void ChangeTargetStorage(Storage newStorage)
|
|
||||||
{
|
|
||||||
// due to an unfortunate oversight, on OSes that are sensitive to pathname casing
|
|
||||||
// the custom flags directory needed to be named `Flags` (uppercase),
|
|
||||||
// while custom mods and videos directories needed to be named `mods` and `videos` respectively (lowercase).
|
|
||||||
// to unify handling to uppercase, move any non-compliant directories automatically for the user to migrate.
|
|
||||||
// can be removed 20220528
|
|
||||||
if (newStorage.ExistsDirectory("flags"))
|
|
||||||
AttemptOperation(() => Directory.Move(newStorage.GetFullPath("flags"), newStorage.GetFullPath("Flags")));
|
|
||||||
if (newStorage.ExistsDirectory("mods"))
|
|
||||||
AttemptOperation(() => Directory.Move(newStorage.GetFullPath("mods"), newStorage.GetFullPath("Mods")));
|
|
||||||
if (newStorage.ExistsDirectory("videos"))
|
|
||||||
AttemptOperation(() => Directory.Move(newStorage.GetFullPath("videos"), newStorage.GetFullPath("Videos")));
|
|
||||||
|
|
||||||
base.ChangeTargetStorage(newStorage);
|
|
||||||
}
|
|
||||||
|
|
||||||
public IEnumerable<string> ListTournaments() => AllTournaments.GetDirectories(string.Empty);
|
public IEnumerable<string> ListTournaments() => AllTournaments.GetDirectories(string.Empty);
|
||||||
|
|
||||||
public override bool Migrate(Storage newStorage)
|
|
||||||
{
|
|
||||||
// this migration only happens once on moving to the per-tournament storage system.
|
|
||||||
// listed files are those known at that point in time.
|
|
||||||
// this can be removed at some point in the future (6 months obsoletion would mean 2021-04-19)
|
|
||||||
|
|
||||||
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(TournamentGameBase.BRACKET_FILENAME, destination);
|
|
||||||
moveFileIfExists("drawings.txt", destination);
|
|
||||||
moveFileIfExists("drawings_results.txt", destination);
|
|
||||||
moveFileIfExists("drawings.ini", destination);
|
|
||||||
|
|
||||||
ChangeTargetStorage(newStorage);
|
|
||||||
storageConfig.SetValue(StorageConfig.CurrentTournament, default_tournament);
|
|
||||||
storageConfig.Save();
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
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();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue