Merge pull request #1005 from monopole/addLoaderTest

Add a plugin loader test.

pkg/target/chartinflatorexecplugin_test.go

@@ -20,6 +20,7 @@ package target_test
 import (
 	"testing"
 
+	"sigs.k8s.io/kustomize/internal/plugintest"
 	"sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
 )
 
@@ -33,7 +34,7 @@ import (
 // This test requires having the helm binary on the PATH.
 //
 func TestChartInflatorExecPlugin(t *testing.T) {
-	tc := NewTestEnvController(t).Set()
+	tc := plugintest_test.NewPluginTestEnv(t).Set()
 	defer tc.Reset()
 
 	tc.BuildExecPlugin(

pkg/target/generatorplugin_test.go

@@ -17,6 +17,7 @@ import (
 	"path/filepath"
 	"testing"
 
+	"sigs.k8s.io/kustomize/internal/plugintest"
 	"sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
 )
 
@@ -32,7 +33,7 @@ port: "12345"
 }
 
 func TestServiceGeneratorPlugin(t *testing.T) {
-	tc := NewTestEnvController(t).Set()
+	tc := plugintest_test.NewPluginTestEnv(t).Set()
 	defer tc.Reset()
 
 	tc.BuildGoPlugin(
@@ -97,7 +98,7 @@ ut labore et dolore magna aliqua.
 
 // nolint:lll
 func TestSecretGenerator(t *testing.T) {
-	tc := NewTestEnvController(t).Set()
+	tc := plugintest_test.NewPluginTestEnv(t).Set()
 	defer tc.Reset()
 
 	tc.BuildGoPlugin(
@@ -129,7 +130,7 @@ type: Opaque
 }
 
 func TestConfigMapGenerator(t *testing.T) {
-	tc := NewTestEnvController(t).Set()
+	tc := plugintest_test.NewPluginTestEnv(t).Set()
 	defer tc.Reset()
 
 	tc.BuildExecPlugin(

pkg/target/testenvcontroller_test.go

@@ -1,129 +0,0 @@
-/*
-Copyright 2019 The Kubernetes 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
-     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 target_test
-
-import (
-	"io/ioutil"
-	"os"
-	"os/exec"
-	"path/filepath"
-	"sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
-	"testing"
-
-	"sigs.k8s.io/kustomize/pkg/pgmconfig"
-	"sigs.k8s.io/kustomize/pkg/plugins"
-)
-
-// TestEnvController manages the KustTarget test environment.
-// It sets/resets XDG_CONFIG_HOME, makes/removes a temp objRoot.
-type TestEnvController struct {
-	t        *testing.T
-	compiler *plugins.Compiler
-	workDir  string
-	oldXdg   string
-	wasSet   bool
-}
-
-func NewTestEnvController(t *testing.T) *TestEnvController {
-	return &TestEnvController{t: t}
-}
-
-func (x *TestEnvController) Set() *TestEnvController {
-	x.createWorkDir()
-	x.compiler = x.makeCompiler()
-	x.setEnv()
-	return x
-}
-
-func (x *TestEnvController) Reset() {
-	x.resetEnv()
-	x.removeWorkDir()
-}
-
-func (x *TestEnvController) BuildGoPlugin(g, v, k string) {
-	err := x.compiler.Compile(g, v, k)
-	if err != nil {
-		x.t.Errorf("compile failed: %v", err)
-	}
-}
-
-func (x *TestEnvController) BuildExecPlugin(name ...string) {
-	obj := filepath.Join(
-		append([]string{x.workDir, pgmconfig.ProgramName, plugin.PluginRoot}, name...)...)
-
-	srcRoot, err := plugins.DefaultSrcRoot()
-	if err != nil {
-		x.t.Error(err)
-	}
-
-	src := filepath.Join(
-		append([]string{srcRoot}, name...)...)
-
-	if err := os.MkdirAll(filepath.Dir(obj), 0755); err != nil {
-		x.t.Errorf("error making directory: %s", filepath.Dir(obj))
-	}
-	cmd := exec.Command("cp", src, obj)
-	cmd.Env = os.Environ()
-	if err := cmd.Run(); err != nil {
-		x.t.Errorf("error copying %s: %v", src, err)
-	}
-}
-
-func (x *TestEnvController) makeCompiler() *plugins.Compiler {
-	// The plugin loader wants to find object code under
-	//    $XDG_CONFIG_HOME/kustomize/plugins
-	// and the compiler writes object code to
-	//    $objRoot
-	// so set things up accordingly.
-	objRoot := filepath.Join(
-		x.workDir, pgmconfig.ProgramName, plugin.PluginRoot)
-	err := os.MkdirAll(objRoot, os.ModePerm)
-	if err != nil {
-		x.t.Error(err)
-	}
-	srcRoot, err := plugins.DefaultSrcRoot()
-	if err != nil {
-		x.t.Error(err)
-	}
-	return plugins.NewCompiler(srcRoot, objRoot)
-}
-
-func (x *TestEnvController) createWorkDir() {
-	var err error
-	x.workDir, err = ioutil.TempDir("", "kustomize-plugin-tests")
-	if err != nil {
-		x.t.Errorf("failed to make work dir: %v", err)
-	}
-}
-
-func (x *TestEnvController) removeWorkDir() {
-	err := os.RemoveAll(x.workDir)
-	if err != nil {
-		x.t.Errorf(
-			"removing work dir: %s %v", x.workDir, err)
-	}
-}
-
-func (x *TestEnvController) setEnv() {
-	x.oldXdg, x.wasSet = os.LookupEnv(pgmconfig.XDG_CONFIG_HOME)
-	os.Setenv(pgmconfig.XDG_CONFIG_HOME, x.workDir)
-}
-
-func (x *TestEnvController) resetEnv() {
-	if x.wasSet {
-		os.Setenv(pgmconfig.XDG_CONFIG_HOME, x.oldXdg)
-	} else {
-		os.Unsetenv(pgmconfig.XDG_CONFIG_HOME)
-	}
-}

pkg/target/transformerplugin_test.go

@@ -16,6 +16,7 @@ package target_test
 import (
 	"testing"
 
+	"sigs.k8s.io/kustomize/internal/plugintest"
 	"sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
 )
 
@@ -56,7 +57,7 @@ metadata:
 }
 
 func TestOrderedTransformers(t *testing.T) {
-	tc := NewTestEnvController(t).Set()
+	tc := plugintest_test.NewPluginTestEnv(t).Set()
 	defer tc.Reset()
 
 	tc.BuildGoPlugin(
@@ -102,7 +103,7 @@ spec:
 }
 
 func TestSedTransformer(t *testing.T) {
-	tc := NewTestEnvController(t).Set()
+	tc := plugintest_test.NewPluginTestEnv(t).Set()
 	defer tc.Reset()
 
 	tc.BuildExecPlugin(
@@ -148,7 +149,7 @@ metadata:
 }
 
 func TestTransformedTransformers(t *testing.T) {
-	tc := NewTestEnvController(t).Set()
+	tc := plugintest_test.NewPluginTestEnv(t).Set()
 	defer tc.Reset()
 
 	tc.BuildGoPlugin(