builder/dockerfile/dispatchers_test.go
5ece81a7
 package dockerfile
 
 import (
9f738cc5
 	"bytes"
 	"context"
669c0677
 	"runtime"
 	"testing"
19f3b071
 
91e197d6
 	"github.com/docker/docker/api/types"
9f738cc5
 	"github.com/docker/docker/api/types/backend"
91e197d6
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/strslice"
9b4aa762
 	"github.com/docker/docker/builder"
669c0677
 	"github.com/docker/docker/builder/dockerfile/instructions"
ab3a037a
 	"github.com/docker/docker/pkg/system"
9408b205
 	"github.com/docker/go-connections/nat"
0380fbff
 	specs "github.com/opencontainers/image-spec/specs-go/v1"
6052f2b3
 	"github.com/stretchr/testify/assert"
e59327aa
 	"github.com/stretchr/testify/require"
5ece81a7
 )
 
e59327aa
 func newBuilderWithMockBackend() *Builder {
b3bc7b28
 	mockBackend := &MockBackend{}
6c28e8ed
 	ctx := context.Background()
e59327aa
 	b := &Builder{
0380fbff
 		options:       &types.ImageBuildOptions{Platform: specs.Platform{OS: runtime.GOOS}},
b3bc7b28
 		docker:        mockBackend,
9f738cc5
 		Stdout:        new(bytes.Buffer),
6c28e8ed
 		clientCtx:     ctx,
e59327aa
 		disableCommit: true,
6c28e8ed
 		imageSources: newImageSources(ctx, builderOptions{
0380fbff
 			Options: &types.ImageBuildOptions{Platform: specs.Platform{OS: runtime.GOOS}},
6c28e8ed
 			Backend: mockBackend,
 		}),
ba401323
 		imageProber:      newImageProber(mockBackend, nil, runtime.GOOS, false),
19f3b071
 		containerManager: newContainerManager(mockBackend),
e59327aa
 	}
 	return b
 }
 
5ece81a7
 func TestEnv2Variables(t *testing.T) {
c7fad9b7
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '\\', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
 	envCommand := &instructions.EnvCommand{
 		Env: instructions.KeyValuePairs{
 			instructions.KeyValuePair{Key: "var1", Value: "val1"},
 			instructions.KeyValuePair{Key: "var2", Value: "val2"},
 		},
 	}
 	err := dispatch(sb, envCommand)
e59327aa
 	require.NoError(t, err)
5ece81a7
 
c7fad9b7
 	expected := []string{
669c0677
 		"var1=val1",
 		"var2=val2",
5ece81a7
 	}
669c0677
 	assert.Equal(t, expected, sb.state.runConfig.Env)
c7fad9b7
 }
5ece81a7
 
