From 0787a93372f5c44880182ac68f9e8f81ba339473 Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 26 Mar 2018 11:11:31 -0700 Subject: [PATCH 1/4] Workdir command and unit tests --- .../dockerfiles/Dockerfile_test_workdir | 10 +++ .../dockerfiles/config_test_workdir.json | 12 +++ integration_tests/integration_test_yaml.go | 71 +++++++++-------- pkg/commands/commands.go | 2 + pkg/commands/run.go | 1 + pkg/commands/workdir.go | 64 +++++++++++++++ pkg/commands/workdir_test.go | 79 +++++++++++++++++++ 7 files changed, 207 insertions(+), 32 deletions(-) create mode 100644 integration_tests/dockerfiles/Dockerfile_test_workdir create mode 100644 integration_tests/dockerfiles/config_test_workdir.json create mode 100644 pkg/commands/workdir.go create mode 100644 pkg/commands/workdir_test.go diff --git a/integration_tests/dockerfiles/Dockerfile_test_workdir b/integration_tests/dockerfiles/Dockerfile_test_workdir new file mode 100644 index 000000000..4fa6b6143 --- /dev/null +++ b/integration_tests/dockerfiles/Dockerfile_test_workdir @@ -0,0 +1,10 @@ +FROM gcr.io/google-appengine/debian9:latest +COPY context/foo foo +WORKDIR /test +WORKDIR workdir +COPY context/foo . +RUN cp foo newfoo +WORKDIR /new/dir +ENV dir /another/new/dir +WORKDIR $dir/newdir +WORKDIR / diff --git a/integration_tests/dockerfiles/config_test_workdir.json b/integration_tests/dockerfiles/config_test_workdir.json new file mode 100644 index 000000000..c87503403 --- /dev/null +++ b/integration_tests/dockerfiles/config_test_workdir.json @@ -0,0 +1,12 @@ +[ + { + "Image1": "gcr.io/kbuild-test/docker-test-workdir:latest", + "Image2": "gcr.io/kbuild-test/kbuild-test-workdir:latest", + "DiffType": "File", + "Diff": { + "Adds": null, + "Dels": null, + "Mods": null + } + } +] \ No newline at end of file diff --git a/integration_tests/integration_test_yaml.go b/integration_tests/integration_test_yaml.go index e81d4269d..1a91eb54d 100644 --- a/integration_tests/integration_test_yaml.go +++ b/integration_tests/integration_test_yaml.go @@ -29,33 +29,40 @@ var fileTests = []struct { context string repo string }{ + // { + // description: "test extract filesystem", + // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_extract_fs", + // configPath: "/workspace/integration_tests/dockerfiles/config_test_extract_fs.json", + // context: "integration_tests/dockerfiles/", + // repo: "extract-filesystem", + // }, + // { + // description: "test run", + // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_run", + // configPath: "/workspace/integration_tests/dockerfiles/config_test_run.json", + // context: "integration_tests/dockerfiles/", + // repo: "test-run", + // }, + // { + // description: "test run no files changed", + // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_run_2", + // configPath: "/workspace/integration_tests/dockerfiles/config_test_run_2.json", + // context: "integration_tests/dockerfiles/", + // repo: "test-run-2", + // }, + // { + // description: "test copy", + // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_copy", + // configPath: "/workspace/integration_tests/dockerfiles/config_test_copy.json", + // context: "/workspace/integration_tests/", + // repo: "test-copy", + // }, { - description: "test extract filesystem", - dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_extract_fs", - configPath: "/workspace/integration_tests/dockerfiles/config_test_extract_fs.json", - context: "integration_tests/dockerfiles/", - repo: "extract-filesystem", - }, - { - description: "test run", - dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_run", - configPath: "/workspace/integration_tests/dockerfiles/config_test_run.json", - context: "integration_tests/dockerfiles/", - repo: "test-run", - }, - { - description: "test run no files changed", - dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_run_2", - configPath: "/workspace/integration_tests/dockerfiles/config_test_run_2.json", - context: "integration_tests/dockerfiles/", - repo: "test-run-2", - }, - { - description: "test copy", - dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_copy", - configPath: "/workspace/integration_tests/dockerfiles/config_test_copy.json", + description: "test workdir", + dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_workdir", + configPath: "/workspace/integration_tests/dockerfiles/config_test_workdir.json", context: "/workspace/integration_tests/", - repo: "test-copy", + repo: "test-workdir", }, } @@ -66,13 +73,13 @@ var structureTests = []struct { dockerBuildContext string repo string }{ - { - description: "test env", - dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_env", - repo: "test-env", - dockerBuildContext: "/workspace/integration_tests/dockerfiles/", - structureTestYamlPath: "/workspace/integration_tests/dockerfiles/test_env.yaml", - }, + // { + // description: "test env", + // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_env", + // repo: "test-env", + // dockerBuildContext: "/workspace/integration_tests/dockerfiles/", + // structureTestYamlPath: "/workspace/integration_tests/dockerfiles/test_env.yaml", + // }, } type step struct { diff --git a/pkg/commands/commands.go b/pkg/commands/commands.go index 8f6b6a8cc..7e10f64be 100644 --- a/pkg/commands/commands.go +++ b/pkg/commands/commands.go @@ -44,6 +44,8 @@ func GetCommand(cmd instructions.Command, buildcontext string) (DockerCommand, e return &ExposeCommand{cmd: c}, nil case *instructions.EnvCommand: return &EnvCommand{cmd: c}, nil + case *instructions.WorkdirCommand: + return &WorkdirCommand{cmd: c}, nil } return nil, errors.Errorf("%s is not a supported command", cmd.Name()) } diff --git a/pkg/commands/run.go b/pkg/commands/run.go index b08cf8800..b6aa2b19c 100644 --- a/pkg/commands/run.go +++ b/pkg/commands/run.go @@ -44,6 +44,7 @@ func (r *RunCommand) ExecuteCommand(config *manifest.Schema2Config) error { logrus.Infof("args: %s", newCommand[1:]) cmd := exec.Command(newCommand[0], newCommand[1:]...) + cmd.Dir = config.WorkingDir cmd.Stdout = os.Stdout return cmd.Run() } diff --git a/pkg/commands/workdir.go b/pkg/commands/workdir.go new file mode 100644 index 000000000..276abec22 --- /dev/null +++ b/pkg/commands/workdir.go @@ -0,0 +1,64 @@ +/* +Copyright 2018 Google LLC + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package commands + +import ( + "github.com/GoogleCloudPlatform/k8s-container-builder/pkg/util" + "github.com/containers/image/manifest" + "github.com/docker/docker/builder/dockerfile/instructions" + "github.com/sirupsen/logrus" + "os" + "path/filepath" + "strings" +) + +type WorkdirCommand struct { + cmd *instructions.WorkdirCommand + snapshotFiles []string +} + +func (w *WorkdirCommand) ExecuteCommand(config *manifest.Schema2Config) error { + logrus.Info("cmd: workdir") + workdirPath := w.cmd.Path + resolvedWorkingDir, err := util.ResolveEnvironmentReplacement(w.workdirToString(), workdirPath, config.Env, true) + if err != nil { + return err + } + if filepath.IsAbs(resolvedWorkingDir) { + config.WorkingDir = resolvedWorkingDir + } else { + config.WorkingDir = filepath.Join(config.WorkingDir, resolvedWorkingDir) + } + logrus.Infof("Changed working directory to %s", config.WorkingDir) + w.snapshotFiles = []string{config.WorkingDir} + return os.MkdirAll(config.WorkingDir, 0755) +} + +func (w *WorkdirCommand) workdirToString() string { + workdir := []string{"WORKDIR"} + return strings.Join(append(workdir, w.cmd.Path), " ") +} + +// FilesToSnapshot returns the workingdir, which should have been created if it didn't already exist +func (w *WorkdirCommand) FilesToSnapshot() []string { + return w.snapshotFiles +} + +// CreatedBy returns some information about the command for the image config history +func (w *WorkdirCommand) CreatedBy() string { + return w.cmd.Name() + " " + w.cmd.Path +} diff --git a/pkg/commands/workdir_test.go b/pkg/commands/workdir_test.go new file mode 100644 index 000000000..3225980c6 --- /dev/null +++ b/pkg/commands/workdir_test.go @@ -0,0 +1,79 @@ +/* +Copyright 2018 Google LLC + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ +package commands + +import ( + "github.com/GoogleCloudPlatform/k8s-container-builder/testutil" + "github.com/containers/image/manifest" + "github.com/docker/docker/builder/dockerfile/instructions" + "testing" +) + +var workdirTests = []struct { + path string + expectedPath string +}{ + { + path: "/a", + expectedPath: "/a", + }, + { + path: "b", + expectedPath: "/a/b", + }, + { + path: "c", + expectedPath: "/a/b/c", + }, + { + path: "/d", + expectedPath: "/d", + }, + { + path: "$path", + expectedPath: "/d/usr", + }, + { + path: "$home", + expectedPath: "/root", + }, + { + path: "$path/$home", + expectedPath: "/root/usr/root", + }, +} + +func TestWorkdirCommand(t *testing.T) { + + cfg := &manifest.Schema2Config{ + WorkingDir: "/", + Env: []string{ + "path=usr/", + "home=/root", + }, + } + + for _, test := range workdirTests { + cmd := WorkdirCommand{ + cmd: &instructions.WorkdirCommand{ + Path: test.path, + }, + snapshotFiles: []string{}, + } + cmd.ExecuteCommand(cfg) + testutil.CheckErrorAndDeepEqual(t, false, nil, test.expectedPath, cfg.WorkingDir) + } +} From a5a84ed552f460d80ef62a9679fdabe8b9eb0d76 Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 26 Mar 2018 11:38:02 -0700 Subject: [PATCH 2/4] workdir integration test --- .../dockerfiles/Dockerfile_test_workdir | 9 ++- integration_tests/integration_test_yaml.go | 70 +++++++++---------- 2 files changed, 41 insertions(+), 38 deletions(-) diff --git a/integration_tests/dockerfiles/Dockerfile_test_workdir b/integration_tests/dockerfiles/Dockerfile_test_workdir index 4fa6b6143..6c89e4c11 100644 --- a/integration_tests/dockerfiles/Dockerfile_test_workdir +++ b/integration_tests/dockerfiles/Dockerfile_test_workdir @@ -1,10 +1,13 @@ FROM gcr.io/google-appengine/debian9:latest COPY context/foo foo WORKDIR /test -WORKDIR workdir -COPY context/foo . -RUN cp foo newfoo +# Test that this will be appended on to the previous command, to create /test/workdir +WORKDIR workdir +COPY context/foo ./currentfoo +# Test that the RUN command will happen in the correct directory +RUN cp currentfoo newfoo WORKDIR /new/dir ENV dir /another/new/dir WORKDIR $dir/newdir +WORKDIR $dir/$doesntexist WORKDIR / diff --git a/integration_tests/integration_test_yaml.go b/integration_tests/integration_test_yaml.go index 1a91eb54d..cda55ac61 100644 --- a/integration_tests/integration_test_yaml.go +++ b/integration_tests/integration_test_yaml.go @@ -29,34 +29,34 @@ var fileTests = []struct { context string repo string }{ - // { - // description: "test extract filesystem", - // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_extract_fs", - // configPath: "/workspace/integration_tests/dockerfiles/config_test_extract_fs.json", - // context: "integration_tests/dockerfiles/", - // repo: "extract-filesystem", - // }, - // { - // description: "test run", - // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_run", - // configPath: "/workspace/integration_tests/dockerfiles/config_test_run.json", - // context: "integration_tests/dockerfiles/", - // repo: "test-run", - // }, - // { - // description: "test run no files changed", - // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_run_2", - // configPath: "/workspace/integration_tests/dockerfiles/config_test_run_2.json", - // context: "integration_tests/dockerfiles/", - // repo: "test-run-2", - // }, - // { - // description: "test copy", - // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_copy", - // configPath: "/workspace/integration_tests/dockerfiles/config_test_copy.json", - // context: "/workspace/integration_tests/", - // repo: "test-copy", - // }, + { + description: "test extract filesystem", + dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_extract_fs", + configPath: "/workspace/integration_tests/dockerfiles/config_test_extract_fs.json", + context: "integration_tests/dockerfiles/", + repo: "extract-filesystem", + }, + { + description: "test run", + dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_run", + configPath: "/workspace/integration_tests/dockerfiles/config_test_run.json", + context: "integration_tests/dockerfiles/", + repo: "test-run", + }, + { + description: "test run no files changed", + dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_run_2", + configPath: "/workspace/integration_tests/dockerfiles/config_test_run_2.json", + context: "integration_tests/dockerfiles/", + repo: "test-run-2", + }, + { + description: "test copy", + dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_copy", + configPath: "/workspace/integration_tests/dockerfiles/config_test_copy.json", + context: "/workspace/integration_tests/", + repo: "test-copy", + }, { description: "test workdir", dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_workdir", @@ -73,13 +73,13 @@ var structureTests = []struct { dockerBuildContext string repo string }{ - // { - // description: "test env", - // dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_env", - // repo: "test-env", - // dockerBuildContext: "/workspace/integration_tests/dockerfiles/", - // structureTestYamlPath: "/workspace/integration_tests/dockerfiles/test_env.yaml", - // }, + { + description: "test env", + dockerfilePath: "/workspace/integration_tests/dockerfiles/Dockerfile_test_env", + repo: "test-env", + dockerBuildContext: "/workspace/integration_tests/dockerfiles/", + structureTestYamlPath: "/workspace/integration_tests/dockerfiles/test_env.yaml", + }, } type step struct { From 54a53489b21bf3a1068203d347e45c61894e284f Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 26 Mar 2018 16:56:28 -0700 Subject: [PATCH 3/4] Added comment to unit test --- pkg/commands/workdir_test.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pkg/commands/workdir_test.go b/pkg/commands/workdir_test.go index 3225980c6..439d77fd5 100644 --- a/pkg/commands/workdir_test.go +++ b/pkg/commands/workdir_test.go @@ -22,6 +22,10 @@ import ( "testing" ) +// Each test here changes the same WorkingDir field in the config +// So, some of the tests build off of each other +// This is needed to make sure WorkingDir handles paths correctly +// For example, if WORKDIR specifies a non-absolute path, it should be appended to the current WORKDIR var workdirTests = []struct { path string expectedPath string From ad17811c39cee21676f7291c973a4d0017f18b1b Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Tue, 27 Mar 2018 15:15:55 -0700 Subject: [PATCH 4/4] Update workdir to use default escape token --- pkg/commands/workdir.go | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/pkg/commands/workdir.go b/pkg/commands/workdir.go index 276abec22..f249608ac 100644 --- a/pkg/commands/workdir.go +++ b/pkg/commands/workdir.go @@ -23,7 +23,6 @@ import ( "github.com/sirupsen/logrus" "os" "path/filepath" - "strings" ) type WorkdirCommand struct { @@ -34,7 +33,7 @@ type WorkdirCommand struct { func (w *WorkdirCommand) ExecuteCommand(config *manifest.Schema2Config) error { logrus.Info("cmd: workdir") workdirPath := w.cmd.Path - resolvedWorkingDir, err := util.ResolveEnvironmentReplacement(w.workdirToString(), workdirPath, config.Env, true) + resolvedWorkingDir, err := util.ResolveEnvironmentReplacement(workdirPath, config.Env, true) if err != nil { return err } @@ -48,11 +47,6 @@ func (w *WorkdirCommand) ExecuteCommand(config *manifest.Schema2Config) error { return os.MkdirAll(config.WorkingDir, 0755) } -func (w *WorkdirCommand) workdirToString() string { - workdir := []string{"WORKDIR"} - return strings.Join(append(workdir, w.cmd.Path), " ") -} - // FilesToSnapshot returns the workingdir, which should have been created if it didn't already exist func (w *WorkdirCommand) FilesToSnapshot() []string { return w.snapshotFiles