feat: support interactive mode for include and exclude target tags

Author: bec-callow-oct

pkg/cmd/release/deploy/deploy.go

@@ -534,8 +534,9 @@ func AskQuestions(octopus *octopusApiClient.Client, stdout io.Writer, asker ques
 	isGuidedFailureModeSpecified := options.GuidedFailureMode != ""
 	isForcePackageDownloadSpecified := options.ForcePackageDownloadWasSpecified
 	isDeploymentTargetsSpecified := len(options.DeploymentTargets) > 0 || len(options.ExcludeTargets) > 0
+	isDeploymentTargetTagsSpecified := len(options.SpecificTargetTagNames) > 0 || len(options.ExcludedTargetTagNames) > 0
 
-	allAdvancedOptionsSpecified := isDeployAtSpecified && isExcludedStepsSpecified && isGuidedFailureModeSpecified && isForcePackageDownloadSpecified && isDeploymentTargetsSpecified
+	allAdvancedOptionsSpecified := isDeployAtSpecified && isExcludedStepsSpecified && isGuidedFailureModeSpecified && isForcePackageDownloadSpecified && isDeploymentTargetsSpecified && isDeploymentTargetTagsSpecified
 
 	shouldAskAdvancedQuestions := false
 	if !allAdvancedOptionsSpecified {
@@ -635,7 +636,19 @@ func AskQuestions(octopus *octopusApiClient.Client, stdout io.Writer, asker ques
 			}
 		}
 
-		// TODO: Add support for isDeploymentTargetTagsSpecified
+		if !isDeploymentTargetTagsSpecified {
+			if len(deploymentEnvironmentIDs) == 0 { // if the Q&A process earlier hasn't loaded environments already, we need to load them now
+				selectedEnvironments, err := executionscommon.FindEnvironments(octopus, options.Environments)
+				if err != nil {
+					return err
+				}
+				deploymentEnvironmentIDs = util.SliceTransform(selectedEnvironments, func(env *environments.Environment) string { return env.ID })
+			}
+			options.SpecificTargetTagNames, options.ExcludedTargetTagNames, err = askTargetTags(octopus, asker, space.ID, selectedRelease.ID, deploymentEnvironmentIDs)
+			if err != nil {
+				return err
+			}
+		}
 	}
 	// DONE
 	return nil
@@ -829,6 +842,56 @@ func askDeploymentTargets(octopus *octopusApiClient.Client, asker question.Asker
 	return nil, nil
 }
 
+func askTargetTags(octopus *octopusApiClient.Client, asker question.Asker, spaceID string, releaseID string, deploymentEnvironmentIDs []string) ([]string, []string, error) {
+	var results []string
+
+	// collect all available target tags from deployment previews across all environments
+	for _, envID := range deploymentEnvironmentIDs {
+		preview, err := deployments.GetReleaseDeploymentPreview(octopus, spaceID, releaseID, envID, true)
+		if err != nil {
+			return nil, nil, err
+		}
+		for _, step := range preview.StepsToExecute {
+			for _, tagSet := range step.AvailableTagSets {
+				for _, tag := range tagSet.AvailableTags {
+					canonicalName := tagSet.TagSetName + "/" + tag.TagName
+					if !util.SliceContains(results, canonicalName) {
+						results = append(results, canonicalName)
+					}
+				}
+			}
+		}
+	}
+
+	if len(results) == 0 {
+		return nil, nil, nil
+	}
+
+	sort.Strings(results)
+
+	var selectedSpecificTags []string
+	err := asker(&survey.MultiSelect{
+		Message: "Specific target tags to include (If none selected, include all)",
+		Options: results,
+	}, &selectedSpecificTags)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	var selectedExcludedTags []string
+	if len(selectedSpecificTags) == 0 {
+		err = asker(&survey.MultiSelect{
+			Message: "Target tags to exclude (If none selected, exclude none)",
+			Options: results,
+		}, &selectedExcludedTags)
+		if err != nil {
+			return nil, nil, err
+		}
+	}
+
+	return selectedSpecificTags, selectedExcludedTags, nil
+}
+
 func askDeploymentPreviewVariables(octopus *octopusApiClient.Client, variablesFromCmd map[string]string, asker question.Asker, spaceID string, releaseID string, deploymentPreviewsReqests []deployments.DeploymentPreviewRequest) (map[string]string, error) {
 	previews, err := deployments.GetReleaseDeploymentPreviews(octopus, spaceID, releaseID, deploymentPreviewsReqests, true)
 	if err != nil {

pkg/cmd/release/deploy/deploy_test.go

@@ -1517,6 +1517,88 @@ func TestDeployCreate_AskQuestions(t *testing.T) {
 				ScheduledExpiryTime:              "2022-09-08T13:31:03+08:00",
 			}, options)
 		}},
