fix: Move ECS CF Generation to Calamari

source/Calamari.Aws/AwsModule.cs

@@ -1,4 +1,5 @@
 using Autofac;
+using Calamari.Aws.Inputs.Ecs;
 using Calamari.Aws.Integration.Ecs;
 
 namespace Calamari.Aws;
@@ -8,5 +9,6 @@ public class AwsModule: Module
     protected override void Load(ContainerBuilder builder)
     {
         builder.RegisterType<EcsStackNameGenerator>().As<IEcsStackNameGenerator>().SingleInstance();
+        builder.RegisterType<EcsImageNameResolver>().As<IEcsImageNameResolver>().SingleInstance();
     }
 }

source/Calamari.Aws/Commands/DeployEcsServiceCommand.cs

@@ -1,142 +1,44 @@
 using System;
-using System.Collections.Generic;
-using Amazon.CloudFormation;
-using Calamari.Aws.Deployment;
 using Calamari.Aws.Deployment.Conventions;
-using Calamari.Aws.Integration.CloudFormation;
-using Calamari.Aws.Integration.CloudFormation.Templates;
+using Calamari.Aws.Inputs.Ecs;
 using Calamari.Aws.Integration.Ecs;
-using Calamari.Aws.Util;
 using Calamari.CloudAccounts;
 using Calamari.Commands.Support;
 using Calamari.Common.Commands;
-using Calamari.Common.Plumbing;
-using Calamari.Common.Plumbing.FileSystem;
 using Calamari.Common.Plumbing.Logging;
 using Calamari.Common.Plumbing.Variables;
-using Calamari.Common.Util;
 using Calamari.Deployment;
-using Newtonsoft.Json;
 
 namespace Calamari.Aws.Commands;
 
-[Command("deploy-aws-ecs-service", Description = "Deploys a service to an Amazon ECS cluster")]
-public class DeployEcsServiceCommand : Command
+[Command(CommandName, Description = "Deploys a service to an Amazon ECS cluster")]
+public class DeployEcsServiceCommand(ILog log, IVariables variables, IEcsStackNameGenerator stackNameGenerator, IEcsImageNameResolver ecsImageNameResolver) : Command
 {
-    readonly ILog log;
-    readonly IVariables variables;
-    readonly ICalamariFileSystem fileSystem;
-    readonly IEcsStackNameGenerator stackNameGenerator;
-    string templateFile;
-    string templateParameterFile;
-
-    public DeployEcsServiceCommand(ILog log, IVariables variables, ICalamariFileSystem fileSystem, IEcsStackNameGenerator stackNameGenerator)
-    {
-        this.log = log;
-        this.variables = variables;
-        this.fileSystem = fileSystem;
-        this.stackNameGenerator = stackNameGenerator;
-        Options.Add("template=", "Path to the CloudFormation template file.", v => templateFile = v);
-        Options.Add("templateParameters=", "Path to the CloudFormation template parameters JSON file.", v => templateParameterFile = v);
-    }
+    const string CommandName = "deploy-aws-ecs-service";
 
     public override int Execute(string[] commandLineArguments)
     {
-        Options.Parse(commandLineArguments);
-
-        Guard.NotNullOrWhiteSpace(templateFile, "The --template argument is required.");
-
         var environment = AwsEnvironmentGeneration.Create(log, variables).GetAwaiter().GetResult();
-        var inputs = ReadAndValidateInputs();
+        var inputs = new DeployEcsCommandInputs(variables, stackNameGenerator, ecsImageNameResolver, log);
+        var inputValidity = inputs.Validate();
+        if (!inputValidity.IsValid)
+        {
+            throw new CommandException(inputValidity.MissingKeyList);
+        }
 
-        var stackArn = new StackArn(inputs.StackName);
-        var templateResolver = new TemplateResolver(fileSystem);
 
         new ConventionProcessor(new RunningDeployment(variables),
                                 [
                                     new LogAwsUserInfoConvention(environment),
-                                    new DeployAwsCloudFormationConvention(ClientFactory,
-                                                                          TemplateFactory,
-                                                                          new StackEventLogger(log),
-                                                                          _ => stackArn,
-                                                                          inputs.WaitForComplete,
-                                                                          inputs.StackName,
-                                                                          environment,
-                                                                          log,
-                                                                          inputs.WaitTimeout),
+                                    new DeployEcsServiceConvention(inputs, environment, log, variables),
                                     new SetEcsOutputVariablesConvention(environment,
-                                                                        inputs.StackName,
+                                                                        inputs.CfStackName,
                                                                         inputs.ClusterName,
-                                                                        inputs.ServiceName,
+                                                                        inputs.ServiceTaskName, 
                                                                         log)
                                 ],
                                 log).RunConventions();
 
         return 0;
-
-        IAmazonCloudFormation ClientFactory() => ClientHelpers.CreateCloudFormationClient(environment);
-
-        ICloudFormationRequestBuilder TemplateFactory() =>
-            CloudFormationTemplate.Create(templateResolver,
-                                          templateFile,
-                                          templateParameterFile,
-                                          filesInPackage: false,
-                                          fileSystem,
-                                          variables,
-                                          inputs.StackName,
-                                          capabilities: ["CAPABILITY_NAMED_IAM"],
-                                          disableRollback: false,
-                                          roleArn: null,
-                                          tags: inputs.Tags,
-                                          stackArn,
-                                          ClientFactory);
     }
-
-    EcsCommandInputs ReadAndValidateInputs()
-    {
-        var clusterName = variables.Get(AwsSpecialVariables.Ecs.ClusterName);
-        Guard.NotNullOrWhiteSpace(clusterName, "Cluster name is required");
-
-        var serviceName = variables.Get(AwsSpecialVariables.Ecs.ServiceName);
-        Guard.NotNullOrWhiteSpace(serviceName, "Service name is required");
-
-        var stackName = variables.Get(AwsSpecialVariables.CloudFormation.StackName);
-        if (string.IsNullOrWhiteSpace(stackName))
-        {
-            stackName = stackNameGenerator.Generate(variables, clusterName, serviceName);
-            log.Verbose($"No stack name supplied; generated \"{stackName}\".");
-        }
-
-        var userTags = JsonConvert.DeserializeObject<List<KeyValuePair<string, string>>>(variables.Get(AwsSpecialVariables.CloudFormation.Tags) ?? "[]") ?? [];
-        var tags = EcsDefaultTags.Merge(variables, userTags);
-
-        var waitOptionType = variables.Get(AwsSpecialVariables.Ecs.WaitOptionLegacy.Type);
-        Guard.NotNullOrWhiteSpace(waitOptionType, "The wait option is required");
-        if (waitOptionType != "waitUntilCompleted" && waitOptionType != "waitWithTimeout" && waitOptionType != "dontWait")
-        {
-            throw new CommandException($"The wait option has an invalid value '{waitOptionType}'. Expected one of: 'waitUntilCompleted', 'waitWithTimeout', 'dontWait'.");
-        }
-
-        var waitOptionTimeoutMs = variables.GetInt32(AwsSpecialVariables.Ecs.WaitOptionLegacy.Timeout);
-        if (waitOptionType == "waitWithTimeout" && !waitOptionTimeoutMs.HasValue)
-        {
-            throw new CommandException("Wait option is 'waitWithTimeout' but timeout value is not set.");
-        }
-
-        return new EcsCommandInputs(
-                                    StackName: stackName,
-                                    ClusterName: clusterName,
-                                    ServiceName: serviceName,
-                                    Tags: tags,
-                                    WaitForComplete: waitOptionType != "dontWait",
-                                    WaitTimeout: waitOptionType == "waitWithTimeout" ? TimeSpan.FromMilliseconds(waitOptionTimeoutMs!.Value) : null);
-    }
-
-    record EcsCommandInputs(
-        string StackName,
-        string ClusterName,
-        string ServiceName,
-        List<KeyValuePair<string, string>> Tags,
-        bool WaitForComplete,
-        TimeSpan? WaitTimeout);
-}
+}

