Merge remote-tracking branch 'upstream/master' into release-cmd/config-v0.1

cmd/config/go.mod

@@ -4,11 +4,14 @@ go 1.13
 
 require (
 	github.com/go-errors/errors v1.0.1
+	github.com/go-openapi/spec v0.19.5
 	github.com/olekukonko/tablewriter v0.0.4
 	github.com/posener/complete/v2 v2.0.1-alpha.12
 	github.com/spf13/cobra v1.0.0
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.4.0
 	k8s.io/apimachinery v0.17.0
-	sigs.k8s.io/kustomize/kyaml v0.1.9
+	sigs.k8s.io/kustomize/kyaml v0.1.7
 )
+
+replace sigs.k8s.io/kustomize/kyaml v0.1.7 => ../../kyaml

cmd/config/go.sum

@@ -168,6 +168,8 @@ github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4k
 github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
 github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
 github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
+github.com/spf13/cobra v0.0.5 h1:f0B+LkLX6DtmRH1isoNA9VTtNUK9K8xYd28JNNfOv/s=
+github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU=
 github.com/spf13/cobra v1.0.0 h1:6m/oheQuQ13N9ks4hubMG6BnvwOeaJrqSPLahSnczz8=
 github.com/spf13/cobra v1.0.0/go.mod h1:/6GTrnGXV9HjY+aR4k0oJ5tcvakLuG6EuKReYlHNrgE=
 github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=

cmd/config/internal/commands/cmdcreatesetter.go

@@ -4,11 +4,15 @@
 package commands
 
 import (
+	"github.com/go-openapi/spec"
 	"github.com/spf13/cobra"
 	"sigs.k8s.io/kustomize/cmd/config/ext"
 	"sigs.k8s.io/kustomize/cmd/config/internal/generateddocs/commands"
+	"sigs.k8s.io/kustomize/kyaml/errors"
 	"sigs.k8s.io/kustomize/kyaml/kio"
+	"sigs.k8s.io/kustomize/kyaml/openapi"
 	"sigs.k8s.io/kustomize/kyaml/setters"
+	"sigs.k8s.io/kustomize/kyaml/setters2"
 	"sigs.k8s.io/kustomize/kyaml/setters2/settersutil"
 )
 
@@ -86,12 +90,30 @@ func (r *CreateSetterRunner) preRunE(c *cobra.Command, args []string) error {
 	if setterVersion == "v2" {
 		var err error
 		r.OpenAPIFile, err = ext.GetOpenAPIFile(args)
-		r.CreateSetter.Description = r.Set.SetPartialField.Description
-		r.CreateSetter.SetBy = r.Set.SetPartialField.SetBy
-		r.CreateSetter.Type = r.Set.SetPartialField.Type
 		if err != nil {
 			return err
 		}
+
+		if err := openapi.AddSchemaFromFile(r.OpenAPIFile); err != nil {
+			return err
+		}
+
+		// check if substitution with same name exists and throw error
+		ref, err := spec.NewRef(setters2.DefinitionsPrefix + setters2.SubstitutionDefinitionPrefix + r.CreateSetter.Name)
+		if err != nil {
+			return err
+		}
+
+		subst, _ := openapi.Resolve(&ref)
+		// if substitution already exists with the input setter name, throw error
+		if subst != nil {
+			return errors.Errorf("substitution with name %s already exists, "+
+				"substitution and setter can't have same name", r.CreateSetter.Name)
+		}
+
+		r.CreateSetter.Description = r.Set.SetPartialField.Description
+		r.CreateSetter.SetBy = r.Set.SetPartialField.SetBy
+		r.CreateSetter.Type = r.Set.SetPartialField.Type
 	}
 	return nil
 }

cmd/config/internal/commands/cmdcreatesetter_test.go

