github.com/portworx/docker@v1.12.1/api/client/inspect.go (about)

     1  package client
     2  
     3  import (
     4  	"fmt"
     5  
     6  	"golang.org/x/net/context"
     7  
     8  	"github.com/docker/docker/api/client/inspect"
     9  	Cli "github.com/docker/docker/cli"
    10  	flag "github.com/docker/docker/pkg/mflag"
    11  	"github.com/docker/engine-api/client"
    12  )
    13  
    14  // CmdInspect displays low-level information on one or more containers, images or tasks.
    15  //
    16  // Usage: docker inspect [OPTIONS] CONTAINER|IMAGE|TASK [CONTAINER|IMAGE|TASK...]
    17  func (cli *DockerCli) CmdInspect(args ...string) error {
    18  	cmd := Cli.Subcmd("inspect", []string{"[OPTIONS] CONTAINER|IMAGE|TASK [CONTAINER|IMAGE|TASK...]"}, Cli.DockerCommands["inspect"].Description, true)
    19  	tmplStr := cmd.String([]string{"f", "-format"}, "", "Format the output using the given go template")
    20  	inspectType := cmd.String([]string{"-type"}, "", "Return JSON for specified type, (e.g image, container or task)")
    21  	size := cmd.Bool([]string{"s", "-size"}, false, "Display total file sizes if the type is container")
    22  	cmd.Require(flag.Min, 1)
    23  
    24  	cmd.ParseFlags(args, true)
    25  
    26  	if *inspectType != "" && *inspectType != "container" && *inspectType != "image" && *inspectType != "task" {
    27  		return fmt.Errorf("%q is not a valid value for --type", *inspectType)
    28  	}
    29  
    30  	ctx := context.Background()
    31  
    32  	var elementSearcher inspect.GetRefFunc
    33  	switch *inspectType {
    34  	case "container":
    35  		elementSearcher = cli.inspectContainers(ctx, *size)
    36  	case "image":
    37  		elementSearcher = cli.inspectImages(ctx, *size)
    38  	case "task":
    39  		if *size {
    40  			fmt.Fprintln(cli.err, "WARNING: --size ignored for tasks")
    41  		}
    42  		elementSearcher = cli.inspectTasks(ctx)
    43  	default:
    44  		elementSearcher = cli.inspectAll(ctx, *size)
    45  	}
    46  
    47  	return inspect.Inspect(cli.out, cmd.Args(), *tmplStr, elementSearcher)
    48  }
    49  
    50  func (cli *DockerCli) inspectContainers(ctx context.Context, getSize bool) inspect.GetRefFunc {
    51  	return func(ref string) (interface{}, []byte, error) {
    52  		return cli.client.ContainerInspectWithRaw(ctx, ref, getSize)
    53  	}
    54  }
    55  
    56  func (cli *DockerCli) inspectImages(ctx context.Context, getSize bool) inspect.GetRefFunc {
    57  	return func(ref string) (interface{}, []byte, error) {
    58  		return cli.client.ImageInspectWithRaw(ctx, ref, getSize)
    59  	}
    60  }
    61  
    62  func (cli *DockerCli) inspectTasks(ctx context.Context) inspect.GetRefFunc {
    63  	return func(ref string) (interface{}, []byte, error) {
    64  		return cli.client.TaskInspectWithRaw(ctx, ref)
    65  	}
    66  }
    67  
    68  func (cli *DockerCli) inspectAll(ctx context.Context, getSize bool) inspect.GetRefFunc {
    69  	return func(ref string) (interface{}, []byte, error) {
    70  		c, rawContainer, err := cli.client.ContainerInspectWithRaw(ctx, ref, getSize)
    71  		if err != nil {
    72  			// Search for image with that id if a container doesn't exist.
    73  			if client.IsErrContainerNotFound(err) {
    74  				i, rawImage, err := cli.client.ImageInspectWithRaw(ctx, ref, getSize)
    75  				if err != nil {
    76  					if client.IsErrImageNotFound(err) {
    77  						// Search for task with that id if an image doesn't exists.
    78  						t, rawTask, err := cli.client.TaskInspectWithRaw(ctx, ref)
    79  						if err != nil {
    80  							return nil, nil, fmt.Errorf("Error: No such image, container or task: %s", ref)
    81  						}
    82  						if getSize {
    83  							fmt.Fprintln(cli.err, "WARNING: --size ignored for tasks")
    84  						}
    85  						return t, rawTask, nil
    86  					}
    87  					return nil, nil, err
    88  				}
    89  				return i, rawImage, nil
    90  			}
    91  			return nil, nil, err
    92  		}
    93  		return c, rawContainer, nil
    94  	}
    95  }