source/Calamari.Aws/Deployment/AwsSpecialVariables.cs

@@ -22,9 +22,35 @@ public static class S3
 
         public static class Ecs
         {
+            public static class Deploy
+            {
+
+                // Not reusing CloudFormation variable here to make it easier to remove all traces of this when we migrate to native ECS API
+                public const string StackName = "Octopus.Action.Aws.Ecs.Deploy.CFStackName";
+
+                public const string DesiredCount =  "Octopus.Action.Aws.Ecs.Deploy.DesiredCount";
+                public const string MinimumHealthPercent =  "Octopus.Action.Aws.Ecs.Deploy.MinimumHealthPercent";
+                public const string MaximumHealthPercent =  "Octopus.Action.Aws.Ecs.Deploy.MaximumHealthPercent";
+                public const string Cpu =  "Octopus.Action.Aws.Ecs.Deploy.Cpu";
+                public const string Memory =  "Octopus.Action.Aws.Ecs.Deploy.Memory";
+                public const string RuntimeArchitecturePlatform =  "Octopus.Action.Aws.Ecs.Deploy.RuntimeArchitecturePlatform";
+                public const string AutoAssignPublicIp =  "Octopus.Action.Aws.Ecs.Deploy.AutoAssignPublicIp";
+                public const string EnableEcsManagedTags =  "Octopus.Action.Aws.Ecs.Deploy.EnableEcsManagedTags";
+                public const string ServiceTaskName =  "Octopus.Action.Aws.Ecs.Deploy.ServiceTaskName";
+                public const string TaskRole =  "Octopus.Action.Aws.Ecs.Deploy.TaskRole";
+                public const string TaskExecutionRole =  "Octopus.Action.Aws.Ecs.Deploy.TaskExecutionRole";
+                public const string SecurityGroupIds =  "Octopus.Action.Aws.Ecs.Deploy.SecurityGroupIds";
+                public const string SubnetIds =   "Octopus.Action.Aws.Ecs.Deploy.SubnetIds";
+                public const string LoadBalancerMappings =   "Octopus.Action.Aws.Ecs.Deploy.LoadBalancerMappings";
+                public const string Volumes = "Octopus.Action.Aws.Ecs.Deploy.Volumes";
+                public const string Containers = "Octopus.Action.Aws.Ecs.Deploy.Containers";
+            }
+
+            // Not reusing CloudFormation variable here to make it easier to remove all traces of this when we migrate to native ECS API
+            public const string Tags = "Octopus.Action.Aws.Ecs.Tags";
             public const string ClusterName = "Octopus.Action.Aws.Ecs.ClusterName";
-            public const string ServiceName = "Octopus.Action.Aws.Ecs.ServiceName";
             public const string WaitOption = "Octopus.Action.Aws.Ecs.WaitOption";
+
 
             public static class Update
             {
@@ -33,13 +59,6 @@ public static class Update
                 public const string TemplateTaskDefinitionName = "Octopus.Action.Aws.Ecs.Update.TemplateTaskDefinitionName";
                 public const string ContainerUpdates = "Octopus.Action.Aws.Ecs.Update.ContainerUpdates";
             }
-
-            // Deploy ECS step: legacy flat key/value pair. Will consolidate when Deploy migrates.
-            public static class WaitOptionLegacy
-            {
-                public const string Type = "Octopus.Action.Aws.Ecs.WaitOption.Type";
-                public const string Timeout = "Octopus.Action.Aws.Ecs.WaitOption.Timeout";
-            }
         }
 
         public static class CloudFormation

