support podman as a runtime for kpt CLI (#3133)

* support podman as function runtime

* add defauting in individual e2e test

* add test with default runtime

Author: Mengqi Yu

.github/workflows/go.yml

@@ -29,8 +29,11 @@ on:
 
 jobs:
   build:
-    name: Build
+    name: Build-test-kpt-CLI
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        runtime: [docker, podman]
     steps:
       - name: Set up Go 1.17
         uses: actions/setup-go@v1
@@ -45,3 +48,5 @@ jobs:
           git config --global user.name Your Name
           make all
           make test-docker
+        env:
+          KPT_FN_RUNTIME: ${{ matrix.runtime }}

Makefile

@@ -95,15 +95,21 @@ test:
 
 # This target is used to run Go tests that require docker runtime.
 # Some tests, like pipeline tests, need to have docker available to run.
+# KPT_FN_RUNTIME can be set to select the desired function runtime.
+# If unspecified, the default function runtime will be used.
 test-docker: build
 	PATH=$(GOBIN):$(PATH) go test -cover --tags=docker ./...
 
 # KPT_E2E_UPDATE_EXPECTED=true (if expected output to be updated)
 # target to run e2e tests for "kpt fn render" command
+# KPT_FN_RUNTIME can be set to select the desired function runtime.
+# If unspecified, the default function runtime will be used.
 test-fn-render: build
 	PATH=$(GOBIN):$(PATH) go test -v --tags=docker --run=TestFnRender/testdata/fn-render/$(T) ./e2e/
 
 # target to run e2e tests for "kpt fn eval" command
+# KPT_FN_RUNTIME can be set to select the desired function runtime.
+# If unspecified, the default function runtime will be used.
 test-fn-eval: build
 	PATH=$(GOBIN):$(PATH) go test -v --tags=docker --run=TestFnEval/testdata/fn-eval/$(T)  ./e2e/
 

e2e/fn_test.go

@@ -18,9 +18,12 @@
 package e2e_test
 
 import (
+	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 
+	"github.com/GoogleContainerTools/kpt/internal/fnruntime"
 	"github.com/GoogleContainerTools/kpt/pkg/test/runner"
 )
 
@@ -56,6 +59,20 @@ func runTests(t *testing.T, cases *runner.TestCases, sequential bool) {
 		if c.Config.Sequential != sequential {
 			continue
 		}
+		// If the current function runtime doesn't match, we skip this test case.
+		currRuntime := strings.ToLower(os.Getenv(fnruntime.ContainerRuntimeEnv))
+		if len(c.Config.Runtimes) > 0 {
+			skip := true
+			for _, rt := range c.Config.Runtimes {
+				if currRuntime == strings.ToLower(rt) {
+					skip = false
+					break
+				}
+			}
+			if skip {
+				continue
+			}
+		}
 		t.Run(c.Path, func(t *testing.T) {
 			if !c.Config.Sequential {
 				t.Parallel()

e2e/testdata/fn-eval/default-runtime/.expected/diff.patch

@@ -0,0 +1,19 @@
+diff --git a/resources.yaml b/resources.yaml
+index 7a494c9..254b9cd 100644
+--- a/resources.yaml
++++ b/resources.yaml
+@@ -15,6 +15,7 @@ apiVersion: apps/v1
+ kind: Deployment
+ metadata:
+   name: nginx-deployment
++  namespace: staging
+ spec:
+   replicas: 3
+ ---
+@@ -22,5 +23,6 @@ apiVersion: custom.io/v1
+ kind: Custom
+ metadata:
+   name: custom
++  namespace: staging
+ spec:
+   image: nginx:1.2.3

e2e/testdata/fn-eval/default-runtime/.expected/exec.sh

@@ -0,0 +1,25 @@
+#! /bin/bash
+# Copyright 2021 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.
+
+set -eo pipefail
+
+# clear environment variable KPT_FN_RUNTIME if it matches the default
+if [ "${KPT_FN_RUNTIME}" = "docker" ]; then
+   unset KPT_FN_RUNTIME
+fi
+
+echo "KPT_FN_RUNTIME is ${KPT_FN_RUNTIME}"
+# run eval with KPT_FN_RUNTIME unset.
+kpt fn eval -i gcr.io/kpt-fn/set-namespace:v0.1.3 -- namespace=staging

e2e/testdata/fn-eval/default-runtime/.krmignore

@@ -0,0 +1 @@
+.expected

e2e/testdata/fn-eval/default-runtime/resources.yaml

@@ -0,0 +1,26 @@
+# Copyright 2021 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.
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+spec:
+  replicas: 3
+---
+apiVersion: custom.io/v1
+kind: Custom
+metadata:
+  name: custom
+spec:
+  image: nginx:1.2.3

e2e/testdata/fn-eval/error-in-pipe/.expected/config.yaml

@@ -13,18 +13,4 @@
 # limitations under the License.
 
 exitCode: 1
-stdErr: |
-  [RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1.3"
-  [FAIL] "gcr.io/kpt-fn/set-namespace:v0.1.3" in 0s
-    Results:
-      [error]: failed to configure function: input namespace cannot be empty
-    Stderr:
-      "[error] /// : failed to configure function: input namespace cannot be empty"
-    Exit code: 1
-  
-  [RUNNING] "gcr.io/kpt-fn/dne"
-  [FAIL] "gcr.io/kpt-fn/dne" in 0s
-    Stderr:
-      "docker: Error response from daemon: manifest for gcr.io/kpt-fn/dne:latest not found: manifest unknown: Failed to fetch \"latest\" from request \"/v2/kpt-fn/dne/manifests/latest\"."
-      "See 'docker run --help'."
-    Exit code: 125
+stdErr: Failed to fetch

e2e/testdata/fn-eval/image-pull-policy-always/.expected/setup.sh

@@ -15,9 +15,11 @@
 
 set -eo pipefail
 
+KPT_FN_RUNTIME="${KPT_FN_RUNTIME:=docker}"
+
 # Function gcr.io/kpt-fn-demo/foo:v0.1 prints "foo" to stderr and
 # function gcr.io/kpt-fn-demo/bar:v0.1 prints "bar" to stderr.
 # We intentionally tag a wrong image as gcr.io/kpt-fn-demo/foo:v0.1, since we
 # expect the correct image to be pulled and override the wrong image.
-docker pull gcr.io/kpt-fn-demo/bar:v0.1
-docker tag gcr.io/kpt-fn-demo/bar:v0.1 gcr.io/kpt-fn-demo/foo:v0.1
+${KPT_FN_RUNTIME} pull gcr.io/kpt-fn-demo/bar:v0.1
+${KPT_FN_RUNTIME} tag gcr.io/kpt-fn-demo/bar:v0.1 gcr.io/kpt-fn-demo/foo:v0.1

e2e/testdata/fn-eval/image-pull-policy-if-not-present/.expected/setup.sh

@@ -15,8 +15,10 @@
 
 set -eo pipefail
 
+KPT_FN_RUNTIME="${KPT_FN_RUNTIME:=docker}"
+
 # Function gcr.io/kpt-fn-demo/foo:v0.1 prints "foo" to stderr and
 # function gcr.io/kpt-fn-demo/bar:v0.1 prints "bar" to stderr.
 # We intentionally tag a wrong image as pull gcr.io/kpt-fn-demo/bar:v0.1
-docker pull gcr.io/kpt-fn-demo/foo:v0.1
-docker tag gcr.io/kpt-fn-demo/foo:v0.1 gcr.io/kpt-fn-demo/bar:v0.1
+${KPT_FN_RUNTIME} pull gcr.io/kpt-fn-demo/foo:v0.1
+${KPT_FN_RUNTIME} tag gcr.io/kpt-fn-demo/foo:v0.1 gcr.io/kpt-fn-demo/bar:v0.1