0adaf6be3b
This replaces the visitAll recursive function with a test that verifies that the option is set for all commands and subcommands, so that it doesn't have to be modified at runtime. We currently still have to loop over all functions for the setValidateArgs call, but that can be looked at separately. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
98 lines
2.7 KiB
Go
98 lines
2.7 KiB
Go
package volume
|
|
|
|
import (
|
|
"context"
|
|
"sort"
|
|
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/command/formatter"
|
|
flagsHelper "github.com/docker/cli/cli/flags"
|
|
"github.com/docker/cli/opts"
|
|
"github.com/fvbommel/sortorder"
|
|
"github.com/moby/moby/client"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
const (
|
|
clusterTableFormat = "table {{.Name}}\t{{.Group}}\t{{.Driver}}\t{{.Availability}}\t{{.Status}}"
|
|
)
|
|
|
|
type listOptions struct {
|
|
quiet bool
|
|
format string
|
|
cluster bool
|
|
filter opts.FilterOpt
|
|
}
|
|
|
|
func newListCommand(dockerCLI command.Cli) *cobra.Command {
|
|
options := listOptions{filter: opts.NewFilterOpt()}
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "ls [OPTIONS]",
|
|
Aliases: []string{"list"},
|
|
Short: "List volumes",
|
|
Args: cli.NoArgs,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
return runList(cmd.Context(), dockerCLI, options)
|
|
},
|
|
ValidArgsFunction: cobra.NoFileCompletions,
|
|
DisableFlagsInUseLine: true,
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
flags.BoolVarP(&options.quiet, "quiet", "q", false, "Only display volume names")
|
|
flags.StringVar(&options.format, "format", "", flagsHelper.FormatHelp)
|
|
flags.VarP(&options.filter, "filter", "f", `Provide filter values (e.g. "dangling=true")`)
|
|
flags.BoolVar(&options.cluster, "cluster", false, "Display only cluster volumes, and use cluster volume list formatting")
|
|
flags.SetAnnotation("cluster", "version", []string{"1.42"})
|
|
flags.SetAnnotation("cluster", "swarm", []string{"manager"})
|
|
|
|
return cmd
|
|
}
|
|
|
|
func runList(ctx context.Context, dockerCLI command.Cli, options listOptions) error {
|
|
apiClient := dockerCLI.Client()
|
|
volumes, err := apiClient.VolumeList(ctx, client.VolumeListOptions{Filters: options.filter.Value()})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
format := options.format
|
|
if len(format) == 0 && !options.cluster {
|
|
if len(dockerCLI.ConfigFile().VolumesFormat) > 0 && !options.quiet {
|
|
format = dockerCLI.ConfigFile().VolumesFormat
|
|
} else {
|
|
format = formatter.TableFormatKey
|
|
}
|
|
} else if options.cluster {
|
|
// TODO(dperny): write server-side filter for cluster volumes. For this
|
|
// proof of concept, we'll just filter out non-cluster volumes here
|
|
|
|
// trick for filtering in place
|
|
n := 0
|
|
for _, vol := range volumes.Volumes {
|
|
if vol.ClusterVolume != nil {
|
|
volumes.Volumes[n] = vol
|
|
n++
|
|
}
|
|
}
|
|
volumes.Volumes = volumes.Volumes[:n]
|
|
if !options.quiet {
|
|
format = clusterTableFormat
|
|
} else {
|
|
format = formatter.TableFormatKey
|
|
}
|
|
}
|
|
|
|
sort.Slice(volumes.Volumes, func(i, j int) bool {
|
|
return sortorder.NaturalLess(volumes.Volumes[i].Name, volumes.Volumes[j].Name)
|
|
})
|
|
|
|
volumeCtx := formatter.Context{
|
|
Output: dockerCLI.Out(),
|
|
Format: formatter.NewVolumeFormat(format, options.quiet),
|
|
}
|
|
return formatter.VolumeWrite(volumeCtx, volumes.Volumes)
|
|
}
|