update the pr to handle the case when the setter to be deleted is used in substitution

kyaml/fieldmeta/fieldmeta.go

@@ -151,10 +151,16 @@ func (fm *FieldMeta) Write(n *yaml.RNode) error {
 		delete(fm.Schema.VendorExtensible.Extensions, "x-kustomize")
 	}
 
-	// Ex: {"$ref":"#/definitions/io.k8s.cli.setters.replicas"} should be converted to
-	// {"openAPI":"replicas"} and added to the line comment
-	arr := strings.Split(fm.Schema.Ref.String(), ".")
-	n.YNode().LineComment = fmt.Sprintf(`{"%s":"%s"}`, shortHandRef, arr[len(arr)-1])
+	// Ref is removed when a setter is deleted, so the Ref string could be empty.
+	if fm.Schema.Ref.String() != "" {
+		// Ex: {"$ref":"#/definitions/io.k8s.cli.setters.replicas"} should be converted to
+		// {"openAPI":"replicas"} and added to the line comment
+		arr := strings.Split(fm.Schema.Ref.String(), ".")
+		n.YNode().LineComment = fmt.Sprintf(`{"%s":"%s"}`, shortHandRef, arr[len(arr)-1])
+	} else {
+		n.YNode().LineComment = ""
+	}
+
 	return nil
 }
 

kyaml/setters2/delete.go

