EngineInstallerBase.cs

Go to the documentation of this file.

using System;
using System.Threading;
using System.Threading.Tasks;
 
using Microsoft.Extensions.Logging;
 
using Tgstation.Server.Api.Models;
using Tgstation.Server.Host.IO;
using Tgstation.Server.Host.Jobs;
 
namespace Tgstation.Server.Host.Components.Engine
{
    abstract class EngineInstallerBase : IEngineInstaller
    {
        protected abstract EngineType TargetEngineType { get; }
 
        protected IIOManager IOManager { get; }
 
        protected ILogger<EngineInstallerBase> Logger { get; }
 
        protected EngineInstallerBase(IIOManager ioManager, ILogger<EngineInstallerBase> logger)
        {
            IOManager = ioManager ?? throw new ArgumentNullException(nameof(ioManager));
            Logger = logger ?? throw new ArgumentNullException(nameof(logger));
        }
 
        public abstract ValueTask<IEngineInstallation> GetInstallation(EngineVersion version, string path, Task installationTask, CancellationToken cancellationToken);
 
        public abstract Task CleanCache(CancellationToken cancellationToken);
 
        public async ValueTask<IEngineInstallation> Install(EngineVersion version, string path, bool deploymentPipelineProcesses, CancellationToken cancellationToken)
        {
            CheckVersionValidity(version);
            ArgumentNullException.ThrowIfNull(path);
 
            await InstallImpl(version, path, deploymentPipelineProcesses, cancellationToken);
 
            return await GetInstallation(version, path, Task.CompletedTask, cancellationToken);
        }
 
        public abstract ValueTask UpgradeInstallation(EngineVersion version, string path, CancellationToken cancellationToken);
 
        public abstract ValueTask<IEngineInstallationData> DownloadVersion(EngineVersion version, JobProgressReporter jobProgressReporter, CancellationToken cancellationToken);
 
        public abstract ValueTask TrustDmbPath(EngineVersion version, string fullDmbPath, CancellationToken cancellationToken);
 
        protected void CheckVersionValidity(EngineVersion version)
        {
            ArgumentNullException.ThrowIfNull(version);
            if (version.Engine!.Value != TargetEngineType)
                throw new InvalidOperationException($"Non-{TargetEngineType} engine specified: {version.Engine.Value}");
        }
 
        protected abstract ValueTask InstallImpl(EngineVersion version, string path, bool deploymentPipelineProcesses, CancellationToken cancellationToken);
    }
}