cli/image_inspect.go

package main

import (
	"context"
	"os"

	"github.com/alibaba/pouch/cli/inspect"

	"github.com/spf13/cobra"
)

// imageInspectDescription is used to describe inspect command in detail and auto generate command doc.
var imageInspectDescription = "Return detailed information on Pouch image"

// ImageInspectCommand use to implement 'image inspect' command.
type ImageInspectCommand struct {
	baseCommand
	format string
}

// Init initialize "image inspect" command.
func (i *ImageInspectCommand) Init(c *Cli) {
	i.cli = c
	i.cmd = &cobra.Command{
		Use:   "inspect [OPTIONS] IMAGE [IMAGE...]",
		Short: "Display detailed information on one or more images",
		Long:  imageInspectDescription,
		Args:  cobra.MinimumNArgs(1),
		RunE: func(cmd *cobra.Command, args []string) error {
			return i.runInspect(args)
		},
		Example: i.example(),
	}
	i.addFlags()
}

// addFlags adds flags for specific command.
func (i *ImageInspectCommand) addFlags() {
	i.cmd.Flags().StringVarP(&i.format, "format", "f", "", "Format the output using the given go template")
}

// runInpsect is used to inspect image.
func (i *ImageInspectCommand) runInspect(args []string) error {
	ctx := context.Background()
	apiClient := i.cli.Client()

	getRefFunc := func(ref string) (interface{}, error) {
		return apiClient.ImageInspect(ctx, ref)
	}

	return inspect.Inspect(os.Stdout, args, i.format, getRefFunc)
}

// example shows examples in inspect command, and is used in auto-generated cli docs.
func (i *ImageInspectCommand) example() string {
	return `$ pouch image inspect docker.io/library/busybox
{
  "CreatedAt": "2017-12-21 04:30:57",
  "Digest": "sha256:bbc3a03235220b170ba48a157dd097dd1379299370e1ed99ce976df0355d24f0",
  "ID": "bbc3a0323522",
  "Name": "docker.io/library/busybox:latest",
  "Size": 720019,
  "Tag": "latest"
}`
}