diff --git a/src/Tgstation.Server.Host/Components/Byond/ByondManager.cs b/src/Tgstation.Server.Host/Components/Byond/EngineManager.cs similarity index 97% rename from src/Tgstation.Server.Host/Components/Byond/ByondManager.cs rename to src/Tgstation.Server.Host/Components/Byond/EngineManager.cs index 3c6f06c3ad..a1bf41f3da 100644 --- a/src/Tgstation.Server.Host/Components/Byond/ByondManager.cs +++ b/src/Tgstation.Server.Host/Components/Byond/EngineManager.cs @@ -20,7 +20,7 @@ using Tgstation.Server.Host.Utils; namespace Tgstation.Server.Host.Components.Byond { /// - sealed class ByondManager : IByondManager + sealed class EngineManager : IEngineManager { /// /// The path to the BYOND bin folder. @@ -66,24 +66,24 @@ namespace Tgstation.Server.Host.Components.Byond static readonly SemaphoreSlim UserFilesSemaphore = new (1); /// - /// The for the . + /// The for the . /// readonly IIOManager ioManager; /// - /// The for the . + /// The for the . /// readonly IByondInstaller byondInstaller; /// - /// The for the . + /// The for the . /// readonly IEventConsumer eventConsumer; /// - /// The for the . + /// The for the . /// - readonly ILogger logger; + readonly ILogger logger; /// /// Map of byond s to s that complete when they are installed. @@ -116,13 +116,13 @@ namespace Tgstation.Server.Host.Components.Byond } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The value of . /// The value of . /// The value of . /// The value of . - public ByondManager(IIOManager ioManager, IByondInstaller byondInstaller, IEventConsumer eventConsumer, ILogger logger) + public EngineManager(IIOManager ioManager, IByondInstaller byondInstaller, IEventConsumer eventConsumer, ILogger logger) { this.ioManager = ioManager ?? throw new ArgumentNullException(nameof(ioManager)); this.byondInstaller = byondInstaller ?? throw new ArgumentNullException(nameof(byondInstaller)); diff --git a/src/Tgstation.Server.Host/Components/Byond/IByondManager.cs b/src/Tgstation.Server.Host/Components/Byond/IEngineManager.cs similarity index 97% rename from src/Tgstation.Server.Host/Components/Byond/IByondManager.cs rename to src/Tgstation.Server.Host/Components/Byond/IEngineManager.cs index 1da8c041d1..80425fe4a5 100644 --- a/src/Tgstation.Server.Host/Components/Byond/IByondManager.cs +++ b/src/Tgstation.Server.Host/Components/Byond/IEngineManager.cs @@ -11,10 +11,10 @@ using Tgstation.Server.Host.Jobs; namespace Tgstation.Server.Host.Components.Byond { /// - /// For managing the BYOND installation. + /// For managing the engine installations. /// /// When passing in s for , ensure they are BYOND format versions unless referring to a custom version. This means should NEVER be 0. - public interface IByondManager : IComponentService, IDisposable + public interface IEngineManager : IComponentService, IDisposable { /// /// The currently active . diff --git a/src/Tgstation.Server.Host/Components/Byond/PosixByondInstaller.cs b/src/Tgstation.Server.Host/Components/Byond/PosixByondInstaller.cs index 7fed2498ec..ff094a9636 100644 --- a/src/Tgstation.Server.Host/Components/Byond/PosixByondInstaller.cs +++ b/src/Tgstation.Server.Host/Components/Byond/PosixByondInstaller.cs @@ -99,7 +99,7 @@ namespace Tgstation.Server.Host.Components.Byond postWriteHandler.HandleWrite(IOManager.ResolvePath(pathToScript)); } - var basePath = IOManager.ConcatPath(path, ByondManager.BinPath); + var basePath = IOManager.ConcatPath(path, EngineManager.BinPath); var ddTask = WriteAndMakeExecutable( IOManager.ConcatPath(basePath, GetDreamDaemonName(version, out _, out _)), diff --git a/src/Tgstation.Server.Host/Components/Byond/WindowsByondInstaller.cs b/src/Tgstation.Server.Host/Components/Byond/WindowsByondInstaller.cs index 0b177584a4..ce3e5aad12 100644 --- a/src/Tgstation.Server.Host/Components/Byond/WindowsByondInstaller.cs +++ b/src/Tgstation.Server.Host/Components/Byond/WindowsByondInstaller.cs @@ -235,7 +235,7 @@ namespace Tgstation.Server.Host.Components.Byond var dreamDaemonPath = IOManager.ResolvePath( IOManager.ConcatPath( path, - ByondManager.BinPath, + EngineManager.BinPath, dreamDaemonName)); Logger.LogInformation("Adding Windows Firewall exception for {path}...", dreamDaemonPath); diff --git a/src/Tgstation.Server.Host/Components/Chat/Commands/ByondCommand.cs b/src/Tgstation.Server.Host/Components/Chat/Commands/ByondCommand.cs index 8f7b680293..9cfc07fbd7 100644 --- a/src/Tgstation.Server.Host/Components/Chat/Commands/ByondCommand.cs +++ b/src/Tgstation.Server.Host/Components/Chat/Commands/ByondCommand.cs @@ -25,9 +25,9 @@ namespace Tgstation.Server.Host.Components.Chat.Commands public bool AdminOnly => false; /// - /// The for the . + /// The for the . /// - readonly IByondManager byondManager; + readonly IEngineManager engineManager; /// /// The for the . @@ -37,11 +37,11 @@ namespace Tgstation.Server.Host.Components.Chat.Commands /// /// Initializes a new instance of the class. /// - /// The value of . + /// The value of . /// The value of . - public ByondCommand(IByondManager byondManager, IWatchdog watchdog) + public ByondCommand(IEngineManager engineManager, IWatchdog watchdog) { - this.byondManager = byondManager ?? throw new ArgumentNullException(nameof(byondManager)); + this.engineManager = engineManager ?? throw new ArgumentNullException(nameof(engineManager)); this.watchdog = watchdog ?? throw new ArgumentNullException(nameof(watchdog)); } @@ -51,22 +51,22 @@ namespace Tgstation.Server.Host.Components.Chat.Commands if (arguments.Split(' ').Any(x => x.Equals("--active", StringComparison.OrdinalIgnoreCase))) { string text; - if (byondManager.ActiveVersion == null) + if (engineManager.ActiveVersion == null) text = "None!"; else - switch (byondManager.ActiveVersion.Engine.Value) + switch (engineManager.ActiveVersion.Engine.Value) { case EngineType.OpenDream: - text = $"OpenDream: {byondManager.ActiveVersion.SourceCommittish}"; + text = $"OpenDream: {engineManager.ActiveVersion.SourceCommittish}"; break; case EngineType.Byond: - text = $"BYOND {byondManager.ActiveVersion.Version.Major}.{byondManager.ActiveVersion.Version.Minor}"; - if (byondManager.ActiveVersion.Version.Build != -1) + text = $"BYOND {engineManager.ActiveVersion.Version.Major}.{engineManager.ActiveVersion.Version.Minor}"; + if (engineManager.ActiveVersion.Version.Build != -1) text += " (Custom Build)"; break; default: - throw new InvalidOperationException($"Invalid EngineType: {byondManager.ActiveVersion.Engine.Value}"); + throw new InvalidOperationException($"Invalid EngineType: {engineManager.ActiveVersion.Engine.Value}"); } return ValueTask.FromResult( diff --git a/src/Tgstation.Server.Host/Components/Chat/Commands/CommandFactory.cs b/src/Tgstation.Server.Host/Components/Chat/Commands/CommandFactory.cs index 06eb90dd75..d8678fe85f 100644 --- a/src/Tgstation.Server.Host/Components/Chat/Commands/CommandFactory.cs +++ b/src/Tgstation.Server.Host/Components/Chat/Commands/CommandFactory.cs @@ -19,9 +19,9 @@ namespace Tgstation.Server.Host.Components.Chat.Commands readonly IAssemblyInformationProvider assemblyInformationProvider; /// - /// The for the . + /// The for the . /// - readonly IByondManager byondManager; + readonly IEngineManager engineManager; /// /// The for the . @@ -52,21 +52,21 @@ namespace Tgstation.Server.Host.Components.Chat.Commands /// Initializes a new instance of the class. /// /// The value of . - /// The value of . + /// The value of . /// The value of . /// The value of . /// The value of . /// The value of . public CommandFactory( IAssemblyInformationProvider assemblyInformationProvider, - IByondManager byondManager, + IEngineManager engineManager, IRepositoryManager repositoryManager, IDatabaseContextFactory databaseContextFactory, ILatestCompileJobProvider compileJobProvider, Models.Instance instance) { this.assemblyInformationProvider = assemblyInformationProvider ?? throw new ArgumentNullException(nameof(assemblyInformationProvider)); - this.byondManager = byondManager ?? throw new ArgumentNullException(nameof(byondManager)); + this.engineManager = engineManager ?? throw new ArgumentNullException(nameof(engineManager)); this.repositoryManager = repositoryManager ?? throw new ArgumentNullException(nameof(repositoryManager)); this.databaseContextFactory = databaseContextFactory ?? throw new ArgumentNullException(nameof(databaseContextFactory)); this.compileJobProvider = compileJobProvider ?? throw new ArgumentNullException(nameof(compileJobProvider)); @@ -92,7 +92,7 @@ namespace Tgstation.Server.Host.Components.Chat.Commands return new List { new VersionCommand(assemblyInformationProvider), - new ByondCommand(byondManager, watchdog), + new ByondCommand(engineManager, watchdog), new RevisionCommand(watchdog, repositoryManager), new PullRequestsCommand(watchdog, repositoryManager, databaseContextFactory, compileJobProvider, instance), new KekCommand(), diff --git a/src/Tgstation.Server.Host/Components/Deployment/DreamMaker.cs b/src/Tgstation.Server.Host/Components/Deployment/DreamMaker.cs index d31de3c46f..c9ea5a5c72 100644 --- a/src/Tgstation.Server.Host/Components/Deployment/DreamMaker.cs +++ b/src/Tgstation.Server.Host/Components/Deployment/DreamMaker.cs @@ -41,9 +41,9 @@ namespace Tgstation.Server.Host.Components.Deployment const string DmeExtension = "dme"; /// - /// The for . + /// The for . /// - readonly IByondManager byond; + readonly IEngineManager engineManager; /// /// The for . @@ -143,7 +143,7 @@ namespace Tgstation.Server.Host.Components.Deployment /// /// Initializes a new instance of the class. /// - /// The value of . + /// The value of . /// The value of . /// The value of . /// The value of . @@ -158,7 +158,7 @@ namespace Tgstation.Server.Host.Components.Deployment /// The value of . /// The value of . public DreamMaker( - IByondManager byond, + IEngineManager engineManager, IIOManager ioManager, StaticFiles.IConfiguration configuration, ISessionControllerFactory sessionControllerFactory, @@ -173,7 +173,7 @@ namespace Tgstation.Server.Host.Components.Deployment SessionConfiguration sessionConfiguration, Api.Models.Instance metadata) { - this.byond = byond ?? throw new ArgumentNullException(nameof(byond)); + this.engineManager = engineManager ?? throw new ArgumentNullException(nameof(engineManager)); this.ioManager = ioManager ?? throw new ArgumentNullException(nameof(ioManager)); this.configuration = configuration ?? throw new ArgumentNullException(nameof(configuration)); this.sessionControllerFactory = sessionControllerFactory ?? throw new ArgumentNullException(nameof(sessionControllerFactory)); @@ -482,7 +482,7 @@ namespace Tgstation.Server.Host.Components.Deployment var progressTask = ProgressTask(progressReporter, estimatedDuration, progressCts.Token); try { - using var byondLock = await byond.UseExecutables(null, null, cancellationToken); + using var byondLock = await engineManager.UseExecutables(null, null, cancellationToken); currentChatCallback = chatManager.QueueDeploymentMessage( revisionInformation, byondLock.Version, diff --git a/src/Tgstation.Server.Host/Components/IInstanceCore.cs b/src/Tgstation.Server.Host/Components/IInstanceCore.cs index d42b4e69da..c19dffad82 100644 --- a/src/Tgstation.Server.Host/Components/IInstanceCore.cs +++ b/src/Tgstation.Server.Host/Components/IInstanceCore.cs @@ -20,9 +20,9 @@ namespace Tgstation.Server.Host.Components IRepositoryManager RepositoryManager { get; } /// - /// The for the . + /// The for the . /// - IByondManager ByondManager { get; } + IEngineManager EngineManager { get; } /// /// The for the . diff --git a/src/Tgstation.Server.Host/Components/Instance.cs b/src/Tgstation.Server.Host/Components/Instance.cs index 879478a207..6d9c61e118 100644 --- a/src/Tgstation.Server.Host/Components/Instance.cs +++ b/src/Tgstation.Server.Host/Components/Instance.cs @@ -36,7 +36,7 @@ namespace Tgstation.Server.Host.Components public IRepositoryManager RepositoryManager { get; } /// - public IByondManager ByondManager { get; } + public IEngineManager EngineManager { get; } /// public IWatchdog Watchdog { get; } @@ -105,7 +105,7 @@ namespace Tgstation.Server.Host.Components /// /// The value of . /// The value of . - /// The value of . + /// The value of . /// The value of . /// The value of . /// The value of . @@ -119,7 +119,7 @@ namespace Tgstation.Server.Host.Components public Instance( Api.Models.Instance metadata, IRepositoryManager repositoryManager, - IByondManager byondManager, + IEngineManager engineManager, IDreamMaker dreamMaker, IWatchdog watchdog, IChatManager chat, @@ -134,7 +134,7 @@ namespace Tgstation.Server.Host.Components { this.metadata = metadata ?? throw new ArgumentNullException(nameof(metadata)); RepositoryManager = repositoryManager ?? throw new ArgumentNullException(nameof(repositoryManager)); - ByondManager = byondManager ?? throw new ArgumentNullException(nameof(byondManager)); + EngineManager = engineManager ?? throw new ArgumentNullException(nameof(engineManager)); DreamMaker = dreamMaker ?? throw new ArgumentNullException(nameof(dreamMaker)); Watchdog = watchdog ?? throw new ArgumentNullException(nameof(watchdog)); Chat = chat ?? throw new ArgumentNullException(nameof(chat)); @@ -160,7 +160,7 @@ namespace Tgstation.Server.Host.Components Configuration.Dispose(); dmbFactory.Dispose(); RepositoryManager.Dispose(); - ByondManager.Dispose(); + EngineManager.Dispose(); await chatDispose; await watchdogDispose; } @@ -185,7 +185,7 @@ namespace Tgstation.Server.Host.Components await Task.WhenAll( SetAutoUpdateInterval(metadata.AutoUpdateInterval.Value).AsTask(), Configuration.StartAsync(cancellationToken), - ByondManager.StartAsync(cancellationToken), + EngineManager.StartAsync(cancellationToken), Chat.StartAsync(cancellationToken), dmbFactory.StartAsync(cancellationToken)); @@ -206,7 +206,7 @@ namespace Tgstation.Server.Host.Components await Watchdog.StopAsync(cancellationToken); await Task.WhenAll( Configuration.StopAsync(cancellationToken), - ByondManager.StopAsync(cancellationToken), + EngineManager.StopAsync(cancellationToken), Chat.StopAsync(cancellationToken), dmbFactory.StopAsync(cancellationToken)); } diff --git a/src/Tgstation.Server.Host/Components/InstanceFactory.cs b/src/Tgstation.Server.Host/Components/InstanceFactory.cs index 6d9d7a8b61..c0007af861 100644 --- a/src/Tgstation.Server.Host/Components/InstanceFactory.cs +++ b/src/Tgstation.Server.Host/Components/InstanceFactory.cs @@ -296,7 +296,7 @@ namespace Tgstation.Server.Host.Components generalConfiguration); try { - var byond = new ByondManager(byondIOManager, byondInstaller, eventConsumer, loggerFactory.CreateLogger()); + var byond = new EngineManager(byondIOManager, byondInstaller, eventConsumer, loggerFactory.CreateLogger()); var dmbFactory = new DmbFactory( databaseContextFactory, diff --git a/src/Tgstation.Server.Host/Components/InstanceWrapper.cs b/src/Tgstation.Server.Host/Components/InstanceWrapper.cs index c8524b50e2..08e2792e01 100644 --- a/src/Tgstation.Server.Host/Components/InstanceWrapper.cs +++ b/src/Tgstation.Server.Host/Components/InstanceWrapper.cs @@ -25,7 +25,7 @@ namespace Tgstation.Server.Host.Components public IRepositoryManager RepositoryManager => Instance.RepositoryManager; /// - public IByondManager ByondManager => Instance.ByondManager; + public IEngineManager EngineManager => Instance.EngineManager; /// public IDreamMaker DreamMaker => Instance.DreamMaker; diff --git a/src/Tgstation.Server.Host/Components/Session/SessionControllerFactory.cs b/src/Tgstation.Server.Host/Components/Session/SessionControllerFactory.cs index e45ed439d6..5a72ee8c01 100644 --- a/src/Tgstation.Server.Host/Components/Session/SessionControllerFactory.cs +++ b/src/Tgstation.Server.Host/Components/Session/SessionControllerFactory.cs @@ -42,9 +42,9 @@ namespace Tgstation.Server.Host.Components.Session readonly IProcessExecutor processExecutor; /// - /// The for the . + /// The for the . /// - readonly IByondManager byond; + readonly IEngineManager engineManager; /// /// The for the . @@ -147,7 +147,7 @@ namespace Tgstation.Server.Host.Components.Session /// Initializes a new instance of the class. /// /// The value of . - /// The value of . + /// The value of . /// The value of . /// The value of . /// The value of . @@ -166,7 +166,7 @@ namespace Tgstation.Server.Host.Components.Session /// The value of . public SessionControllerFactory( IProcessExecutor processExecutor, - IByondManager byond, + IEngineManager engineManager, ITopicClientFactory topicClientFactory, ICryptographySuite cryptographySuite, IAssemblyInformationProvider assemblyInformationProvider, @@ -185,7 +185,7 @@ namespace Tgstation.Server.Host.Components.Session Api.Models.Instance instance) { this.processExecutor = processExecutor ?? throw new ArgumentNullException(nameof(processExecutor)); - this.byond = byond ?? throw new ArgumentNullException(nameof(byond)); + this.engineManager = engineManager ?? throw new ArgumentNullException(nameof(engineManager)); this.topicClientFactory = topicClientFactory ?? throw new ArgumentNullException(nameof(topicClientFactory)); this.cryptographySuite = cryptographySuite ?? throw new ArgumentNullException(nameof(cryptographySuite)); this.assemblyInformationProvider = assemblyInformationProvider ?? throw new ArgumentNullException(nameof(assemblyInformationProvider)); @@ -239,7 +239,7 @@ namespace Tgstation.Server.Host.Components.Session } // get the byond lock - var byondLock = currentByondLock ?? await byond.UseExecutables( + var byondLock = currentByondLock ?? await engineManager.UseExecutables( dmbProvider.ByondVersion, gameIOManager.ConcatPath(dmbProvider.Directory, dmbProvider.DmbName), cancellationToken); @@ -370,7 +370,7 @@ namespace Tgstation.Server.Host.Components.Session logger.LogTrace("Begin session reattach..."); var byondTopicSender = topicClientFactory.CreateTopicClient(reattachInformation.TopicRequestTimeout); - var byondLock = await byond.UseExecutables( + var byondLock = await engineManager.UseExecutables( reattachInformation.Dmb.ByondVersion, null, // Doesn't matter if it's trusted or not on reattach cancellationToken); diff --git a/src/Tgstation.Server.Host/Controllers/ByondController.cs b/src/Tgstation.Server.Host/Controllers/ByondController.cs index 19212d7c5b..42732cf6ae 100644 --- a/src/Tgstation.Server.Host/Controllers/ByondController.cs +++ b/src/Tgstation.Server.Host/Controllers/ByondController.cs @@ -84,10 +84,10 @@ namespace Tgstation.Server.Host.Controllers public ValueTask Read() => WithComponentInstance(instance => ValueTask.FromResult( - instance.ByondManager.ActiveVersion != null + instance.EngineManager.ActiveVersion != null ? Json( new ByondResponse( - instance.ByondManager.ActiveVersion)) + instance.EngineManager.ActiveVersion)) : Conflict(new ErrorMessageResponse(ErrorCode.ResourceNotPresent)))); /// @@ -107,7 +107,7 @@ namespace Tgstation.Server.Host.Controllers () => ValueTask.FromResult( new PaginatableResult( instance - .ByondManager + .EngineManager .InstalledVersions .Select(x => new ByondResponse(x)) .AsQueryable() @@ -169,7 +169,7 @@ namespace Tgstation.Server.Host.Controllers return await WithComponentInstance( async instance => { - var byondManager = instance.ByondManager; + var byondManager = instance.EngineManager; var versionAlreadyInstalled = !uploadingZip && byondManager.InstalledVersions.Any(x => x.Equals(model)); if (versionAlreadyInstalled) { @@ -231,7 +231,7 @@ namespace Tgstation.Server.Host.Controllers async (core, databaseContextFactory, paramJob, progressHandler, jobCancellationToken) => { if (sourceRepo != null) - await core.ByondManager.EnsureEngineSource( + await core.EngineManager.EnsureEngineSource( sourceRepo, model.Engine.Value, jobCancellationToken); @@ -254,7 +254,7 @@ namespace Tgstation.Server.Host.Controllers } await using (zipFileStream) - await core.ByondManager.ChangeVersion( + await core.EngineManager.ChangeVersion( progressHandler, model, zipFileStream, @@ -306,7 +306,7 @@ namespace Tgstation.Server.Host.Controllers var notInstalledResponse = await WithComponentInstance( instance => { - var byondManager = instance.ByondManager; + var byondManager = instance.EngineManager; if (model.Equals(byondManager.ActiveVersion)) return ValueTask.FromResult( @@ -343,7 +343,7 @@ namespace Tgstation.Server.Host.Controllers await jobManager.RegisterOperation( job, (instanceCore, databaseContextFactory, job, progressReporter, jobCancellationToken) - => instanceCore.ByondManager.DeleteVersion(progressReporter, model, jobCancellationToken), + => instanceCore.EngineManager.DeleteVersion(progressReporter, model, jobCancellationToken), cancellationToken); var apiResponse = job.ToApi(); diff --git a/tests/Tgstation.Server.Tests/Live/DummyChatProviderFactory.cs b/tests/Tgstation.Server.Tests/Live/DummyChatProviderFactory.cs index d4d7c98b09..ba12c498ec 100644 --- a/tests/Tgstation.Server.Tests/Live/DummyChatProviderFactory.cs +++ b/tests/Tgstation.Server.Tests/Live/DummyChatProviderFactory.cs @@ -40,7 +40,7 @@ namespace Tgstation.Server.Tests.Live var commandFactory = new CommandFactory( Mock.Of(), - Mock.Of(), + Mock.Of(), Mock.Of(), Mock.Of(), Mock.Of(), diff --git a/tests/Tgstation.Server.Tests/TestVersions.cs b/tests/Tgstation.Server.Tests/TestVersions.cs index 387438b687..30d39e2cb9 100644 --- a/tests/Tgstation.Server.Tests/TestVersions.cs +++ b/tests/Tgstation.Server.Tests/TestVersions.cs @@ -441,7 +441,7 @@ namespace Tgstation.Server.Tests var ddPath = ioManager.ConcatPath( tempPath, - ByondManager.BinPath, + EngineManager.BinPath, byondInstaller.GetDreamDaemonName(byondVersion, out var supportsCli, out var shouldSupportMapThreads)); Assert.IsTrue(supportsCli);