package context import ( "fmt" "os" "sort" "github.com/docker/cli/cli" "github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command/completion" "github.com/docker/cli/cli/command/formatter" "github.com/docker/cli/cli/context/docker" flagsHelper "github.com/docker/cli/cli/flags" "github.com/docker/docker/client" "github.com/fvbommel/sortorder" "github.com/spf13/cobra" ) type listOptions struct { format string quiet bool } func newListCommand(dockerCli command.Cli) *cobra.Command { opts := &listOptions{} cmd := &cobra.Command{ Use: "ls [OPTIONS]", Aliases: []string{"list"}, Short: "List contexts", Args: cli.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { return runList(dockerCli, opts) }, ValidArgsFunction: completion.NoComplete, } flags := cmd.Flags() flags.StringVar(&opts.format, "format", "", flagsHelper.FormatHelp) flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Only show context names") return cmd } func runList(dockerCli command.Cli, opts *listOptions) error { if opts.format == "" { opts.format = formatter.TableFormatKey } contextMap, err := dockerCli.ContextStore().List() if err != nil { return err } var ( curContext = dockerCli.CurrentContext() curFound bool contexts = make([]*formatter.ClientContext, 0, len(contextMap)) ) for _, rawMeta := range contextMap { isCurrent := rawMeta.Name == curContext if isCurrent { curFound = true } meta, err := command.GetDockerContext(rawMeta) if err != nil { // Add a stub-entry to the list, including the error-message // indicating that the context couldn't be loaded. contexts = append(contexts, &formatter.ClientContext{ Name: rawMeta.Name, Current: isCurrent, Error: err.Error(), ContextType: getContextType(nil, opts.format), }) continue } var errMsg string dockerEndpoint, err := docker.EndpointFromContext(rawMeta) if err != nil { errMsg = err.Error() } desc := formatter.ClientContext{ Name: rawMeta.Name, Current: isCurrent, Description: meta.Description, DockerEndpoint: dockerEndpoint.Host, Error: errMsg, ContextType: getContextType(meta.AdditionalFields, opts.format), } contexts = append(contexts, &desc) } if !curFound { // The currently specified context wasn't found. We add a stub-entry // to the list, including the error-message indicating that the context // wasn't found. var errMsg string _, err := dockerCli.ContextStore().GetMetadata(curContext) if err != nil { errMsg = err.Error() } contexts = append(contexts, &formatter.ClientContext{ Name: curContext, Current: true, Error: errMsg, ContextType: getContextType(nil, opts.format), }) } sort.Slice(contexts, func(i, j int) bool { return sortorder.NaturalLess(contexts[i].Name, contexts[j].Name) }) if err := format(dockerCli, opts, contexts); err != nil { return err } if os.Getenv(client.EnvOverrideHost) != "" { _, _ = fmt.Fprintf(dockerCli.Err(), "Warning: %[1]s environment variable overrides the active context. "+ "To use a context, either set the global --context flag, or unset %[1]s environment variable.\n", client.EnvOverrideHost) } return nil } // getContextType sets the LegacyContextType field for compatibility with // Visual Studio, which depends on this field from the "cloud integration" // wrapper. // // https://github.com/docker/compose-cli/blob/c156ce6da4c2b317174d42daf1b019efa87e9f92/api/context/store/contextmetadata.go#L28-L34 // https://github.com/docker/compose-cli/blob/c156ce6da4c2b317174d42daf1b019efa87e9f92/api/context/store/store.go#L34-L51 // // TODO(thaJeztah): remove this and [ClientContext.ContextType] once Visual Studio is updated to no longer depend on this. func getContextType(meta map[string]any, format string) string { if format != formatter.JSONFormat && format != formatter.JSONFormatKey { // We only need the ContextType field when formatting as JSON, // which is the format-string used by Visual Studio to detect the // context-type. return "" } if ct, ok := meta["Type"]; ok { // If the context on-disk has a context-type (ecs, aci), return it. return ct.(string) } // Use the default context-type. return "moby" } func format(dockerCli command.Cli, opts *listOptions, contexts []*formatter.ClientContext) error { contextCtx := formatter.Context{ Output: dockerCli.Out(), Format: formatter.NewClientContextFormat(opts.format, opts.quiet), } return formatter.ClientContextWrite(contextCtx, contexts) }