source/Calamari.Aws/Deployment/Conventions/DeployAwsCloudFormationConvention.cs

@@ -219,7 +219,7 @@ async Task<string> UpdateCloudFormation(
 
     /// <summary>
     /// Not all exceptions are bad. Some just mean there is nothing to do, which is fine.
-    /// This method will ignore expected exceptions, and rethrow any that are really issues.
+    /// This method will ignore expected exceptions and rethrow any that are really issues.
     /// </summary>
     /// <param name="ex">The exception we need to deal with</param>
     /// <exception cref="AmazonCloudFormationException">The supplied exception if it really is an error</exception>

source/Calamari.Aws/Deployment/Conventions/DeployEcsServiceConvention.cs

@@ -0,0 +1,60 @@
+using System;
+using Amazon.CloudFormation;
+using Amazon.CloudFormation.Model;
+using Calamari.Aws.Inputs.Ecs;
+using Calamari.Aws.Integration.CloudFormation;
+using Calamari.Aws.Integration.CloudFormation.Templates;
+using Calamari.Aws.Integration.Ecs;
+using Calamari.Aws.Integration.Ecs.Deploy;
+using Calamari.Aws.Util;
+using Calamari.CloudAccounts;
+using Calamari.Common.Commands;
+using Calamari.Common.Plumbing.Logging;
+using Calamari.Common.Plumbing.Variables;
+using Calamari.Deployment.Conventions;
+
+namespace Calamari.Aws.Deployment.Conventions;
+
+// Currently a thin wrapper over existing template deployment process with the goal to swapping it out for native ECS API solution in the future.
+public class DeployEcsServiceConvention(DeployEcsCommandInputs commandInputs, AwsEnvironmentGeneration awsEnvironment, ILog log, IVariables variables)
+    : IInstallConvention
+{
+    readonly EcsDeployTemplateGenerator templateGenerator = new(commandInputs);
+
+
+    public void Install(RunningDeployment deployment)
+    {
+        var generated = templateGenerator.Generate();
+        var stackEventLogger = new StackEventLogger(log);
+
+        var deployCloudFormationConvention = new DeployAwsCloudFormationConvention(ClientFactory,
+            TemplateFactory,
+            stackEventLogger,
+            StackProvider,
+            commandInputs.ShouldWaitForDeploymentCompletion,
+            commandInputs.CfStackName,
+            awsEnvironment,
+            log,
+            commandInputs.WaitOption.GetTimeoutSpan()
+        );
+        deployCloudFormationConvention.Install(deployment);
+        return;
+
+        StackArn StackProvider(RunningDeployment _) => commandInputs.CfStackArn;
+        IAmazonCloudFormation ClientFactory() => ClientHelpers.CreateCloudFormationClient(awsEnvironment);
+
+        ICloudFormationRequestBuilder TemplateFactory()
+        {
+            return new CloudFormationTemplate(() => generated.Body,
+                new ListTemplateInputs<Parameter>(generated.Parameters),
+                commandInputs.CfStackName,
+                ["CAPABILITY_NAMED_IAM"],
+                false,
+                null,
+                commandInputs.Tags,
+                commandInputs.CfStackArn,
+                ClientFactory,
+                variables);
+        }
+    }
+}