@@ -22,8 +22,10 @@ func TestCreateSetterCommand(t *testing.T) {
 		input             string
 		args              []string
 		out               string
+		inputOpenAPI      string
 		expectedOpenAPI   string
 		expectedResources string
+		err               string
 	}{
 		{
 			name: "add replicas",
@@ -36,6 +38,10 @@ metadata:
 spec:
   replicas: 3
  `,
+			inputOpenAPI: `
+apiVersion: v1alpha1
+kind: Example
+`,
 			expectedOpenAPI: `
 apiVersion: v1alpha1
 kind: Example
@@ -58,6 +64,27 @@ spec:
   replicas: 3 # {"$ref":"#/definitions/io.k8s.cli.setters.replicas"}
  `,
 		},
+		{
+			name: "error if substitution with same name exists",
+			args: []string{"my-image", "3", "--description", "hello world", "--set-by", "me"},
+			inputOpenAPI: `
+apiVersion: v1alpha1
+kind: Example
+openAPI:
+  definitions:
+    io.k8s.cli.substitutions.my-image:
+      x-k8s-cli:
+        substitution:
+          name: my-image
+          pattern: something/${my-image-setter}::${my-tag-setter}/nginxotherthing
+          values:
+          - marker: ${my-image-setter}
+            ref: '#/definitions/io.k8s.cli.setters.my-image-setter'
+          - marker: ${my-tag-setter}
+            ref: '#/definitions/io.k8s.cli.setters.my-tag-setter'
+ `,
+			err: "substitution with name my-image already exists, substitution and setter can't have same name",
+		},
 	}
 	for i := range tests {
 		test := tests[i]
@@ -71,10 +98,7 @@ spec:
 				t.FailNow()
 			}
 			defer os.Remove(f.Name())
-			err = ioutil.WriteFile(f.Name(), []byte(`
-apiVersion: v1alpha1
-kind: Example
-`), 0600)
+			err = ioutil.WriteFile(f.Name(), []byte(test.inputOpenAPI), 0600)
 			if !assert.NoError(t, err) {
 				t.FailNow()
 			}
@@ -99,6 +123,14 @@ kind: Example
 			runner.Command.SetOut(out)
 			runner.Command.SetArgs(append([]string{r.Name()}, test.args...))
 			err = runner.Command.Execute()
+			if test.err != "" {
+				if !assert.NotNil(t, err) {
+					t.FailNow()
+				} else {
+					assert.Equal(t, err.Error(), test.err)
+					return
+				}
+			}
 			if !assert.NoError(t, err) {
 				t.FailNow()
 			}

cmd/config/internal/commands/cmdcreatesubstitution.go

@@ -4,12 +4,15 @@
 package commands
 
 import (
+	"fmt"
 	"regexp"
 	"strings"
 
+	"github.com/go-openapi/spec"
 	"github.com/spf13/cobra"
 	"sigs.k8s.io/kustomize/cmd/config/ext"
 	"sigs.k8s.io/kustomize/kyaml/errors"
+	"sigs.k8s.io/kustomize/kyaml/openapi"
 	"sigs.k8s.io/kustomize/kyaml/setters2"
 	"sigs.k8s.io/kustomize/kyaml/setters2/settersutil"
 )
@@ -63,6 +66,23 @@ func (r *CreateSubstitutionRunner) preRunE(c *cobra.Command, args []string) erro
 		return err
 	}
 
+	if err := openapi.AddSchemaFromFile(r.OpenAPIFile); err != nil {
+		return err
+	}
+
+	// check if setter with same name exists and throw error
+	ref, err := spec.NewRef(setters2.DefinitionsPrefix + setters2.SetterDefinitionPrefix + r.CreateSubstitution.Name)
+	if err != nil {
+		return err
+	}
+
+	setter, _ := openapi.Resolve(&ref)
+	// if setter already exists with input substitution name, throw error
+	if setter != nil {
+		return errors.Errorf(fmt.Sprintf("setter with name %s already exists, "+
+			"substitution and setter can't have same name", r.CreateSubstitution.Name))
+	}
+
 	// extract setter name tokens from pattern enclosed in ${}
 	re := regexp.MustCompile(`\$\{([^}]*)\}`)
 	markers := re.FindAll([]byte(r.CreateSubstitution.Pattern), -1)

cmd/config/internal/commands/cmdcreatesubstitution_test.go

@@ -25,6 +25,7 @@ func TestCreateSubstitutionCommand(t *testing.T) {
 		out               string
 		expectedOpenAPI   string
 		expectedResources string
+		err               string
 	}{
 		{
 			name: "substitution replicas",
@@ -103,6 +104,23 @@ spec:
         image: sidecar:1.7.9
  `,
 		},
