feat: Make ECR repository name configurable in container based deploy…

…ments
aws · Feb 16, 2022 · 8c55225 · 8c55225
1 parent 0243302
commit 8c55225
Show file tree

Hide file tree

Showing 13 changed files with 115 additions and 20 deletions.
diff --git a/src/AWS.Deploy.CLI/Commands/TypeHints/ECRRepositoryCommand.cs b/src/AWS.Deploy.CLI/Commands/TypeHints/ECRRepositoryCommand.cs
@@ -0,0 +1,55 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Amazon.ECR.Model;
+using AWS.Deploy.Common;
+using AWS.Deploy.Common.Recipes;
+using AWS.Deploy.Common.TypeHintData;
+using AWS.Deploy.Orchestration.Data;
+
+namespace AWS.Deploy.CLI.Commands.TypeHints
+{
+    public class ECRRepositoryCommand : ITypeHintCommand
+    {
+        private readonly IAWSResourceQueryer _awsResourceQueryer;
+        private readonly IConsoleUtilities _consoleUtilities;
+
+        public ECRRepositoryCommand(IAWSResourceQueryer awsResourceQueryer, IConsoleUtilities consoleUtilities)
+        {
+            _awsResourceQueryer = awsResourceQueryer;
+            _consoleUtilities = consoleUtilities;
+        }
+
+        public async Task<object> Execute(Recommendation recommendation, OptionSettingItem optionSetting)
+        {
+            var repositories = await GetData();
+            var currentRepositoryName = recommendation.GetOptionSettingValue<string>(optionSetting);
+
+            var userInputConfiguration = new UserInputConfiguration<Repository>(
+                rep => rep.RepositoryName,
+                rep => rep.RepositoryName.Equals(currentRepositoryName),
+                currentRepositoryName)
+            {
+                AskNewName = true,
+            };
+
+            var userResponse = _consoleUtilities.AskUserToChooseOrCreateNew(repositories, "Select ECR Repository:", userInputConfiguration);
+
+            return userResponse.SelectedOption?.RepositoryName ?? userResponse.NewName
+                ?? throw new UserPromptForNameReturnedNullException(DeployToolErrorCode.ECRRepositoryPromptForNameReturnedNull, "The user response for an ECR Repository was null");
+        }
+        public async Task<List<TypeHintResource>?> GetResources(Recommendation recommendation, OptionSettingItem optionSetting)
+        {
+            var repositories = await GetData();
+            return repositories.Select(x => new TypeHintResource(x.RepositoryName, x.RepositoryName)).ToList();
+        }
+
+        private async Task<List<Repository>> GetData()
+        {
+            return await _awsResourceQueryer.GetECRRepositories();
+        }
+    }
+}
diff --git a/src/AWS.Deploy.CLI/Commands/TypeHints/TypeHintCommandFactory.cs b/src/AWS.Deploy.CLI/Commands/TypeHints/TypeHintCommandFactory.cs
@@ -59,6 +59,7 @@ public TypeHintCommandFactory(IToolInteractiveService toolInteractiveService, IA
                 { OptionSettingTypeHint.SNSTopicArn, new SNSTopicArnsCommand(awsResourceQueryer, consoleUtilities) },
                 { OptionSettingTypeHint.S3BucketName, new S3BucketNameCommand(awsResourceQueryer, consoleUtilities) },
                 { OptionSettingTypeHint.InstanceType, new InstanceTypeCommand(awsResourceQueryer, consoleUtilities) },
+                { OptionSettingTypeHint.ECRRepository,  new ECRRepositoryCommand(awsResourceQueryer, consoleUtilities)}
             };
         }
 

diff --git a/src/AWS.Deploy.Common/Exceptions.cs b/src/AWS.Deploy.Common/Exceptions.cs
@@ -101,6 +101,7 @@ public enum DeployToolErrorCode
         FailedToCreateElasticBeanstalkStorageLocation = 10007900,
         UnableToAccessAWSRegion = 10008000,
         OptInRegionDisabled = 10008100,
+        ECRRepositoryPromptForNameReturnedNull = 10008200
     }
 
     public class ProjectFileNotFoundException : DeployToolException