c7fad9b7
 func TestEnvValueWithExistingRunConfigEnv(t *testing.T) {
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '\\', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
 	sb.state.runConfig.Env = []string{"var1=old", "var2=fromenv"}
 	envCommand := &instructions.EnvCommand{
 		Env: instructions.KeyValuePairs{
 			instructions.KeyValuePair{Key: "var1", Value: "val1"},
 		},
 	}
 	err := dispatch(sb, envCommand)
e59327aa
 	require.NoError(t, err)
c7fad9b7
 	expected := []string{
669c0677
 		"var1=val1",
c7fad9b7
 		"var2=fromenv",
5ece81a7
 	}
669c0677
 	assert.Equal(t, expected, sb.state.runConfig.Env)
5ece81a7
 }
 
 func TestMaintainer(t *testing.T) {
 	maintainerEntry := "Some Maintainer <maintainer@example.com>"
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '\\', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
 	cmd := &instructions.MaintainerCommand{Maintainer: maintainerEntry}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
669c0677
 	assert.Equal(t, maintainerEntry, sb.state.maintainer)
5ece81a7
 }
 
 func TestLabel(t *testing.T) {
 	labelName := "label"
 	labelValue := "value"
 
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '\\', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
 	cmd := &instructions.LabelCommand{
 		Labels: instructions.KeyValuePairs{
 			instructions.KeyValuePair{Key: labelName, Value: labelValue},
 		},
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
5ece81a7
 
669c0677
 	require.Contains(t, sb.state.runConfig.Labels, labelName)
 	assert.Equal(t, sb.state.runConfig.Labels[labelName], labelValue)
9b4aa762
 }
 
 func TestFromScratch(t *testing.T) {
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '\\', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
 	cmd := &instructions.Stage{
 		BaseName: "scratch",
 	}
 	err := initializeStage(sb, cmd)
5ece81a7
 
08252bc9
 	if runtime.GOOS == "windows" && !system.LCOWSupported() {
6052f2b3
 		assert.EqualError(t, err, "Windows does not support FROM scratch")
9b4aa762
 		return
 	}
5ece81a7
 
e59327aa
 	require.NoError(t, err)
669c0677
 	assert.True(t, sb.state.hasFromImage())
 	assert.Equal(t, "", sb.state.imageID)
f1545882
 	expected := "PATH=" + system.DefaultPathEnv(runtime.GOOS)
669c0677
 	assert.Equal(t, []string{expected}, sb.state.runConfig.Env)
9b4aa762
 }
5ece81a7
 
9b4aa762
 func TestFromWithArg(t *testing.T) {
 	tag, expected := ":sometag", "expectedthisid"
5ece81a7
 
b3bc7b28
 	getImage := func(name string) (builder.Image, builder.ReleaseableLayer, error) {
6052f2b3
 		assert.Equal(t, "alpine"+tag, name)
b3bc7b28
 		return &mockImage{id: "expectedthisid"}, nil, nil
9b4aa762
 	}
 	b := newBuilderWithMockBackend()
b3bc7b28
 	b.docker.(*MockBackend).getImageFunc = getImage
669c0677
 	args := newBuildArgs(make(map[string]*string))
5ece81a7
 
669c0677
 	val := "sometag"
 	metaArg := instructions.ArgCommand{
 		Key:   "THETAG",
 		Value: &val,
 	}
 	cmd := &instructions.Stage{
 		BaseName: "alpine:${THETAG}",
 	}
 	err := processMetaArg(metaArg, NewShellLex('\\'), args)
9b4aa762
 
669c0677
 	sb := newDispatchRequest(b, '\\', nil, args, newStagesBuildResults())
e59327aa
 	require.NoError(t, err)
669c0677
 	err = initializeStage(sb, cmd)
 	require.NoError(t, err)
 
 	assert.Equal(t, expected, sb.state.imageID)
 	assert.Equal(t, expected, sb.state.baseImage.ImageID())
 	assert.Len(t, sb.state.buildArgs.GetAllAllowed(), 0)
 	assert.Len(t, sb.state.buildArgs.GetAllMeta(), 1)
9b4aa762
 }
 
 func TestFromWithUndefinedArg(t *testing.T) {
 	tag, expected := "sometag", "expectedthisid"
 
b3bc7b28
 	getImage := func(name string) (builder.Image, builder.ReleaseableLayer, error) {
6052f2b3
 		assert.Equal(t, "alpine", name)
b3bc7b28
 		return &mockImage{id: "expectedthisid"}, nil, nil
5ece81a7
 	}
9b4aa762
 	b := newBuilderWithMockBackend()
b3bc7b28
 	b.docker.(*MockBackend).getImageFunc = getImage
669c0677
 	sb := newDispatchRequest(b, '\\', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
 
9b4aa762
 	b.options.BuildArgs = map[string]*string{"THETAG": &tag}
 
669c0677
 	cmd := &instructions.Stage{
 		BaseName: "alpine${THETAG}",
 	}
 	err := initializeStage(sb, cmd)
e59327aa
 	require.NoError(t, err)
669c0677
 	assert.Equal(t, expected, sb.state.imageID)
5ece81a7
 }
 
669c0677
 func TestFromMultiStageWithNamedStage(t *testing.T) {
28379bd2
 	b := newBuilderWithMockBackend()
669c0677
 	firstFrom := &instructions.Stage{BaseName: "someimg", Name: "base"}
 	secondFrom := &instructions.Stage{BaseName: "base"}
 	previousResults := newStagesBuildResults()
 	firstSB := newDispatchRequest(b, '\\', nil, newBuildArgs(make(map[string]*string)), previousResults)
 	secondSB := newDispatchRequest(b, '\\', nil, newBuildArgs(make(map[string]*string)), previousResults)
 	err := initializeStage(firstSB, firstFrom)
 	require.NoError(t, err)
 	assert.True(t, firstSB.state.hasFromImage())
 	previousResults.indexed["base"] = firstSB.state.runConfig
 	previousResults.flat = append(previousResults.flat, firstSB.state.runConfig)
 	err = initializeStage(secondSB, secondFrom)
 	require.NoError(t, err)
 	assert.True(t, secondSB.state.hasFromImage())
5ece81a7
 }
 
 func TestOnbuild(t *testing.T) {
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '\\', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
 	cmd := &instructions.OnbuildCommand{
 		Expression: "ADD . /app/src",
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
669c0677
 	assert.Equal(t, "ADD . /app/src", sb.state.runConfig.OnBuild[0])
5ece81a7
 }
9408b205
 
 func TestWorkdir(t *testing.T) {
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
9408b205
 	workingDir := "/app"
 	if runtime.GOOS == "windows" {
669c0677
 		workingDir = "C:\\app"
 	}
 	cmd := &instructions.WorkdirCommand{
 		Path: workingDir,
9408b205
 	}
 
669c0677
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
669c0677
 	assert.Equal(t, workingDir, sb.state.runConfig.WorkingDir)
9408b205
 }
 
 func TestCmd(t *testing.T) {
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
9408b205
 	command := "./executable"
 
669c0677
 	cmd := &instructions.CmdCommand{
 		ShellDependantCmdLine: instructions.ShellDependantCmdLine{
 			CmdLine:      strslice.StrSlice{command},
 			PrependShell: true,
 		},
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
9408b205
 
 	var expectedCommand strslice.StrSlice
 	if runtime.GOOS == "windows" {
 		expectedCommand = strslice.StrSlice(append([]string{"cmd"}, "/S", "/C", command))
 	} else {
 		expectedCommand = strslice.StrSlice(append([]string{"/bin/sh"}, "-c", command))
 	}
 
669c0677
 	assert.Equal(t, expectedCommand, sb.state.runConfig.Cmd)
 	assert.True(t, sb.state.cmdSet)
9408b205
 }
 
 func TestHealthcheckNone(t *testing.T) {
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
 	cmd := &instructions.HealthCheckCommand{
 		Health: &container.HealthConfig{
 			Test: []string{"NONE"},
 		},
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
9408b205
 
669c0677
 	require.NotNil(t, sb.state.runConfig.Healthcheck)
 	assert.Equal(t, []string{"NONE"}, sb.state.runConfig.Healthcheck.Test)
9408b205
 }
 
 func TestHealthcheckCmd(t *testing.T) {
 
669c0677
 	b := newBuilderWithMockBackend()
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
 	expectedTest := []string{"CMD-SHELL", "curl -f http://localhost/ || exit 1"}
 	cmd := &instructions.HealthCheckCommand{
 		Health: &container.HealthConfig{
 			Test: expectedTest,
 		},
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
9408b205
 
669c0677
 	require.NotNil(t, sb.state.runConfig.Healthcheck)
 	assert.Equal(t, expectedTest, sb.state.runConfig.Healthcheck.Test)
9408b205
 }
 
 func TestEntrypoint(t *testing.T) {
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
9408b205
 	entrypointCmd := "/usr/sbin/nginx"
 
669c0677
 	cmd := &instructions.EntrypointCommand{
 		ShellDependantCmdLine: instructions.ShellDependantCmdLine{
 			CmdLine:      strslice.StrSlice{entrypointCmd},
 			PrependShell: true,
 		},
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
669c0677
 	require.NotNil(t, sb.state.runConfig.Entrypoint)
9408b205
 
 	var expectedEntrypoint strslice.StrSlice
 	if runtime.GOOS == "windows" {
 		expectedEntrypoint = strslice.StrSlice(append([]string{"cmd"}, "/S", "/C", entrypointCmd))
 	} else {
 		expectedEntrypoint = strslice.StrSlice(append([]string{"/bin/sh"}, "-c", entrypointCmd))
 	}
669c0677
 	assert.Equal(t, expectedEntrypoint, sb.state.runConfig.Entrypoint)
9408b205
 }
 
 func TestExpose(t *testing.T) {
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
9408b205
 
 	exposedPort := "80"
669c0677
 	cmd := &instructions.ExposeCommand{
 		Ports: []string{exposedPort},
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
9408b205
 
669c0677
 	require.NotNil(t, sb.state.runConfig.ExposedPorts)
 	require.Len(t, sb.state.runConfig.ExposedPorts, 1)
9408b205
 
 	portsMapping, err := nat.ParsePortSpec(exposedPort)
e59327aa
 	require.NoError(t, err)
669c0677
 	assert.Contains(t, sb.state.runConfig.ExposedPorts, portsMapping[0].Port)
9408b205
 }
 
 func TestUser(t *testing.T) {
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
9408b205
 
669c0677
 	cmd := &instructions.UserCommand{
 		User: "test",
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
669c0677
 	assert.Equal(t, "test", sb.state.runConfig.User)
9408b205
 }
 
 func TestVolume(t *testing.T) {
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
9408b205
 
 	exposedVolume := "/foo"
 
669c0677
 	cmd := &instructions.VolumeCommand{
 		Volumes: []string{exposedVolume},
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
669c0677
 	require.NotNil(t, sb.state.runConfig.Volumes)
 	assert.Len(t, sb.state.runConfig.Volumes, 1)
 	assert.Contains(t, sb.state.runConfig.Volumes, exposedVolume)
9408b205
 }
 
 func TestStopSignal(t *testing.T) {
669c0677
 	if runtime.GOOS == "windows" {
 		t.Skip("Windows does not support stopsignal")
 		return
 	}
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
9408b205
 	signal := "SIGKILL"
 
669c0677
 	cmd := &instructions.StopSignalCommand{
 		Signal: signal,
 	}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
669c0677
 	assert.Equal(t, signal, sb.state.runConfig.StopSignal)
9408b205
 }
 
 func TestArg(t *testing.T) {
239c53bf
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
9408b205
 
 	argName := "foo"
 	argVal := "bar"
669c0677
 	cmd := &instructions.ArgCommand{Key: argName, Value: &argVal}
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
9408b205
 
239c53bf
 	expected := map[string]string{argName: argVal}
669c0677
 	assert.Equal(t, expected, sb.state.buildArgs.GetAllAllowed())
9408b205
 }
 
 func TestShell(t *testing.T) {
e59327aa
 	b := newBuilderWithMockBackend()
669c0677
 	sb := newDispatchRequest(b, '`', nil, newBuildArgs(make(map[string]*string)), newStagesBuildResults())
9408b205
 
 	shellCmd := "powershell"
669c0677
 	cmd := &instructions.ShellCommand{Shell: strslice.StrSlice{shellCmd}}
9408b205
 
669c0677
 	err := dispatch(sb, cmd)
e59327aa
 	require.NoError(t, err)
9408b205
 
 	expectedShell := strslice.StrSlice([]string{shellCmd})
669c0677
 	assert.Equal(t, expectedShell, sb.state.runConfig.Shell)
9f738cc5
 }
 
 func TestPrependEnvOnCmd(t *testing.T) {
 	buildArgs := newBuildArgs(nil)
 	buildArgs.AddArg("NO_PROXY", nil)
 
 	args := []string{"sorted=nope", "args=not", "http_proxy=foo", "NO_PROXY=YA"}
 	cmd := []string{"foo", "bar"}
 	cmdWithEnv := prependEnvOnCmd(buildArgs, args, cmd)
 	expected := strslice.StrSlice([]string{
 		"|3", "NO_PROXY=YA", "args=not", "sorted=nope", "foo", "bar"})
 	assert.Equal(t, expected, cmdWithEnv)
 }
 
 func TestRunWithBuildArgs(t *testing.T) {
 	b := newBuilderWithMockBackend()
669c0677
 	args := newBuildArgs(make(map[string]*string))
 	args.argsFromOptions["HTTP_PROXY"] = strPtr("FOO")
9f738cc5
 	b.disableCommit = false
669c0677
 	sb := newDispatchRequest(b, '`', nil, args, newStagesBuildResults())
9f738cc5
 
2f0ebba0
 	runConfig := &container.Config{}
9f738cc5
 	origCmd := strslice.StrSlice([]string{"cmd", "in", "from", "image"})
fe7b4d8f
 	cmdWithShell := strslice.StrSlice(append(getShell(runConfig, runtime.GOOS), "echo foo"))
9f738cc5
 	envVars := []string{"|1", "one=two"}
 	cachedCmd := strslice.StrSlice(append(envVars, cmdWithShell...))
 
 	imageCache := &mockImageCache{
 		getCacheFunc: func(parentID string, cfg *container.Config) (string, error) {
 			// Check the runConfig.Cmd sent to probeCache()
 			assert.Equal(t, cachedCmd, cfg.Cmd)
97f86071
 			assert.Equal(t, strslice.StrSlice(nil), cfg.Entrypoint)
9f738cc5
 			return "", nil
 		},
d8b6a35d
 	}
9f738cc5
 
 	mockBackend := b.docker.(*MockBackend)
ba401323
 	mockBackend.makeImageCacheFunc = func(_ []string, _ string) builder.ImageCache {
19f3b071
 		return imageCache
 	}
ba401323
 	b.imageProber = newImageProber(mockBackend, nil, runtime.GOOS, false)
b3bc7b28
 	mockBackend.getImageFunc = func(_ string) (builder.Image, builder.ReleaseableLayer, error) {
 		return &mockImage{
 			id:     "abcdef",
 			config: &container.Config{Cmd: origCmd},
 		}, nil, nil
9f738cc5
 	}
 	mockBackend.containerCreateFunc = func(config types.ContainerCreateConfig) (container.ContainerCreateCreatedBody, error) {
 		// Check the runConfig.Cmd sent to create()
 		assert.Equal(t, cmdWithShell, config.Config.Cmd)
 		assert.Contains(t, config.Config.Env, "one=two")
97f86071
 		assert.Equal(t, strslice.StrSlice{""}, config.Config.Entrypoint)
9f738cc5
 		return container.ContainerCreateCreatedBody{ID: "12345"}, nil
 	}
 	mockBackend.commitFunc = func(cID string, cfg *backend.ContainerCommitConfig) (string, error) {
 		// Check the runConfig.Cmd sent to commit()
 		assert.Equal(t, origCmd, cfg.Config.Cmd)
 		assert.Equal(t, cachedCmd, cfg.ContainerConfig.Cmd)
97f86071
 		assert.Equal(t, strslice.StrSlice(nil), cfg.Config.Entrypoint)
9f738cc5
 		return "", nil
 	}
669c0677
 	from := &instructions.Stage{BaseName: "abcdef"}
 	err := initializeStage(sb, from)
 	require.NoError(t, err)
 	sb.state.buildArgs.AddArg("one", strPtr("two"))
 	run := &instructions.RunCommand{
 		ShellDependantCmdLine: instructions.ShellDependantCmdLine{
 			CmdLine:      strslice.StrSlice{"echo foo"},
 			PrependShell: true,
 		},
 	}
 	require.NoError(t, dispatch(sb, run))
9f738cc5
 
 	// Check that runConfig.Cmd has not been modified by run
669c0677
 	assert.Equal(t, origCmd, sb.state.runConfig.Cmd)
d8b6a35d
 }