Files
kustomize/cmd/config/internal/commands/e2e/e2e_test.go
Davanum Srinivas d32eacf034 Remove starlark support
Signed-off-by: Davanum Srinivas <davanum@gmail.com>
2024-09-23 16:52:05 -04:00

620 lines
13 KiB
Go

// Copyright 2019 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0
package e2e
import (
"bytes"
"fmt"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"sync"
"testing"
"github.com/stretchr/testify/assert"
"sigs.k8s.io/kustomize/kyaml/testutil"
)
func TestRunE2e(t *testing.T) {
binDir := build()
tests := []struct {
name string
args func(string) []string
files func(string) map[string]string
expectedFiles func(string) map[string]string
expectedErr string
skipIfFalseEnv string
}{
{
name: "exec_function_no_args",
args: func(d string) []string {
return []string{
"--enable-exec", "--exec-path", filepath.Join(d, e2eConfigDir),
}
},
files: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
a-string-value: ''
a-int-value: '0'
a-bool-value: 'false'
`,
}
},
},
{
name: "exec_function_no_args_json",
args: func(d string) []string {
return []string{
"--enable-exec", "--exec-path", filepath.Join(d, "e2econtainerconfig"),
}
},
files: func(d string) map[string]string {
return map[string]string{
"deployment.json": `
{
"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {
"name": "foo"
}
}
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"deployment.json": `
{
"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {
"annotations": {
"a-bool-value": "false",
"a-int-value": "0",
"a-string-value": ""
},
"name": "foo"
}
}
`,
}
},
},
{
name: "exec_function_args",
args: func(d string) []string {
return []string{
"--enable-exec", "--exec-path", filepath.Join(d, "e2econtainerconfig"),
"--", "stringValue=a", "intValue=1", "boolValue=true",
}
},
files: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
a-string-value: 'a'
a-int-value: '1'
a-bool-value: 'true'
`,
}
},
},
{
name: "exec_function_config",
args: func(d string) []string {
return []string{"--enable-exec"}
},
files: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": fmt.Sprintf(`
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
exec:
path: %s
`, filepath.Join(d, "e2econtainerconfig")),
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": fmt.Sprintf(`
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
exec:
path: %s
a-string-value: ''
a-int-value: '0'
a-bool-value: 'false'
`, filepath.Join(d, "e2econtainerconfig"))}
},
},
//
// Starklark function tests
//
{
name: "exec_function_config_data",
args: func(d string) []string {
return []string{"--enable-exec"}
},
files: func(d string) map[string]string {
return map[string]string{
"config.yaml": fmt.Sprintf(`
apiVersion: example.com/v1alpha1
kind: Input
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
exec:
path: %s
data:
stringValue: a
intValue: 2
boolValue: true
`, filepath.Join(d, "e2econtainerconfig")),
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"config.yaml": fmt.Sprintf(`
apiVersion: example.com/v1alpha1
kind: Input
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
exec:
path: %s
a-string-value: 'a'
a-int-value: '2'
a-bool-value: 'true'
data:
stringValue: a
intValue: 2
boolValue: true
`, filepath.Join(d, "e2econtainerconfig")),
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
a-string-value: 'a'
a-int-value: '2'
a-bool-value: 'true'
`,
}
},
},
{
//
// NOTE: Do not change the expected value of this test. It is to ensure that
// exec functions are off by default when run from the CLI.
// exec functions execute arbitrary code outside of a sandbox environment.
//
name: "exec_function_config_disabled",
args: func(d string) []string { return []string{} },
files: func(d string) map[string]string {
return map[string]string{
"config.yaml": fmt.Sprintf(`
apiVersion: example.com/v1alpha1
kind: Input
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
exec:
path: %s
data:
stringValue: a
intValue: 2
boolValue: true
`, filepath.Join(d, "e2econtainerconfig")),
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"config.yaml": fmt.Sprintf(`
apiVersion: example.com/v1alpha1
kind: Input
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
exec:
path: %s
data:
stringValue: a
intValue: 2
boolValue: true
`, filepath.Join(d, "e2econtainerconfig")),
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
internal.config.kubernetes.io/annotations-migration-resource-id: '1'
`,
}
},
},
{
name: "exec_function_no_enable",
expectedErr: "must specify --enable-exec with --exec-path",
args: func(d string) []string {
return []string{"--exec-path", filepath.Join(d, "e2econtainerconfig")}
},
files: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
a-string-value: ''
a-int-value: '0'
a-bool-value: 'false'
`,
}
},
},
//
// Container
//
{
name: "container_function_no_args",
skipIfFalseEnv: "KUSTOMIZE_DOCKER_E2E",
args: func(d string) []string {
return []string{"--image", "gcr.io/kustomize-functions/e2econtainerconfig"}
},
files: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
a-string-value: ''
a-int-value: '0'
a-bool-value: 'false'
`,
}
},
},
{
name: "container_function_args",
skipIfFalseEnv: "KUSTOMIZE_DOCKER_E2E",
args: func(d string) []string {
return []string{
"--image", "gcr.io/kustomize-functions/e2econtainerconfig",
"--", "stringValue=a", "intValue=1", "boolValue=true",
}
},
files: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
a-string-value: 'a'
a-int-value: '1'
a-bool-value: 'true'
`,
}
},
},
{
name: "container_function_config",
skipIfFalseEnv: "KUSTOMIZE_DOCKER_E2E",
args: func(d string) []string { return []string{} },
files: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
container:
image: "gcr.io/kustomize-functions/e2econtainerconfig"
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
container:
image: "gcr.io/kustomize-functions/e2econtainerconfig"
a-string-value: ''
a-int-value: '0'
a-bool-value: 'false'
`}
},
},
{
name: "container_function_config",
skipIfFalseEnv: "KUSTOMIZE_DOCKER_E2E",
args: func(d string) []string { return []string{} },
files: func(d string) map[string]string {
return map[string]string{
"config.yaml": `
apiVersion: example.com/v1alpha1
kind: Input
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
container:
image: "gcr.io/kustomize-functions/e2econtainerconfig"
data:
stringValue: a
intValue: 2
boolValue: true
`,
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
`,
}
},
expectedFiles: func(d string) map[string]string {
return map[string]string{
"config.yaml": `
apiVersion: example.com/v1alpha1
kind: Input
metadata:
name: foo
annotations:
config.kubernetes.io/function: |
container:
image: "gcr.io/kustomize-functions/e2econtainerconfig"
a-string-value: 'a'
a-int-value: '2'
a-bool-value: 'true'
data:
stringValue: a
intValue: 2
boolValue: true
`,
"deployment.yaml": `
apiVersion: apps/v1
kind: Deployment
metadata:
name: foo
annotations:
a-string-value: 'a'
a-int-value: '2'
a-bool-value: 'true'
`,
}
},
},
}
// TODO: dedup this with the shared version
for i := range tests {
tt := tests[i]
t.Run(tt.name, func(t *testing.T) {
if tt.skipIfFalseEnv != "" && os.Getenv(tt.skipIfFalseEnv) == "false" {
t.Skip()
}
dir, err := os.MkdirTemp("", "kustomize-test-data-")
if !assert.NoError(t, err) {
t.FailNow()
}
defer os.RemoveAll(dir)
os.Chdir(dir)
// write the input
for path, data := range tt.files(binDir) {
err := os.WriteFile(path, []byte(data), 0600)
testutil.AssertNoError(t, err)
}
args := append([]string{"fn", "run", "."}, tt.args(binDir)...)
cmd := exec.Command(filepath.Join(binDir, kyamlBin), args...) //nolint: gosec
cmd.Dir = dir
var stdErr, stdOut bytes.Buffer
cmd.Stdout = &stdOut
cmd.Stderr = &stdErr
cmd.Env = os.Environ()
err = cmd.Run()
if tt.expectedErr != "" {
if !assert.Contains(t, stdErr.String(), tt.expectedErr, stdErr.String()) {
t.FailNow()
}
return
}
testutil.AssertNoError(t, err, stdErr.String())
for path, data := range tt.expectedFiles(binDir) {
b, err := os.ReadFile(path)
testutil.AssertNoError(t, err, stdErr.String())
if !assert.Equal(t, strings.TrimSpace(data), strings.TrimSpace(string(b)), stdErr.String()) {
t.FailNow()
}
}
})
}
}
var buildOnce sync.Once
var binDir string
const e2eConfigDir = "e2econtainerconfig"
func build() string {
// only build the binaries once
buildOnce.Do(func() {
var err error
binDir, err = os.MkdirTemp("", "kustomize-test-")
if err != nil {
panic(err)
}
build := exec.Command("go", "build", "-o", //nolint: gosec
filepath.Join(binDir, e2econtainerconfigBin))
build.Dir = "e2econtainerconfig"
build.Stdout = os.Stdout
build.Stderr = os.Stderr
build.Env = os.Environ()
err = build.Run()
if err != nil {
panic(err)
}
build = exec.Command("go", "build", "-o", filepath.Join(binDir, kyamlBin)) //nolint: gosec
build.Dir = filepath.Join("..", "..", "..", "kubectl-krm")
build.Stdout = os.Stdout
build.Stderr = os.Stderr
err = build.Run()
if err != nil {
panic(err)
}
if os.Getenv("KUSTOMIZE_DOCKER_E2E") == "false" {
return
}
build = exec.Command("docker", "build", ".",
"-f", "./cmd/config/internal/commands/e2e/e2econtainerconfig/Dockerfile",
"-t", "gcr.io/kustomize-functions/e2econtainerconfig",
)
build.Dir = "../../../../../" // Repo root
build.Stdout = os.Stdout
build.Stderr = os.Stderr
err = build.Run()
if err != nil {
panic(err)
}
})
return binDir
}
var (
e2econtainerconfigBin string
kyamlBin string
)
func init() { //nolint: gochecknoinits
kyamlBin = "kubectl-krm"
e2econtainerconfigBin = e2eConfigDir
if runtime.GOOS == "windows" {
kyamlBin = "kubectl-krm.exe"
e2econtainerconfigBin = "e2econtainerconfig.exe"
}
}