The JSON field was added in [moby@9fd2c0f], to address [moby#19177], which reported an incompatibility with Classic (V1) Swarm, which produced a non- standard response; > Make docker load to output json when the response content type is json > Swarm hijacks the response from docker load and returns JSON rather > than plain text like the Engine does. This makes the API library to return > information to figure that out. A later change in [moby@96d7db6] added additional logic to make sure the correct content-type was returned, depending on whether the `quiet` option was set (which produced a non-JSON response). This caused inconsistency in the API response, and [moby@2f27632] changed the endpoint to always produce JSON (only skipping the "progress" output if `quiet` was set). This means that the "load" endpoint ([`imageRouter.postImagesLoad`]) now unconditionally returns JSON, making the `JSON` field fully redundant. This patch removes the use of the JSON field, as it's redundant, and the way it handles the content-type is incorrect because it would not handle correct, but different formatted response-headers (`application/json; charset=utf-8`), which could result in malformed output on the client. [moby@9fd2c0f]:9fd2c0feb0[moby#19177]: https://github.com/moby/moby/issues/19177 [moby@96d7db6]:96d7db665b[moby@2f27632]:2f27632cde[`imageRouter.postImagesLoad`]:7b9d2ef6e5/api/server/router/image/image_routes.go (L248-L255)Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
159 lines
5.8 KiB
Go
159 lines
5.8 KiB
Go
package image
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
"unsafe"
|
|
|
|
"github.com/docker/cli/internal/test"
|
|
"github.com/moby/moby/client"
|
|
"gotest.tools/v3/assert"
|
|
"gotest.tools/v3/golden"
|
|
)
|
|
|
|
func TestNewLoadCommandErrors(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
isTerminalIn bool
|
|
expectedError string
|
|
imageLoadFunc func(input io.Reader, options ...client.ImageLoadOption) (client.ImageLoadResult, error)
|
|
}{
|
|
{
|
|
name: "wrong-args",
|
|
args: []string{"arg"},
|
|
expectedError: "accepts no arguments",
|
|
},
|
|
{
|
|
name: "input-to-terminal",
|
|
args: []string{},
|
|
isTerminalIn: true,
|
|
expectedError: "requested load from stdin, but stdin is empty",
|
|
},
|
|
{
|
|
name: "pull-error",
|
|
args: []string{},
|
|
expectedError: "something went wrong",
|
|
imageLoadFunc: func(input io.Reader, options ...client.ImageLoadOption) (client.ImageLoadResult, error) {
|
|
return client.ImageLoadResult{}, errors.New("something went wrong")
|
|
},
|
|
},
|
|
{
|
|
name: "invalid platform",
|
|
args: []string{"--platform", "<invalid>"},
|
|
expectedError: `invalid platform`,
|
|
imageLoadFunc: func(input io.Reader, options ...client.ImageLoadOption) (client.ImageLoadResult, error) {
|
|
return client.ImageLoadResult{}, nil
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{imageLoadFunc: tc.imageLoadFunc})
|
|
cli.In().SetIsTerminal(tc.isTerminalIn)
|
|
cmd := newLoadCommand(cli)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
cmd.SetArgs(tc.args)
|
|
assert.ErrorContains(t, cmd.Execute(), tc.expectedError)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestNewLoadCommandInvalidInput(t *testing.T) {
|
|
expectedError := "open *"
|
|
cmd := newLoadCommand(test.NewFakeCli(&fakeClient{}))
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
cmd.SetArgs([]string{"--input", "*"})
|
|
err := cmd.Execute()
|
|
assert.ErrorContains(t, err, expectedError)
|
|
}
|
|
|
|
func mockImageLoadResult(content string) client.ImageLoadResult {
|
|
out := client.ImageLoadResult{}
|
|
|
|
// Set unexported field "body"
|
|
v := reflect.ValueOf(&out).Elem()
|
|
f := v.FieldByName("body")
|
|
r := io.NopCloser(strings.NewReader(content))
|
|
reflect.NewAt(f.Type(), unsafe.Pointer(f.UnsafeAddr())).Elem().Set(reflect.ValueOf(r))
|
|
return out
|
|
}
|
|
|
|
func TestNewLoadCommandSuccess(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
args []string
|
|
imageLoadFunc func(input io.Reader, options ...client.ImageLoadOption) (client.ImageLoadResult, error)
|
|
}{
|
|
{
|
|
name: "simple",
|
|
args: []string{},
|
|
imageLoadFunc: func(input io.Reader, options ...client.ImageLoadOption) (client.ImageLoadResult, error) {
|
|
// FIXME(thaJeztah): how to mock this?
|
|
// return client.ImageLoadResult{
|
|
// Body: io.NopCloser(strings.NewReader(`{"ID":"simple","Status":"success"}`)),
|
|
// }, nil
|
|
return mockImageLoadResult(`{"ID":"simple","Status":"success"}`), nil
|
|
},
|
|
},
|
|
{
|
|
name: "input-file",
|
|
args: []string{"--input", "testdata/load-command-success.input.txt"},
|
|
imageLoadFunc: func(input io.Reader, options ...client.ImageLoadOption) (client.ImageLoadResult, error) {
|
|
// FIXME(thaJeztah): how to mock this?
|
|
// return client.ImageLoadResult{Body: io.NopCloser(strings.NewReader(`{"ID":"input-file","Status":"success"}`))}, nil
|
|
return mockImageLoadResult(`{"ID":"input-file","Status":"success"}`), nil
|
|
},
|
|
},
|
|
{
|
|
name: "with-single-platform",
|
|
args: []string{"--platform", "linux/amd64"},
|
|
imageLoadFunc: func(input io.Reader, options ...client.ImageLoadOption) (client.ImageLoadResult, error) {
|
|
// FIXME(thaJeztah): need to find appropriate way to test the result of "ImageHistoryWithPlatform" being applied
|
|
assert.Check(t, len(options) > 0) // can be 1 or two depending on whether a terminal is attached :/
|
|
// assert.Check(t, is.Contains(options, client.ImageHistoryWithPlatform(ocispec.Platform{OS: "linux", Architecture: "amd64"})))
|
|
// FIXME(thaJeztah): how to mock this?
|
|
// return client.ImageLoadResult{Body: io.NopCloser(strings.NewReader(`{"ID":"single-platform","Status":"success"}`))}, nil
|
|
return mockImageLoadResult(`{"ID":"single-platform","Status":"success"}`), nil
|
|
},
|
|
},
|
|
{
|
|
name: "with-comma-separated-platforms",
|
|
args: []string{"--platform", "linux/amd64,linux/arm64/v8,linux/riscv64"},
|
|
imageLoadFunc: func(input io.Reader, options ...client.ImageLoadOption) (client.ImageLoadResult, error) {
|
|
assert.Check(t, len(options) > 0) // can be 1 or two depending on whether a terminal is attached :/
|
|
// FIXME(thaJeztah): how to mock this?
|
|
// return client.ImageLoadResult{Body: io.NopCloser(strings.NewReader(`{"ID":"with-comma-separated-platforms","Status":"success"}`))}, nil
|
|
return mockImageLoadResult(`{"ID":"with-comma-separated-platforms","Status":"success"}`), nil
|
|
},
|
|
},
|
|
{
|
|
name: "with-multiple-platform-options",
|
|
args: []string{"--platform", "linux/amd64", "--platform", "linux/arm64/v8", "--platform", "linux/riscv64"},
|
|
imageLoadFunc: func(input io.Reader, options ...client.ImageLoadOption) (client.ImageLoadResult, error) {
|
|
assert.Check(t, len(options) > 0) // can be 1 or two depending on whether a terminal is attached :/
|
|
// FIXME(thaJeztah): how to mock this?
|
|
// return client.ImageLoadResult{Body: io.NopCloser(strings.NewReader(`{"ID":"with-multiple-platform-options","Status":"success"}`))}, nil
|
|
return mockImageLoadResult(`{"ID":"with-multiple-platform-options","Status":"success"}`), nil
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cli := test.NewFakeCli(&fakeClient{imageLoadFunc: tc.imageLoadFunc})
|
|
cmd := newLoadCommand(cli)
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetArgs(tc.args)
|
|
err := cmd.Execute()
|
|
assert.NilError(t, err)
|
|
golden.Assert(t, cli.OutBuffer().String(), fmt.Sprintf("load-command-success.%s.golden", tc.name))
|
|
})
|
|
}
|
|
}
|