kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-06-11 09:02:53 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Removed individual files in favor of combined metadata file

Browse Source
This commit is contained in:
guineveresaenger
2018-07-17 13:50:12 -07:00
parent afac2fb46a
commit 187415430f
6 changed files with 13 additions and 489 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
pkg/commands/addannotation.go
View File

@@ -1,112 +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 commands
import (
// "errors"
// "fmt"
// "regexp"
// "strings"
"github.com/spf13/cobra"
// "github.com/kubernetes-sigs/kustomize/pkg/constants"
"github.com/kubernetes-sigs/kustomize/pkg/fs"
)
// type addAnnotationOptions struct {
// annotations string
// }
// newCmdAddAnnotation adds one or more commonAnnotations to the kustomization file.
func newCmdAddAnnotation(fsys fs.FileSystem) *cobra.Command {
var o addMetadataOptions
cmd := &cobra.Command{
Use: "annotation",
Short: "Adds one or more commonAnnotations to the kustomization.yaml in current directory",
Example: `
add annotation {annotationKey1:annotationValue1},{annotationKey2:annotationValue2}`,
RunE: func(cmd *cobra.Command, args []string) error {
mdKind := "annotation"
err := o.Validate(args, mdKind)
if err != nil {
return err
}
err = o.Complete(cmd, args)
if err != nil {
return err
}
return o.RunAddMetadata(fsys, mdKind)
},
}
return cmd
}
// // Validate validates addAnnotation command.
// func (o *addAnnotationOptions) Validate(args []string) error {
// if len(args) < 1 {
// return errors.New("must specify an annotation")
// }
// if len(args) > 1 {
// return errors.New("annotations must be comma-separated, with no spaces. See help text for example.")
// }
// inputs := strings.Split(args[0], ",")
// for _, input := range inputs {
// ok, err := regexp.MatchString(`\A([a-zA-Z0-9_.-]+):([a-zA-Z0-9_.-]+)\z`, input)
// if err != nil {
// return err
// }
// if !ok {
// return fmt.Errorf("invalid annotation format: %s", input)
// }
// }
// o.annotations = args[0]
// return nil
// }
// // Complete completes addAnnotation command.
// func (o *addAnnotationOptions) Complete(cmd *cobra.Command, args []string) error {
// return nil
// }
// // RunAddAnnotation runs addAnnotation command (do real work).
// func (o *addAnnotationOptions) RunAddAnnotation(fsys fs.FileSystem) error {
// mf, err := newKustomizationFile(constants.KustomizationFileName, fsys)
// if err != nil {
// return err
// }
// m, err := mf.read()
// if err != nil {
// return err
// }
// if m.CommonAnnotations == nil {
// m.CommonAnnotations = make(map[string]string)
// }
// annotations := strings.Split(o.annotations, ",")
// for _, ann := range annotations {
// kv := strings.Split(ann, ":")
// if _, ok := m.CommonAnnotations[kv[0]]; ok {
// return fmt.Errorf("annotation %s already in kustomization file", kv[0])
// }
// m.CommonAnnotations[kv[0]] = kv[1]
// }
// return mf.write(m)
// }

126
pkg/commands/addannotation_test.go
View File

