package volumes
import (
"fmt"
"html/template"
"os"
"strings"
"github.com/containers/buildah/pkg/formats"
"github.com/containers/libpod/v2/cmd/podman/registry"
"github.com/containers/libpod/v2/pkg/domain/entities"
"github.com/pkg/errors"
"github.com/spf13/cobra"
"golang.org/x/net/context"
)
var (
volumeInspectDescription = `Display detailed information on one or more volumes.
Use a Go template to change the format from JSON.`
inspectCommand = &cobra.Command{
Use: "inspect [flags] VOLUME [VOLUME...]",
Short: "Display detailed information on one or more volumes",
Long: volumeInspectDescription,
RunE: inspect,
Example: `podman volume inspect myvol
podman volume inspect --all
podman volume inspect --format "{{.Driver}} {{.Scope}}" myvol`,
}
)
var (
inspectOpts = entities.VolumeInspectOptions{}
inspectFormat string
)
func init() {
registry.Commands = append(registry.Commands, registry.CliCommand{
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
Command: inspectCommand,
Parent: volumeCmd,
})
flags := inspectCommand.Flags()
flags.BoolVarP(&inspectOpts.All, "all", "a", false, "Inspect all volumes")
flags.StringVarP(&inspectFormat, "format", "f", "json", "Format volume output using Go template")
}
func inspect(cmd *cobra.Command, args []string) error {
if (inspectOpts.All && len(args) > 0) || (!inspectOpts.All && len(args) < 1) {
return errors.New("provide one or more volume names or use --all")
}
responses, err := registry.ContainerEngine().VolumeInspect(context.Background(), args, inspectOpts)
if err != nil {
return err
}
switch inspectFormat {
case "", formats.JSONString:
jsonOut, err := json.MarshalIndent(responses, "", " ")
if err != nil {
return errors.Wrapf(err, "error marshalling inspect JSON")
}
fmt.Println(string(jsonOut))
default:
if !strings.HasSuffix(inspectFormat, "\n") {
inspectFormat += "\n"
}
format := "{{range . }}" + inspectFormat + "{{end}}"
tmpl, err := template.New("volumeInspect").Parse(format)
if err != nil {
return err
}
if err := tmpl.Execute(os.Stdout, responses); err != nil {
return err
}
}
return nil
}