1berry/docker-cli
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5970 from thaJeztah/swarm_completion_cleanup

Browse Source 
cli/command/service: un-export CompletionFn
This commit is contained in:
Paweł Gronowski 2025-03-31 11:39:37 +00:00 committed by GitHub
commit fc817a1367
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 42 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
cli/command/service/cmd.go
View File

@ -1,12 +1,8 @@
package service
import (
"os"
"github.com/docker/cli/cli"
"github.com/docker/cli/cli/command"
"github.com/docker/cli/cli/command/completion"
"github.com/docker/docker/api/types"
"github.com/spf13/cobra"
)
@ -35,27 +31,3 @@ func NewServiceCommand(dockerCli command.Cli) *cobra.Command {
)
return cmd
}
// CompletionFn offers completion for swarm service names and optional IDs.
// By default, only names are returned.
// Set DOCKER_COMPLETION_SHOW_SERVICE_IDS=yes to also complete IDs.
func CompletionFn(dockerCLI completion.APIClientProvider) cobra.CompletionFunc {
// https://github.com/docker/cli/blob/f9ced58158d5e0b358052432244b483774a1983d/contrib/completion/bash/docker#L41-L43
showIDs := os.Getenv("DOCKER_COMPLETION_SHOW_SERVICE_IDS") == "yes"
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
list, err := dockerCLI.Client().ServiceList(cmd.Context(), types.ServiceListOptions{})
if err != nil {
return nil, cobra.ShellCompDirectiveError
}
names := make([]string, 0, len(list))
for _, service := range list {
if showIDs {
names = append(names, service.Spec.Name, service.ID)
} else {
names = append(names, service.Spec.Name)
}
}
return names, cobra.ShellCompDirectiveNoFileComp
}
}

33
cli/command/service/completion.go Normal file
View File

@ -0,0 +1,33 @@
package service
import (
"os"
"github.com/docker/cli/cli/command/completion"
"github.com/docker/docker/api/types"
"github.com/spf13/cobra"
)
// completeServiceNames offers completion for swarm service names and optional IDs.
// By default, only names are returned.
// Set DOCKER_COMPLETION_SHOW_SERVICE_IDS=yes to also complete IDs.
func completeServiceNames(dockerCLI completion.APIClientProvider) cobra.CompletionFunc {
// https://github.com/docker/cli/blob/f9ced58158d5e0b358052432244b483774a1983d/contrib/completion/bash/docker#L41-L43
showIDs := os.Getenv("DOCKER_COMPLETION_SHOW_SERVICE_IDS") == "yes"
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
list, err := dockerCLI.Client().ServiceList(cmd.Context(), types.ServiceListOptions{})
if err != nil {
return nil, cobra.ShellCompDirectiveError
}
names := make([]string, 0, len(list))
for _, service := range list {
if showIDs {
names = append(names, service.Spec.Name, service.ID)
} else {
names = append(names, service.Spec.Name)
}
}
return names, cobra.ShellCompDirectiveNoFileComp
}
}

4
cli/command/service/inspect.go
View File

@ -41,9 +41,7 @@ func newInspectCommand(dockerCli command.Cli) *cobra.Command {
}
return runInspect(cmd.Context(), dockerCli, opts)
},
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return CompletionFn(dockerCli)(cmd, args, toComplete)
},
ValidArgsFunction: completeServiceNames(dockerCli),
}
flags := cmd.Flags()

6
cli/command/service/logs.go
View File

@ -51,10 +51,8 @@ func newLogsCommand(dockerCli command.Cli) *cobra.Command {
opts.target = args[0]
return runLogs(cmd.Context(), dockerCli, &opts)
},
Annotations: map[string]string{"version": "1.29"},
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return CompletionFn(dockerCli)(cmd, args, toComplete)
},
Annotations: map[string]string{"version": "1.29"},
ValidArgsFunction: completeServiceNames(dockerCli),
}
flags := cmd.Flags()

4
cli/command/service/ps.go
View File

@ -39,9 +39,7 @@ func newPsCommand(dockerCli command.Cli) *cobra.Command {
options.services = args
return runPS(cmd.Context(), dockerCli, options)
},
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return CompletionFn(dockerCli)(cmd, args, toComplete)
},
ValidArgsFunction: completeServiceNames(dockerCli),
}
flags := cmd.Flags()
flags.BoolVarP(&options.quiet, "quiet", "q", false, "Only display task IDs")

4
cli/command/service/remove.go
View File

@ -19,9 +19,7 @@ func newRemoveCommand(dockerCli command.Cli) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error {
return runRemove(cmd.Context(), dockerCli, args)
},
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return CompletionFn(dockerCli)(cmd, args, toComplete)
},
ValidArgsFunction: completeServiceNames(dockerCli),
}
cmd.Flags()

6
cli/command/service/rollback.go
View File

@ -23,10 +23,8 @@ func newRollbackCommand(dockerCli command.Cli) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error {
return runRollback(cmd.Context(), dockerCli, options, args[0])
},
Annotations: map[string]string{"version": "1.31"},
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return CompletionFn(dockerCli)(cmd, args, toComplete)
},
Annotations: map[string]string{"version": "1.31"},
ValidArgsFunction: completeServiceNames(dockerCli),
}
flags := cmd.Flags()

2
cli/command/service/scale.go
View File

@ -121,7 +121,7 @@ func runServiceScale(ctx context.Context, apiClient client.ServiceAPIClient, ser
func completeScaleArgs(dockerCli command.Cli) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
// reuse the existing logic for configurable completion of service names and IDs.
completions, directive := CompletionFn(dockerCli)(cmd, args, toComplete)
completions, directive := completeServiceNames(dockerCli)(cmd, args, toComplete)
if directive == cobra.ShellCompDirectiveError {
return completions, directive
}

4
cli/command/service/update.go
View File

@ -35,9 +35,7 @@ func newUpdateCommand(dockerCLI command.Cli) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error {
return runUpdate(cmd.Context(), dockerCLI, cmd.Flags(), options, args[0])
},
ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return CompletionFn(dockerCLI)(cmd, args, toComplete)
},
ValidArgsFunction: completeServiceNames(dockerCLI),
}
flags := cmd.Flags()