[WIP] Refactor network name completion

Signed-off-by: Harald Albers <[email protected]>
docker · Oct 17, 2024 · 2d60765 · 2d60765
1 parent 0eb6f97
commit 2d60765
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 15 deletions.
diff --git a/cli/command/completion/functions.go b/cli/command/completion/functions.go
@@ -91,21 +91,30 @@ func VolumeNames(dockerCLI APIClientProvider) ValidArgsFn {
 	}
 }
 
-// NetworkNames offers completion for networks
-func NetworkNames(dockerCLI APIClientProvider) ValidArgsFn {
+// CompleteNetworkNames offers completion for networks
+func CompleteNetworkNames(dockerCLI APIClientProvider) ValidArgsFn {
 	return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		list, err := dockerCLI.Client().NetworkList(cmd.Context(), network.ListOptions{})
+		names, err := NetworkNames(dockerCLI, cmd)
 		if err != nil {
 			return nil, cobra.ShellCompDirectiveError
 		}
-		var names []string
-		for _, nw := range list {
-			names = append(names, nw.Name)
-		}
 		return names, cobra.ShellCompDirectiveNoFileComp
 	}
 }
 
+// NetworkNames returns a list of networks
+func NetworkNames(dockerCLI APIClientProvider, cmd *cobra.Command) ([]string, error) {
+	summaries, err := dockerCLI.Client().NetworkList(cmd.Context(), network.ListOptions{})
+	if err != nil {
+		return nil, err
+	}
+	var names []string
+	for _, nws := range summaries {
+		names = append(names, nws.Name)
+	}
+	return names, nil
+}
+
 // EnvVarNames offers completion for environment-variable names. This
 // completion can be used for "--env" and "--build-arg" flags, which
 // allow obtaining the value of the given environment-variable if present

diff --git a/cli/command/container/create.go b/cli/command/container/create.go
@@ -82,7 +82,7 @@ func NewCreateCommand(dockerCli command.Cli) *cobra.Command {
 	_ = cmd.RegisterFlagCompletionFunc("cap-drop", completeLinuxCapabilityNames)
 	_ = cmd.RegisterFlagCompletionFunc("env", completion.EnvVarNames)
 	_ = cmd.RegisterFlagCompletionFunc("env-file", completion.FileNames)
-	_ = cmd.RegisterFlagCompletionFunc("network", completion.NetworkNames(dockerCli))
+	_ = cmd.RegisterFlagCompletionFunc("network", completion.CompleteNetworkNames(dockerCli))
 	_ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms)
 	_ = cmd.RegisterFlagCompletionFunc("pull", completion.FromList(PullImageAlways, PullImageMissing, PullImageNever))
 	_ = cmd.RegisterFlagCompletionFunc("restart", completeRestartPolicies)

diff --git a/cli/command/container/run.go b/cli/command/container/run.go
@@ -73,7 +73,7 @@ func NewRunCommand(dockerCli command.Cli) *cobra.Command {
 	_ = cmd.RegisterFlagCompletionFunc("cap-drop", completeLinuxCapabilityNames)
 	_ = cmd.RegisterFlagCompletionFunc("env", completion.EnvVarNames)
 	_ = cmd.RegisterFlagCompletionFunc("env-file", completion.FileNames)
-	_ = cmd.RegisterFlagCompletionFunc("network", completion.NetworkNames(dockerCli))
+	_ = cmd.RegisterFlagCompletionFunc("network", completion.CompleteNetworkNames(dockerCli))
 	_ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms)
 	_ = cmd.RegisterFlagCompletionFunc("pull", completion.FromList(PullImageAlways, PullImageMissing, PullImageNever))
 	_ = cmd.RegisterFlagCompletionFunc("restart", completeRestartPolicies)

diff --git a/cli/command/network/connect.go b/cli/command/network/connect.go
@@ -41,7 +41,7 @@ func newConnectCommand(dockerCLI command.Cli) *cobra.Command {
 		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			if len(args) == 0 {
-				return completion.NetworkNames(dockerCLI)(cmd, args, toComplete)
+				return completion.CompleteNetworkNames(dockerCLI)(cmd, args, toComplete)
 			}
 			nw := args[0]
 			return completion.ContainerNames(dockerCLI, true, not(isConnected(nw)))(cmd, args, toComplete)

diff --git a/cli/command/network/disconnect.go b/cli/command/network/disconnect.go
@@ -31,7 +31,7 @@ func newDisconnectCommand(dockerCli command.Cli) *cobra.Command {
 		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			if len(args) == 0 {
-				return completion.NetworkNames(dockerCli)(cmd, args, toComplete)
+				return completion.CompleteNetworkNames(dockerCli)(cmd, args, toComplete)
 			}
 			network := args[0]
 			return completion.ContainerNames(dockerCli, true, isConnected(network))(cmd, args, toComplete)

diff --git a/cli/command/network/inspect.go b/cli/command/network/inspect.go
@@ -34,7 +34,7 @@ func newInspectCommand(dockerCLI command.Cli) *cobra.Command {
 			opts.names = args
 			return runInspect(cmd.Context(), dockerCLI.Client(), dockerCLI.Out(), opts)
 		},
-		ValidArgsFunction: completion.NetworkNames(dockerCLI),
+		ValidArgsFunction: completion.CompleteNetworkNames(dockerCLI),
 	}
 
 	cmd.Flags().StringVarP(&opts.format, "format", "f", "", flagsHelper.InspectFormatHelp)

diff --git a/cli/command/network/remove.go b/cli/command/network/remove.go
@@ -27,7 +27,7 @@ func newRemoveCommand(dockerCli command.Cli) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runRemove(cmd.Context(), dockerCli, args, &opts)
 		},
-		ValidArgsFunction: completion.NetworkNames(dockerCli),
+		ValidArgsFunction: completion.CompleteNetworkNames(dockerCli),
 	}
 
 	flags := cmd.Flags()

diff --git a/cli/command/system/completion.go b/cli/command/system/completion.go
@@ -66,8 +66,10 @@ func completeFilters(dockerCLI completion.APIClientProvider) completion.ValidArg
 			return nil, cobra.ShellCompDirectiveNoFileComp
 		}
 		if strings.HasPrefix(toComplete, "network=") {
-			// the pure network name list should be pulled out from NetworkNames.
-			names, _ := completion.NetworkNames(dockerCLI)(cmd, args, toComplete)
+			names, err := completion.NetworkNames(dockerCLI, cmd)
+			if err != nil {
+				return nil, cobra.ShellCompDirectiveError
+			}
 			return prefixWith("network=", names), cobra.ShellCompDirectiveDefault
 		}
 		if strings.HasPrefix(toComplete, "type=") {