From 04a030bcf005bf6dd6a4d17d52c0af1bdf6c713c Mon Sep 17 00:00:00 2001 From: zoncoen Date: Thu, 15 Nov 2018 19:04:11 +0900 Subject: [PATCH 1/3] enable nameSuffix field of kustomization.yaml --- pkg/resid/resid.go | 8 ++++++++ pkg/target/kusttarget.go | 2 +- pkg/target/kusttarget_test.go | 21 +++++++++++---------- pkg/types/kustomization.go | 4 ++++ 4 files changed, 24 insertions(+), 11 deletions(-) diff --git a/pkg/resid/resid.go b/pkg/resid/resid.go index 84d738d1b..47df4efc6 100644 --- a/pkg/resid/resid.go +++ b/pkg/resid/resid.go @@ -17,6 +17,7 @@ limitations under the License. package resid import ( + "fmt" "strings" "sigs.k8s.io/kustomize/pkg/gvk" @@ -134,6 +135,13 @@ func (n ResId) Name() string { return n.name } +// NameWithPrefixSuffix returns resource name with prefix and suffix. +func (n ResId) NameWithPrefixSuffix() string { + prefix := strings.Join(n.prefixList(), "") + suffix := strings.Join(n.suffixList(), "") + return fmt.Sprintf("%s%s%s", prefix, n.name, suffix) +} + // Prefix returns name prefix. func (n ResId) Prefix() string { return n.prefix diff --git a/pkg/target/kusttarget.go b/pkg/target/kusttarget.go index 5e43fc0aa..97985678a 100644 --- a/pkg/target/kusttarget.go +++ b/pkg/target/kusttarget.go @@ -284,7 +284,7 @@ func (kt *KustTarget) newTransformer(patches []*resource.Resource) (transformers string(kt.kustomization.Namespace), kt.tConfig.NameSpace)) t, err = transformers.NewNamePrefixSuffixTransformer( string(kt.kustomization.NamePrefix), - "", // TODO(zoncoen): pass the name suffix + string(kt.kustomization.NameSuffix), kt.tConfig.NamePrefix, ) if err != nil { diff --git a/pkg/target/kusttarget_test.go b/pkg/target/kusttarget_test.go index 4bc6dc18a..323dae50b 100644 --- a/pkg/target/kusttarget_test.go +++ b/pkg/target/kusttarget_test.go @@ -39,6 +39,7 @@ import ( const ( kustomizationContent1 = ` namePrefix: foo- +nameSuffix: -bar namespace: ns1 commonLabels: app: nginx @@ -132,12 +133,12 @@ var ns = gvk.Gvk{Version: "v1", Kind: "Namespace"} func TestResources1(t *testing.T) { expected := resmap.ResMap{ - resid.NewResIdWithPrefixNamespace(deploy, "dply1", "foo-", "ns1"): rf.RF().FromMap( + resid.NewResIdWithPrefixSuffixNamespace(deploy, "dply1", "foo-", "-bar", "ns1"): rf.RF().FromMap( map[string]interface{}{ "apiVersion": "apps/v1", "kind": "Deployment", "metadata": map[string]interface{}{ - "name": "foo-dply1", + "name": "foo-dply1-bar", "namespace": "ns1", "labels": map[string]interface{}{ "app": "nginx", @@ -165,12 +166,12 @@ func TestResources1(t *testing.T) { }, }, }), - resid.NewResIdWithPrefixNamespace(cmap, "literalConfigMap", "foo-", "ns1"): rf.RF().FromMap( + resid.NewResIdWithPrefixSuffixNamespace(cmap, "literalConfigMap", "foo-", "-bar", "ns1"): rf.RF().FromMap( map[string]interface{}{ "apiVersion": "v1", "kind": "ConfigMap", "metadata": map[string]interface{}{ - "name": "foo-literalConfigMap-mc92bgcbh5", + "name": "foo-literalConfigMap-bar-8d2dkb8k24", "namespace": "ns1", "labels": map[string]interface{}{ "app": "nginx", @@ -184,12 +185,12 @@ func TestResources1(t *testing.T) { "DB_PASSWORD": "somepw", }, }).SetBehavior(ifc.BehaviorCreate), - resid.NewResIdWithPrefixNamespace(secret, "secret", "foo-", "ns1"): rf.RF().FromMap( + resid.NewResIdWithPrefixSuffixNamespace(secret, "secret", "foo-", "-bar", "ns1"): rf.RF().FromMap( map[string]interface{}{ "apiVersion": "v1", "kind": "Secret", "metadata": map[string]interface{}{ - "name": "foo-secret-877fcfhgt5", + "name": "foo-secret-bar-9btc7bt4kb", "namespace": "ns1", "labels": map[string]interface{}{ "app": "nginx", @@ -204,12 +205,12 @@ func TestResources1(t *testing.T) { "DB_PASSWORD": base64.StdEncoding.EncodeToString([]byte("somepw")), }, }).SetBehavior(ifc.BehaviorCreate), - resid.NewResIdWithPrefixNamespace(ns, "ns1", "foo-", ""): rf.RF().FromMap( + resid.NewResIdWithPrefixSuffixNamespace(ns, "ns1", "foo-", "-bar", ""): rf.RF().FromMap( map[string]interface{}{ "apiVersion": "v1", "kind": "Namespace", "metadata": map[string]interface{}{ - "name": "foo-ns1", + "name": "foo-ns1-bar", "labels": map[string]interface{}{ "app": "nginx", }, @@ -270,8 +271,8 @@ func TestDisableNameSuffixHash(t *testing.T) { } for id, r := range actual { - if !strings.HasSuffix(r.GetName(), id.Name()) { - t.Fatalf("unexpected hash was added to %s: %s", id.Name(), r.GetName()) + if r.GetName() != id.NameWithPrefixSuffix() { + t.Errorf("unexpected hash was added to %s: %s", id.NameWithPrefixSuffix(), r.GetName()) } } } diff --git a/pkg/types/kustomization.go b/pkg/types/kustomization.go index bfa0037e3..e39268f3f 100644 --- a/pkg/types/kustomization.go +++ b/pkg/types/kustomization.go @@ -42,6 +42,10 @@ type Kustomization struct { // file including generated configmaps and secrets. NamePrefix string `json:"namePrefix,omitempty" yaml:"namePrefix,omitempty"` + // NameSuffix will suffix the names of all resources mentioned in the kustomization + // file including generated configmaps and secrets. + NameSuffix string `json:"nameSuffix,omitempty" yaml:"nameSuffix,omitempty"` + // Namespace to add to all objects. Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"` From 3488b542ac87643c423de163b7c948223d63349a Mon Sep 17 00:00:00 2001 From: zoncoen Date: Thu, 15 Nov 2018 19:04:31 +0900 Subject: [PATCH 2/3] add edit command option for editing name suffix --- pkg/commands/edit/all.go | 3 + pkg/commands/edit/set/all.go | 4 + pkg/commands/edit/set/set_name_suffix.go | 86 +++++++++++++++++++ pkg/commands/edit/set/set_name_suffix_test.go | 60 +++++++++++++ pkg/commands/kustfile/kustomizationfile.go | 1 + .../kustfile/kustomizationfile_test.go | 5 ++ pkg/fs/fakefs.go | 4 +- 7 files changed, 162 insertions(+), 1 deletion(-) create mode 100644 pkg/commands/edit/set/set_name_suffix.go create mode 100644 pkg/commands/edit/set/set_name_suffix_test.go diff --git a/pkg/commands/edit/all.go b/pkg/commands/edit/all.go index 74bc747bb..fd27e38de 100644 --- a/pkg/commands/edit/all.go +++ b/pkg/commands/edit/all.go @@ -36,6 +36,9 @@ func NewCmdEdit(fsys fs.FileSystem, v ifc.Validator, kf ifc.KunstructuredFactory # Sets the nameprefix field kustomize edit set nameprefix + + # Sets the namesuffix field + kustomize edit set namesuffix `, Args: cobra.MinimumNArgs(1), } diff --git a/pkg/commands/edit/set/all.go b/pkg/commands/edit/set/all.go index 466b0c74d..67321bbe8 100644 --- a/pkg/commands/edit/set/all.go +++ b/pkg/commands/edit/set/all.go @@ -31,12 +31,16 @@ func NewCmdSet(fsys fs.FileSystem, v ifc.Validator) *cobra.Command { Example: ` # Sets the nameprefix field kustomize edit set nameprefix + + # Sets the namesuffix field + kustomize edit set namesuffix `, Args: cobra.MinimumNArgs(1), } c.AddCommand( newCmdSetNamePrefix(fsys), + newCmdSetNameSuffix(fsys), newCmdSetNamespace(fsys, v), newCmdSetImageTag(fsys), ) diff --git a/pkg/commands/edit/set/set_name_suffix.go b/pkg/commands/edit/set/set_name_suffix.go new file mode 100644 index 000000000..c4b310d6c --- /dev/null +++ b/pkg/commands/edit/set/set_name_suffix.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 set + +import ( + "errors" + + "github.com/spf13/cobra" + "sigs.k8s.io/kustomize/pkg/commands/kustfile" + "sigs.k8s.io/kustomize/pkg/fs" +) + +type setNameSuffixOptions struct { + suffix string +} + +// newCmdSetNameSuffix sets the value of the nameSuffix field in the kustomization. +func newCmdSetNameSuffix(fsys fs.FileSystem) *cobra.Command { + var o setNameSuffixOptions + + cmd := &cobra.Command{ + Use: "namesuffix", + Short: "Sets the value of the nameSuffix field in the kustomization file.", + Example: ` +The command + set namesuffix -acme +will add the field "nameSuffix: -acme" to the kustomization file if it doesn't exist, +and overwrite the value with "-acme" if the field does exist. +`, + RunE: func(cmd *cobra.Command, args []string) error { + err := o.Validate(args) + if err != nil { + return err + } + err = o.Complete(cmd, args) + if err != nil { + return err + } + return o.RunSetNameSuffix(fsys) + }, + } + return cmd +} + +// Validate validates setNameSuffix command. +func (o *setNameSuffixOptions) Validate(args []string) error { + if len(args) != 1 { + return errors.New("must specify exactly one suffix value") + } + // TODO: add further validation on the value. + o.suffix = args[0] + return nil +} + +// Complete completes setNameSuffix command. +func (o *setNameSuffixOptions) Complete(cmd *cobra.Command, args []string) error { + return nil +} + +// RunSetNameSuffix runs setNameSuffix command (does real work). +func (o *setNameSuffixOptions) RunSetNameSuffix(fSys fs.FileSystem) error { + mf, err := kustfile.NewKustomizationFile(fSys) + if err != nil { + return err + } + m, err := mf.Read() + if err != nil { + return err + } + m.NameSuffix = o.suffix + return mf.Write(m) +} diff --git a/pkg/commands/edit/set/set_name_suffix_test.go b/pkg/commands/edit/set/set_name_suffix_test.go new file mode 100644 index 000000000..9e18e7dc6 --- /dev/null +++ b/pkg/commands/edit/set/set_name_suffix_test.go @@ -0,0 +1,60 @@ +/* +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 set + +import ( + "strings" + "testing" + + "sigs.k8s.io/kustomize/pkg/fs" +) + +const ( + goodSuffixValue = "-acme" +) + +func TestSetNameSuffixHappyPath(t *testing.T) { + fakeFS := fs.MakeFakeFS() + fakeFS.WriteTestKustomization() + + cmd := newCmdSetNameSuffix(fakeFS) + args := []string{goodSuffixValue} + err := cmd.RunE(cmd, args) + if err != nil { + t.Errorf("unexpected cmd error: %v", err) + } + content, err := fakeFS.ReadTestKustomization() + if err != nil { + t.Errorf("unexpected read error: %v", err) + } + if !strings.Contains(string(content), goodSuffixValue) { + t.Errorf("expected suffix value in kustomization file") + } +} + +func TestSetNameSuffixNoArgs(t *testing.T) { + fakeFS := fs.MakeFakeFS() + + cmd := newCmdSetNameSuffix(fakeFS) + err := cmd.Execute() + if err == nil { + t.Errorf("expected error: %v", err) + } + if err.Error() != "must specify exactly one suffix value" { + t.Errorf("incorrect error: %v", err.Error()) + } +} diff --git a/pkg/commands/kustfile/kustomizationfile.go b/pkg/commands/kustfile/kustomizationfile.go index a94665465..64de7c35c 100644 --- a/pkg/commands/kustfile/kustomizationfile.go +++ b/pkg/commands/kustfile/kustomizationfile.go @@ -54,6 +54,7 @@ func determineFieldOrder() []string { "Resources", "Bases", "NamePrefix", + "NameSuffix", "Namespace", "Crds", "CommonLabels", diff --git a/pkg/commands/kustfile/kustomizationfile_test.go b/pkg/commands/kustfile/kustomizationfile_test.go index 3ad489304..c1f74d0b4 100644 --- a/pkg/commands/kustfile/kustomizationfile_test.go +++ b/pkg/commands/kustfile/kustomizationfile_test.go @@ -33,6 +33,7 @@ func TestFieldOrder(t *testing.T) { "Resources", "Bases", "NamePrefix", + "NameSuffix", "Namespace", "Crds", "CommonLabels", @@ -85,6 +86,7 @@ func TestWriteAndRead(t *testing.T) { func TestDeprecationOfPatches(t *testing.T) { hasDeprecatedFields := []byte(` namePrefix: acme +nameSuffix: emca patches: - alice patchesStrategicMerge: @@ -103,6 +105,9 @@ patchesStrategicMerge: if k.NamePrefix != "acme" { t.Fatalf("Unexpected name prefix") } + if k.NameSuffix != "emca" { + t.Fatalf("Unexpected name suffix") + } if len(k.Patches) > 0 { t.Fatalf("Expected nothing in Patches.") } diff --git a/pkg/fs/fakefs.go b/pkg/fs/fakefs.go index 4695aa736..e72ee3829 100644 --- a/pkg/fs/fakefs.go +++ b/pkg/fs/fakefs.go @@ -19,9 +19,10 @@ package fs import ( "fmt" "path/filepath" - "sigs.k8s.io/kustomize/pkg/constants" "sort" "strings" + + "sigs.k8s.io/kustomize/pkg/constants" ) var _ FileSystem = &fakeFs{} @@ -40,6 +41,7 @@ func MakeFakeFS() *fakeFs { // kustomizationContent is used in tests. const kustomizationContent = `namePrefix: some-prefix +nameSuffix: some-suffix # Labels to add to all objects and selectors. # These labels would also be used to form the selector for apply --prune # Named differently than “labels” to avoid confusion with metadata for this object From b8c2ed20d148f9c852c73755547765e4d870dcbb Mon Sep 17 00:00:00 2001 From: zoncoen Date: Tue, 20 Nov 2018 17:09:40 +0900 Subject: [PATCH 3/3] fix the command usage --- pkg/commands/edit/set/set_name_suffix.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/commands/edit/set/set_name_suffix.go b/pkg/commands/edit/set/set_name_suffix.go index c4b310d6c..25ecafe35 100644 --- a/pkg/commands/edit/set/set_name_suffix.go +++ b/pkg/commands/edit/set/set_name_suffix.go @@ -37,7 +37,7 @@ func newCmdSetNameSuffix(fsys fs.FileSystem) *cobra.Command { Short: "Sets the value of the nameSuffix field in the kustomization file.", Example: ` The command - set namesuffix -acme + set namesuffix -- -acme will add the field "nameSuffix: -acme" to the kustomization file if it doesn't exist, and overwrite the value with "-acme" if the field does exist. `,