mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
55cdb6dcd0
This fix addresses an issue where including the `{{.Size}}` format
field in conjunction with `docker ps --format`, without the `--size`
flag, would not correctly display the size of containers.
This is done by doing a check on the custom format string, and setting
the size flag on the options struct if the field is found. This struct
gets passed to the engine API which then generates the correct query.
An integration test is included which runs `docker ps --format "table
{{.Size}}"` without `--size`, and checks that the returned output is
not `0 B`.
Fixes #21991
As suggested by @cpuguy83, a parser is implemented to process the format
string as a template, and then traverses the template tree to determine
if `.Size` was called.
This was then reworked by making use of template execution with a
pre-processor struct that will set the `--size` option if the template
calls for the field.
The pre-processor now also sets a boolean in the context passed to the
writer. There is an integration test for this that calls `docker ps
--size --format "{{.Size}}"` and then checks that `size: {{.Size}}` is
not appended, as it would with previous behavior.
Finally, a change was made to the formatter to not automatically
add a `{{.Size}}` if a custom format is provided.
Signed-off-by: Paulo Ribeiro <paigr.io@gmail.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
105 lines
2.6 KiB
Go
105 lines
2.6 KiB
Go
package client
|
|
|
|
import (
|
|
"golang.org/x/net/context"
|
|
"io/ioutil"
|
|
|
|
"github.com/docker/docker/api/client/formatter"
|
|
Cli "github.com/docker/docker/cli"
|
|
"github.com/docker/docker/opts"
|
|
flag "github.com/docker/docker/pkg/mflag"
|
|
"github.com/docker/docker/utils/templates"
|
|
"github.com/docker/engine-api/types"
|
|
"github.com/docker/engine-api/types/filters"
|
|
)
|
|
|
|
type preProcessor struct {
|
|
opts *types.ContainerListOptions
|
|
}
|
|
|
|
// Size sets the size option when called by a template execution.
|
|
func (p *preProcessor) Size() bool {
|
|
p.opts.Size = true
|
|
return true
|
|
}
|
|
|
|
// CmdPs outputs a list of Docker containers.
|
|
//
|
|
// Usage: docker ps [OPTIONS]
|
|
func (cli *DockerCli) CmdPs(args ...string) error {
|
|
var (
|
|
err error
|
|
|
|
psFilterArgs = filters.NewArgs()
|
|
|
|
cmd = Cli.Subcmd("ps", nil, Cli.DockerCommands["ps"].Description, true)
|
|
quiet = cmd.Bool([]string{"q", "-quiet"}, false, "Only display numeric IDs")
|
|
size = cmd.Bool([]string{"s", "-size"}, false, "Display total file sizes")
|
|
all = cmd.Bool([]string{"a", "-all"}, false, "Show all containers (default shows just running)")
|
|
noTrunc = cmd.Bool([]string{"-no-trunc"}, false, "Don't truncate output")
|
|
nLatest = cmd.Bool([]string{"l", "-latest"}, false, "Show the latest created container (includes all states)")
|
|
last = cmd.Int([]string{"n"}, -1, "Show n last created containers (includes all states)")
|
|
format = cmd.String([]string{"-format"}, "", "Pretty-print containers using a Go template")
|
|
flFilter = opts.NewListOpts(nil)
|
|
)
|
|
cmd.Require(flag.Exact, 0)
|
|
|
|
cmd.Var(&flFilter, []string{"f", "-filter"}, "Filter output based on conditions provided")
|
|
|
|
cmd.ParseFlags(args, true)
|
|
if *last == -1 && *nLatest {
|
|
*last = 1
|
|
}
|
|
|
|
// Consolidate all filter flags, and sanity check them.
|
|
// They'll get processed in the daemon/server.
|
|
for _, f := range flFilter.GetAll() {
|
|
if psFilterArgs, err = filters.ParseFlag(f, psFilterArgs); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
options := types.ContainerListOptions{
|
|
All: *all,
|
|
Limit: *last,
|
|
Size: *size,
|
|
Filter: psFilterArgs,
|
|
}
|
|
|
|
pre := &preProcessor{opts: &options}
|
|
tmpl, err := templates.Parse(*format)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_ = tmpl.Execute(ioutil.Discard, pre)
|
|
|
|
containers, err := cli.client.ContainerList(context.Background(), options)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
f := *format
|
|
if len(f) == 0 {
|
|
if len(cli.PsFormat()) > 0 && !*quiet {
|
|
f = cli.PsFormat()
|
|
} else {
|
|
f = "table"
|
|
}
|
|
}
|
|
|
|
psCtx := formatter.ContainerContext{
|
|
Context: formatter.Context{
|
|
Output: cli.out,
|
|
Format: f,
|
|
Quiet: *quiet,
|
|
Trunc: !*noTrunc,
|
|
},
|
|
Size: *size,
|
|
Containers: containers,
|
|
}
|
|
|
|
psCtx.Write()
|
|
|
|
return nil
|
|
}
|