Switch namespace and patch transformers to kyaml.

2026-06-29 09:40:49 +00:00 · 2020-06-27 14:24:12 -07:00
parent 42d1f7b792
commit d3a7335bbc
18 changed files with 234 additions and 81 deletions
--- a/api/builtins/NamespaceTransformer.go
+++ b/api/builtins/NamespaceTransformer.go
@@ -5,6 +5,7 @@ package builtins

 import (
 	"fmt"
+	"strings"

 	"sigs.k8s.io/kustomize/api/filters/namespace"
 	"sigs.k8s.io/kustomize/api/resid"
@@ -31,6 +32,11 @@ func (p *NamespaceTransformerPlugin) Config(
 	_ *resmap.PluginHelpers, c []byte) (err error) {
 	p.Namespace = ""
 	p.FieldSpecs = nil
+	if !strings.Contains(string(c), "yamlSupport") {
+		// If not explicitly denied,
+		// activate kyaml-based transformation.
+		p.YAMLSupport = true
+	}
 	return yaml.Unmarshal(c, p)
 }

--- a/api/builtins/PatchJson6902Transformer.go
+++ b/api/builtins/PatchJson6902Transformer.go
@@ -5,6 +5,7 @@ package builtins

 import (
 	"fmt"
+	"strings"

 	jsonpatch "github.com/evanphx/json-patch"
 	"github.com/pkg/errors"
@@ -34,6 +35,11 @@ func (p *PatchJson6902TransformerPlugin) Config(
 	if err != nil {
 		return err
 	}
+	if !strings.Contains(string(c), "yamlSupport") {
+		// If not explicitly denied,
+		// activate kyaml-based transformation.
+		p.YAMLSupport = true
+	}
 	if p.Target.Name == "" {
 		return fmt.Errorf("must specify the target name")
 	}
--- a/api/builtins/PatchStrategicMergeTransformer.go
+++ b/api/builtins/PatchStrategicMergeTransformer.go
@@ -5,6 +5,7 @@ package builtins

 import (
 	"fmt"
+	"strings"

 	"sigs.k8s.io/kustomize/api/filters/patchstrategicmerge"
 	"sigs.k8s.io/kustomize/api/resmap"
@@ -30,6 +31,11 @@ func (p *PatchStrategicMergeTransformerPlugin) Config(
 	if err != nil {
 		return err
 	}
+	if !strings.Contains(string(c), "yamlSupport") {
+		// If not explicitly denied,
+		// activate kyaml-based transformation.
+		p.YAMLSupport = true
+	}
 	if len(p.Paths) == 0 && p.Patches == "" {
 		return fmt.Errorf("empty file path and empty patch content")
 	}
@@ -75,17 +81,6 @@ func (p *PatchStrategicMergeTransformerPlugin) Transform(m resmap.ResMap) error
 		}
 		if !p.YAMLSupport {
 			err = target.Patch(patch.Copy())
-			if err != nil {
-				return err
-			}
-			// remove the resource from resmap
-			// when the patch is to $patch: delete that target
-			if len(target.Map()) == 0 {
-				err = m.Remove(target.CurId())
-				if err != nil {
-					return err
-				}
-			}
 		} else {
 			patchCopy := patch.DeepCopy()
 			patchCopy.SetName(target.GetName())
@@ -99,6 +94,19 @@ func (p *PatchStrategicMergeTransformerPlugin) Transform(m resmap.ResMap) error
 				Patch: node,
 			}, target)
 		}
+		if err != nil {
+			return err
+		}
+		if len(target.Map()) == 0 {
+			// This means all fields have been removed from the object.
+			// This can happen if a patch required deletion of the
+			// entire resource (not just a part of it).  This means
+			// the overall resmap must shrink by one.
+			err = m.Remove(target.CurId())
+			if err != nil {
+				return err
+			}
+		}
 	}
 	return nil
 }
