Include runtime dependencies for taggers in gcr.io/k8s-skaffold/skaffold (#1987)

* Include necessary dependencies for taggers
* Check that the taggers produce an image with the expected tag
* Avoid recursive copy of test files
For the git tagger test, set up a dummy repo inside the testdata folder.
* Bundle timezone data with the skaffold binary
This ensures that te dateTime tagger works on windows when go is not installed.
* Fix integration test setup for git commit tagger
Signed-off-by: Cornelius Weig <[email protected]>

Author: corneliusweig

Gopkg.lock

@@ -78,3 +78,7 @@
 [[constraint]]
   name = "github.com/golang/protobuf"
   branch = "master"
+
+[[constraint]]
+  branch = "master"
+  name = "4d63.com/tz"

Gopkg.toml

@@ -16,6 +16,7 @@ FROM gcr.io/gcp-runtimes/ubuntu_16_0_4 as runtime_deps
 
 RUN apt-get update && \
   apt-get install --no-install-recommends --no-install-suggests -y \
+  git \
   python && \
   rm -rf /var/lib/apt/lists/*
 
@@ -25,8 +26,8 @@ RUN curl -Lo /usr/local/bin/kubectl https://storage.googleapis.com/kubernetes-re
 
 ENV HELM_VERSION v2.8.1
 RUN curl -LO https://storage.googleapis.com/kubernetes-helm/helm-${HELM_VERSION}-linux-amd64.tar.gz && \
-  tar -zxvf helm-${HELM_VERSION}-linux-amd64.tar.gz && \
-  mv linux-amd64/helm /usr/local/bin/helm
+  tar -xvf helm-${HELM_VERSION}-linux-amd64.tar.gz -C /usr/local/bin --strip-components 1 && \
+  rm -f helm-${HELM_VERSION}-linux-amd64.tar.gz
 
 ENV CLOUD_SDK_VERSION 217.0.0
 RUN curl -LO https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-${CLOUD_SDK_VERSION}-linux-x86_64.tar.gz && \
@@ -68,7 +69,6 @@ RUN apt-get update && apt-get install --no-install-recommends --no-install-sugge
   ca-certificates \
   curl \
   build-essential \
-  git \
   gcc \
   python-setuptools \
   lsb-release \

deploy/skaffold/Dockerfile

@@ -17,11 +17,21 @@ limitations under the License.
 package integration
 
 import (
+	"context"
+	"os"
+	"os/exec"
 	"testing"
+	"time"
 
+	"4d63.com/tz"
 	"github.com/GoogleContainerTools/skaffold/integration/skaffold"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/docker"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/util"
+	"github.com/docker/docker/api/types"
 )
 
+const imageName = "simple-build:"
+
 func TestBuild(t *testing.T) {
 	if testing.Short() {
 		t.Skip("skipping integration test")
@@ -31,32 +41,126 @@ func TestBuild(t *testing.T) {
 		description string
 		dir         string
 		args        []string
+		expectImage string
+		setup       func(t *testing.T, workdir string) (teardown func())
 	}{
 		{
 			description: "docker build",
 			dir:         "testdata/build",
-		}, {
+		},
+		{
 			description: "git tagger",
 			dir:         "testdata/tagPolicy",
 			args:        []string{"-p", "gitCommit"},
-		}, {
+			setup:       setupGitRepo,
+			expectImage: imageName + "v1",
+		},
+		{
 			description: "sha256 tagger",
 			dir:         "testdata/tagPolicy",
 			args:        []string{"-p", "sha256"},
-		}, {
+			expectImage: imageName + "latest",
+		},
+		{
 			description: "dateTime tagger",
 			dir:         "testdata/tagPolicy",
 			args:        []string{"-p", "dateTime"},
-		}, {
+			// around midnight this test might fail, if the tests above run slowly
+			expectImage: imageName + nowInChicago(),
+		},
+		{
 			description: "envTemplate tagger",
 			dir:         "testdata/tagPolicy",
 			args:        []string{"-p", "envTemplate"},
+			expectImage: imageName + "tag",
 		},
 	}
 
 	for _, test := range tests {
 		t.Run(test.description, func(t *testing.T) {
+			if test.setup != nil {
+				teardown := test.setup(t, test.dir)
+				defer teardown()
+			}
+
+			// remove image in case it is already present
+			removeImage(t, test.expectImage)
 			skaffold.Build(test.args...).InDir(test.dir).RunOrFail(t)
+			checkImageExists(t, test.expectImage)
 		})
 	}
 }
+
+// removeImage removes the given image if present.
+func removeImage(t *testing.T, image string) {
+	t.Helper()
+
+	if image == "" {
+		return
+	}
+
+	client, err := docker.NewAPIClient(false, nil)
+	failNowIfError(t, err)
+
+	ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(5*time.Second))
+	defer cancel()
+	_, _ = client.ImageRemove(ctx, image, types.ImageRemoveOptions{
+		Force:         true,
+		PruneChildren: true,
+	})
+}
+
+// checkImageExists asserts that the given image is present
+func checkImageExists(t *testing.T, image string) {
+	t.Helper()
+
+	if image == "" {
+		return
+	}
+
+	client, err := docker.NewAPIClient(false, nil)
+	failNowIfError(t, err)
+
+	ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(5*time.Second))
+	defer cancel()
+	if !client.ImageExists(ctx, image) {
+		t.Errorf("expected image '%s' not present", image)
+	}
+}
+
+// setupGitRepo sets up a clean repo with tag v1
+func setupGitRepo(t *testing.T, dir string) func() {
+	gitArgs := [][]string{
+		{"init"},
+		{"config", "user.email", "[email protected]"},
+		{"config", "user.name", "John Doe"},
+		{"add", "."},
+		{"commit", "-m", "Initial commit"},
+		{"tag", "v1"},
+	}
+
+	for _, args := range gitArgs {
+		cmd := exec.Command("git", args...)
+		cmd.Dir = dir
+		if buf, err := util.RunCmdOut(cmd); err != nil {
+			t.Logf(string(buf))
+			t.Fatal(err)
+		}
+	}
+
+	return func() {
+		os.RemoveAll(dir + "/.git")
+	}
+}
+
+// nowInChicago returns the dateTime string as generated by the dateTime tagger
+func nowInChicago() string {
+	loc, _ := tz.LoadLocation("America/Chicago")
+	return time.Now().In(loc).Format("2006-01-02")
+}
+
+func failNowIfError(t *testing.T, err error) {
+	if err != nil {
+		t.Fatal(err)
+	}
+}

integration/build_test.go

@@ -203,7 +203,7 @@ func (b *RunBuilder) cmd(ctx context.Context) *exec.Cmd {
 	// If the test is killed by a timeout, go test will wait for
 	// os.Stderr and os.Stdout to close as a result.
 	//
-	// However, the `cmd` will stil run in the background
+	// However, the `cmd` will still run in the background
 	// and hold those descriptors open.
 	// As a result, go test will hang forever.
 	//

integration/skaffold/helper.go

@@ -20,7 +20,9 @@ profiles:
     tagPolicy:
       dateTime:
         format: "2006-01-02"
-        timezone: "UTC"
+        # UTC does not require timezone data lookup
+        # Would have caught #1979
+        timezone: "America/Chicago"
 - name: envTemplate
   build:
     tagPolicy:

integration/testdata/tagPolicy/skaffold.yaml

@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"time"
 
+	"4d63.com/tz"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/constants"
 )
 
@@ -60,7 +61,7 @@ func (tagger *dateTimeTagger) GenerateFullyQualifiedImageName(workingDir, imageN
 		timezone = tagger.TimeZone
 	}
 
-	loc, err := time.LoadLocation(timezone)
+	loc, err := tz.LoadLocation(timezone)
 	if err != nil {
 		return "", fmt.Errorf("bad timezone provided: \"%s\", error: %s", timezone, err)
 	}