2022-02-03 04:37:55 -05:00
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"os"
|
|
|
|
"testing"
|
|
|
|
|
|
|
|
"github.com/docker/cli/cli/command"
|
2022-11-03 17:30:27 -04:00
|
|
|
"github.com/docker/cli/cli/flags"
|
2022-02-03 13:11:05 -05:00
|
|
|
"github.com/docker/cli/internal/test/output"
|
2022-02-03 04:37:55 -05:00
|
|
|
"gotest.tools/v3/assert"
|
|
|
|
"gotest.tools/v3/fs"
|
|
|
|
)
|
|
|
|
|
2022-02-03 13:11:05 -05:00
|
|
|
var pluginFilename = "docker-buildx"
|
|
|
|
|
2022-11-03 17:30:27 -04:00
|
|
|
func TestBuildWithBuildx(t *testing.T) {
|
|
|
|
dir := fs.NewDir(t, t.Name(),
|
|
|
|
fs.WithFile(pluginFilename, `#!/bin/sh
|
|
|
|
echo '{"SchemaVersion":"0.1.0","Vendor":"Docker Inc.","Version":"v0.6.3","ShortDescription":"Build with BuildKit"}'`, fs.WithMode(0777)),
|
|
|
|
)
|
|
|
|
defer dir.Remove()
|
|
|
|
|
|
|
|
var b bytes.Buffer
|
|
|
|
|
|
|
|
t.Setenv("DOCKER_CONTEXT", "default")
|
|
|
|
dockerCli, err := command.NewDockerCli(command.WithInputStream(discard), command.WithCombinedStreams(&b))
|
|
|
|
assert.NilError(t, err)
|
|
|
|
assert.NilError(t, dockerCli.Initialize(flags.NewClientOptions()))
|
|
|
|
dockerCli.ConfigFile().CLIPluginsExtraDirs = []string{dir.Path()}
|
|
|
|
|
|
|
|
tcmd := newDockerCommand(dockerCli)
|
|
|
|
tcmd.SetArgs([]string{"build", "."})
|
|
|
|
|
|
|
|
cmd, args, err := tcmd.HandleGlobalFlags()
|
|
|
|
assert.NilError(t, err)
|
|
|
|
|
|
|
|
var envs []string
|
|
|
|
args, os.Args, envs, err = processBuilder(dockerCli, cmd, args, os.Args)
|
|
|
|
assert.NilError(t, err)
|
|
|
|
assert.DeepEqual(t, []string{builderDefaultPlugin, "build", "."}, args)
|
|
|
|
assert.DeepEqual(t, []string{"BUILDX_BUILDER=default"}, envs)
|
2022-02-03 13:11:05 -05:00
|
|
|
}
|
|
|
|
|
2022-11-03 17:30:27 -04:00
|
|
|
func TestBuildWithBuildxAndBuilder(t *testing.T) {
|
|
|
|
t.Setenv("BUILDX_BUILDER", "mybuilder")
|
|
|
|
|
2022-02-03 04:37:55 -05:00
|
|
|
dir := fs.NewDir(t, t.Name(),
|
2022-02-03 13:11:05 -05:00
|
|
|
fs.WithFile(pluginFilename, `#!/bin/sh
|
2022-02-03 04:37:55 -05:00
|
|
|
echo '{"SchemaVersion":"0.1.0","Vendor":"Docker Inc.","Version":"v0.6.3","ShortDescription":"Build with BuildKit"}'`, fs.WithMode(0777)),
|
|
|
|
)
|
|
|
|
defer dir.Remove()
|
|
|
|
|
|
|
|
var b bytes.Buffer
|
2022-11-03 17:30:27 -04:00
|
|
|
|
|
|
|
t.Setenv("DOCKER_CONTEXT", "default")
|
2022-02-03 04:37:55 -05:00
|
|
|
dockerCli, err := command.NewDockerCli(command.WithInputStream(discard), command.WithCombinedStreams(&b))
|
|
|
|
assert.NilError(t, err)
|
2022-11-03 17:30:27 -04:00
|
|
|
assert.NilError(t, dockerCli.Initialize(flags.NewClientOptions()))
|
2022-02-03 04:37:55 -05:00
|
|
|
dockerCli.ConfigFile().CLIPluginsExtraDirs = []string{dir.Path()}
|
|
|
|
|
|
|
|
tcmd := newDockerCommand(dockerCli)
|
|
|
|
tcmd.SetArgs([]string{"build", "."})
|
|
|
|
|
|
|
|
cmd, args, err := tcmd.HandleGlobalFlags()
|
|
|
|
assert.NilError(t, err)
|
|
|
|
|
2022-11-03 17:30:27 -04:00
|
|
|
var envs []string
|
|
|
|
args, os.Args, envs, err = processBuilder(dockerCli, cmd, args, os.Args)
|
2022-02-03 04:37:55 -05:00
|
|
|
assert.NilError(t, err)
|
|
|
|
assert.DeepEqual(t, []string{builderDefaultPlugin, "build", "."}, args)
|
2022-11-03 17:30:27 -04:00
|
|
|
assert.Check(t, len(envs) == 0)
|
2022-02-03 04:37:55 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestBuildkitDisabled(t *testing.T) {
|
2022-09-22 10:31:28 -04:00
|
|
|
t.Setenv("DOCKER_BUILDKIT", "0")
|
2022-02-03 04:37:55 -05:00
|
|
|
|
2022-02-03 13:11:05 -05:00
|
|
|
dir := fs.NewDir(t, t.Name(),
|
|
|
|
fs.WithFile(pluginFilename, `#!/bin/sh exit 1`, fs.WithMode(0777)),
|
|
|
|
)
|
|
|
|
defer dir.Remove()
|
|
|
|
|
|
|
|
b := bytes.NewBuffer(nil)
|
|
|
|
|
|
|
|
dockerCli, err := command.NewDockerCli(command.WithInputStream(discard), command.WithCombinedStreams(b))
|
|
|
|
assert.NilError(t, err)
|
2022-11-03 17:30:27 -04:00
|
|
|
assert.NilError(t, dockerCli.Initialize(flags.NewClientOptions()))
|
2022-02-03 13:11:05 -05:00
|
|
|
dockerCli.ConfigFile().CLIPluginsExtraDirs = []string{dir.Path()}
|
|
|
|
|
|
|
|
tcmd := newDockerCommand(dockerCli)
|
|
|
|
tcmd.SetArgs([]string{"build", "."})
|
|
|
|
|
|
|
|
cmd, args, err := tcmd.HandleGlobalFlags()
|
|
|
|
assert.NilError(t, err)
|
|
|
|
|
2022-11-03 17:30:27 -04:00
|
|
|
var envs []string
|
|
|
|
args, os.Args, envs, err = processBuilder(dockerCli, cmd, args, os.Args)
|
2022-02-03 13:11:05 -05:00
|
|
|
assert.NilError(t, err)
|
|
|
|
assert.DeepEqual(t, []string{"build", "."}, args)
|
2022-11-03 17:30:27 -04:00
|
|
|
assert.Check(t, len(envs) == 0)
|
2022-02-03 13:11:05 -05:00
|
|
|
|
|
|
|
output.Assert(t, b.String(), map[int]func(string) error{
|
|
|
|
0: output.Suffix("DEPRECATED: The legacy builder is deprecated and will be removed in a future release."),
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestBuilderBroken(t *testing.T) {
|
|
|
|
dir := fs.NewDir(t, t.Name(),
|
|
|
|
fs.WithFile(pluginFilename, `#!/bin/sh exit 1`, fs.WithMode(0777)),
|
|
|
|
)
|
|
|
|
defer dir.Remove()
|
|
|
|
|
|
|
|
b := bytes.NewBuffer(nil)
|
|
|
|
|
|
|
|
dockerCli, err := command.NewDockerCli(command.WithInputStream(discard), command.WithCombinedStreams(b))
|
2022-02-03 04:37:55 -05:00
|
|
|
assert.NilError(t, err)
|
2022-11-03 17:30:27 -04:00
|
|
|
assert.NilError(t, dockerCli.Initialize(flags.NewClientOptions()))
|
2022-02-03 13:11:05 -05:00
|
|
|
dockerCli.ConfigFile().CLIPluginsExtraDirs = []string{dir.Path()}
|
2022-02-03 04:37:55 -05:00
|
|
|
|
|
|
|
tcmd := newDockerCommand(dockerCli)
|
|
|
|
tcmd.SetArgs([]string{"build", "."})
|
|
|
|
|
|
|
|
cmd, args, err := tcmd.HandleGlobalFlags()
|
|
|
|
assert.NilError(t, err)
|
|
|
|
|
2022-11-03 17:30:27 -04:00
|
|
|
var envs []string
|
|
|
|
args, os.Args, envs, err = processBuilder(dockerCli, cmd, args, os.Args)
|
2022-02-03 04:37:55 -05:00
|
|
|
assert.NilError(t, err)
|
|
|
|
assert.DeepEqual(t, []string{"build", "."}, args)
|
2022-11-03 17:30:27 -04:00
|
|
|
assert.Check(t, len(envs) == 0)
|
2022-02-03 13:11:05 -05:00
|
|
|
|
|
|
|
output.Assert(t, b.String(), map[int]func(string) error{
|
|
|
|
0: output.Prefix("failed to fetch metadata:"),
|
|
|
|
2: output.Suffix("DEPRECATED: The legacy builder is deprecated and will be removed in a future release."),
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestBuilderBrokenEnforced(t *testing.T) {
|
2022-09-22 10:31:28 -04:00
|
|
|
t.Setenv("DOCKER_BUILDKIT", "1")
|
2022-02-03 13:11:05 -05:00
|
|
|
|
|
|
|
dir := fs.NewDir(t, t.Name(),
|
|
|
|
fs.WithFile(pluginFilename, `#!/bin/sh exit 1`, fs.WithMode(0777)),
|
|
|
|
)
|
|
|
|
defer dir.Remove()
|
|
|
|
|
|
|
|
b := bytes.NewBuffer(nil)
|
|
|
|
|
|
|
|
dockerCli, err := command.NewDockerCli(command.WithInputStream(discard), command.WithCombinedStreams(b))
|
|
|
|
assert.NilError(t, err)
|
2022-11-03 17:30:27 -04:00
|
|
|
assert.NilError(t, dockerCli.Initialize(flags.NewClientOptions()))
|
2022-02-03 13:11:05 -05:00
|
|
|
dockerCli.ConfigFile().CLIPluginsExtraDirs = []string{dir.Path()}
|
|
|
|
|
|
|
|
tcmd := newDockerCommand(dockerCli)
|
|
|
|
tcmd.SetArgs([]string{"build", "."})
|
|
|
|
|
|
|
|
cmd, args, err := tcmd.HandleGlobalFlags()
|
|
|
|
assert.NilError(t, err)
|
|
|
|
|
2022-11-03 17:30:27 -04:00
|
|
|
var envs []string
|
|
|
|
args, os.Args, envs, err = processBuilder(dockerCli, cmd, args, os.Args)
|
2022-02-03 13:11:05 -05:00
|
|
|
assert.DeepEqual(t, []string{"build", "."}, args)
|
2022-11-03 17:30:27 -04:00
|
|
|
assert.Check(t, len(envs) == 0)
|
2022-02-03 13:11:05 -05:00
|
|
|
|
|
|
|
output.Assert(t, err.Error(), map[int]func(string) error{
|
|
|
|
0: output.Prefix("failed to fetch metadata:"),
|
|
|
|
2: output.Suffix("ERROR: BuildKit is enabled but the buildx component is missing or broken."),
|
|
|
|
})
|
2022-02-03 04:37:55 -05:00
|
|
|
}
|
2022-11-03 17:30:27 -04:00
|
|
|
|
|
|
|
func TestHasBuilderName(t *testing.T) {
|
|
|
|
cases := []struct {
|
|
|
|
name string
|
|
|
|
args []string
|
|
|
|
envs []string
|
|
|
|
expected bool
|
|
|
|
}{
|
|
|
|
{
|
|
|
|
name: "no args",
|
|
|
|
args: []string{"docker", "build", "."},
|
|
|
|
envs: []string{"FOO=bar"},
|
|
|
|
expected: false,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "env var",
|
|
|
|
args: []string{"docker", "build", "."},
|
|
|
|
envs: []string{"BUILDX_BUILDER=foo"},
|
|
|
|
expected: true,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "empty env var",
|
|
|
|
args: []string{"docker", "build", "."},
|
|
|
|
envs: []string{"BUILDX_BUILDER="},
|
|
|
|
expected: false,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "flag",
|
|
|
|
args: []string{"docker", "build", "--builder", "foo", "."},
|
|
|
|
envs: []string{"FOO=bar"},
|
|
|
|
expected: true,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "both",
|
|
|
|
args: []string{"docker", "build", "--builder", "foo", "."},
|
|
|
|
envs: []string{"BUILDX_BUILDER=foo"},
|
|
|
|
expected: true,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
for _, tt := range cases {
|
|
|
|
tt := tt
|
|
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
|
|
assert.Equal(t, tt.expected, hasBuilderName(tt.args, tt.envs))
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|