mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-11 17:12:51 +00:00
add edit command option for editing name suffix
This commit is contained in:
@@ -36,6 +36,9 @@ func NewCmdEdit(fsys fs.FileSystem, v ifc.Validator, kf ifc.KunstructuredFactory
|
|||||||
|
|
||||||
# Sets the nameprefix field
|
# Sets the nameprefix field
|
||||||
kustomize edit set nameprefix <prefix-value>
|
kustomize edit set nameprefix <prefix-value>
|
||||||
|
|
||||||
|
# Sets the namesuffix field
|
||||||
|
kustomize edit set namesuffix <suffix-value>
|
||||||
`,
|
`,
|
||||||
Args: cobra.MinimumNArgs(1),
|
Args: cobra.MinimumNArgs(1),
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -31,12 +31,16 @@ func NewCmdSet(fsys fs.FileSystem, v ifc.Validator) *cobra.Command {
|
|||||||
Example: `
|
Example: `
|
||||||
# Sets the nameprefix field
|
# Sets the nameprefix field
|
||||||
kustomize edit set nameprefix <prefix-value>
|
kustomize edit set nameprefix <prefix-value>
|
||||||
|
|
||||||
|
# Sets the namesuffix field
|
||||||
|
kustomize edit set namesuffix <suffix-value>
|
||||||
`,
|
`,
|
||||||
Args: cobra.MinimumNArgs(1),
|
Args: cobra.MinimumNArgs(1),
|
||||||
}
|
}
|
||||||
|
|
||||||
c.AddCommand(
|
c.AddCommand(
|
||||||
newCmdSetNamePrefix(fsys),
|
newCmdSetNamePrefix(fsys),
|
||||||
|
newCmdSetNameSuffix(fsys),
|
||||||
newCmdSetNamespace(fsys, v),
|
newCmdSetNamespace(fsys, v),
|
||||||
newCmdSetImageTag(fsys),
|
newCmdSetImageTag(fsys),
|
||||||
)
|
)
|
||||||
|
|||||||
86
pkg/commands/edit/set/set_name_suffix.go
Normal file
86
pkg/commands/edit/set/set_name_suffix.go
Normal file
@@ -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)
|
||||||
|
}
|
||||||
60
pkg/commands/edit/set/set_name_suffix_test.go
Normal file
60
pkg/commands/edit/set/set_name_suffix_test.go
Normal file
@@ -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())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -54,6 +54,7 @@ func determineFieldOrder() []string {
|
|||||||
"Resources",
|
"Resources",
|
||||||
"Bases",
|
"Bases",
|
||||||
"NamePrefix",
|
"NamePrefix",
|
||||||
|
"NameSuffix",
|
||||||
"Namespace",
|
"Namespace",
|
||||||
"Crds",
|
"Crds",
|
||||||
"CommonLabels",
|
"CommonLabels",
|
||||||
|
|||||||
@@ -33,6 +33,7 @@ func TestFieldOrder(t *testing.T) {
|
|||||||
"Resources",
|
"Resources",
|
||||||
"Bases",
|
"Bases",
|
||||||
"NamePrefix",
|
"NamePrefix",
|
||||||
|
"NameSuffix",
|
||||||
"Namespace",
|
"Namespace",
|
||||||
"Crds",
|
"Crds",
|
||||||
"CommonLabels",
|
"CommonLabels",
|
||||||
@@ -85,6 +86,7 @@ func TestWriteAndRead(t *testing.T) {
|
|||||||
func TestDeprecationOfPatches(t *testing.T) {
|
func TestDeprecationOfPatches(t *testing.T) {
|
||||||
hasDeprecatedFields := []byte(`
|
hasDeprecatedFields := []byte(`
|
||||||
namePrefix: acme
|
namePrefix: acme
|
||||||
|
nameSuffix: emca
|
||||||
patches:
|
patches:
|
||||||
- alice
|
- alice
|
||||||
patchesStrategicMerge:
|
patchesStrategicMerge:
|
||||||
@@ -103,6 +105,9 @@ patchesStrategicMerge:
|
|||||||
if k.NamePrefix != "acme" {
|
if k.NamePrefix != "acme" {
|
||||||
t.Fatalf("Unexpected name prefix")
|
t.Fatalf("Unexpected name prefix")
|
||||||
}
|
}
|
||||||
|
if k.NameSuffix != "emca" {
|
||||||
|
t.Fatalf("Unexpected name suffix")
|
||||||
|
}
|
||||||
if len(k.Patches) > 0 {
|
if len(k.Patches) > 0 {
|
||||||
t.Fatalf("Expected nothing in Patches.")
|
t.Fatalf("Expected nothing in Patches.")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -19,9 +19,10 @@ package fs
|
|||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"sigs.k8s.io/kustomize/pkg/constants"
|
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"sigs.k8s.io/kustomize/pkg/constants"
|
||||||
)
|
)
|
||||||
|
|
||||||
var _ FileSystem = &fakeFs{}
|
var _ FileSystem = &fakeFs{}
|
||||||
@@ -40,6 +41,7 @@ func MakeFakeFS() *fakeFs {
|
|||||||
|
|
||||||
// kustomizationContent is used in tests.
|
// kustomizationContent is used in tests.
|
||||||
const kustomizationContent = `namePrefix: some-prefix
|
const kustomizationContent = `namePrefix: some-prefix
|
||||||
|
nameSuffix: some-suffix
|
||||||
# Labels to add to all objects and selectors.
|
# Labels to add to all objects and selectors.
|
||||||
# These labels would also be used to form the selector for apply --prune
|
# 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
|
# Named differently than “labels” to avoid confusion with metadata for this object
|
||||||
|
|||||||
Reference in New Issue
Block a user