aboutsummaryrefslogtreecommitdiff
path: root/cmd/podman/volumes/list.go
blob: 804b9f319f82c24ac84083a0389c8a6bf71cfb18 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
package volumes

import (
	"context"
	"fmt"
	"io"
	"os"
	"strings"
	"text/tabwriter"
	"text/template"

	"github.com/containers/libpod/v2/cmd/podman/registry"
	"github.com/containers/libpod/v2/cmd/podman/validate"
	"github.com/containers/libpod/v2/pkg/domain/entities"
	"github.com/pkg/errors"
	"github.com/spf13/cobra"
)

var (
	volumeLsDescription = `
podman volume ls

List all available volumes. The output of the volumes can be filtered
and the output format can be changed to JSON or a user specified Go template.`
	lsCommand = &cobra.Command{
		Use:     "ls",
		Aliases: []string{"list"},
		Args:    validate.NoArgs,
		Short:   "List volumes",
		Long:    volumeLsDescription,
		RunE:    list,
	}
)

var (
	// Temporary struct to hold cli values.
	cliOpts = struct {
		Filter []string
		Format string
		Quiet  bool
	}{}
	lsOpts = entities.VolumeListOptions{}
)

func init() {
	registry.Commands = append(registry.Commands, registry.CliCommand{
		Mode:    []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
		Command: lsCommand,
		Parent:  volumeCmd,
	})
	flags := lsCommand.Flags()
	flags.StringSliceVarP(&cliOpts.Filter, "filter", "f", []string{}, "Filter volume output")
	flags.StringVar(&cliOpts.Format, "format", "{{.Driver}}\t{{.Name}}\n", "Format volume output using Go template")
	flags.BoolVarP(&cliOpts.Quiet, "quiet", "q", false, "Print volume output in quiet mode")
}

func list(cmd *cobra.Command, args []string) error {
	var w io.Writer = os.Stdout
	if cliOpts.Quiet && cmd.Flag("format").Changed {
		return errors.New("quiet and format flags cannot be used together")
	}
	if len(cliOpts.Filter) > 0 {
		lsOpts.Filter = make(map[string][]string)
	}
	for _, f := range cliOpts.Filter {
		filterSplit := strings.Split(f, "=")
		if len(filterSplit) < 2 {
			return errors.Errorf("filter input must be in the form of filter=value: %s is invalid", f)
		}
		lsOpts.Filter[filterSplit[0]] = append(lsOpts.Filter[filterSplit[0]], filterSplit[1:]...)
	}
	responses, err := registry.ContainerEngine().VolumeList(context.Background(), lsOpts)
	if err != nil {
		return err
	}
	if cliOpts.Format == "json" {
		return outputJSON(responses)
	}

	if len(responses) < 1 {
		return nil
	}
	// "\t" from the command line is not being recognized as a tab
	// replacing the string "\t" to a tab character if the user passes in "\t"
	cliOpts.Format = strings.Replace(cliOpts.Format, `\t`, "\t", -1)
	if cliOpts.Quiet {
		cliOpts.Format = "{{.Name}}\n"
	}
	headers := "DRIVER\tVOLUME NAME\n"
	row := cliOpts.Format
	if !strings.HasSuffix(cliOpts.Format, "\n") {
		row += "\n"
	}
	format := "{{range . }}" + row + "{{end}}"
	if !cliOpts.Quiet && !cmd.Flag("format").Changed {
		w = tabwriter.NewWriter(os.Stdout, 12, 2, 2, ' ', 0)
		format = headers + format
	}
	tmpl, err := template.New("listVolume").Parse(format)
	if err != nil {
		return err
	}
	if err := tmpl.Execute(w, responses); err != nil {
		return err
	}
	if flusher, ok := w.(interface{ Flush() error }); ok {
		return flusher.Flush()
	}
	return nil
}

func outputJSON(vols []*entities.VolumeListReport) error {
	b, err := json.MarshalIndent(vols, "", "  ")
	if err != nil {
		return err
	}
	fmt.Println(string(b))
	return nil
}