Add support for --detach/-d flag in stack rm

gmargaritis · thaJeztah · thaJeztah · commit 238d659ff9a0 · 2024-03-04T09:56:53.000+01:00
Added --detach/-d to stack rm. Setting --detach=false waits until
all of the stack tasks have reached a terminal state.

Co-authored-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
Signed-off-by: George Margaritis &lt;gmargaritis@protonmail.com&gt;
diff --git a/cli/command/stack/options/opts.go b/cli/command/stack/options/opts.go
@@ -38,6 +38,7 @@ type PS struct {
 // Remove holds docker stack remove options
 type Remove struct {
 	Namespaces []string
+	Detach     bool
 }
 
 // Services holds docker stack services options
diff --git a/cli/command/stack/remove.go b/cli/command/stack/remove.go
@@ -27,5 +27,8 @@ func newRemoveCommand(dockerCli command.Cli) *cobra.Command {
 			return completeNames(dockerCli)(cmd, args, toComplete)
 		},
 	}
+
+	flags := cmd.Flags()
+	flags.BoolVarP(&opts.Detach, "detach", "d", true, "Do not wait for stack removal")
 	return cmd
 }
diff --git a/cli/command/stack/swarm/common.go b/cli/command/stack/swarm/common.go
@@ -44,3 +44,7 @@ func getStackSecrets(ctx context.Context, apiclient client.APIClient, namespace
 func getStackConfigs(ctx context.Context, apiclient client.APIClient, namespace string) ([]swarm.Config, error) {
 	return apiclient.ConfigList(ctx, types.ConfigListOptions{Filters: getStackFilter(namespace)})
 }
+
+func getStackTasks(ctx context.Context, apiclient client.APIClient, namespace string) ([]swarm.Task, error) {
+	return apiclient.TaskList(ctx, types.TaskListOptions{Filters: getStackFilter(namespace)})
+}
diff --git a/cli/command/stack/swarm/remove.go b/cli/command/stack/swarm/remove.go
@@ -11,6 +11,7 @@ import (
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/swarm"
 	"github.com/docker/docker/api/types/versions"
+	apiclient "github.com/docker/docker/client"
 	"github.com/pkg/errors"
 )
 
@@ -58,6 +59,14 @@ func RunRemove(ctx context.Context, dockerCli command.Cli, opts options.Remove)
 
 		if hasError {
 			errs = append(errs, fmt.Sprintf("Failed to remove some resources from stack: %s", namespace))
+			continue
+		}
+
+		if !opts.Detach {
+			err = waitOnTasks(ctx, client, namespace)
+			if err != nil {
+				errs = append(errs, fmt.Sprintf("Failed to wait on tasks of stack: %s: %s", namespace, err))
+			}
 		}
 	}
 
@@ -137,3 +146,45 @@ func removeConfigs(
 	}
 	return hasError
 }
+
+var numberedStates = map[swarm.TaskState]int64{
+	swarm.TaskStateNew:       1,
+	swarm.TaskStateAllocated: 2,
+	swarm.TaskStatePending:   3,
+	swarm.TaskStateAssigned:  4,
+	swarm.TaskStateAccepted:  5,
+	swarm.TaskStatePreparing: 6,
+	swarm.TaskStateReady:     7,
+	swarm.TaskStateStarting:  8,
+	swarm.TaskStateRunning:   9,
+	swarm.TaskStateComplete:  10,
+	swarm.TaskStateShutdown:  11,
+	swarm.TaskStateFailed:    12,
+	swarm.TaskStateRejected:  13,
+}
+
+func terminalState(state swarm.TaskState) bool {
+	return numberedStates[state] > numberedStates[swarm.TaskStateRunning]
+}
+
+func waitOnTasks(ctx context.Context, client apiclient.APIClient, namespace string) error {
+	terminalStatesReached := 0
+	for {
+		tasks, err := getStackTasks(ctx, client, namespace)
+		if err != nil {
+			return fmt.Errorf("failed to get tasks: %w", err)
+		}
+
+		for _, task := range tasks {
+			if terminalState(task.Status.State) {
+				terminalStatesReached++
+				break
+			}
+		}
+
+		if terminalStatesReached == len(tasks) {
+			break
+		}
+	}
+	return nil
+}
diff --git a/docs/reference/commandline/stack_rm.md b/docs/reference/commandline/stack_rm.md
@@ -7,6 +7,12 @@ Remove one or more stacks
 
 `docker stack rm`, `docker stack remove`, `docker stack down`
 
+### Options
+
+| Name             | Type   | Default | Description                   |
+|:-----------------|:-------|:--------|:------------------------------|
+| `-d`, `--detach` | `bool` | `true`  | Do not wait for stack removal |
+
 
 <!---MARKER_GEN_END-->
 

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ type PS struct {`
`38`	`38`	`// Remove holds docker stack remove options`
`39`	`39`	`type Remove struct {`
`40`	`40`	`Namespaces []string`
	`41`	`+ Detach bool`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`// Services holds docker stack services options`
Original file line number	Diff line number	Diff line change
`@@ -27,5 +27,8 @@ func newRemoveCommand(dockerCli command.Cli) *cobra.Command {`
`27`	`27`	`return completeNames(dockerCli)(cmd, args, toComplete)`
`28`	`28`	`},`
`29`	`29`	`}`
	`30`	`+`
	`31`	`+ flags := cmd.Flags()`
	`32`	`+ flags.BoolVarP(&opts.Detach, "detach", "d", true, "Do not wait for stack removal")`
`30`	`33`	`return cmd`
`31`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,3 +44,7 @@ func getStackSecrets(ctx context.Context, apiclient client.APIClient, namespace`
`44`	`44`	`func getStackConfigs(ctx context.Context, apiclient client.APIClient, namespace string) ([]swarm.Config, error) {`
`45`	`45`	`return apiclient.ConfigList(ctx, types.ConfigListOptions{Filters: getStackFilter(namespace)})`
`46`	`46`	`}`
	`47`	`+`
	`48`	`+func getStackTasks(ctx context.Context, apiclient client.APIClient, namespace string) ([]swarm.Task, error) {`
	`49`	`+ return apiclient.TaskList(ctx, types.TaskListOptions{Filters: getStackFilter(namespace)})`
	`50`	`+}`