+		{
+			name: "error if setter with same name exists",
+			args: []string{
+				"my-image", "--field-value", "nginx:1.7.9", "--pattern", "${my-image-setter}:${my-tag-setter}"},
+			inputOpenAPI: `
+apiVersion: v1alpha1
+kind: Example
+openAPI:
+  definitions:
+    io.k8s.cli.setters.my-image:
+      x-k8s-cli:
+        setter:
+          name: my-image
+          value: "nginx"
+ `,
+			err: "setter with name my-image already exists, substitution and setter can't have same name",
+		},
 		{
 			name: "substitution and create setters 1",
 			args: []string{
@@ -206,6 +224,14 @@ spec:
 			runner.Command.SetOut(out)
 			runner.Command.SetArgs(append([]string{r.Name()}, test.args...))
 			err = runner.Command.Execute()
+
+			if test.err != "" {
+				if !assert.NotNil(t, err) {
+					t.FailNow()
+				}
+				assert.Equal(t, err.Error(), test.err)
+				return
+			}
 			if !assert.NoError(t, err) {
 				t.FailNow()
 			}

cmd/config/internal/commands/cmdlistsetters.go

@@ -59,42 +59,83 @@ func (r *ListSettersRunner) preRunE(c *cobra.Command, args []string) error {
 
 func (r *ListSettersRunner) runE(c *cobra.Command, args []string) error {
 	if setterVersion == "v2" {
-		// use setters v2
-		path, err := ext.GetOpenAPIFile(args)
-		if err != nil {
+		if err := r.ListSetters(c, args); err != nil {
 			return err
 		}
-		if err := r.List.List(path, args[0]); err != nil {
-			return err
-		}
-		table := newTable(c.OutOrStdout(), r.Markdown)
-		table.SetHeader([]string{"NAME", "VALUE", "SET BY", "DESCRIPTION", "COUNT"})
-		for i := range r.List.Setters {
-			s := r.List.Setters[i]
-			v := s.Value
-
-			// if the setter is for a list, populate the values
-			if len(s.ListValues) > 0 {
-				v = strings.Join(s.ListValues, ",")
-				v = fmt.Sprintf("[%s]", v)
-			}
-			table.Append([]string{
-				s.Name, v, s.SetBy, s.Description, fmt.Sprintf("%d", s.Count)})
-		}
-		table.Render()
-
-		if len(r.List.Setters) == 0 {
-			// exit non-0 if no matching setters are found
-			if ExitOnError {
-				os.Exit(1)
-			}
-		}
-		return nil
+		return r.ListSubstitutions(c, args)
 	}
 
 	return handleError(c, lookup(r.Lookup, c, args))
 }
 
+func (r *ListSettersRunner) ListSetters(c *cobra.Command, args []string) error {
+	// use setters v2
+	path, err := ext.GetOpenAPIFile(args)
+	if err != nil {
+		return err
+	}
+	if err := r.List.ListSetters(path, args[0]); err != nil {
+		return err
+	}
+	table := newTable(c.OutOrStdout(), r.Markdown)
+	table.SetHeader([]string{"NAME", "VALUE", "SET BY", "DESCRIPTION", "COUNT"})
+	for i := range r.List.Setters {
+		s := r.List.Setters[i]
+		v := s.Value
+
+		// if the setter is for a list, populate the values
+		if len(s.ListValues) > 0 {
+			v = strings.Join(s.ListValues, ",")
+			v = fmt.Sprintf("[%s]", v)
+		}
+		table.Append([]string{
+			s.Name, v, s.SetBy, s.Description, fmt.Sprintf("%d", s.Count)})
+	}
+	table.Render()
+
+	if len(r.List.Setters) == 0 {
+		// exit non-0 if no matching setters are found
+		if ExitOnError {
+			os.Exit(1)
+		}
+	}
+	return nil
+}
+
+func (r *ListSettersRunner) ListSubstitutions(c *cobra.Command, args []string) error {
+	// use setters v2
+	path, err := ext.GetOpenAPIFile(args)
+	if err != nil {
+		return err
+	}
+	if err := r.List.ListSubst(path); err != nil {
+		return err
+	}
+	table := newTable(c.OutOrStdout(), r.Markdown)
+	table.SetHeader([]string{"SUBSTITUTION", "PATTERN", "SETTERS"})
+	for i := range r.List.Substitutions {
+		s := r.List.Substitutions[i]
+		setters := ""
+		for _, value := range s.Values {
+			setter := strings.TrimPrefix(value.Ref, setters2.DefinitionsPrefix+setters2.SetterDefinitionPrefix)
+			setters = setters + "," + setter
+		}
+		setters = fmt.Sprintf("[%s]", strings.TrimPrefix(setters, ","))
+		table.Append([]string{
+			s.Name, s.Pattern, setters})
+	}
+	if len(r.List.Substitutions) == 0 {
+		// exit non-0 if no matching substitutions are found
+		if ExitOnError {
+			os.Exit(1)
+		}
+	} else {
+		table.Render()
+	}
+
+	return nil
+}
+
 func newTable(o io.Writer, m bool) *tablewriter.Table {
 	table := tablewriter.NewWriter(o)
 	table.SetRowLine(false)

cmd/config/internal/commands/cmdlistsetters_test.go

@@ -104,6 +104,8 @@ spec:
   image      nginx   me2      hello world 2   2      
   replicas   3       me1      hello world 1   1      
   tag        1.7.9   me3      hello world 3   1      
+  SUBSTITUTION    PATTERN      SETTERS    
+  image          IMAGE:TAG   [image,tag]  
 `,
 		},
 		{
@@ -176,6 +178,8 @@ spec:
   image      nginx   me2      hello world 2   3      
   replicas   3       me1      hello world 1   2      
   tag        1.7.9   me3      hello world 3   2      
+  SUBSTITUTION    PATTERN      SETTERS    
+  image          IMAGE:TAG   [image,tag]  
 `,
 		},
 		{
@@ -247,6 +251,8 @@ spec:
 `,
 			expected: `  NAME    VALUE   SET BY    DESCRIPTION    COUNT  
   image   nginx   me2      hello world 2   3      
+  SUBSTITUTION    PATTERN      SETTERS    
+  image          IMAGE:TAG   [image,tag]  
 `,
 		},
 	}