diff --git a/src/AWS.Deploy.Common/Recipes/OptionSettingTypeHint.cs b/src/AWS.Deploy.Common/Recipes/OptionSettingTypeHint.cs
@@ -30,6 +30,7 @@ public enum OptionSettingTypeHint
         ExistingIAMRole,
         ExistingECSCluster,
         ExistingVpc,
-        ExistingBeanstalkApplication
+        ExistingBeanstalkApplication,
+        ECRRepository
     };
 }
diff --git a/src/AWS.Deploy.Common/Recommendation.cs b/src/AWS.Deploy.Common/Recommendation.cs
@@ -45,7 +45,7 @@ public Recommendation(RecipeDefinition recipe, ProjectDefinition projectDefiniti
             DeploymentBundle = new DeploymentBundle();
             DeploymentBundleSettings = deploymentBundleSettings;
 
-            CollectRecommendationReplacementTokens(Recipe.OptionSettings);
+            CollectRecommendationReplacementTokens(GetConfigurableOptionSettingItems().ToList());
 
             foreach (var replacement in additionalReplacements)
             {

diff --git a/src/AWS.Deploy.Constants/CLI.cs b/src/AWS.Deploy.Constants/CLI.cs
@@ -18,8 +18,5 @@ internal static class CLI
         public const string PROMPT_CHOOSE_DEPLOYMENT_TARGET = "Choose deployment target";
 
         public const string CLI_APP_NAME = "AWS .NET Deployment Tool";
-
-        public const string REPLACE_TOKEN_LATEST_DOTNET_BEANSTALK_PLATFORM_ARN = "{LatestDotnetBeanstalkPlatformArn}";
-        public const string REPLACE_TOKEN_STACK_NAME = "{StackName}";
     }
 }
diff --git a/src/AWS.Deploy.Constants/RecipeIdentifier.cs b/src/AWS.Deploy.Constants/RecipeIdentifier.cs
@@ -6,8 +6,12 @@ namespace AWS.Deploy.Constants
 {
     internal static class RecipeIdentifier
     {
+        // Recipe IDs
+        public const string EXISTING_BEANSTALK_ENVIRONMENT_RECIPE_ID = "AspNetAppExistingBeanstalkEnvironment";
+
+        // Replacement Tokens
         public const string REPLACE_TOKEN_STACK_NAME = "{StackName}";
         public const string REPLACE_TOKEN_LATEST_DOTNET_BEANSTALK_PLATFORM_ARN = "{LatestDotnetBeanstalkPlatformArn}";
-        public const string EXISTING_BEANSTALK_ENVIRONMENT_RECIPE_ID = "AspNetAppExistingBeanstalkEnvironment";
+        public const string REPLACE_TOKEN_ECR_REPOSITORY_NAME = "{DefaultECRRepositoryName}";
     }
 }
diff --git a/src/AWS.Deploy.Orchestration/Data/AWSResourceQueryer.cs b/src/AWS.Deploy.Orchestration/Data/AWSResourceQueryer.cs
@@ -61,7 +61,7 @@ public interface IAWSResourceQueryer
         Task<List<PlatformSummary>> GetElasticBeanstalkPlatformArns();
         Task<PlatformSummary> GetLatestElasticBeanstalkPlatformArn();
         Task<List<AuthorizationData>> GetECRAuthorizationToken();
-        Task<List<Repository>> GetECRRepositories(List<string> repositoryNames);
+        Task<List<Repository>> GetECRRepositories(List<string>? repositoryNames = null);
         Task<Repository> CreateECRRepository(string repositoryName);
         Task<List<Stack>> GetCloudFormationStacks();
         Task<GetCallerIdentityResponse> GetCallerIdentity(string awsRegion);
@@ -407,7 +407,7 @@ public async Task<List<AuthorizationData>> GetECRAuthorizationToken()
             return response.AuthorizationData;
         }
 