+
+		{"target tags with specific and excluded tags", func(t *testing.T, api *testutil.MockHttpServer, qa *testutil.AskMocker, stdout *bytes.Buffer) {
+			options := &executor.TaskOptionsDeployRelease{
+				ProjectName:                      "fire project",
+				ReleaseVersion:                   "1.9",
+				Environments:                     []string{"dev"},
+				ExcludedSteps:                    []string{"Cleanup"},
+				GuidedFailureMode:                "false",
+				ForcePackageDownloadWasSpecified: true,
+				DeploymentTargets:                []string{"vm-1"},
+				ScheduledStartTime:               "now",
+			}
+
+			errReceiver := testutil.GoBegin(func() error {
+				defer testutil.Close(api, qa)
+				octopus, _ := octopusApiClient.NewClient(testutil.NewMockHttpClientWithTransport(api), serverUrl, placeholderApiKey, "")
+				return deploy.AskQuestions(octopus, stdout, qa.AsAsker(), space1, options, now)
+			})
+
+			doStandardApiResponses(options, api, release19, variableSnapshotNoVars)
+			stdout.Reset()
+
+			_ = qa.ExpectQuestion(t, &survey.Select{
+				Message: "Change additional options?",
+				Options: []string{"Proceed to deploy", "Change"},
+			}).AnswerWith("Change")
+			stdout.Reset()
+
+			api.ExpectRequest(t, "GET", fmt.Sprintf("/api/Spaces-1/releases/%s/deployments/preview/%s?includeDisabledSteps=true", release19.ID, devEnvironment.ID)).RespondWith(&deployments.DeploymentPreview{
+				StepsToExecute: []*deployments.DeploymentTemplateStep{
+					{
+						AvailableTagSets: []*deployments.TagSetPreview{
+							{
+								TagSetName: "Role",
+								AvailableTags: []*deployments.TargetTagPreview{
+									{TagName: "WebServer"},
+									{TagName: "Database"},
+									{TagName: "Legacy"},
+								},
+							},
+							{
+								TagSetName: "Environment",
+								AvailableTags: []*deployments.TargetTagPreview{
+									{TagName: "Production"},
+									{TagName: "Staging"},
+								},
+							},
+						},
+					},
+				},
+			})
+
+			_ = qa.ExpectQuestion(t, &survey.MultiSelect{
+				Message: "Specific target tags to include (If none selected, include all)",
+				Options: []string{"Environment/Production", "Environment/Staging", "Role/Database", "Role/Legacy", "Role/WebServer"},
+			}).AnswerWith([]string{"Role/WebServer", "Environment/Production"})
+
+			_ = qa.ExpectQuestion(t, &survey.MultiSelect{
+				Message: "Target tags to exclude (If none selected, exclude none)",
+				Options: []string{"Environment/Production", "Environment/Staging", "Role/Database", "Role/Legacy", "Role/WebServer"},
+			}).AnswerWith([]string{"Role/Legacy"})
+
+			err := <-errReceiver
+			assert.Nil(t, err)
+
+			// check that the question-asking process has filled out the things we told it to
+			assert.Equal(t, &executor.TaskOptionsDeployRelease{
+				ProjectName:                      "Fire Project",
+				ReleaseVersion:                   "1.9",
+				Environments:                     []string{"dev"},
+				GuidedFailureMode:                "false",
+				ForcePackageDownload:             false,
+				ForcePackageDownloadWasSpecified: true,
+				Variables:                        make(map[string]string, 0),
+				ExcludedSteps:                    []string{"Cleanup"},
+				DeploymentTargets:                []string{"vm-1"},
+				SpecificTargetTagNames:           []string{"Role/WebServer", "Environment/Production"},
+				ExcludedTargetTagNames:           []string{"Role/Legacy"},
+				ReleaseID:                        release19.ID,
+				ScheduledStartTime:               "now",
+			}, options)
+		}},
 	}
 
 	for _, test := range tests {