feat: Remove disabled fields from showing on redeployment in server mode

aws · Jul 2, 2024 · fdf67d3 · fdf67d3
1 parent 2c676af
commit fdf67d3
Show file tree

Hide file tree

Showing 10 changed files with 119 additions and 2 deletions.
diff --git a/src/AWS.Deploy.CLI/ServerMode/Controllers/DeploymentController.cs b/src/AWS.Deploy.CLI/ServerMode/Controllers/DeploymentController.cs
@@ -208,7 +208,9 @@ private List<OptionSettingItemSummary> ListOptionSettingSummary(IOptionSettingHa
                     Value = optionSettingHandler.GetOptionSettingValue(recommendation, setting),
                     Advanced = setting.AdvancedSetting,
                     ReadOnly = recommendation.IsExistingCloudApplication && !setting.Updatable,
-                    Visible = optionSettingHandler.IsOptionSettingDisplayable(recommendation, setting),
+                    Visible =
+                        optionSettingHandler.IsOptionSettingDisplayable(recommendation, setting) &&
+                        !(recommendation.IsExistingCloudApplication && !setting.Updatable && !setting.VisibleOnRedeployment),
                     SummaryDisplayable = optionSettingHandler.IsSummaryDisplayable(recommendation, setting),
                     AllowedValues = setting.AllowedValues,
                     ValueMapping = setting.ValueMapping,

diff --git a/src/AWS.Deploy.Common/Recipes/OptionSettingItem.cs b/src/AWS.Deploy.Common/Recipes/OptionSettingItem.cs
@@ -124,6 +124,11 @@ public partial class OptionSettingItem : IOptionSettingItem
         /// </summary>
         public bool Updatable { get; set; }
 
+        /// <summary>
+        /// If the value is true, the setting will be displayed during a redeployment. This only applies to server-mode clients.
+        /// </summary>
+        public bool VisibleOnRedeployment { get; set; }
+
         /// <summary>
         /// List of all validators that should be run when configuring this OptionSettingItem.
         /// </summary>

diff --git a/src/AWS.Deploy.Recipes/RecipeDefinitions/ASP.NETAppAppRunner.recipe b/src/AWS.Deploy.Recipes/RecipeDefinitions/ASP.NETAppAppRunner.recipe
@@ -100,6 +100,7 @@
             "TypeHint": "AppRunnerService",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "DefaultValue": "{StackName}-service",
             "Validators": [
                 {

diff --git a/src/AWS.Deploy.Recipes/RecipeDefinitions/ASP.NETAppECSFargate.recipe b/src/AWS.Deploy.Recipes/RecipeDefinitions/ASP.NETAppECSFargate.recipe
@@ -118,6 +118,7 @@
             "TypeHint": "ECSCluster",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "ChildOptionSettings": [
                 {
                     "Id": "CreateNew",
@@ -136,6 +137,7 @@
                     "TypeHint": "ExistingECSCluster",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "Validators": [
                         {
                             "ValidatorType": "Regex",
@@ -160,6 +162,7 @@
                     "DefaultValue": "{StackName}",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "Validators": [
                         {
                             "ValidatorType": "Regex",
@@ -195,6 +198,7 @@
             "DefaultValue": "{StackName}-service",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "Validators": [
                 {
                     "ValidatorType": "Regex",
@@ -738,7 +742,8 @@
                     "Type": "Bool",
                     "DefaultValue": true,
                     "AdvancedSetting": false,
-                    "Updatable": false
+                    "Updatable": false,
+                    "VisibleOnRedeployment": true
                 }
             ]
         },

diff --git a/src/AWS.Deploy.Recipes/RecipeDefinitions/ASP.NETAppElasticBeanstalkLinux.recipe b/src/AWS.Deploy.Recipes/RecipeDefinitions/ASP.NETAppElasticBeanstalkLinux.recipe
@@ -137,6 +137,7 @@
             "TypeHint": "BeanstalkApplication",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "ChildOptionSettings": [
                 {
                     "Id": "CreateNew",
@@ -155,6 +156,7 @@
                     "DefaultValue": "{StackName}",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "DependsOn": [
                         {
                             "Id": "BeanstalkApplication.CreateNew",
@@ -187,6 +189,7 @@
                     "DefaultValue": "{StackName}",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "DependsOn": [
                         {
                             "Id": "BeanstalkApplication.CreateNew",
@@ -215,6 +218,7 @@
             "Type": "Object",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "ChildOptionSettings": [
                 {
                     "Id": "EnvironmentName",
@@ -225,6 +229,7 @@
                     "DefaultValue": "{StackName}-dev",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "Validators": [
                         {
                             "ValidatorType": "Regex",

diff --git a/src/AWS.Deploy.Recipes/RecipeDefinitions/ASP.NETAppElasticBeanstalkWindows.recipe b/src/AWS.Deploy.Recipes/RecipeDefinitions/ASP.NETAppElasticBeanstalkWindows.recipe
@@ -137,6 +137,7 @@
             "TypeHint": "BeanstalkApplication",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "ChildOptionSettings": [
                 {
                     "Id": "CreateNew",
@@ -155,6 +156,7 @@
                     "DefaultValue": "{StackName}",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "DependsOn": [
                         {
                             "Id": "BeanstalkApplication.CreateNew",
@@ -187,6 +189,7 @@
                     "DefaultValue": "{StackName}",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "DependsOn": [
                         {
                             "Id": "BeanstalkApplication.CreateNew",
@@ -216,6 +219,7 @@
             "DefaultValue": "{StackName}-dev",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "Validators": [
                 {
                     "ValidatorType": "Regex",

diff --git a/src/AWS.Deploy.Recipes/RecipeDefinitions/ConsoleAppECSFargateScheduleTask.recipe b/src/AWS.Deploy.Recipes/RecipeDefinitions/ConsoleAppECSFargateScheduleTask.recipe
@@ -136,6 +136,7 @@
             "TypeHint": "ECSCluster",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "ChildOptionSettings": [
                 {
                     "Id": "CreateNew",
@@ -154,6 +155,7 @@
                     "TypeHint": "ExistingECSCluster",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "Validators": [
                         {
                             "ValidatorType": "Regex",
@@ -178,6 +180,7 @@
                     "DefaultValue": "{StackName}",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "Validators": [
                         {
                             "ValidatorType": "Regex",

diff --git a/src/AWS.Deploy.Recipes/RecipeDefinitions/ConsoleAppECSFargateService.recipe b/src/AWS.Deploy.Recipes/RecipeDefinitions/ConsoleAppECSFargateService.recipe
@@ -176,6 +176,7 @@
             "TypeHint": "ECSCluster",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "ChildOptionSettings": [
                 {
                     "Id": "CreateNew",
@@ -194,6 +195,7 @@
                     "TypeHint": "ExistingECSCluster",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "Validators": [
                         {
                             "ValidatorType": "Regex",
@@ -218,6 +220,7 @@
                     "DefaultValue": "{StackName}",
                     "AdvancedSetting": false,
                     "Updatable": false,
+                    "VisibleOnRedeployment": true,
                     "Validators": [
                         {
                             "ValidatorType": "Regex",
@@ -247,6 +250,7 @@
             "DefaultValue": "{StackName}-service",
             "AdvancedSetting": false,
             "Updatable": false,
+            "VisibleOnRedeployment": true,
             "Validators": [
                 {
                     "ValidatorType": "Regex",

diff --git a/src/AWS.Deploy.Recipes/RecipeDefinitions/aws-deploy-recipe-schema.json b/src/AWS.Deploy.Recipes/RecipeDefinitions/aws-deploy-recipe-schema.json
@@ -587,6 +587,12 @@
                     "description": "If the setting is false the setting can not be changed during redeployment.",
                     "minLength": 1
                 },
+                "VisibleOnRedeployment": {
+                    "type": "boolean",
+                    "title": "VisibleOnRedeployment",
+                    "description": "If the value is true, the setting will be displayed during a redeployment. This only applies to server-mode clients.",
+                    "minLength": 1
+                },
                 "DependsOn": {
                     "type": "array",
                     "title": "",

diff --git a/test/AWS.Deploy.CLI.IntegrationTests/ServerModeTests.cs b/test/AWS.Deploy.CLI.IntegrationTests/ServerModeTests.cs
@@ -190,6 +190,88 @@ public async Task GetRecommendationsWithEncryptedCredentials()
             }
         }
 
+        [Fact]
+        public async Task AppRunnerRedeployment_VisibleOnRedeploymentSettings()
+        {
+            _stackName = $"ServerModeAppRunner{Guid.NewGuid().ToString().Split('-').Last()}";
+
+            var projectPath = _testAppManager.GetProjectPath(Path.Combine("testapps", "WebAppWithDockerFile", "WebAppWithDockerFile.csproj"));
+            var portNumber = 4950;
+            using var httpClient = ServerModeHttpClientFactory.ConstructHttpClient(ServerModeUtilities.ResolveDefaultCredentials);
+
+            var serverCommand = new ServerModeCommand(_serviceProvider.GetRequiredService<IToolInteractiveService>(), portNumber, null, true);
+            var cancelSource = new CancellationTokenSource();
+
+            var serverTask = serverCommand.ExecuteAsync(cancelSource.Token);
+            try
+            {
+                var baseUrl = $"http://localhost:{portNumber}/";
+                var restClient = new RestAPIClient(baseUrl, httpClient);
+
+                await restClient.WaitUntilServerModeReady();
+
+                var startSessionOutput = await restClient.StartDeploymentSessionAsync(new StartDeploymentSessionInput
+                {
+                    AwsRegion = _awsRegion,
+                    ProjectPath = projectPath
+                });
+
+                var sessionId = startSessionOutput.SessionId;
+                Assert.NotNull(sessionId);
+
+                var signalRClient = new DeploymentCommunicationClient(baseUrl);
+                await signalRClient.JoinSession(sessionId);
+
+                var logOutput = new StringBuilder();
+                RegisterSignalRMessageCallbacks(signalRClient, logOutput);
+
+                var getRecommendationOutput = await restClient.GetRecommendationsAsync(sessionId);
+                Assert.NotEmpty(getRecommendationOutput.Recommendations);
+
+                var appRunnerRecommendation = getRecommendationOutput.Recommendations.FirstOrDefault(x => string.Equals(x.RecipeId, "AspNetAppAppRunner"));
+                Assert.NotNull(appRunnerRecommendation);
+
+                await restClient.SetDeploymentTargetAsync(sessionId, new SetDeploymentTargetInput
+                {
+                    NewDeploymentName = _stackName,
+                    NewDeploymentRecipeId = appRunnerRecommendation.RecipeId
+                });
+
+                await restClient.StartDeploymentAsync(sessionId);
+
+                await restClient.WaitForDeployment(sessionId);
+
+                var stackStatus = await _cloudFormationHelper.GetStackStatus(_stackName);
+                Assert.Equal(StackStatus.CREATE_COMPLETE, stackStatus);
+
+                Assert.True(logOutput.Length > 0);
+
+                var redeploymentSessionOutput = await restClient.StartDeploymentSessionAsync(new StartDeploymentSessionInput
+                {
+                    AwsRegion = _awsRegion,
+                    ProjectPath = projectPath
+                });
+
+                var redeploymentSessionId = redeploymentSessionOutput.SessionId;
+
+                await restClient.SetDeploymentTargetAsync(redeploymentSessionId, new SetDeploymentTargetInput
+                {
+                    ExistingDeploymentId = await _cloudFormationHelper.GetStackArn(_stackName)
+                });
+
+                var settings = await restClient.GetConfigSettingsAsync(redeploymentSessionId);
+
+                Assert.True(settings.OptionSettings.First(x => x.Id.Equals("ServiceName")).Visible);
+                Assert.False(settings.OptionSettings.First(x => x.Id.Equals("EncryptionKmsKey")).Visible);
+            }
+            finally
+            {
+                cancelSource.Cancel();
+                await _cloudFormationHelper.DeleteStack(_stackName);
+                _stackName = null;
+            }
+        }
+
         [Fact]
         public async Task WebFargateDeploymentNoConfigChanges()
         {