@@ -1,126 +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 commands
import (
"testing"
"strings"
"github.com/kubernetes-sigs/kustomize/pkg/constants"
"github.com/kubernetes-sigs/kustomize/pkg/fs"
)
func TestAnnotationsValid(t *testing.T) {
var testcases = []struct {
input string
valid bool
name string
}{
{
input: "owls:great,unicorns:magical",
valid: true,
name: "Adds two annotations",
},
{
input: "owls:great",
valid: false,
name: "Annotation keys must be unique",
},
{
input: "otters:cute",
valid: true,
name: "Adds single annotation",
},
{
input: "dogs,cats",
valid: false,
name: "Does not contain colon",
},
{
input: ":noKey",
valid: false,
name: "Missing key",
},
{
input: "noValue:",
valid: false,
name: "Missing value",
},
}
fakeFS := fs.MakeFakeFS()
fakeFS.WriteFile(constants.KustomizationFileName, []byte(kustomizationContent))
cmd := newCmdAddAnnotation(fakeFS)
for _, tc := range testcases {
annotations := strings.Split(tc.input, ",")
//run command with test input
args := []string{tc.input}
err := cmd.RunE(cmd, args)
if err != nil && tc.valid {
t.Errorf("for test case %s, unexpected cmd error: %v", tc.name, err)
}
if err == nil && !tc.valid {
t.Errorf("unexpected error: expected invalid annotation format error for test case %v", tc.name)
}
if err == nil && (tc.name == "Annotation keys must be unique") {
t.Errorf("unexpected error: for test case %s, expected already there problem", tc.name)
}
content, readErr := fakeFS.ReadFile(constants.KustomizationFileName)
if readErr != nil {
t.Errorf("unexpected read error: %v", readErr)
}
//check if valid input was added to commonAnnotations
for _, annotation := range annotations {
key := strings.Split(annotation, ":")[0]
if !strings.Contains(string(content), key) && tc.valid {
t.Errorf("unexpected error: for test case %s, expected key to be in file.", tc.name)
}
}
}
}
func TestAddAnnotationNoArgs(t *testing.T) {
fakeFS := fs.MakeFakeFS()
cmd := newCmdAddAnnotation(fakeFS)
err := cmd.Execute()
if err == nil {
t.Errorf("expected an error but error is %v", err)
}
if err != nil && err.Error() != "must specify an annotation" {
t.Errorf("incorrect error: %v", err.Error())
}
}
func TestAddAnnotationMultipleArgs(t *testing.T) {
fakeFS := fs.MakeFakeFS()
fakeFS.WriteFile(constants.KustomizationFileName, []byte(kustomizationContent))
cmd := newCmdAddAnnotation(fakeFS)
args := []string{"this:input", "has:spaces"}
err := cmd.RunE(cmd, args)
if err == nil {
t.Errorf("expected an error but error is %v", err)
}
if err != nil && err.Error() != "annotations must be comma-separated, with no spaces. See help text for example." {
t.Errorf("incorrect error: %v", err.Error())
}
}

116
pkg/commands/addlabel.go
View File

@@ -1,116 +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 commands
import (
// "errors"
// "fmt"
// "regexp"
// "strings"
"github.com/spf13/cobra"
// "github.com/kubernetes-sigs/kustomize/pkg/constants"
"github.com/kubernetes-sigs/kustomize/pkg/fs"
)
// type addLabelOptions struct {
// labels string
// }
// newCmdAddLabel adds one or more commonLabels to the kustomization file.
func newCmdAddLabel(fsys fs.FileSystem) *cobra.Command {
var o addMetadataOptions
cmd := &cobra.Command{
Use: "label",
Short: "Adds one or more commonLabels to the kustomization.yaml in current directory",
Example: `
add label {labelKey1:labelValue1},{labelKey2:labelValue2}`,
RunE: func(cmd *cobra.Command, args []string) error {
mdKind := "label"
err := o.Validate(args, mdKind)
if err != nil {
return err
}
err = o.Complete(cmd, args)
if err != nil {
return err
}
return o.RunAddMetadata(fsys, mdKind)
},
}
return cmd
}
// // Validate validates addLabel command.
// func (o *addLabelOptions) Validate(args []string) error {
// if len(args) < 1 {
// return errors.New("must specify a label")
// }
// if len(args) > 1 {
// return errors.New("labels must be comma-separated, with no spaces. See help text for example.")
// }
// inputs := strings.Split(args[0], ",")
// for _, input := range inputs {
// ok, err := regexp.MatchString(`\A([a-zA-Z0-9_.-]+):([a-zA-Z0-9_.-]+)\z`, input)
// if err != nil {
// return err
// }
// if !ok {
// return fmt.Errorf("invalid label format: %s", input)
// }
// }
// o.labels = args[0]
// return nil
// }
// // Complete completes addLabel command.
// func (o *addLabelOptions) Complete(cmd *cobra.Command, args []string) error {
// return nil
// }
// // RunAddLabel runs addLabel command (do real work).
// func (o *addLabelOptions) RunAddLabel(fsys fs.FileSystem) error {
// mf, err := newKustomizationFile(constants.KustomizationFileName, fsys)
// if err != nil {
// return err
// }
// m, err := mf.read()
// if err != nil {
// return err
// }
// if m.CommonLabels == nil {
// m.CommonLabels = make(map[string]string)
// }
// labels := strings.Split(o.labels, ",")
// for _, label := range labels {
// kv := strings.Split(label, ":")
// if _, ok := m.CommonLabels[kv[0]]; ok {
// return fmt.Errorf("label %s already in kustomization file", kv[0])
// }
// m.CommonLabels[kv[0]] = kv[1]
// }
// return mf.write(m)
// }

