9f453d3fea
It's part of the presentation logic of the cli, and only used internally. We can consider providing utilities for these, but better as part of separate packages. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
108 lines
3.2 KiB
Go
108 lines
3.2 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 service
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
|
|
"github.com/containerd/errdefs"
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/command/completion"
|
|
"github.com/docker/cli/cli/command/formatter"
|
|
flagsHelper "github.com/docker/cli/cli/flags"
|
|
"github.com/moby/moby/api/types/network"
|
|
"github.com/moby/moby/api/types/swarm"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/pflag"
|
|
)
|
|
|
|
type inspectOptions struct {
|
|
refs []string
|
|
format string
|
|
pretty bool
|
|
}
|
|
|
|
func newInspectCommand(dockerCli command.Cli) *cobra.Command {
|
|
var opts inspectOptions
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "inspect [OPTIONS] SERVICE [SERVICE...]",
|
|
Short: "Display detailed information on one or more services",
|
|
Args: cli.RequiresMinArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.refs = args
|
|
|
|
if opts.pretty && len(opts.format) > 0 {
|
|
return errors.Errorf("--format is incompatible with human friendly format")
|
|
}
|
|
return runInspect(cmd.Context(), dockerCli, opts)
|
|
},
|
|
ValidArgsFunction: completeServiceNames(dockerCli),
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
flags.StringVarP(&opts.format, "format", "f", "", flagsHelper.InspectFormatHelp)
|
|
flags.BoolVar(&opts.pretty, "pretty", false, "Print the information in a human friendly format")
|
|
|
|
flags.VisitAll(func(flag *pflag.Flag) {
|
|
// Set a default completion function if none was set. We don't look
|
|
// up if it does already have one set, because Cobra does this for
|
|
// us, and returns an error (which we ignore for this reason).
|
|
_ = cmd.RegisterFlagCompletionFunc(flag.Name, completion.NoComplete)
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
func runInspect(ctx context.Context, dockerCli command.Cli, opts inspectOptions) error {
|
|
client := dockerCli.Client()
|
|
|
|
if opts.pretty {
|
|
opts.format = "pretty"
|
|
}
|
|
|
|
getRef := func(ref string) (any, []byte, error) {
|
|
// Service inspect shows defaults values in empty fields.
|
|
service, _, err := client.ServiceInspectWithRaw(ctx, ref, swarm.ServiceInspectOptions{InsertDefaults: true})
|
|
if err == nil || !errdefs.IsNotFound(err) {
|
|
return service, nil, err
|
|
}
|
|
return nil, nil, errors.Errorf("Error: no such service: %s", ref)
|
|
}
|
|
|
|
getNetwork := func(ref string) (any, []byte, error) {
|
|
nw, _, err := client.NetworkInspectWithRaw(ctx, ref, network.InspectOptions{Scope: "swarm"})
|
|
if err == nil || !errdefs.IsNotFound(err) {
|
|
return nw, nil, err
|
|
}
|
|
return nil, nil, errors.Errorf("Error: no such network: %s", ref)
|
|
}
|
|
|
|
f := opts.format
|
|
if len(f) == 0 {
|
|
f = "raw"
|
|
if len(dockerCli.ConfigFile().ServiceInspectFormat) > 0 {
|
|
f = dockerCli.ConfigFile().ServiceInspectFormat
|
|
}
|
|
}
|
|
|
|
// check if the user is trying to apply a template to the pretty format, which
|
|
// is not supported
|
|
if strings.HasPrefix(f, "pretty") && f != "pretty" {
|
|
return errors.Errorf("Cannot supply extra formatting options to the pretty template")
|
|
}
|
|
|
|
serviceCtx := formatter.Context{
|
|
Output: dockerCli.Out(),
|
|
Format: newFormat(f),
|
|
}
|
|
|
|
if err := inspectFormatWrite(serviceCtx, opts.refs, getRef, getNetwork); err != nil {
|
|
return cli.StatusError{StatusCode: 1, Status: err.Error()}
|
|
}
|
|
return nil
|
|
}
|