-        public async Task<List<Repository>> GetECRRepositories(List<string> repositoryNames)
+        public async Task<List<Repository>> GetECRRepositories(List<string>? repositoryNames = null)
         {
             var ecrClient = _awsClientFactory.GetAWSClient<IAmazonECR>();
 

diff --git a/src/AWS.Deploy.Orchestration/DeploymentBundleHandler.cs b/src/AWS.Deploy.Orchestration/DeploymentBundleHandler.cs
@@ -19,7 +19,7 @@ public interface IDeploymentBundleHandler
     {
         Task<string> BuildDockerImage(CloudApplication cloudApplication, Recommendation recommendation);
         Task<string> CreateDotnetPublishZip(Recommendation recommendation);
-        Task PushDockerImageToECR(CloudApplication cloudApplication, Recommendation recommendation, string sourceTag);
+        Task PushDockerImageToECR(Recommendation recommendation, string repositoryName, string sourceTag);
     }
 
     public class DeploymentBundleHandler : IDeploymentBundleHandler
@@ -71,15 +71,15 @@ public async Task<string> BuildDockerImage(CloudApplication cloudApplication, Re
             return imageTag;
         }
 
-        public async Task PushDockerImageToECR(CloudApplication cloudApplication, Recommendation recommendation, string sourceTag)
+        public async Task PushDockerImageToECR(Recommendation recommendation, string repositoryName, string sourceTag)
         {
             _interactiveService.LogMessageLine(string.Empty);
             _interactiveService.LogMessageLine("Pushing the docker image to ECR repository...");
 
             await InitiateDockerLogin();
 
             var tagSuffix = sourceTag.Split(":")[1];
-            var repository = await SetupECRRepository(cloudApplication.Name.ToLower());
+            var repository = await SetupECRRepository(repositoryName);
             var targetTag = $"{repository.RepositoryUri}:{tagSuffix}";
 
             await TagDockerImage(sourceTag, targetTag);

diff --git a/src/AWS.Deploy.Orchestration/Orchestrator.cs b/src/AWS.Deploy.Orchestration/Orchestrator.cs
@@ -121,18 +121,22 @@ public async Task<List<Recommendation>> GenerateRecommendationsFromSavedDeployme
 
         public async Task ApplyAllReplacementTokens(Recommendation recommendation, string cloudApplicationName)
         {
-            if (recommendation.ReplacementTokens.ContainsKey(Constants.CLI.REPLACE_TOKEN_LATEST_DOTNET_BEANSTALK_PLATFORM_ARN))
+            if (recommendation.ReplacementTokens.ContainsKey(Constants.RecipeIdentifier.REPLACE_TOKEN_LATEST_DOTNET_BEANSTALK_PLATFORM_ARN))
             {
                 if (_awsResourceQueryer == null)
                     throw new InvalidOperationException($"{nameof(_awsResourceQueryer)} is null as part of the Orchestrator object");
 
                 var latestPlatform = await _awsResourceQueryer.GetLatestElasticBeanstalkPlatformArn();
-                recommendation.AddReplacementToken(Constants.CLI.REPLACE_TOKEN_LATEST_DOTNET_BEANSTALK_PLATFORM_ARN, latestPlatform.PlatformArn);
+                recommendation.AddReplacementToken(Constants.RecipeIdentifier.REPLACE_TOKEN_LATEST_DOTNET_BEANSTALK_PLATFORM_ARN, latestPlatform.PlatformArn);
             }
-            if (recommendation.ReplacementTokens.ContainsKey(Constants.CLI.REPLACE_TOKEN_STACK_NAME))
+            if (recommendation.ReplacementTokens.ContainsKey(Constants.RecipeIdentifier.REPLACE_TOKEN_STACK_NAME))
             {
                 // Apply the user entered stack name to the recommendation so that any default settings based on stack name are applied.
-                recommendation.AddReplacementToken(Constants.CLI.REPLACE_TOKEN_STACK_NAME, cloudApplicationName);
+                recommendation.AddReplacementToken(Constants.RecipeIdentifier.REPLACE_TOKEN_STACK_NAME, cloudApplicationName);
+            }
+            if (recommendation.ReplacementTokens.ContainsKey(Constants.RecipeIdentifier.REPLACE_TOKEN_ECR_REPOSITORY_NAME))
+            {
+                recommendation.AddReplacementToken(Constants.RecipeIdentifier.REPLACE_TOKEN_ECR_REPOSITORY_NAME, cloudApplicationName.ToLower());
             }
         }
 
@@ -169,8 +173,8 @@ public async Task<bool> CreateContainerDeploymentBundle(CloudApplication cloudAp
             try
             {
                 var imageTag = await _deploymentBundleHandler.BuildDockerImage(cloudApplication, recommendation);
-
-                await _deploymentBundleHandler.PushDockerImageToECR(cloudApplication, recommendation, imageTag);
+                var respositoryName = recommendation.GetOptionSettingValue<string>(recommendation.GetOptionSetting("ECRRepositoryName"));
+                await _deploymentBundleHandler.PushDockerImageToECR(recommendation, respositoryName, imageTag);
             }
             catch(DockerBuildFailedException ex)
             {

diff --git a/src/AWS.Deploy.Recipes/DeploymentBundleDefinitions/Container.deploymentbundle b/src/AWS.Deploy.Recipes/DeploymentBundleDefinitions/Container.deploymentbundle
@@ -20,6 +20,25 @@
             "DefaultValue": "",
             "AdvancedSetting": true,
             "Updatable": true
+        },
+        {
+            "Id": "ECRRepositoryName",
+            "Name": "ECS Repository Name",
+            "Description": "Specifies the ECR repository where the docker images will be stored",
+            "Type": "String",
+            "TypeHint": "ECRRepository",
+            "DefaultValue": "{DefaultECRRepositoryName}",
+            "AdvancedSetting": false,
+            "Updatable": true,
+            "Validators": [
+                {
+                    "ValidatorType": "Regex",
+                    "Configuration" : {
+                        "Regex": "^(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*$",
+                        "ValidationFailedMessage": "Invalid ECR repository Name. The ECR repository name can only contain lowercase letters, numbers, hyphens(-), dots(.), underscores(_) and forward slashes (/). For more information visit https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname"
+                    }
+                }
+            ]
         }
     ]
 }
diff --git a/...loy.CLI.Common.UnitTests/Recipes/Validation/ECSFargateOptionSettingItemValidationTests.cs b/...loy.CLI.Common.UnitTests/Recipes/Validation/ECSFargateOptionSettingItemValidationTests.cs
@@ -124,6 +124,19 @@ public void ListenerConditionPathPatternValidationTest(string value, bool isVali
             Validate(optionSettingItem, value, isValid);
         }
 
+        [Theory]
+        [InlineData("myrepo123", true)]
+        [InlineData("myrepo123.a/b", true)]
+        [InlineData("MyRepo", false)] // cannot contain uppercase letters
+        [InlineData("myrepo123@", false)] // cannot contain @
+        [InlineData("myrepo123.a//b", false)] // cannot contain consecutive slashes.
+        public void ECRRepositoryNameValidationTest(string value, bool isValid)
+        {
+            var optionSettingItem = new OptionSettingItem("id", "name", "description");
+            optionSettingItem.Validators.Add(GetRegexValidatorConfig("^(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*$"));
+            Validate(optionSettingItem, value, isValid);
+        }
+
         private OptionSettingItemValidatorConfig GetRegexValidatorConfig(string regex)
         {
             var regexValidatorConfig = new OptionSettingItemValidatorConfig

diff --git a/test/AWS.Deploy.CLI.UnitTests/DeploymentBundleHandlerTests.cs b/test/AWS.Deploy.CLI.UnitTests/DeploymentBundleHandlerTests.cs
@@ -99,11 +99,11 @@ public async Task PushDockerImage_RepositoryNameCheck()
             var projectPath = SystemIOUtilities.ResolvePath("ConsoleAppTask");
             var project = await _projectDefinitionParser.Parse(projectPath);
             var recommendation = new Recommendation(_recipeDefinition, project, new List<OptionSettingItem>(), 100, new Dictionary<string, string>());
+            var repositoryName = "repository";
 
-            var cloudApplication = new CloudApplication("ConsoleAppTask", string.Empty, CloudApplicationResourceType.CloudFormationStack, string.Empty);
-            await _deploymentBundleHandler.PushDockerImageToECR(cloudApplication, recommendation, "ConsoleAppTask:latest");
+            await _deploymentBundleHandler.PushDockerImageToECR(recommendation, repositoryName, "ConsoleAppTask:latest");
 
-            Assert.Equal(cloudApplication.Name.ToLower(), recommendation.DeploymentBundle.ECRRepositoryName);
+            Assert.Equal(repositoryName, recommendation.DeploymentBundle.ECRRepositoryName);
         }
 
         [Fact]