--- a/api/builtins/PatchTransformer.go
+++ b/api/builtins/PatchTransformer.go
@@ -34,6 +34,11 @@ func (p *PatchTransformerPlugin) Config(
 	if err != nil {
 		return err
 	}
+	if !strings.Contains(string(c), "yamlSupport") {
+		// If not explicitly denied,
+		// activate kyaml-based transformation.
+		p.YAMLSupport = true
+	}
 	p.Patch = strings.TrimSpace(p.Patch)
 	if p.Patch == "" && p.Path == "" {
 		return fmt.Errorf(
--- a/api/filters/patchstrategicmerge/patchstrategicmerge.go
+++ b/api/filters/patchstrategicmerge/patchstrategicmerge.go
@@ -1,3 +1,6 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
 package patchstrategicmerge

 import (
@@ -13,9 +16,13 @@ type Filter struct {
 var _ kio.Filter = Filter{}

 func (pf Filter) Filter(nodes []*yaml.RNode) ([]*yaml.RNode, error) {
-	return kio.FilterAll(yaml.FilterFunc(pf.run)).Filter(nodes)
-}
-
-func (pf Filter) run(node *yaml.RNode) (*yaml.RNode, error) {
-	return merge2.Merge(pf.Patch, node)
+	var result []*yaml.RNode
+	for i := range nodes {
+		r, err := merge2.Merge(pf.Patch, nodes[i])
+		if err != nil {
+			return nil, err
+		}
+		result = append(result, r)
+	}
+	return result, nil
 }
--- a/api/krusty/baseandoverlaymedium_test.go
+++ b/api/krusty/baseandoverlaymedium_test.go
@@ -225,13 +225,13 @@ spec:
    spec:
      containers:
      - env:
+        - name: foo
+          value: bar
        - name: FOO
          valueFrom:
            configMapKeyRef:
              key: somekey
              name: test-infra-app-env-ffmd9b969m
-        - name: foo
-          value: bar
        image: nginx:1.8.0
        name: nginx
        ports:
--- a/api/krusty/customconfig_test.go
+++ b/api/krusty/customconfig_test.go
@@ -59,6 +59,7 @@ spec:
  location: SW
 `)
 	th.WriteF("/app/base/animalPark.yaml", `
+apiVersion: foo
 kind: AnimalPark
 metadata:
  name: sandiego
@@ -93,6 +94,7 @@ varReference:
 `)
 	m := th.Run("/app/base", th.MakeDefaultOptions())
 	th.AssertActualEqualsExpected(m, `
+apiVersion: foo
 kind: AnimalPark
 metadata:
  labels:
@@ -161,6 +163,7 @@ varReference:
 `)
 	m := th.Run("/app/base", th.MakeDefaultOptions())
 	th.AssertActualEqualsExpected(m, `
+apiVersion: foo
 kind: AnimalPark
 metadata:
  labels:
@@ -212,14 +215,17 @@ func TestFixedBug605_BaseCustomizationAvailableInOverlay(t *testing.T) {
 nameReference:
 - kind: Gorilla
  fieldSpecs:
-  - kind: AnimalPark
+  - apiVersion: foo
+    kind: AnimalPark
    path: spec/gorillaRef/name
 - kind: Giraffe
  fieldSpecs:
-  - kind: AnimalPark
+  - apiVersion: foo
+    kind: AnimalPark
    path: spec/giraffeRef/name
 varReference:
 - path: spec/food
+  apiVersion: foo
  kind: AnimalPark
 `)
 	th.WriteK("/app/overlay", `
@@ -242,6 +248,7 @@ spec:
 `)
 	// The following replaces the gorillaRef in the AnimalPark.
 	th.WriteF("/app/overlay/animalPark.yaml", `
+apiVersion: foo
 kind: AnimalPark
 metadata:
  name: sandiego
@@ -251,6 +258,7 @@ spec:
 `)
 	m := th.Run("/app/overlay", th.MakeDefaultOptions())
 	th.AssertActualEqualsExpected(m, `
+apiVersion: foo
 kind: AnimalPark
 metadata:
  labels:
--- a/api/krusty/extendedpatch_test.go
+++ b/api/krusty/extendedpatch_test.go
@@ -156,8 +156,7 @@ spec:
        - mountPath: /tmp/ps
          name: busybox-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: busybox-persistent-storage
+      - name: busybox-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -233,8 +232,7 @@ spec:
        - mountPath: /tmp/ps
          name: nginx-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: nginx-persistent-storage
+      - name: nginx-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -260,8 +258,7 @@ spec:
        - mountPath: /tmp/ps
          name: busybox-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: busybox-persistent-storage
+      - name: busybox-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -335,8 +332,7 @@ spec:
        - mountPath: /tmp/ps
          name: nginx-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: nginx-persistent-storage
+      - name: nginx-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -463,8 +459,7 @@ spec:
        - mountPath: /tmp/ps
          name: busybox-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: busybox-persistent-storage
+      - name: busybox-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -564,8 +559,7 @@ spec:
        - mountPath: /tmp/ps
          name: busybox-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: busybox-persistent-storage
+      - name: busybox-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -667,8 +661,7 @@ spec:
        - mountPath: /tmp/ps
          name: busybox-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: busybox-persistent-storage
+      - name: busybox-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -769,8 +762,7 @@ spec:
        - mountPath: /tmp/ps
          name: busybox-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: busybox-persistent-storage
+      - name: busybox-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -965,8 +957,7 @@ spec:
        - mountPath: /tmp/ps
          name: busybox-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: busybox-persistent-storage
+      - name: busybox-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -1180,8 +1171,7 @@ spec:
        - mountPath: /tmp/ps
          name: busybox-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: busybox-persistent-storage
+      - name: busybox-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
--- a/api/krusty/generatormergeandreplace_test.go
+++ b/api/krusty/generatormergeandreplace_test.go
@@ -150,8 +150,6 @@ spec:

 func makeBaseWithGenerators(th kusttest_test.Harness) {
 	th.WriteK("/app", `
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
 namePrefix: team-foo-
 commonLabels:
  app: mynginx
@@ -325,8 +323,6 @@ spec:
        name: configmap-in-overlay
 `)
 	th.WriteK("/overlay", `
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
 namePrefix: staging-
 commonLabels:
  env: staging
@@ -389,12 +385,12 @@ spec:
      - gcePersistentDisk:
          pdName: nginx-persistent-storage
        name: nginx-persistent-storage
-      - configMap:
-          name: staging-configmap-in-overlay-k7cbc75tg8
-        name: configmap-in-overlay
      - configMap:
          name: staging-team-foo-configmap-in-base-gh9d7t85gb
        name: configmap-in-base
+      - configMap:
+          name: staging-configmap-in-overlay-k7cbc75tg8
+        name: configmap-in-overlay
 ---
 apiVersion: v1
 kind: Service
--- a/api/krusty/inlinepatch_test.go
+++ b/api/krusty/inlinepatch_test.go
@@ -79,8 +79,7 @@ spec:
        - mountPath: /tmp/ps
          name: nginx-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: nginx-persistent-storage
+      - name: nginx-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
@@ -223,8 +222,7 @@ spec:
        - mountPath: /tmp/ps
          name: nginx-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: nginx-persistent-storage
+      - name: nginx-persistent-storage
      - configMap:
          name: configmap-in-base
        name: configmap-in-base
--- a/api/krusty/multiplepatch_test.go
+++ b/api/krusty/multiplepatch_test.go
@@ -146,12 +146,12 @@ spec:
      - gcePersistentDisk:
          pdName: nginx-persistent-storage
        name: nginx-persistent-storage
-      - configMap:
-          name: a-configmap-in-overlay-ffm9hf78mc
-        name: configmap-in-overlay
      - configMap:
          name: a-b-configmap-in-base-fm96mhk4dt
        name: configmap-in-base
+      - configMap:
+          name: a-configmap-in-overlay-ffm9hf78mc
+        name: configmap-in-overlay
 ---
 apiVersion: v1
 kind: Service
@@ -190,8 +190,6 @@ metadata:

 func makeCommonFileForMultiplePatchTest(th kusttest_test.Harness) {
 	th.WriteK("/app/base", `
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
 namePrefix: team-foo-
 commonLabels:
  app: mynginx
@@ -249,8 +247,6 @@ spec:
    app: nginx
 `)
 	th.WriteK("/app/overlay/staging", `
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
 namePrefix: staging-
 commonLabels:
  env: staging
@@ -355,12 +351,12 @@ spec:
      - gcePersistentDisk:
          pdName: nginx-persistent-storage
        name: nginx-persistent-storage
-      - configMap:
-          name: staging-configmap-in-overlay-k7cbc75tg8
-        name: configmap-in-overlay
      - configMap:
          name: staging-team-foo-configmap-in-base-g7k6gt2889
        name: configmap-in-base
+      - configMap:
+          name: staging-configmap-in-overlay-k7cbc75tg8
+        name: configmap-in-overlay
 ---
 apiVersion: v1
 kind: Service
@@ -544,8 +540,7 @@ spec:
        - mountPath: /tmp/ps
          name: nginx-persistent-storage
      volumes:
-      - emptyDir: {}
-        name: nginx-persistent-storage
+      - name: nginx-persistent-storage
      - configMap:
          name: staging-team-foo-configmap-in-base-g7k6gt2889
        name: configmap-in-base