126
pkg/commands/addlabel_test.go
View File

@@ -1,126 +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 commands
import (
"testing"
"strings"
"github.com/kubernetes-sigs/kustomize/pkg/constants"
"github.com/kubernetes-sigs/kustomize/pkg/fs"
)
func TestLabelsValid(t *testing.T) {
var testcases = []struct {
input string
valid bool
name string
}{
{
input: "owls:great,unicorns:magical",
valid: true,
name: "Adds two labels",
},
{
input: "owls:great",
valid: false,
name: "Label keys must be unique",
},
{
input: "otters:cute",
valid: true,
name: "Adds single label",
},
{
input: "dogs,cats",
valid: false,
name: "Does not contain colon",
},
{
input: ":noKey",
valid: false,
name: "Missing key",
},
{
input: "noValue:",
valid: false,
name: "Missing value",
},
}
fakeFS := fs.MakeFakeFS()
fakeFS.WriteFile(constants.KustomizationFileName, []byte(kustomizationContent))
cmd := newCmdAddLabel(fakeFS)
for _, tc := range testcases {
labels := strings.Split(tc.input, ",")
//run command with test input
args := []string{tc.input}
err := cmd.RunE(cmd, args)
if err != nil && tc.valid {
t.Errorf("for test case %s, unexpected cmd error: %v", tc.name, err)
}
if err == nil && !tc.valid {
t.Errorf("unexpected error: expected invalid annotation format error for test case %v", tc.name)
}
if err == nil && (tc.name == "Label keys must be unique") {
t.Errorf("unexpected error: for test case %s, expected already there problem", tc.name)
}
content, readErr := fakeFS.ReadFile(constants.KustomizationFileName)
if readErr != nil {
t.Errorf("unexpected read error: %v", readErr)
}
//check if valid input was added to commonLabels
for _, label := range labels {
key := strings.Split(label, ":")[0]
if !strings.Contains(string(content), key) && tc.valid {
t.Errorf("unexpected error: for test case %s, expected key to be in file.", tc.name)
}
}
}
}
func TestAddLabelNoArgs(t *testing.T) {
fakeFS := fs.MakeFakeFS()
cmd := newCmdAddLabel(fakeFS)
err := cmd.Execute()
if err == nil {
t.Errorf("expected an error but error is: %v", err)
}
if err != nil && err.Error() != "must specify a label" {
t.Errorf("incorrect error: %v", err.Error())
}
}
func TestAddLabelMultipleArgs(t *testing.T) {
fakeFS := fs.MakeFakeFS()
fakeFS.WriteFile(constants.KustomizationFileName, []byte(kustomizationContent))
cmd := newCmdAddLabel(fakeFS)
args := []string{"this:input", "has:spaces"}
err := cmd.RunE(cmd, args)
if err == nil {
t.Errorf("expected an error but error is: %v", err)
}
if err != nil && err.Error() != "labels must be comma-separated, with no spaces. See help text for example." {
t.Errorf("incorrect error: %v", err.Error())
}
}

