checkpoint

api/types/genargs.go

@@ -8,18 +8,14 @@ import (
 	"strings"
 )
 
-// GenArgs contains both GeneratorArgs and GeneratorOptions.
+// GenArgs is a facade over GeneratorArgs, exposing a few readonly properties.
 type GenArgs struct {
 	args *GeneratorArgs
-	opts *GeneratorOptions
 }
 
-// NewGenArgs returns a new object of GenArgs
-func NewGenArgs(args *GeneratorArgs, opts *GeneratorOptions) *GenArgs {
-	return &GenArgs{
-		args: args,
-		opts: opts,
-	}
+// NewGenArgs returns a new instance of GenArgs.
+func NewGenArgs(args *GeneratorArgs) *GenArgs {
+	return &GenArgs{args: args}
 }
 
 func (g *GenArgs) String() string {
@@ -38,7 +34,7 @@ func (g *GenArgs) String() string {
 // content hash should be appended to the name of the resource.
 func (g *GenArgs) ShouldAddHashSuffixToName() bool {
 	return g.args != nil &&
-		(g.opts == nil || !g.opts.DisableNameSuffixHash)
+		(g.args.Options == nil || !g.args.Options.DisableNameSuffixHash)
 }
 
 // Behavior returns Behavior field of GeneratorArgs

api/types/genargs_test.go

@@ -24,8 +24,10 @@ func TestGenArgs_String(t *testing.T) {
 		},
 		{
 			ga: NewGenArgs(
-				&GeneratorArgs{Behavior: "merge"},
-				&GeneratorOptions{DisableNameSuffixHash: false}),
+				&GeneratorArgs{
+					Behavior: "merge",
+					Options:  &GeneratorOptions{DisableNameSuffixHash: false},
+				}),
 			expected: "{nsfx:true,beh:merge}",
 		},
 	}

api/types/generatorargs.go

@@ -22,6 +22,6 @@ type GeneratorArgs struct {
 	// KvPairSources for the generator.
 	KvPairSources `json:",inline,omitempty" yaml:",inline,omitempty"`
 
-	// GeneratorOptions modify this generator
-	GeneratorOptions *GeneratorOptions `json:"generatorOptions,omitempty" yaml:"generatorOptions,omitempty"`
+	// Local overrides to global generator options
+	Options *GeneratorOptions `json:"options,omitempty" yaml:"options,omitempty"`
 }

api/types/generatoroptions.go

@@ -16,3 +16,55 @@ type GeneratorOptions struct {
 	// resource contents.
 	DisableNameSuffixHash bool `json:"disableNameSuffixHash,omitempty" yaml:"disableNameSuffixHash,omitempty"`
 }
+
+// MergeGlobalOptionsIntoLocal merges two instances of GeneratorOptions.
+// Values in the first 'local' argument cannot be overridden by the second
+// 'global' argument, except in the case of booleans.
+//
+// With booleans, there's no way to distinguish an 'intentional'
+// false from 'default' false.  So the rule is, if the global value
+// of the value of a boolean is true, i.e. disable, it trumps the
+// local value.  If the global value is false, then the local value is
+// respected.  Bottom line: a local false cannot override a global true.
+//
+// boolean fields are always a bad idea; should always use enums instead.
+func MergeGlobalOptionsIntoLocal(
+	localOpts *GeneratorOptions,
+	globalOpts *GeneratorOptions) *GeneratorOptions {
+	if globalOpts == nil {
+		return localOpts
+	}
+	if localOpts == nil {
+		localOpts = &GeneratorOptions{}
+	}
+	overrideMap(&localOpts.Labels, globalOpts.Labels)
+	overrideMap(&localOpts.Annotations, globalOpts.Annotations)
+	if globalOpts.DisableNameSuffixHash {
+		localOpts.DisableNameSuffixHash = true
+	}
+	return localOpts
+}
+
+func overrideMap(localMap *map[string]string, globalMap map[string]string) {
+	if *localMap == nil {
+		if globalMap != nil {
+			*localMap = CopyMap(globalMap)
+		}
+		return
+	}
+	for k, v := range globalMap {
+		_, ok := (*localMap)[k]
+		if !ok {
+			(*localMap)[k] = v
+		}
+	}
+}
+
+// CopyMap copies a map.
+func CopyMap(in map[string]string) map[string]string {
+	out := make(map[string]string)
+	for k, v := range in {
+		out[k] = v
+	}
+	return out
+}

api/types/generatoroptions_test.go

@@ -0,0 +1,125 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package types_test
+
+import (
+	"reflect"
+	"testing"
+
+	. "sigs.k8s.io/kustomize/api/types"
+)
+
+func TestMergeGlobalOptionsIntoLocal(t *testing.T) {
+	tests := []struct {
+		name     string
+		local    *GeneratorOptions
+		global   *GeneratorOptions
+		expected *GeneratorOptions
+	}{
+		{
+			name:     "everything nil",
+			local:    nil,
+			global:   nil,
+			expected: nil,
+		},
+		{
+			name: "nil global",
+			local: &GeneratorOptions{
+				Labels:      map[string]string{"pet": "dog"},
+				Annotations: map[string]string{"fruit": "apple"},
+			},
+			global: nil,
+			expected: &GeneratorOptions{
+				Labels:                map[string]string{"pet": "dog"},
+				Annotations:           map[string]string{"fruit": "apple"},
+				DisableNameSuffixHash: false,
+			},
+		},
+		{
+			name:  "nil local",
+			local: nil,
+			global: &GeneratorOptions{
+				Labels:      map[string]string{"pet": "dog"},
+				Annotations: map[string]string{"fruit": "apple"},
+			},
+			expected: &GeneratorOptions{
+				Labels:                map[string]string{"pet": "dog"},
+				Annotations:           map[string]string{"fruit": "apple"},
+				DisableNameSuffixHash: false,
+			},
+		},
+		{
+			name: "global doesn't damage local",
+			local: &GeneratorOptions{
+				Labels: map[string]string{"pet": "dog"},
+				Annotations: map[string]string{
+					"fruit": "apple"},
+			},
+			global: &GeneratorOptions{
+				Labels: map[string]string{
+					"pet":     "cat",
+					"simpson": "homer",
+				},
+				Annotations: map[string]string{
+					"fruit": "peach",
+					"tesla": "Y",
+				},
+			},
+			expected: &GeneratorOptions{
+				Labels: map[string]string{
+					"pet":     "dog",
+					"simpson": "homer",
+				},
+				Annotations: map[string]string{
+					"fruit": "apple",
+					"tesla": "Y",
+				},
+				DisableNameSuffixHash: false,
+			},
+		},
+		{
+			name: "global disable trumps local",
+			local: &GeneratorOptions{
+				DisableNameSuffixHash: false,
+			},
+			global: &GeneratorOptions{
+				DisableNameSuffixHash: true,
+			},
+			expected: &GeneratorOptions{
+				DisableNameSuffixHash: true,
+			},
+		},
+		{
+			name: "local disable works",
+			local: &GeneratorOptions{
+				DisableNameSuffixHash: true,
+			},
+			global: &GeneratorOptions{
+				DisableNameSuffixHash: false,
+			},
+			expected: &GeneratorOptions{
+				DisableNameSuffixHash: true,
+			},
+		},
+		{
+			name: "everyone wants disable",
+			local: &GeneratorOptions{
+				DisableNameSuffixHash: true,
+			},
+			global: &GeneratorOptions{
+				DisableNameSuffixHash: true,
+			},
+			expected: &GeneratorOptions{
+				DisableNameSuffixHash: true,
+			},
+		},
+	}
+	for _, tc := range tests {
+		actual := MergeGlobalOptionsIntoLocal(tc.local, tc.global)
+		if !reflect.DeepEqual(tc.expected, actual) {
+			t.Fatalf("%s annotations: Expected '%v', got '%v'",
+				tc.name, tc.expected, *actual)
+		}
+	}
+}