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

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
+}