20
pkg/commands/addmetadata.go
View File

@@ -18,13 +18,17 @@ package commands
import ( import (
"fmt" "fmt"
"regexp"
"strings"
"github.com/kubernetes-sigs/kustomize/pkg/constants" "github.com/kubernetes-sigs/kustomize/pkg/constants"
"github.com/kubernetes-sigs/kustomize/pkg/fs" "github.com/kubernetes-sigs/kustomize/pkg/fs"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"regexp"
"strings"
) )
const label = "label"
const ann = "annotation"
type addMetadataOptions struct { type addMetadataOptions struct {
metadata string metadata string
} }
@@ -39,7 +43,7 @@ func newCmdAddAnnotation(fsys fs.FileSystem) *cobra.Command {
Example: ` Example: `
add annotation {annotationKey1:annotationValue1},{annotationKey2:annotationValue2}`, add annotation {annotationKey1:annotationValue1},{annotationKey2:annotationValue2}`,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
mdKind := "annotation" mdKind := ann
err := o.Validate(args, mdKind) err := o.Validate(args, mdKind)
if err != nil { if err != nil {
return err return err
@@ -64,7 +68,7 @@ func newCmdAddLabel(fsys fs.FileSystem) *cobra.Command {
Example: ` Example: `
add label {labelKey1:labelValue1},{labelKey2:labelValue2}`, add label {labelKey1:labelValue1},{labelKey2:labelValue2}`,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
mdKind := "label" mdKind := label
err := o.Validate(args, mdKind) err := o.Validate(args, mdKind)
if err != nil { if err != nil {
return err return err
@@ -120,24 +124,24 @@ func (o *addMetadataOptions) RunAddMetadata(fsys fs.FileSystem, mdKind string) e
return err return err
} }
if mdKind == "label" && m.CommonLabels == nil { if mdKind == label && m.CommonLabels == nil {
m.CommonLabels = make(map[string]string) m.CommonLabels = make(map[string]string)
} }
if mdKind == "annotation" && m.CommonAnnotations == nil { if mdKind == ann && m.CommonAnnotations == nil {
m.CommonAnnotations = make(map[string]string) m.CommonAnnotations = make(map[string]string)
} }
entries := strings.Split(o.metadata, ",") entries := strings.Split(o.metadata, ",")
for _, entry := range entries { for _, entry := range entries {
kv := strings.Split(entry, ":") kv := strings.Split(entry, ":")
if mdKind == "label" { if mdKind == label {
if _, ok := m.CommonLabels[kv[0]]; ok { if _, ok := m.CommonLabels[kv[0]]; ok {
return fmt.Errorf("%s %s already in kustomization file", mdKind, kv[0]) return fmt.Errorf("%s %s already in kustomization file", mdKind, kv[0])
} }
m.CommonLabels[kv[0]] = kv[1] m.CommonLabels[kv[0]] = kv[1]
} }
if mdKind == "annotation" { if mdKind == ann {
if _, ok := m.CommonAnnotations[kv[0]]; ok { if _, ok := m.CommonAnnotations[kv[0]]; ok {
return fmt.Errorf("%s %s already in kustomization file", mdKind, kv[0]) return fmt.Errorf("%s %s already in kustomization file", mdKind, kv[0])
} }

2
pkg/commands/addmetadata_test.go
View File

@@ -223,4 +223,4 @@ func TestAddAnnotationMultipleArgs(t *testing.T) {
if err != nil && err.Error() != "annotations must be comma-separated, with no spaces. See help text for example" { if err != nil && err.Error() != "annotations must be comma-separated, with no spaces. See help text for example" {
t.Errorf("incorrect error: %v", err.Error()) t.Errorf("incorrect error: %v", err.Error())
} }
} }