Merge pull request #451 from Liujingfang1/hash

add MakeHashTransformer in TransformerFactory; remove hash interface
This commit is contained in:
k8s-ci-robot
2018-10-10 14:10:48 -07:00
committed by GitHub
16 changed files with 88 additions and 66 deletions

View File

@@ -0,0 +1,43 @@
/*
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 transformer provides transformer factory
package transformer
import (
"sigs.k8s.io/kustomize/internal/k8sdeps/transformer/hash"
"sigs.k8s.io/kustomize/internal/k8sdeps/transformer/patch"
"sigs.k8s.io/kustomize/pkg/resource"
"sigs.k8s.io/kustomize/pkg/transformers"
)
// factoryImpl makes patch transformer and name hash transformer
type factoryImpl struct{}
// NewFactoryImpl makes a new factoryImpl instance
func NewFactoryImpl() *factoryImpl {
return &factoryImpl{}
}
// MakePatchTransformer makes a new patch transformer
func (p *factoryImpl) MakePatchTransformer(slice []*resource.Resource, rf *resource.Factory) (transformers.Transformer, error) {
return patch.NewPatchTransformer(slice, rf)
}
// MakeHashTransformer makes a new name hash transformer
func (p *factoryImpl) MakeHashTransformer() transformers.Transformer {
return hash.NewNameHashTransformer()
}

View File

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
package k8sdeps package hash
import ( import (
"crypto/sha256" "crypto/sha256"

View File

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
package k8sdeps package hash
import ( import (
"reflect" "reflect"
@@ -22,8 +22,14 @@ import (
"testing" "testing"
"k8s.io/api/core/v1" "k8s.io/api/core/v1"
"sigs.k8s.io/kustomize/pkg/gvk"
) )
var service = gvk.Gvk{Version: "v1", Kind: "Service"}
var secret = gvk.Gvk{Version: "v1", Kind: "Secret"}
var cmap = gvk.Gvk{Version: "v1", Kind: "ConfigMap"}
var deploy = gvk.Gvk{Group: "apps", Version: "v1", Kind: "Deployment"}
func TestConfigMapHash(t *testing.T) { func TestConfigMapHash(t *testing.T) {
cases := []struct { cases := []struct {
desc string desc string

View File

@@ -14,27 +14,25 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
package transformers package hash
import ( import (
"fmt" "fmt"
"sigs.k8s.io/kustomize/pkg/ifc"
"sigs.k8s.io/kustomize/pkg/resmap" "sigs.k8s.io/kustomize/pkg/resmap"
"sigs.k8s.io/kustomize/pkg/resource" "sigs.k8s.io/kustomize/pkg/resource"
"sigs.k8s.io/kustomize/pkg/transformers"
) )
// nameHashTransformer contains the prefix and the path config for each field that // nameHashTransformer contains the prefix and the path config for each field that
// the name prefix will be applied. // the name prefix will be applied.
type nameHashTransformer struct { type nameHashTransformer struct{}
hash ifc.Hash
}
var _ Transformer = &nameHashTransformer{} var _ transformers.Transformer = &nameHashTransformer{}
// NewNameHashTransformer construct a nameHashTransformer. // NewNameHashTransformer construct a nameHashTransformer.
func NewNameHashTransformer(h ifc.Hash) Transformer { func NewNameHashTransformer() transformers.Transformer {
return &nameHashTransformer{hash: h} return &nameHashTransformer{}
} }
// Transform appends hash to configmaps and secrets. // Transform appends hash to configmaps and secrets.
@@ -51,7 +49,7 @@ func (o *nameHashTransformer) Transform(m resmap.ResMap) error {
} }
func (o *nameHashTransformer) appendHash(res *resource.Resource) error { func (o *nameHashTransformer) appendHash(res *resource.Resource) error {
h, err := o.hash.Hash(res.Map()) h, err := NewKustHash().Hash(res.Map())
if err != nil { if err != nil {
return err return err
} }

View File

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
package transformers package hash
import ( import (
"reflect" "reflect"
@@ -152,7 +152,7 @@ func TestNameHashTransformer(t *testing.T) {
}).SetBehavior(ifc.BehaviorCreate), }).SetBehavior(ifc.BehaviorCreate),
} }
tran := NewNameHashTransformer(k8sdeps.NewKustHash()) tran := NewNameHashTransformer()
tran.Transform(objs) tran.Transform(objs)
if !reflect.DeepEqual(objs, expected) { if !reflect.DeepEqual(objs, expected) {

View File

@@ -31,19 +31,6 @@ import (
"sigs.k8s.io/kustomize/pkg/transformers" "sigs.k8s.io/kustomize/pkg/transformers"
) )
// patchTransformerFactory makes patch transformer
type patchTransformerFactory struct{}
// NewPatchTransformerFactory makes a new patchTransformerFactory
func NewPatchTransformerFactory() *patchTransformerFactory {
return &patchTransformerFactory{}
}
// MakePatchTransformer makes a new patch transformer
func (p *patchTransformerFactory) MakePatchTransformer(slice []*resource.Resource, rf *resource.Factory) (transformers.Transformer, error) {
return NewPatchTransformer(slice, rf)
}
// patchTransformer applies patches. // patchTransformer applies patches.
type patchTransformer struct { type patchTransformer struct {
patches []*resource.Resource patches []*resource.Resource

View File

@@ -21,7 +21,7 @@ import (
"github.com/golang/glog" "github.com/golang/glog"
"sigs.k8s.io/kustomize/internal/k8sdeps" "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" "sigs.k8s.io/kustomize/pkg/commands"
) )
@@ -30,9 +30,8 @@ func main() {
if err := commands.NewDefaultCommand( if err := commands.NewDefaultCommand(
k8sdeps.NewKunstructuredFactoryImpl(), k8sdeps.NewKunstructuredFactoryImpl(),
patch.NewPatchTransformerFactory(), transformer.NewFactoryImpl(),
k8sdeps.NewKustValidator(), k8sdeps.NewKustValidator()).Execute(); err != nil {
k8sdeps.NewKustHash()).Execute(); err != nil {
os.Exit(1) os.Exit(1)
} }
os.Exit(0) os.Exit(0)

View File

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

View File

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

View File

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

View File

@@ -42,11 +42,6 @@ type Loader interface {
Cleanup() error 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 // Kunstructured allows manipulation of k8s objects
// that do not have Golang structs. // that do not have Golang structs.
type Kunstructured interface { type Kunstructured interface {

View File

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

View File

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

View File

@@ -23,7 +23,7 @@ import (
"testing" "testing"
"sigs.k8s.io/kustomize/internal/k8sdeps" "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/constants"
"sigs.k8s.io/kustomize/pkg/fs" "sigs.k8s.io/kustomize/pkg/fs"
"sigs.k8s.io/kustomize/pkg/gvk" "sigs.k8s.io/kustomize/pkg/gvk"
@@ -95,9 +95,8 @@ func makeKustTarget(t *testing.T, l ifc.Loader) *KustTarget {
fakeFs := fs.MakeFakeFS() fakeFs := fs.MakeFakeFS()
fakeFs.Mkdir("/") fakeFs.Mkdir("/")
kt, err := NewKustTarget( kt, err := NewKustTarget(
l, fakeFs, rf, patch.NewPatchTransformerFactory(), l, fakeFs, rf, transformer.NewFactoryImpl(),
transformerconfig.NewFactory(l).DefaultConfig(), transformerconfig.NewFactory(l).DefaultConfig())
k8sdeps.NewKustHash())
if err != nil { if err != nil {
t.Fatalf("Unexpected construction error %v", err) t.Fatalf("Unexpected construction error %v", err)
} }