image/history: Add `--platform` flag

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/image/history.go

@@ -3,17 +3,20 @@ package image
 import (
 	"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/formatter"
 	flagsHelper "github.com/docker/cli/cli/flags"
 	"github.com/docker/docker/api/types/image"
+	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 )
 
 type historyOptions struct {
 	image    string
+	platform string
 
 	human   bool
 	quiet   bool
@@ -45,12 +48,24 @@ func NewHistoryCommand(dockerCli command.Cli) *cobra.Command {
 	flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Only show image IDs")
 	flags.BoolVar(&opts.noTrunc, "no-trunc", false, "Don't truncate output")
 	flags.StringVar(&opts.format, "format", "", flagsHelper.FormatHelp)
+	flags.StringVar(&opts.platform, "platform", "", `Show history for the given platform. Formatted as "os[/arch[/variant]]" (e.g., "linux/amd64")`)
+	_ = flags.SetAnnotation("platform", "version", []string{"1.48"})
 
+	_ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms)
 	return cmd
 }
 
 func runHistory(ctx context.Context, dockerCli command.Cli, opts historyOptions) error {
-	history, err := dockerCli.Client().ImageHistory(ctx, opts.image, image.HistoryOptions{})
+	var options image.HistoryOptions
+	if opts.platform != "" {
+		p, err := platforms.Parse(opts.platform)
+		if err != nil {
+			return errors.Wrap(err, "invalid platform")
+		}
+		options.Platform = &p
+	}
+
+	history, err := dockerCli.Client().ImageHistory(ctx, opts.image, options)
 	if err != nil {
 		return err
 	}

cli/command/image/history_test.go

@@ -8,8 +8,10 @@ import (
 
 	"github.com/docker/cli/internal/test"
 	"github.com/docker/docker/api/types/image"
+	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/pkg/errors"
 	"gotest.tools/v3/assert"
+	is "gotest.tools/v3/assert/cmp"
 	"gotest.tools/v3/golden"
 )
 
@@ -33,6 +35,11 @@ func TestNewHistoryCommandErrors(t *testing.T) {
 				return []image.HistoryResponseItem{{}}, errors.Errorf("something went wrong")
 			},
 		},
+		{
+			name:          "invalid platform",
+			args:          []string{"--platform", "<invalid>", "arg1"},
+			expectedError: `invalid platform`,
+		},
 	}
 	for _, tc := range testCases {
 		tc := tc
@@ -89,6 +96,17 @@ func TestNewHistoryCommandSuccess(t *testing.T) {
 				}}, nil
 			},
 		},
