// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Diagnostics;
using Microsoft.Extensions.Internal;
using Microsoft.Extensions.Logging;
 
namespace Microsoft.AspNetCore.Server.IntegrationTesting;
 
/// <summary>
/// Abstract base class of all deployers with implementation of some of the common helpers.
/// </summary>
public abstract class ApplicationDeployer : IDisposable
{
    public static readonly string DotnetCommandName = "dotnet";
 
    private readonly Stopwatch _stopwatch = new Stopwatch();
 
    private PublishedApplication _publishedApplication;
 
    public ApplicationDeployer(DeploymentParameters deploymentParameters, ILoggerFactory loggerFactory)
    {
        DeploymentParameters = deploymentParameters;
        LoggerFactory = loggerFactory;
        Logger = LoggerFactory.CreateLogger(GetType().FullName);
 
        ValidateParameters();
    }
 
    private void ValidateParameters()
    {
        if (DeploymentParameters.ServerType == ServerType.None)
        {
            throw new ArgumentException($"Invalid ServerType '{DeploymentParameters.ServerType}'.");
        }
 
        if (DeploymentParameters.RuntimeFlavor == RuntimeFlavor.None && !string.IsNullOrEmpty(DeploymentParameters.TargetFramework))
        {
            DeploymentParameters.RuntimeFlavor = GetRuntimeFlavor(DeploymentParameters.TargetFramework);
        }
 
        if (DeploymentParameters.ApplicationPublisher == null)
        {
            ArgumentException.ThrowIfNullOrEmpty(DeploymentParameters.ApplicationPath);
 
            if (!Directory.Exists(DeploymentParameters.ApplicationPath))
            {
                throw new DirectoryNotFoundException($"Application path {DeploymentParameters.ApplicationPath} does not exist.");
            }
 
            if (string.IsNullOrEmpty(DeploymentParameters.ApplicationName))
            {
                DeploymentParameters.ApplicationName = new DirectoryInfo(DeploymentParameters.ApplicationPath).Name;
            }
        }
    }
 
    private static RuntimeFlavor GetRuntimeFlavor(string tfm)
    {
        if (Tfm.Matches(Tfm.Net462, tfm))
        {
            return RuntimeFlavor.Clr;
        }
        return RuntimeFlavor.CoreClr;
    }
 
    protected DeploymentParameters DeploymentParameters { get; }
 
    protected ILoggerFactory LoggerFactory { get; }
 
    protected ILogger Logger { get; }
 
    public abstract Task<DeploymentResult> DeployAsync();
 
    protected void DotnetPublish(string publishRoot = null)
    {
        var publisher = DeploymentParameters.ApplicationPublisher ?? new ApplicationPublisher(DeploymentParameters.ApplicationPath);
        _publishedApplication = publisher.Publish(DeploymentParameters, Logger).GetAwaiter().GetResult();
        DeploymentParameters.PublishedApplicationRootPath = _publishedApplication.Path;
    }
 
    protected void CleanPublishedOutput()
    {
        using (Logger.BeginScope("CleanPublishedOutput"))
        {
            if (DeploymentParameters.PreservePublishedApplicationForDebugging)
            {
                Logger.LogWarning(
                    "Skipping deleting the locally published folder as property " +
                    $"'{nameof(DeploymentParameters.PreservePublishedApplicationForDebugging)}' is set to 'true'.");
            }
            else
            {
                _publishedApplication?.Dispose();
            }
        }
    }
 
    protected string GetDotNetExeForArchitecture()
    {
        var executableName = DotnetCommandName;
        // We expect x64 dotnet.exe to be on the path but we have to go searching for the x86 version.
        if (DotNetCommands.IsRunningX86OnX64(DeploymentParameters.RuntimeArchitecture))
        {
            executableName = DotNetCommands.GetDotNetExecutable(DeploymentParameters.RuntimeArchitecture);
            if (!File.Exists(executableName))
            {
                throw new Exception($"Unable to find '{executableName}'.'");
            }
        }
 
        return executableName;
    }
 
    protected void ShutDownIfAnyHostProcess(Process hostProcess)
    {
        if (hostProcess != null && !hostProcess.HasExited)
        {
            Logger.LogInformation("Attempting to cancel process {0}", hostProcess.Id);
 
            // Shutdown the host process.
            hostProcess.KillTree();
            if (!hostProcess.HasExited)
            {
                Logger.LogWarning("Unable to terminate the host process with process Id '{processId}", hostProcess.Id);
            }
            else
            {
                Logger.LogInformation("Successfully terminated host process with process Id '{processId}'", hostProcess.Id);
            }
        }
        else
        {
            Logger.LogWarning("Host process already exited or never started successfully.");
        }
    }
 
    protected void AddEnvironmentVariablesToProcess(ProcessStartInfo startInfo, IDictionary<string, string> environmentVariables)
    {
        var environment = startInfo.Environment;
        ProcessHelpers.SetEnvironmentVariable(environment, "ASPNETCORE_ENVIRONMENT", DeploymentParameters.EnvironmentName, Logger);
        ProcessHelpers.AddEnvironmentVariablesToProcess(startInfo, environmentVariables, Logger);
    }
 
    protected void InvokeUserApplicationCleanup()
    {
        using (Logger.BeginScope("UserAdditionalCleanup"))
        {
            if (DeploymentParameters.UserAdditionalCleanup != null)
            {
                // User cleanup.
                try
                {
                    DeploymentParameters.UserAdditionalCleanup(DeploymentParameters);
                }
                catch (Exception exception)
                {
                    Logger.LogWarning("User cleanup code failed with exception : {exception}", exception.Message);
                }
            }
        }
    }
 
    protected void TriggerHostShutdown(CancellationTokenSource hostShutdownSource)
    {
        Logger.LogInformation("Host process shutting down.");
        try
        {
            hostShutdownSource.Cancel();
        }
        catch (Exception)
        {
            // Suppress errors.
        }
    }
 
    protected void StartTimer()
    {
        Logger.LogInformation($"Deploying {DeploymentParameters}");
        _stopwatch.Start();
    }
 
    protected void StopTimer()
    {
        _stopwatch.Stop();
        Logger.LogInformation("[Time]: Total time taken for this test variation '{t}' seconds", _stopwatch.Elapsed.TotalSeconds);
    }
 
    public abstract void Dispose();
}