531f7e121d
It's adding a slight indirection by constructing a function when called, but makes the completion functions more consistent, the signature easier to read, and making the return type a [cobra.CompletionFunc] makes it more transparent what it's intended for, and helps discovery of functions that provide completion. [cobra.CompletionFunc]: https://pkg.go.dev/github.com/spf13/cobra#CompletionFunc Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
82 lines
2.6 KiB
Go
82 lines
2.6 KiB
Go
// FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
|
|
//go:build go1.23
|
|
|
|
package image
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
|
|
"github.com/containerd/platforms"
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/command/completion"
|
|
"github.com/docker/cli/cli/command/inspect"
|
|
flagsHelper "github.com/docker/cli/cli/flags"
|
|
"github.com/moby/moby/api/types/image"
|
|
"github.com/moby/moby/client"
|
|
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
type inspectOptions struct {
|
|
format string
|
|
refs []string
|
|
platform string
|
|
}
|
|
|
|
// newInspectCommand creates a new cobra.Command for `docker image inspect`
|
|
func newInspectCommand(dockerCLI command.Cli) *cobra.Command {
|
|
var opts inspectOptions
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "inspect [OPTIONS] IMAGE [IMAGE...]",
|
|
Short: "Display detailed information on one or more images",
|
|
Args: cli.RequiresMinArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.refs = args
|
|
return runInspect(cmd.Context(), dockerCLI, opts)
|
|
},
|
|
ValidArgsFunction: completion.ImageNames(dockerCLI, -1),
|
|
DisableFlagsInUseLine: true,
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
flags.StringVarP(&opts.format, "format", "f", "", flagsHelper.InspectFormatHelp)
|
|
|
|
// Don't default to DOCKER_DEFAULT_PLATFORM env variable, always default to
|
|
// inspecting the image as-is. This also avoids forcing the platform selection
|
|
// on older APIs which don't support it.
|
|
flags.StringVar(&opts.platform, "platform", "", `Inspect a specific platform of the multi-platform image.
|
|
If the image or the server is not multi-platform capable, the command will error out if the platform does not match.
|
|
'os[/arch[/variant]]': Explicit platform (eg. linux/amd64)`)
|
|
flags.SetAnnotation("platform", "version", []string{"1.49"})
|
|
|
|
_ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms())
|
|
return cmd
|
|
}
|
|
|
|
func runInspect(ctx context.Context, dockerCLI command.Cli, opts inspectOptions) error {
|
|
var platform *ocispec.Platform
|
|
if opts.platform != "" {
|
|
p, err := platforms.Parse(opts.platform)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
platform = &p
|
|
}
|
|
|
|
apiClient := dockerCLI.Client()
|
|
return inspect.Inspect(dockerCLI.Out(), opts.refs, opts.format, func(ref string) (any, []byte, error) {
|
|
var buf bytes.Buffer
|
|
resp, err := apiClient.ImageInspect(ctx, ref,
|
|
client.ImageInspectWithRawResponse(&buf),
|
|
client.ImageInspectWithPlatform(platform),
|
|
)
|
|
if err != nil {
|
|
return image.InspectResponse{}, nil, err
|
|
}
|
|
return resp, buf.Bytes(), err
|
|
})
|
|
}
|