+		{
+			name: "platform",
+			args: []string{"--platform", "linux/amd64", "image:tag"},
+			imageHistoryFunc: func(img string, options image.HistoryOptions) ([]image.HistoryResponseItem, error) {
+				assert.Check(t, is.DeepEqual(ocispec.Platform{OS: "linux", Architecture: "amd64"}, *options.Platform))
+				return []image.HistoryResponseItem{{
+					ID:      "1234567890123456789",
+					Created: time.Now().Unix(),
+				}}, nil
+			},
+		},
 	}
 	for _, tc := range testCases {
 		tc := tc

cli/command/image/testdata/history-command-success.platform.golden

@@ -0,0 +1,2 @@
+IMAGE          CREATED                  CREATED BY   SIZE      COMMENT
+123456789012   Less than a second ago                0B        

docs/reference/commandline/history.md

@@ -14,6 +14,7 @@ Show the history of an image
 | `--format`      | `string` |         | Format output using a custom template:<br>'table':            Print output in table format with column headers (default)<br>'table TEMPLATE':   Print output in table format using the given Go template<br>'json':             Print in JSON format<br>'TEMPLATE':         Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
 | `-H`, `--human` | `bool`   | `true`  | Print sizes and dates in human readable format                                                                                                                                                                                                                                                                                                                                                                                       |
 | `--no-trunc`    | `bool`   |         | Don't truncate output                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `--platform`    | `string` |         | Show history for the given platform. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`)                                                                                                                                                                                                                                                                                                                                        |
 | `-q`, `--quiet` | `bool`   |         | Only show image IDs                                                                                                                                                                                                                                                                                                                                                                                                                  |
 
 

docs/reference/commandline/image_history.md

@@ -10,10 +10,11 @@ Show the history of an image
 ### Options
 
 | Name                      | Type     | Default | Description                                                                                                                                                                                                                                                                                                                                                                                                                          |
-|:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|:--------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | [`--format`](#format)     | `string` |         | Format output using a custom template:<br>'table':            Print output in table format with column headers (default)<br>'table TEMPLATE':   Print output in table format using the given Go template<br>'json':             Print in JSON format<br>'TEMPLATE':         Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
 | `-H`, `--human`           | `bool`   | `true`  | Print sizes and dates in human readable format                                                                                                                                                                                                                                                                                                                                                                                       |
 | `--no-trunc`              | `bool`   |         | Don't truncate output                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [`--platform`](#platform) | `string` |         | Show history for the given platform. Formatted as `os[/arch[/variant]]` (e.g., `linux/amd64`)                                                                                                                                                                                                                                                                                                                                        |
 | `-q`, `--quiet`           | `bool`   |         | Only show image IDs                                                                                                                                                                                                                                                                                                                                                                                                                  |
 
 
@@ -76,3 +77,54 @@ $ docker history --format "{{.ID}}: {{.CreatedSince}}" busybox
 f6e427c148a7: 4 weeks ago
 <missing>: 4 weeks ago
 ```
+
+### <a name="platform"></a> Show history for a specific platform (--platform)
+
+The `--platform` option allows you to specify which platform variant to show
+history for if multiple platforms are present. By default, `docker history`
+shows the history for the daemon's native platform or if not present, the
+first available platform.
+
+If the local image store has multiple platform variants of an image, the
+`--platform` option selects which variant to show the history for. An error
+is produced if the given platform is not present in the local image cache.
+
+The platform option takes the `os[/arch[/variant]]` format; for example,
+`linux/amd64` or `linux/arm64/v8`. Architecture and variant are optional,
+and if omitted falls back to the daemon's defaults.
+
+
+The following example pulls the RISC-V variant of the `alpine:latest` image
+and shows its history.
+
+
+```console
+$ docker image pull --quiet --platform=linux/riscv64 alpine
+docker.io/library/alpine:latest
+
+$ docker image history --platform=linux/s390x alpine
+IMAGE          CREATED       CREATED BY                                      SIZE      COMMENT
+beefdbd8a1da   3 weeks ago   /bin/sh -c #(nop)  CMD ["/bin/sh"]              0B
+<missing>      3 weeks ago   /bin/sh -c #(nop) ADD file:ba2637314e600db5a…   8.46MB
+```
+
+The following example attempts to show the history for a platform variant of
+`alpine:latest` that doesn't exist in the local image store, resulting in
+an error.
+
+```console
+$ docker image ls --tree
+IMAGE                   ID             DISK USAGE   CONTENT SIZE   IN USE
+alpine:latest           beefdbd8a1da       10.6MB         3.37MB
+├─ linux/riscv64        80cde017a105       10.6MB         3.37MB
+├─ linux/amd64          33735bd63cf8           0B             0B
+├─ linux/arm/v6         50f635c8b04d           0B             0B
+├─ linux/arm/v7         f2f82d424957           0B             0B
+├─ linux/arm64/v8       9cee2b382fe2           0B             0B
+├─ linux/386            b3e87f642f5c           0B             0B
+├─ linux/ppc64le        c7a6800e3dc5           0B             0B
+└─ linux/s390x          2b5b26e09ca2           0B             0B
+
+$ docker image history --platform=linux/s390x alpine
+Error response from daemon: image with reference alpine:latest was found but does not match the specified platform: wanted linux/s390x
+```