@@ -0,0 +1,145 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package setters2
+
+import (
+	"strings"
+
+	"github.com/go-openapi/spec"
+	"sigs.k8s.io/kustomize/kyaml/errors"
+	"sigs.k8s.io/kustomize/kyaml/fieldmeta"
+	"sigs.k8s.io/kustomize/kyaml/openapi"
+	"sigs.k8s.io/kustomize/kyaml/yaml"
+)
+
+// Delete delete setter or substitution references from resource fields.
+// Requires that FieldName have been set.
+type Delete struct {
+
+	// FieldName if delete the OpenAPI reference to fields with this name or path
+	// FieldName may be the full name of the field, full path to the field, or the path suffix.
+	// e.g. all of the following would match spec.template.spec.containers.image --
+	// [image, containers.image, spec.containers.image, template.spec.containers.image,
+	//  spec.template.spec.containers.image]
+	FieldName string
+}
+
+// Filter implements yaml.Filter
+func (d *Delete) Filter(object *yaml.RNode) (*yaml.RNode, error) {
+	if d.FieldName == "" {
+		return nil, errors.Errorf("must specify fieldName")
+	}
+	return object, accept(d, object)
+}
+
+func (d *Delete) visitSequence(_ *yaml.RNode, _ string, _ *openapi.ResourceSchema) error {
+	// no-op
+	return nil
+}
+
+// visitScalar implements visitor
+// visitScalar will remove the reference on each scalar field whose name matches.
+func (d *Delete) visitScalar(object *yaml.RNode, p string, _ *openapi.ResourceSchema) error {
+	// check if the field matches
+	if d.FieldName != "" && !strings.HasSuffix(p, d.FieldName) {
+		return nil
+	}
+
+	// read the field metadata
+	fm := fieldmeta.FieldMeta{}
+	if err := fm.Read(object); err != nil {
+		return err
+	}
+
+	// remove the ref on the metadata
+	fm.Schema.Ref = spec.Ref{}
+
+	// write the field metadata
+	if err := fm.Write(object); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// DeleterDefinition may be used to update a files OpenAPI definitions with a new setter.
+type DeleterDefinition struct {
+	// Name is the name of the setter to create or update.
+	Name string `yaml:"name"`
+}
+
+func (dd DeleterDefinition) DeleteFromFile(path string) error {
+	return yaml.UpdateFile(dd, path)
+}
+
+// ContainedInSubstituion check if the setter used in substituition
+func ContainedInSubstituion(definitions *yaml.RNode, key string) bool {
+	fieldNames, err := definitions.Fields()
+	if err != nil {
+		return false
+	}
+	for _, fieldname := range fieldNames {
+		// the definition key -- contains the substitution name
+		subkey := definitions.Field(fieldname).Key.YNode().Value
+		if strings.HasPrefix(subkey, fieldmeta.SubstitutionDefinitionPrefix) {
+			substNode, err := definitions.Field(fieldname).Value.Pipe(yaml.Lookup(K8sCliExtensionKey, "substitution"))
+			if err != nil {
+				continue
+			}
+
+			b, err := substNode.String()
+			if err != nil {
+				continue
+			}
+
+			subst := SubstitutionDefinition{}
+			if err := yaml.Unmarshal([]byte(b), &subst); err != nil {
+				continue
+			}
+			// Check the ref in value to see if it contains the setter key
+			for _, v := range subst.Values {
+				if strings.HasSuffix(v.Ref, key) {
+					return true
+				}
+			}
+		}
+	}
+
+	return false
+}
+
+func (dd DeleterDefinition) Filter(object *yaml.RNode) (*yaml.RNode, error) {
+	key := fieldmeta.SetterDefinitionPrefix + dd.Name
+
+	definitions, err := object.Pipe(yaml.Lookup(openapi.SupplementaryOpenAPIFieldName, "definitions"))
+	if err != nil || definitions == nil {
+		return nil, err
+	}
+	// return error if the setter to be deleted doesn't exist
+	if definitions.Field(key) == nil {
+		return nil, errors.Errorf("setter does not exist")
+	}
+
+	if ContainedInSubstituion(definitions, key) {
+		return nil, errors.Errorf("setter is used in substitution, please delete the substitution first")
+	}
+
+	for i := 0; i < len(definitions.Content()); i += 2 {
+		if definitions.Content()[i].Value == key {
+			if len(definitions.YNode().Content) > i+2 {
+				l := len(definitions.YNode().Content)
+				// remove from the middle of the list
+				definitions.YNode().Content = definitions.Content()[:i]
+				definitions.YNode().Content = append(
+					definitions.YNode().Content,
+					definitions.Content()[i+2:l]...)
+			} else {
+				// remove from the end of the list
+				definitions.YNode().Content = definitions.Content()[:i]
+			}
+		}
+	}
+
+	return object, nil
+}

kyaml/setters2/delete_test.go

@@ -0,0 +1,191 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package setters2
+
+import (
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"sigs.k8s.io/kustomize/kyaml/yaml"
+)
+
+func TestDelete_Filter(t *testing.T) {
+	var tests = []struct {
+		name           string
+		description    string
+		setter         string
+		input          string
+		expectedOutput string
+	}{
+		{
+			name:   "delete-replicas",
+			setter: "replicas",
+			input: `
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+  annotations:
+    replicas: 3 # {"$openapi":"replicas"}
+spec:
+  replicas: 3 # {"$openapi":"replicas"}
+ `,
+			expectedOutput: `
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+  annotations:
+    replicas: 3
+spec:
+  replicas: 3
+ `,
+		},
+		{
+			name:   "delete-foo-annotation",
+			setter: "foo",
+			input: `
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+  annotations:
+    foo: 3 # {"$openapi":"foo"}
+ `,
+			expectedOutput: `
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+  annotations:
+    foo: 3
+ `,
+		},
+		{
+			name:   "delete-replicas-enum",
+			setter: "replicas",
+			input: `
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+spec:
+  replicas: 1 # {"$openapi":"replicas"}
+ `,
+			expectedOutput: `
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+spec:
+  replicas: 1
+ `,
+		},
+	}
+	for i := range tests {
+		test := tests[i]
+		t.Run(test.name, func(t *testing.T) {
+			// parse the input to be modified
+			r, err := yaml.Parse(test.input)
+			if !assert.NoError(t, err) {
+				t.FailNow()
+			}
+
+			// invoke the delete
+			instance := &Delete{FieldName: test.setter}
+			result, err := instance.Filter(r)
+			if !assert.NoError(t, err) {
+				t.FailNow()
+			}
+
+			// compare the actual and expected output
+			actual, err := result.String()
+			if !assert.NoError(t, err) {
+				t.FailNow()
+			}
+			actual = strings.TrimSpace(actual)
+			expected := strings.TrimSpace(test.expectedOutput)
+			if !assert.Equal(t, expected, actual) {
+				t.FailNow()
+			}
+		})
+	}
+}
+
+var resourcefile2 = `apiVersion: resource.dev/v1alpha1
+kind: resourcefile
+metadata:
+    name: hello-world-set
+upstream:
+    type: git
+    git:
+        commit: 5c1c019b59299a4f6c7edd1ff5ff54d720621bbe
+        directory: /package-examples/helloworld-set
+        ref: v0.1.0
+packageMetadata:
+    shortDescription: example package using setters
+openAPI:
+  definitions:
+    io.k8s.cli.setters.image:
+      x-k8s-cli:
+        setter:
+          name: image
+          value: "2"
+    io.k8s.cli.setters.tag:
+      x-k8s-cli:
+        setter:
+          name: tag
+          value: "sometag"
+`
+
+func TestDelete_Filter2(t *testing.T) {
+	path := filepath.Join(os.TempDir(), "resourcefile2")
+
+	//write initial resourcefile to temp path
+	err := ioutil.WriteFile(path, []byte(resourcefile2), 0666)
+	if !assert.NoError(t, err) {
+		t.FailNow()
+	}
+
+	//add a deleter definition
+	dd := DeleterDefinition{
+		Name: "image",
+	}
+
+	err = dd.DeleteFromFile(path)
+	if !assert.NoError(t, err) {
+		t.FailNow()
+	}
+
+	b, err := ioutil.ReadFile(path)
+	if err != nil {
+		t.FailNow()
+	}
+
+	expected := `apiVersion: resource.dev/v1alpha1
+kind: resourcefile
+metadata:
+  name: hello-world-set
+upstream:
+  type: git
+  git:
+    commit: 5c1c019b59299a4f6c7edd1ff5ff54d720621bbe
+    directory: /package-examples/helloworld-set
+    ref: v0.1.0
+packageMetadata:
+  shortDescription: example package using setters
+openAPI:
+  definitions:
+    io.k8s.cli.setters.tag:
+      x-k8s-cli:
+        setter:
+          name: tag
+          value: "sometag"
+`
+	assert.Equal(t, expected, string(b))
+}

kyaml/setters2/settersutil/deletecreator_test.go

@@ -0,0 +1,107 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package settersutil
+
+import (
+	"io/ioutil"
+	"os"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+var openAPIFile = `
+openAPI:
+  definitions:
+    io.k8s.cli.setters.image:
+      x-k8s-cli:
+        setter:
+          name: image
+          value: "2"
+    io.k8s.cli.setters.tag:
+      x-k8s-cli:
+        setter:
+          name: tag
+          value: "sometag"
+
+`
+
+var resourceFile = `
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+  annotations:
+    image: 3 # {"$openapi":"image"}
+spec:
+  image: 3 # {"$openapi":"image"}
+`
+
+func TestDeleterCreator_Delete(t *testing.T) {
+	openAPI, err := ioutil.TempFile("", "openAPI.yaml")
+	if !assert.NoError(t, err) {
+		t.FailNow()
+	}
+	defer os.Remove(openAPI.Name())
+	//write openapi to temp dir
+	err = ioutil.WriteFile(openAPI.Name(), []byte(openAPIFile), 0666)
+	if !assert.NoError(t, err) {
+		t.FailNow()
+	}
+
+	//write resource file to temp dir
+	resource, err := ioutil.TempFile("", "k8s-cli-*.yaml")
+	if !assert.NoError(t, err) {
+		t.FailNow()
+	}
+	defer os.Remove(resource.Name())
+	err = ioutil.WriteFile(resource.Name(), []byte(resourceFile), 0666)
+	if !assert.NoError(t, err) {
+		t.FailNow()
+	}
+
+	//add a delete creator
+	dc := DeleterCreator{
+		Name: "image",
+	}
+
+	err = dc.Delete(openAPI.Name(), resource.Name())
+	if !assert.NoError(t, err) {
+		t.FailNow()
+	}
+
+	actualOpenAPI, err := ioutil.ReadFile(openAPI.Name())
+	if err != nil {
+		t.FailNow()
+	}
+
+	actualResource, err := ioutil.ReadFile(resource.Name())
+	if err != nil {
+		t.FailNow()
+	}
+
+	expectedOpenAPI := `
+openAPI:
+  definitions:
+    io.k8s.cli.setters.tag:
+      x-k8s-cli:
+        setter:
+          name: tag
+          value: "sometag"
+`
+	expectedResoure := `
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+  annotations:
+    image: 3
+spec:
+  image: 3
+`
+
+	assert.Equal(t, strings.TrimSpace(expectedOpenAPI), strings.TrimSpace(string(actualOpenAPI)))
+	assert.Equal(t, strings.TrimSpace(expectedResoure), strings.TrimSpace(string(actualResource)))
+}

kyaml/setters2/settersutil/deletercreator.go

@@ -0,0 +1,42 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package settersutil
+
+import (
+	"sigs.k8s.io/kustomize/kyaml/kio"
+	"sigs.k8s.io/kustomize/kyaml/openapi"
+	"sigs.k8s.io/kustomize/kyaml/setters2"
+)
+
+// DeleterCreator delete a setter in the OpenAPI definitions, and removes references
+// to the setter from matching resource fields.
+type DeleterCreator struct {
+	// Name is the name of the setter to create or update.
+	Name string
+}
+
+func (d DeleterCreator) Delete(openAPIPath, resourcesPath string) error {
+	dd := setters2.DeleterDefinition{
+		Name: d.Name,
+	}
+	if err := dd.DeleteFromFile(openAPIPath); err != nil {
+		return err
+	}
+
+	// Load the updated definitions
+	if err := openapi.AddSchemaFromFile(openAPIPath); err != nil {
+		return err
+	}
+
+	// Update the resources with the deleter reference
+	inout := &kio.LocalPackageReadWriter{PackagePath: resourcesPath}
+	return kio.Pipeline{
+		Inputs: []kio.Reader{inout},
+		Filters: []kio.Filter{kio.FilterAll(
+			&setters2.Delete{
+				FieldName: d.Name,
+			})},
+		Outputs: []kio.Writer{inout},
+	}.Execute()
+}