mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-13 18:10:59 +00:00
Add subcommand for adding patches to the kustomization file.
This commit is contained in:
96
commands/addpatch.go
Normal file
96
commands/addpatch.go
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2017 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 commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"k8s.io/kubectl/pkg/kustomize/constants"
|
||||||
|
"k8s.io/kubectl/pkg/kustomize/util/fs"
|
||||||
|
)
|
||||||
|
|
||||||
|
type addPatchOptions struct {
|
||||||
|
patchFilePath string
|
||||||
|
}
|
||||||
|
|
||||||
|
// newCmdAddPatch adds the name of a file containing a patch to the kustomization file.
|
||||||
|
func newCmdAddPatch(out, errOut io.Writer, fsys fs.FileSystem) *cobra.Command {
|
||||||
|
var o addPatchOptions
|
||||||
|
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "patch",
|
||||||
|
Short: "Add the name of a file containing a patch to the kustomization file.",
|
||||||
|
Example: `
|
||||||
|
add patch {filepath}`,
|
||||||
|
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.RunAddPatch(out, errOut, fsys)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate validates addPatch command.
|
||||||
|
func (o *addPatchOptions) Validate(args []string) error {
|
||||||
|
if len(args) != 1 {
|
||||||
|
return errors.New("must specify a patch file")
|
||||||
|
}
|
||||||
|
o.patchFilePath = args[0]
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Complete completes addPatch command.
|
||||||
|
func (o *addPatchOptions) Complete(cmd *cobra.Command, args []string) error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RunAddPatch runs addPatch command (do real work).
|
||||||
|
func (o *addPatchOptions) RunAddPatch(out, errOut io.Writer, fsys fs.FileSystem) error {
|
||||||
|
_, err := fsys.Stat(o.patchFilePath)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
mf, err := newKustomizationFile(constants.KustomizationFileName, fsys)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
m, err := mf.read()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if stringInSlice(o.patchFilePath, m.Patches) {
|
||||||
|
return fmt.Errorf("patch %s already in kustomization file", o.patchFilePath)
|
||||||
|
}
|
||||||
|
|
||||||
|
m.Patches = append(m.Patches, o.patchFilePath)
|
||||||
|
|
||||||
|
return mf.write(m)
|
||||||
|
}
|
||||||
94
commands/addpatch_test.go
Normal file
94
commands/addpatch_test.go
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2017 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 commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"k8s.io/kubectl/pkg/kustomize/constants"
|
||||||
|
"k8s.io/kubectl/pkg/kustomize/util/fs"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
patchFileName = "myWonderfulPatch.yaml"
|
||||||
|
patchFileContent = `
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
|
||||||
|
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||||
|
`
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestAddPatchHappyPath(t *testing.T) {
|
||||||
|
buf := bytes.NewBuffer([]byte{})
|
||||||
|
fakeFS := fs.MakeFakeFS()
|
||||||
|
fakeFS.WriteFile(patchFileName, []byte(patchFileContent))
|
||||||
|
fakeFS.WriteFile(constants.KustomizationFileName, []byte(kustomizationContent))
|
||||||
|
|
||||||
|
cmd := newCmdAddPatch(buf, os.Stderr, fakeFS)
|
||||||
|
args := []string{patchFileName}
|
||||||
|
err := cmd.RunE(cmd, args)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("unexpected cmd error: %v", err)
|
||||||
|
}
|
||||||
|
content, err := fakeFS.ReadFile(constants.KustomizationFileName)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("unexpected read error: %v", err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(string(content), patchFileName) {
|
||||||
|
t.Errorf("expected patch name in kustomization")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddPatchAlreadyThere(t *testing.T) {
|
||||||
|
buf := bytes.NewBuffer([]byte{})
|
||||||
|
fakeFS := fs.MakeFakeFS()
|
||||||
|
fakeFS.WriteFile(patchFileName, []byte(patchFileContent))
|
||||||
|
fakeFS.WriteFile(constants.KustomizationFileName, []byte(kustomizationContent))
|
||||||
|
|
||||||
|
cmd := newCmdAddPatch(buf, os.Stderr, fakeFS)
|
||||||
|
args := []string{patchFileName}
|
||||||
|
err := cmd.RunE(cmd, args)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected cmd error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// adding an existing patch should return an error
|
||||||
|
err = cmd.RunE(cmd, args)
|
||||||
|
if err == nil {
|
||||||
|
t.Errorf("expected already there problem")
|
||||||
|
}
|
||||||
|
if err.Error() != "patch "+patchFileName+" already in kustomization file" {
|
||||||
|
t.Errorf("unexpected error %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddPatchNoArgs(t *testing.T) {
|
||||||
|
buf := bytes.NewBuffer([]byte{})
|
||||||
|
fakeFS := fs.MakeFakeFS()
|
||||||
|
|
||||||
|
cmd := newCmdAddPatch(buf, os.Stderr, fakeFS)
|
||||||
|
err := cmd.Execute()
|
||||||
|
if err == nil {
|
||||||
|
t.Errorf("expected error: %v", err)
|
||||||
|
}
|
||||||
|
if err.Error() != "must specify a patch file" {
|
||||||
|
t.Errorf("incorrect error: %v", err.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -69,15 +69,6 @@ func (o *addResourceOptions) Complete(cmd *cobra.Command, args []string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func stringInSlice(str string, list []string) bool {
|
|
||||||
for _, v := range list {
|
|
||||||
if v == str {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// RunAddResource runs addResource command (do real work).
|
// RunAddResource runs addResource command (do real work).
|
||||||
func (o *addResourceOptions) RunAddResource(out, errOut io.Writer, fsys fs.FileSystem) error {
|
func (o *addResourceOptions) RunAddResource(out, errOut io.Writer, fsys fs.FileSystem) error {
|
||||||
_, err := fsys.Stat(o.resourceFilePath)
|
_, err := fsys.Stat(o.resourceFilePath)
|
||||||
|
|||||||
@@ -33,14 +33,13 @@ const (
|
|||||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
|
||||||
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||||
`
|
`
|
||||||
kustomizationContent = `kustomizationName: helloworld
|
kustomizationContent = `namePrefix: some-prefix
|
||||||
namePrefix: some-prefix
|
|
||||||
# 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
|
||||||
objectLabels:
|
commonLabels:
|
||||||
app: helloworld
|
app: helloworld
|
||||||
objectAnnotations:
|
commonAnnotations:
|
||||||
note: This is an example annotation
|
note: This is an example annotation
|
||||||
resources: []
|
resources: []
|
||||||
#- service.yaml
|
#- service.yaml
|
||||||
|
|||||||
@@ -92,11 +92,15 @@ func newCmdAdd(stdOut, stdErr io.Writer, fsys fs.FileSystem) *cobra.Command {
|
|||||||
|
|
||||||
# Adds a resource to the kustomization
|
# Adds a resource to the kustomization
|
||||||
kustomize edit add resource <filepath>
|
kustomize edit add resource <filepath>
|
||||||
|
|
||||||
|
# Adds a patch to the kustomization
|
||||||
|
kustomize edit add patch <filepath>
|
||||||
`,
|
`,
|
||||||
Args: cobra.MinimumNArgs(1),
|
Args: cobra.MinimumNArgs(1),
|
||||||
}
|
}
|
||||||
c.AddCommand(
|
c.AddCommand(
|
||||||
newCmdAddResource(stdOut, stdErr, fsys),
|
newCmdAddResource(stdOut, stdErr, fsys),
|
||||||
|
newCmdAddPatch(stdOut, stdErr, fsys),
|
||||||
newCmdAddConfigMap(stdErr, fsys),
|
newCmdAddConfigMap(stdErr, fsys),
|
||||||
)
|
)
|
||||||
return c
|
return c
|
||||||
|
|||||||
@@ -93,3 +93,12 @@ func (mf *kustomizationFile) write(kustomization *types.Kustomization) error {
|
|||||||
|
|
||||||
return mf.fsys.WriteFile(mf.path, bytes)
|
return mf.fsys.WriteFile(mf.path, bytes)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func stringInSlice(str string, list []string) bool {
|
||||||
|
for _, v := range list {
|
||||||
|
if v == str {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user