feat: add PatchArgs API type to populate patch options

This commit converts the Options section of a patch into an object instead of map.
This allows better clarification of the available options.

Author: adoramshoval

api/internal/target/kusttarget_configplugin.go

@@ -250,10 +250,10 @@ var transformerConfigurators = map[builtinhelpers.BuiltinPluginType]func(
 			return
 		}
 		var c struct {
-			Path    string          `json:"path,omitempty" yaml:"path,omitempty"`
-			Patch   string          `json:"patch,omitempty" yaml:"patch,omitempty"`
-			Target  *types.Selector `json:"target,omitempty" yaml:"target,omitempty"`
-			Options map[string]bool `json:"options,omitempty" yaml:"options,omitempty"`
+			Path    string           `json:"path,omitempty" yaml:"path,omitempty"`
+			Patch   string           `json:"patch,omitempty" yaml:"patch,omitempty"`
+			Target  *types.Selector  `json:"target,omitempty" yaml:"target,omitempty"`
+			Options *types.PatchArgs `json:"options,omitempty" yaml:"options,omitempty"`
 		}
 		for _, pc := range kt.kustomization.Patches {
 			c.Target = pc.Target

api/types/patch.go

@@ -3,8 +3,6 @@
 
 package types
 
-import "reflect"
-
 // Patch represent either a Strategic Merge Patch or a JSON patch
 // and its targets.
 // The content of the patch can either be from a file
@@ -20,15 +18,17 @@ type Patch struct {
 	Target *Selector `json:"target,omitempty" yaml:"target,omitempty"`
 
 	// Options is a list of options for the patch
-	Options map[string]bool `json:"options,omitempty" yaml:"options,omitempty"`
+	Options *PatchArgs `json:"options,omitempty" yaml:"options,omitempty"`
 }
 
 // Equals return true if p equals o.
 func (p *Patch) Equals(o Patch) bool {
 	targetEqual := (p.Target == o.Target) ||
 		(p.Target != nil && o.Target != nil && *p.Target == *o.Target)
+	optionsEqual := (p.Options == o.Options) ||
+		(p.Options != nil && o.Options != nil && *p.Options == *o.Options)
 	return p.Path == o.Path &&
 		p.Patch == o.Patch &&
 		targetEqual &&
-		reflect.DeepEqual(p.Options, o.Options)
+		optionsEqual
 }

api/types/patch_test.go

@@ -101,6 +101,28 @@ func TestPatchEquals(t *testing.T) {
 			},
 			expect: true,
 		},
+		{
+			name: "same options",
+			patch1: Patch{
+				Path:   "foo",
+				Patch:  "bar",
+				Target: &selector,
+				Options: &PatchArgs{
+					AllowNameChange:    true,
+					AllowNoTargetMatch: true,
+				},
+			},
+			patch2: Patch{
+				Path:   "foo",
+				Patch:  "bar",
+				Target: &selector,
+				Options: &PatchArgs{
+					AllowNameChange:    true,
+					AllowNoTargetMatch: true,
+				},
+			},
+			expect: true,
+		},
 		{
 			name: "one nil target",
 			patch1: Patch{
@@ -124,6 +146,28 @@ func TestPatchEquals(t *testing.T) {
 			},
 			expect: false,
 		},
+		{
+			name: "different options",
+			patch1: Patch{
+				Path:   "foo",
+				Patch:  "bar",
+				Target: &selector,
+				Options: &PatchArgs{
+					AllowNameChange:    false,
+					AllowNoTargetMatch: true,
+				},
+			},
+			patch2: Patch{
+				Path:   "foo",
+				Patch:  "bar",
+				Target: &selector,
+				Options: &PatchArgs{
+					AllowNameChange:    true,
+					AllowNoTargetMatch: true,
+				},
+			},
+			expect: false,
+		},
 	}
 
 	for _, tc := range testcases {

api/types/patchargs.go

@@ -0,0 +1,16 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package types
+
+// PatchArgs represent set of options on resources of a patch.
+type PatchArgs struct {
+	// AllowNameChange allows name changes to the resource.
+	AllowNameChange bool `json:"allowNameChange,omitempty" yaml:"allowNameChange,omitempty"`
+
+	// AllowKindChange allows kind changes to the resource.
+	AllowKindChange bool `json:"allowKindChange,omitempty" yaml:"allowKindChange,omitempty"`
+
+	// AllowNoTargetMatch allows files rendering in case of no target (`api/types/selector`) match.
+	AllowNoTargetMatch bool `json:"allowNoTargetMatch,omitempty" yaml:"allowNoTargetMatch,omitempty"`
+}

kustomize/commands/edit/fix/convert.go

@@ -241,7 +241,7 @@ func constructTargets(file string, node *kyaml.RNode, fieldPaths []string,
 	}
 
 	if patch, ok := patchTarget[file]; ok {
-		if !patch.Options["allowNameChange"] || !patch.Options["allowKindChange"] {
+		if patch.Options == nil || (!patch.Options.AllowNameChange || !patch.Options.AllowKindChange) {
 			return writePatchTargets(patch, node, fieldPaths, options)
 		}
 	}
@@ -299,11 +299,13 @@ func writePatchTargets(patch types.Patch, node *kyaml.RNode, fieldPaths []string
 		if options[i].String() != "" {
 			target.Options = options[i]
 		}
-		if patch.Options["allowNameChange"] {
-			target.Select.ResId.Name = node.GetName()
-		}
-		if patch.Options["allowKindChange"] {
-			target.Select.ResId.Kind = node.GetKind()
+		if patch.Options != nil {
+			if patch.Options.AllowNameChange {
+				target.Select.ResId.Name = node.GetName()
+			}
+			if patch.Options.AllowKindChange {
+				target.Select.ResId.Kind = node.GetKind()
+			}
 		}
 		if node.GetNamespace() != "" {
 			target.Select.ResId.Namespace = node.GetNamespace()