Merge pull request #451 from Liujingfang1/hash

add MakeHashTransformer in TransformerFactory; remove hash interface

pkg/commands/build/build.go

@@ -25,7 +25,7 @@ import (
 	"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/ifc/transformer"
 	"sigs.k8s.io/kustomize/pkg/loader"
 	"sigs.k8s.io/kustomize/pkg/resmap"
 	"sigs.k8s.io/kustomize/pkg/resource"
@@ -63,8 +63,7 @@ Use different transformer configurations by passing files to kustomize
 func NewCmdBuild(
 	out io.Writer, fs fs.FileSystem,
 	kf ifc.KunstructuredFactory,
-	ptf patch.TransformerFactory,
-	hash ifc.Hash) *cobra.Command {
+	ptf transformer.Factory) *cobra.Command {
 	var o buildOptions
 	var p string
 
@@ -78,7 +77,7 @@ func NewCmdBuild(
 			if err != nil {
 				return err
 			}
-			return o.RunBuild(out, fs, kf, ptf, hash)
+			return o.RunBuild(out, fs, kf, ptf)
 		},
 	}
 	cmd.Flags().StringVarP(
@@ -124,8 +123,7 @@ func (o *buildOptions) Validate(args []string, p string, fs fs.FileSystem) error
 func (o *buildOptions) RunBuild(
 	out io.Writer, fSys fs.FileSystem,
 	kf ifc.KunstructuredFactory,
-	ptf patch.TransformerFactory,
-	hash ifc.Hash) error {
+	ptf transformer.Factory) error {
 	rootLoader, err := loader.NewLoader(o.kustomizationPath, "", fSys)
 	if err != nil {
 		return err
@@ -138,7 +136,7 @@ func (o *buildOptions) RunBuild(
 	kt, err := target.NewKustTarget(
 		rootLoader, fSys,
 		resmap.NewFactory(resource.NewFactory(kf)),
-		ptf, tc, hash)
+		ptf, tc)
 	if err != nil {
 		return err
 	}

pkg/commands/build/build_test.go

@@ -27,7 +27,7 @@ import (
 
 	"github.com/ghodss/yaml"
 	"sigs.k8s.io/kustomize/internal/k8sdeps"
-	"sigs.k8s.io/kustomize/internal/k8sdeps/patch"
+	"sigs.k8s.io/kustomize/internal/k8sdeps/transformer"
 	"sigs.k8s.io/kustomize/pkg/commands/kustfile"
 	"sigs.k8s.io/kustomize/pkg/constants"
 	"sigs.k8s.io/kustomize/pkg/fs"
@@ -132,8 +132,7 @@ func runBuildTestCase(t *testing.T, testcaseName string, updateKustomizeExpected
 	err = ops.RunBuild(
 		buf, fSys,
 		k8sdeps.NewKunstructuredFactoryImpl(),
-		patch.NewPatchTransformerFactory(),
-		k8sdeps.NewKustHash())
+		transformer.NewFactoryImpl())
 	switch {
 	case err != nil && len(testcase.ExpectedError) == 0:
 		t.Errorf("unexpected error: %v", err)

pkg/commands/commands.go

@@ -27,13 +27,13 @@ import (
 	"sigs.k8s.io/kustomize/pkg/commands/misc"
 	"sigs.k8s.io/kustomize/pkg/fs"
 	"sigs.k8s.io/kustomize/pkg/ifc"
-	"sigs.k8s.io/kustomize/pkg/ifc/patch"
+	"sigs.k8s.io/kustomize/pkg/ifc/transformer"
 )
 
 // NewDefaultCommand returns the default (aka root) command for kustomize command.
 func NewDefaultCommand(
-	kf ifc.KunstructuredFactory, ptf patch.TransformerFactory,
-	validator ifc.Validator, hash ifc.Hash) *cobra.Command {
+	kf ifc.KunstructuredFactory, ptf transformer.Factory,
+	validator ifc.Validator) *cobra.Command {
 	fsys := fs.MakeRealFS()
 	stdOut := os.Stdout
 
@@ -49,7 +49,7 @@ See https://sigs.k8s.io/kustomize
 
 	c.AddCommand(
 		// TODO: Make consistent API for newCmd* functions.
-		build.NewCmdBuild(stdOut, fsys, kf, ptf, hash),
+		build.NewCmdBuild(stdOut, fsys, kf, ptf),
 		edit.NewCmdEdit(fsys, validator, kf),
 		misc.NewCmdConfig(fsys),
 		misc.NewCmdVersion(stdOut),

pkg/ifc/ifc.go

@@ -42,11 +42,6 @@ type Loader interface {
 	Cleanup() error
 }
 
-// Hash interface provides function to compute hash of objects
-type Hash interface {
-	Hash(m map[string]interface{}) (string, error)
-}
-
 // Kunstructured allows manipulation of k8s objects
 // that do not have Golang structs.
 type Kunstructured interface {

pkg/ifc/transformer/transformer.go

@@ -15,14 +15,15 @@ limitations under the License.
 */
 
 // Package patch holds miscellaneous interfaces used by kustomize.
-package patch
+package transformer
 
 import (
 	"sigs.k8s.io/kustomize/pkg/resource"
 	"sigs.k8s.io/kustomize/pkg/transformers"
 )
 
-// TransformerFactory makes patch transformer.
-type TransformerFactory interface {
+// Factory makes transformers
+type Factory interface {
 	MakePatchTransformer(slice []*resource.Resource, rf *resource.Factory) (transformers.Transformer, error)
+	MakeHashTransformer() transformers.Transformer
 }

pkg/target/kusttarget.go

@@ -29,7 +29,7 @@ import (
 	"github.com/pkg/errors"
 	"sigs.k8s.io/kustomize/pkg/constants"
 	"sigs.k8s.io/kustomize/pkg/fs"
-	"sigs.k8s.io/kustomize/pkg/ifc/patch"
+	"sigs.k8s.io/kustomize/pkg/ifc/transformer"
 	interror "sigs.k8s.io/kustomize/pkg/internal/error"
 	patchtransformer "sigs.k8s.io/kustomize/pkg/patch/transformer"
 	"sigs.k8s.io/kustomize/pkg/resmap"
@@ -42,21 +42,19 @@ import (
 // KustTarget encapsulates the entirety of a kustomization build.
 type KustTarget struct {
 	kustomization *types.Kustomization
-	hash          ifc.Hash
 	ldr           ifc.Loader
 	fSys          fs.FileSystem
 	rf            *resmap.Factory
 	tcfg          *transformerconfig.TransformerConfig
-	ptf           patch.TransformerFactory
+	ptf           transformer.Factory
 }
 
 // NewKustTarget returns a new instance of KustTarget primed with a Loader.
 func NewKustTarget(
 	ldr ifc.Loader, fSys fs.FileSystem,
 	rf *resmap.Factory,
-	ptf patch.TransformerFactory,
-	tcfg *transformerconfig.TransformerConfig,
-	h ifc.Hash) (*KustTarget, error) {
+	ptf transformer.Factory,
+	tcfg *transformerconfig.TransformerConfig) (*KustTarget, error) {
 	content, err := ldr.Load(constants.KustomizationFileName)
 	if err != nil {
 		return nil, err
@@ -74,7 +72,6 @@ func NewKustTarget(
 		fSys:          fSys,
 		rf:            rf,
 		tcfg:          tcfg,
-		hash:          h,
 		ptf:           ptf,
 	}, nil
 }
@@ -102,7 +99,7 @@ func (kt *KustTarget) MakeCustomizedResMap() (resmap.ResMap, error) {
 
 // resolveRefsToGeneratedResources fixes all name references.
 func (kt *KustTarget) resolveRefsToGeneratedResources(m resmap.ResMap) (resmap.ResMap, error) {
-	err := transformers.NewNameHashTransformer(kt.hash).Transform(m)
+	err := kt.ptf.MakeHashTransformer().Transform(m)
 	if err != nil {
 		return nil, err
 	}
@@ -225,7 +222,7 @@ func (kt *KustTarget) loadCustomizedBases() (resmap.ResMap, *interror.Kustomizat
 			continue
 		}
 		target, err := NewKustTarget(
-			ldr, kt.fSys, kt.rf, kt.ptf, kt.tcfg, kt.hash)
+			ldr, kt.fSys, kt.rf, kt.ptf, kt.tcfg)
 		if err != nil {
 			errs.Append(errors.Wrap(err, "couldn't make target for "+path))
 			continue
@@ -255,7 +252,7 @@ func (kt *KustTarget) loadBasesAsFlatList() ([]*KustTarget, error) {
 			continue
 		}
 		target, err := NewKustTarget(
-			ldr, kt.fSys, kt.rf, kt.ptf, kt.tcfg, kt.hash)
+			ldr, kt.fSys, kt.rf, kt.ptf, kt.tcfg)
 		if err != nil {
 			errs.Append(err)
 			continue

pkg/target/kusttarget_test.go

@@ -23,7 +23,7 @@ import (
 	"testing"
 
 	"sigs.k8s.io/kustomize/internal/k8sdeps"
-	"sigs.k8s.io/kustomize/internal/k8sdeps/patch"
+	"sigs.k8s.io/kustomize/internal/k8sdeps/transformer"
 	"sigs.k8s.io/kustomize/pkg/constants"
 	"sigs.k8s.io/kustomize/pkg/fs"
 	"sigs.k8s.io/kustomize/pkg/gvk"
@@ -95,9 +95,8 @@ 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())
+		l, fakeFs, rf, transformer.NewFactoryImpl(),
+		transformerconfig.NewFactory(l).DefaultConfig())
 	if err != nil {
 		t.Fatalf("Unexpected construction error %v", err)
 	}

pkg/transformers/namehash.go

@@ -1,61 +0,0 @@
-/*
-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 transformers
-
-import (
-	"fmt"
-
-	"sigs.k8s.io/kustomize/pkg/ifc"
-	"sigs.k8s.io/kustomize/pkg/resmap"
-	"sigs.k8s.io/kustomize/pkg/resource"
-)
-
-// nameHashTransformer contains the prefix and the path config for each field that
-// the name prefix will be applied.
-type nameHashTransformer struct {
-	hash ifc.Hash
-}
-
-var _ Transformer = &nameHashTransformer{}
-
-// NewNameHashTransformer construct a nameHashTransformer.
-func NewNameHashTransformer(h ifc.Hash) Transformer {
-	return &nameHashTransformer{hash: h}
-}
-
-// Transform appends hash to configmaps and secrets.
-func (o *nameHashTransformer) Transform(m resmap.ResMap) error {
-	for _, res := range m {
-		if res.IsGenerated() {
-			err := o.appendHash(res)
-			if err != nil {
-				return err
-			}
-		}
-	}
-	return nil
-}
-
-func (o *nameHashTransformer) appendHash(res *resource.Resource) error {
-	h, err := o.hash.Hash(res.Map())
-	if err != nil {
-		return err
-	}
-	nameWithHash := fmt.Sprintf("%s-%s", res.GetName(), h)
-	res.SetName(nameWithHash)
-	return nil
-}

pkg/transformers/namehash_test.go

@@ -1,162 +0,0 @@
-/*
-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 transformers
-
-import (
-	"reflect"
-	"testing"
-
-	"sigs.k8s.io/kustomize/internal/k8sdeps"
-	"sigs.k8s.io/kustomize/pkg/ifc"
-	"sigs.k8s.io/kustomize/pkg/resid"
-	"sigs.k8s.io/kustomize/pkg/resmap"
-	"sigs.k8s.io/kustomize/pkg/resource"
-)
-
-func TestNameHashTransformer(t *testing.T) {
-	rf := resource.NewFactory(
-		k8sdeps.NewKunstructuredFactoryImpl())
-	objs := resmap.ResMap{
-		resid.NewResId(cmap, "cm1"): rf.FromMap(
-			map[string]interface{}{
-				"apiVersion": "v1",
-				"kind":       "ConfigMap",
-				"metadata": map[string]interface{}{
-					"name": "cm1",
-				},
-			}),
-		resid.NewResId(deploy, "deploy1"): rf.FromMap(
-			map[string]interface{}{
-				"group":      "apps",
-				"apiVersion": "v1",
-				"kind":       "Deployment",
-				"metadata": map[string]interface{}{
-					"name": "deploy1",
-				},
-				"spec": map[string]interface{}{
-					"template": map[string]interface{}{
-						"metadata": map[string]interface{}{
-							"labels": map[string]interface{}{
-								"old-label": "old-value",
-							},
-						},
-						"spec": map[string]interface{}{
-							"containers": []interface{}{
-								map[string]interface{}{
-									"name":  "nginx",
-									"image": "nginx:1.7.9",
-								},
-							},
-						},
-					},
-				},
-			}),
-		resid.NewResId(service, "svc1"): rf.FromMap(
-			map[string]interface{}{
-				"apiVersion": "v1",
-				"kind":       "Service",
-				"metadata": map[string]interface{}{
-					"name": "svc1",
-				},
-				"spec": map[string]interface{}{
-					"ports": []interface{}{
-						map[string]interface{}{
-							"name": "port1",
-							"port": "12345",
-						},
-					},
-				},
-			}),
-		resid.NewResId(secret, "secret1"): rf.FromMap(
-			map[string]interface{}{
-				"apiVersion": "v1",
-				"kind":       "Secret",
-				"metadata": map[string]interface{}{
-					"name": "secret1",
-				},
-			}).SetBehavior(ifc.BehaviorCreate),
-	}
-
-	expected := resmap.ResMap{
-		resid.NewResId(cmap, "cm1"): rf.FromMap(
-			map[string]interface{}{
-				"apiVersion": "v1",
-				"kind":       "ConfigMap",
-				"metadata": map[string]interface{}{
-					"name": "cm1",
-				},
-			}),
-		resid.NewResId(deploy, "deploy1"): rf.FromMap(
-			map[string]interface{}{
-				"group":      "apps",
-				"apiVersion": "v1",
-				"kind":       "Deployment",
-				"metadata": map[string]interface{}{
-					"name": "deploy1",
-				},
-				"spec": map[string]interface{}{
-					"template": map[string]interface{}{
-						"metadata": map[string]interface{}{
-							"labels": map[string]interface{}{
-								"old-label": "old-value",
-							},
-						},
-						"spec": map[string]interface{}{
-							"containers": []interface{}{
-								map[string]interface{}{
-									"name":  "nginx",
-									"image": "nginx:1.7.9",
-								},
-							},
-						},
-					},
-				},
-			}),
-		resid.NewResId(service, "svc1"): rf.FromMap(
-			map[string]interface{}{
-				"apiVersion": "v1",
-				"kind":       "Service",
-				"metadata": map[string]interface{}{
-					"name": "svc1",
-				},
-				"spec": map[string]interface{}{
-					"ports": []interface{}{
-						map[string]interface{}{
-							"name": "port1",
-							"port": "12345",
-						},
-					},
-				},
-			}),
-		resid.NewResId(secret, "secret1"): rf.FromMap(
-			map[string]interface{}{
-				"apiVersion": "v1",
-				"kind":       "Secret",
-				"metadata": map[string]interface{}{
-					"name": "secret1-7kc45hd5f7",
-				},
-			}).SetBehavior(ifc.BehaviorCreate),
-	}
-
-	tran := NewNameHashTransformer(k8sdeps.NewKustHash())
-	tran.Transform(objs)
-
-	if !reflect.DeepEqual(objs, expected) {
-		err := expected.ErrorIfNotEqual(objs)
-		t.Fatalf("actual doesn't match expected: %v", err)
-	}
-}