Merge pull request #449 from monopole/tcFactory

Consolidate TransformerConfig creation to factory.

Author: k8s-ci-robot

pkg/commands/build/build.go

@@ -17,18 +17,17 @@ limitations under the License.
 package build
 
 import (
-	"errors"
 	"io"
-	"log"
-	"sigs.k8s.io/kustomize/pkg/resmap"
 	"strings"
 
+	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"sigs.k8s.io/kustomize/pkg/constants"
 	"sigs.k8s.io/kustomize/pkg/fs"
 	"sigs.k8s.io/kustomize/pkg/ifc"
 	"sigs.k8s.io/kustomize/pkg/ifc/patch"
 	"sigs.k8s.io/kustomize/pkg/loader"
+	"sigs.k8s.io/kustomize/pkg/resmap"
 	"sigs.k8s.io/kustomize/pkg/resource"
 	"sigs.k8s.io/kustomize/pkg/target"
 	"sigs.k8s.io/kustomize/pkg/transformerconfig"
@@ -131,13 +130,15 @@ func (o *buildOptions) RunBuild(
 	if err != nil {
 		return err
 	}
+	tc, err := makeTransformerconfig(fSys, o.transformerconfigPaths)
+	if err != nil {
+		return err
+	}
 	defer rootLoader.Cleanup()
 	kt, err := target.NewKustTarget(
 		rootLoader, fSys,
 		resmap.NewFactory(resource.NewFactory(kf)),
-		ptf,
-		makeTransformerconfig(fSys, o.transformerconfigPaths),
-		hash)
+		ptf, tc, hash)
 	if err != nil {
 		return err
 	}
@@ -159,17 +160,15 @@ func (o *buildOptions) RunBuild(
 
 // makeTransformerConfig returns a complete TransformerConfig object from either files
 // or the default configs
-func makeTransformerconfig(fSys fs.FileSystem, paths []string) *transformerconfig.TransformerConfig {
-	ldr, err := loader.NewLoader(".", "", fSys)
-	if err != nil {
-		log.Fatalf("error creating loader to load transformer configurations %v\n", err)
-	}
+func makeTransformerconfig(
+	fSys fs.FileSystem, paths []string) (*transformerconfig.TransformerConfig, error) {
 	if paths == nil || len(paths) == 0 {
-		return transformerconfig.MakeDefaultTransformerConfig()
+		return transformerconfig.NewFactory(nil).DefaultConfig(), nil
 	}
-	t, err := transformerconfig.MakeTransformerConfigFromFiles(ldr, paths)
+	ldr, err := loader.NewLoader(".", "", fSys)
 	if err != nil {
-		log.Fatalf("failed to load transformer configrations %v\n", err)
+		return nil, errors.Wrap(
+			err, "cannot create transformer configuration loader")
 	}
-	return t
+	return transformerconfig.NewFactory(ldr).FromFiles(paths)
 }

pkg/crds/crds.go

@@ -24,15 +24,15 @@ import (
 	"github.com/ghodss/yaml"
 	"k8s.io/kube-openapi/pkg/common"
 	"sigs.k8s.io/kustomize/pkg/gvk"
-	"sigs.k8s.io/kustomize/pkg/ifc"
 	"sigs.k8s.io/kustomize/pkg/transformerconfig"
 )
 
 // RegisterCRDs parse CRD schemas from paths and update various pathConfigs
-func RegisterCRDs(loader ifc.Loader, paths []string) (*transformerconfig.TransformerConfig, error) {
-	pathConfigs := transformerconfig.MakeEmptyTransformerConfig()
+func RegisterCRDs(
+	tf *transformerconfig.Factory, paths []string) (*transformerconfig.TransformerConfig, error) {
+	pathConfigs := tf.EmptyConfig()
 	for _, path := range paths {
-		pathConfig, err := registerCRD(loader, path)
+		pathConfig, err := registerCRD(tf, path)
 		if err != nil {
 			return nil, err
 		}
@@ -42,9 +42,9 @@ func RegisterCRDs(loader ifc.Loader, paths []string) (*transformerconfig.Transfo
 }
 
 // register CRD from one path
-func registerCRD(loader ifc.Loader, path string) (*transformerconfig.TransformerConfig, error) {
-	result := transformerconfig.MakeEmptyTransformerConfig()
-	content, err := loader.Load(path)
+func registerCRD(tf *transformerconfig.Factory, path string) (*transformerconfig.TransformerConfig, error) {
+	result := tf.EmptyConfig()
+	content, err := tf.Loader().Load(path)
 	if err != nil {
 		return result, err
 	}
@@ -61,7 +61,7 @@ func registerCRD(loader ifc.Loader, path string) (*transformerconfig.Transformer
 
 	crds := getCRDs(types)
 	for crd, k := range crds {
-		crdPathConfigs := transformerconfig.MakeEmptyTransformerConfig()
+		crdPathConfigs := tf.EmptyConfig()
 		err = getCRDPathConfig(
 			types, crd, crd, k, []string{}, crdPathConfigs)
 		if err != nil {

pkg/crds/crds_test.go

@@ -177,7 +177,8 @@ func TestRegisterCRD(t *testing.T) {
 		NameReference: refpathconfigs,
 	}
 
-	pathconfig, _ := registerCRD(makeLoader(t), "/testpath/crd.json")
+	pathconfig, _ := RegisterCRDs(
+		transformerconfig.NewFactory(makeLoader(t)), []string{"/testpath/crd.json"})
 
 	if !reflect.DeepEqual(pathconfig, expected) {
 		t.Fatalf("expected\n %v\n but got\n %v\n", expected, pathconfig)

pkg/target/kusttarget.go

@@ -136,7 +136,8 @@ func (kt *KustTarget) loadCustomizedResMap() (resmap.ResMap, error) {
 	if err != nil {
 		errs.Append(errors.Wrap(err, "loadResMapFromBasesAndResources"))
 	}
-	crdPathConfigs, err := crds.RegisterCRDs(kt.ldr, kt.kustomization.Crds)
+	crdPathConfigs, err := crds.RegisterCRDs(
+		transformerconfig.NewFactory(kt.ldr), kt.kustomization.Crds)
 	kt.tcfg = kt.tcfg.Merge(crdPathConfigs)
 	if err != nil {
 		errs.Append(errors.Wrap(err, "RegisterCRDs"))

pkg/target/kusttarget_test.go

@@ -91,6 +91,19 @@ metadata:
 var rf = resmap.NewFactory(resource.NewFactory(
 	k8sdeps.NewKunstructuredFactoryImpl()))
 
+func makeKustTarget(t *testing.T, l ifc.Loader) *KustTarget {
+	fakeFs := fs.MakeFakeFS()
+	fakeFs.Mkdir("/")
+	kt, err := NewKustTarget(
+		l, fakeFs, rf, patch.NewPatchTransformerFactory(),
+		transformerconfig.NewFactory(l).DefaultConfig(),
+		k8sdeps.NewKustHash())
+	if err != nil {
+		t.Fatalf("Unexpected construction error %v", err)
+	}
+	return kt
+}
+
 func makeLoader1(t *testing.T) ifc.Loader {
 	ldr := loadertest.NewFakeLoader("/testpath")
 	err := ldr.AddFile("/testpath/"+constants.KustomizationFileName, []byte(kustomizationContent1))
@@ -206,17 +219,8 @@ func TestResources1(t *testing.T) {
 				},
 			}),
 	}
-	l := makeLoader1(t)
-	fakeFs := fs.MakeFakeFS()
-	fakeFs.Mkdir("/")
-	kt, err := NewKustTarget(
-		l, fakeFs, rf, patch.NewPatchTransformerFactory(),
-		transformerconfig.MakeDefaultTransformerConfig(),
-		k8sdeps.NewKustHash())
-	if err != nil {
-		t.Fatalf("unexpected construction error %v", err)
-	}
-	actual, err := kt.MakeCustomizedResMap()
+	actual, err := makeKustTarget(
+		t, makeLoader1(t)).MakeCustomizedResMap()
 	if err != nil {
 		t.Fatalf("unexpected Resources error %v", err)
 	}
@@ -233,16 +237,7 @@ func TestResourceNotFound(t *testing.T) {
 	if err != nil {
 		t.Fatalf("Failed to setup fake ldr.")
 	}
-	fakeFs := fs.MakeFakeFS()
-	fakeFs.Mkdir("/")
-	kt, err := NewKustTarget(
-		l, fakeFs, rf, patch.NewPatchTransformerFactory(),
-		transformerconfig.MakeDefaultTransformerConfig(),
-		k8sdeps.NewKustHash())
-	if err != nil {
-		t.Fatalf("Unexpected construction error %v", err)
-	}
-	_, err = kt.MakeCustomizedResMap()
+	_, err = makeKustTarget(t, l).MakeCustomizedResMap()
 	if err == nil {
 		t.Fatalf("Didn't get the expected error for an unknown resource")
 	}
@@ -257,16 +252,7 @@ func TestSecretTimeout(t *testing.T) {
 	if err != nil {
 		t.Fatalf("Failed to setup fake ldr.")
 	}
-	fakeFs := fs.MakeFakeFS()
-	fakeFs.Mkdir("/")
-	kt, err := NewKustTarget(
-		l, fakeFs, rf, patch.NewPatchTransformerFactory(),
-		transformerconfig.MakeDefaultTransformerConfig(),
-		k8sdeps.NewKustHash())
-	if err != nil {
-		t.Fatalf("Unexpected construction error %v", err)
-	}
-	_, err = kt.MakeCustomizedResMap()
+	_, err = makeKustTarget(t, l).MakeCustomizedResMap()
 	if err == nil {
 		t.Fatalf("Didn't get the expected error for an unknown resource")
 	}

pkg/transformerconfig/factory.go

@@ -0,0 +1,86 @@
+/*
+Copyright 2018 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 transformerconfig
+
+import (
+	"log"
+
+	"github.com/ghodss/yaml"
+	"sigs.k8s.io/kustomize/pkg/ifc"
+	"sigs.k8s.io/kustomize/pkg/transformerconfig/defaultconfig"
+)
+
+// Factory makes instances of TransformerConfig.
+type Factory struct {
+	loader ifc.Loader
+}
+
+func NewFactory(l ifc.Loader) *Factory {
+	return &Factory{loader: l}
+}
+
+func (tf *Factory) Loader() ifc.Loader {
+	if tf.loader.(ifc.Loader) == nil {
+		log.Fatal("no loader")
+	}
+	return tf.loader
+}
+
+// FromFiles returns a TranformerConfig object from a list of files
+func (tf *Factory) FromFiles(
+	paths []string) (*TransformerConfig, error) {
+	result := &TransformerConfig{}
+	for _, path := range paths {
+		data, err := tf.Loader().Load(path)
+		if err != nil {
+			return nil, err
+		}
+		t, err := makeTransformerConfigFromBytes(data)
+		if err != nil {
+			return nil, err
+		}
+		result = result.Merge(t)
+	}
+	return result, nil
+}
+
+// makeTransformerConfigFromBytes returns a TransformerConfig object from bytes
+func makeTransformerConfigFromBytes(data []byte) (*TransformerConfig, error) {
+	var t TransformerConfig
+	err := yaml.Unmarshal(data, &t)
+	if err != nil {
+		return nil, err
+	}
+	t.sortFields()
+	return &t, nil
+}
+
+// EmptyConfig returns an empty TransformerConfig object
+func (tf *Factory) EmptyConfig() *TransformerConfig {
+	return &TransformerConfig{}
+}
+
+// DefaultConfig returns a default TransformerConfig.
+// This should never fail, hence the Fatal panic.
+func (tf *Factory) DefaultConfig() *TransformerConfig {
+	c, err := makeTransformerConfigFromBytes(
+		defaultconfig.GetDefaultPathConfigs())
+	if err != nil {
+		log.Fatalf("Unable to make default transformconfig: %v", err)
+	}
+	return c
+}

pkg/transformerconfig/factory_test.go

@@ -0,0 +1,64 @@
+/*
+Copyright 2018 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 transformerconfig
+
+import (
+	"reflect"
+	"sigs.k8s.io/kustomize/pkg/fs"
+	"sigs.k8s.io/kustomize/pkg/gvk"
+	"sigs.k8s.io/kustomize/pkg/ifc"
+	"sigs.k8s.io/kustomize/pkg/loader"
+	"testing"
+)
+
+func TestMakeDefaultTransformerConfig(t *testing.T) {
+	// Confirm default can be made without fatal error inside call.
+	l, _, _ := makeFakeLoaderAndOutput()
+	_ = NewFactory(l).DefaultConfig()
+}
+
+func makeFakeLoaderAndOutput() (ifc.Loader, *TransformerConfig, *TransformerConfig) {
+	transformerConfig := `
+namePrefix:
+- path: nameprefix/path
+  kind: SomeKind
+`
+	fakeFS := fs.MakeFakeFS()
+	fakeFS.WriteFile("transformerconfig/test/config.yaml", []byte(transformerConfig))
+	ldr := loader.NewFileLoader(fakeFS)
+	expected := &TransformerConfig{
+		NamePrefix: []PathConfig{
+			{
+				Gvk:  gvk.Gvk{Kind: "SomeKind"},
+				Path: "nameprefix/path",
+			},
+		},
+	}
+	return ldr, expected, NewFactory(ldr).DefaultConfig()
+}
+
+func TestMakeTransformerConfigFromFiles(t *testing.T) {
+	ldr, expected, _ := makeFakeLoaderAndOutput()
+	tcfg, err := NewFactory(ldr).FromFiles([]string{"transformerconfig/test/config.yaml"})
+	if err != nil {
+		t.Fatalf("unexpected error %v", err)
+	}
+
+	if !reflect.DeepEqual(tcfg, expected) {
+		t.Fatalf("expected %v\n but go6t %v\n", expected, tcfg)
+	}
+}