build test images for e2e

.ko.yaml

@@ -0,0 +1,2 @@
+# Use :nonroot base image for all containers
+defaultBaseImage: gcr.io/distroless/base:debug-nonroot

lib/test/cli.go

@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"os/exec"
 	"strings"
+	"text/template"
 )
 
 const (
@@ -234,3 +235,25 @@ func appendCLIOutput(buffer *bytes.Buffer, desc string, out string, err error) {
 func cmdCLIDesc(cli string, args []string) string {
 	return fmt.Sprintf("%s %s", cli, strings.Join(args, " "))
 }
+
+// ImagePath is a helper function to transform an image name into an image reference that can be pulled.
+func ImagePath(name string) string {
+	tpl, err := template.New("image").Parse(Flags.ImageTemplate)
+	if err != nil {
+		panic("could not parse image template: " + err.Error())
+	}
+
+	var buf bytes.Buffer
+	if err := tpl.Execute(&buf, struct {
+		Repository string
+		Name       string
+		Tag        string
+	}{
+		Repository: Flags.DockerRepo,
+		Name:       name,
+		Tag:        Flags.Tag,
+	}); err != nil {
+		panic("could not apply the image template: " + err.Error())
+	}
+	return buf.String()
+}

lib/test/flags.go

@@ -28,6 +28,9 @@ var Flags = InitializeFlags()
 // ClientFlags define the flags that are needed to run the e2e tests.
 type ClientFlags struct {
 	DockerConfigJSON string
+	ImageTemplate    string // Template to build the image reference (defaults to {{.Repository}}/{{.Name}}:{{.Tag}})
+	DockerRepo       string // Docker repo (defaults to $KO_DOCKER_REPO)
+	Tag              string // Tag for test images
 }
 
 // InitializeFlags initializes the client's flags
@@ -38,5 +41,14 @@ func InitializeFlags() *ClientFlags {
 	flag.StringVar(&f.DockerConfigJSON, "dockerconfigjson", dockerConfigJSON,
 		"Provide the path to Docker configuration file in json format. Defaults to $DOCKER_CONFIG_JSON")
 
+	flag.StringVar(&f.ImageTemplate, "imagetemplate", "{{.Repository}}/{{.Name}}:{{.Tag}}",
+		"Provide a template to generate the reference to an image from the test. Defaults to `{{.Repository}}/{{.Name}}:{{.Tag}}`.")
+
+	defaultRepo := os.Getenv("KO_DOCKER_REPO")
+	flag.StringVar(&f.DockerRepo, "dockerrepo", defaultRepo,
+		"Provide the uri of the docker repo you have uploaded the test image to using `uploadtestimage.sh`. Defaults to $KO_DOCKER_REPO")
+
+	flag.StringVar(&f.Tag, "tag", "latest", "Provide the version tag for the test images.")
+
 	return &f
 }

lib/test/service.go

@@ -28,7 +28,7 @@ import (
 
 // ServiceCreate verifies given service creation in sync mode and also verifies output
 func ServiceCreate(r *KnRunResultCollector, serviceName string) {
-	out := r.KnTest().Kn().Run("service", "create", serviceName, "--image", GetKnTestImage())
+	out := r.KnTest().Kn().Run("service", "create", serviceName, "--image", ImagePath("helloworld"))
 	r.AssertNoError(out)
 	assert.Check(r.T(), util.ContainsAllIgnoreCase(out.Stdout, "service", serviceName, "creating", "namespace", r.KnTest().Kn().Namespace(), "ready"))
 }
@@ -51,7 +51,7 @@ func ServiceList(r *KnRunResultCollector, serviceName string) {
 func ServiceDescribe(r *KnRunResultCollector, serviceName string) {
 	out := r.KnTest().Kn().Run("service", "describe", serviceName)
 	r.AssertNoError(out)
-	assert.Assert(r.T(), util.ContainsAll(out.Stdout, serviceName, r.KnTest().Kn().Namespace(), GetKnTestImage()))
+	assert.Assert(r.T(), util.ContainsAll(out.Stdout, serviceName, r.KnTest().Kn().Namespace(), ImagePath("helloworld")))
 	assert.Assert(r.T(), util.ContainsAll(out.Stdout, "Conditions", "ConfigurationsReady", "Ready", "RoutesReady"))
 	assert.Assert(r.T(), util.ContainsAll(out.Stdout, "Name", "Namespace", "URL", "Age", "Revisions"))
 }

test/README.md

@@ -66,3 +66,21 @@ mode, use
 ```bash
 test/local-e2e-tests.sh -short
 ```
+
+## Test images
+
+### Building the test images
+
+The [`upload-test-images.sh`](./upload-test-images.sh) script can be used to
+build and push the test images used by e2e tests. The script
+expects 'KO_DOCKER_REPO' environment variable set.
+
+To run the script for all end to end test images:
+
+```bash
+./test/upload-test-images.sh
+```
+
+### Adding new test images
+
+New test images should be placed in `test/test_images`.

test/common.sh

@@ -51,3 +51,10 @@ function knative_setup() {
     wait_until_pods_running knative-eventing || return 1
   fi
 }
+
+# Create test resources and images
+function test_setup() {
+  echo ">> Uploading test images..."
+  ${REPO_ROOT_DIR}/test/upload-test-images.sh || return 1  
+}
+

test/test_images/helloworld/release.yaml

@@ -0,0 +1,16 @@
+# Copyright 2020 The Knative Authors
+#
+# 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
+#
+#     https://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.
+
+image: ko://knative.dev/client/test/test_images/helloworld
+

test/upload-test-images.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+#
+# Copyright 2020 The Knative Authors
+#
+# 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
+#
+#     https://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.
+
+set -o errexit
+
+function upload_test_images() {
+  echo ">> Publishing test images"
+  # Script needs to be executed from the root directory
+  # to pickup .ko.yaml
+  cd "$( dirname "$0")/.."
+  local image_dir="test/test_images"
+  local docker_tag=$1
+  local tag_option=""
+  if [ -n "${docker_tag}" ]; then
+    tag_option="--tags $docker_tag,latest"
+  fi
+
+  # ko resolve is being used for the side-effect of publishing images,
+  # so the resulting yaml produced is ignored.
+  # We limit the number of concurrent builds (jobs) to avoid OOMs.
+  ko resolve --jobs=4 ${tag_option} -RBf "${image_dir}" > /dev/null
+}
+
+: ${KO_DOCKER_REPO:?"You must set 'KO_DOCKER_REPO'"}
+
+upload_test_images $@