Merge pull request #2971 from etefera/fix-broken-patches-change

Fix unintended patches change in all Kustomization writes.
kubernetes-sigs · Sep 11, 2020 · fbddd26 · fbddd26
2 parents badc117 + d3c46d3
commit fbddd26
Show file tree

Hide file tree

Showing 5 changed files with 144 additions and 98 deletions.
diff --git a/kustomize/internal/commands/edit/fix/fix.go b/kustomize/internal/commands/edit/fix/fix.go
@@ -39,5 +39,6 @@ func RunFix(fSys filesys.FileSystem) error {
 		return err
 	}
 
+	m.FixKustomizationPreMarshalling()
 	return mf.Write(m)
 }
diff --git a/kustomize/internal/commands/edit/fix/fix_test.go b/kustomize/internal/commands/edit/fix/fix_test.go
@@ -7,6 +7,7 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/google/go-cmp/cmp"
 	"sigs.k8s.io/kustomize/api/filesys"
 	testutils_test "sigs.k8s.io/kustomize/kustomize/v3/internal/commands/testutils"
 )
@@ -31,3 +32,104 @@ func TestFix(t *testing.T) {
 		t.Errorf("expected kind in kustomization")
 	}
 }
+
+func TestFixOutdatedPatchesFieldTitle(t *testing.T) {
+	kustomizationContentWithOutdatedPatchesFieldTitle := []byte(`
+patchesJson6902:
+- path: patch1.yaml
+  target:
+    kind: Service
+- path: patch2.yaml
+  target:
+    group: apps
+    kind: Deployment
+    version: v1
+`)
+
+	expected := []byte(`
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+patches:
+- path: patch1.yaml
+  target:
+    kind: Service
+- path: patch2.yaml
+  target:
+    group: apps
+    kind: Deployment
+    version: v1
+`)
+	fSys := filesys.MakeFsInMemory()
+	testutils_test.WriteTestKustomizationWith(fSys, kustomizationContentWithOutdatedPatchesFieldTitle)
+	cmd := NewCmdFix(fSys)
+	err := cmd.RunE(cmd, nil)
+	if err != nil {
+		t.Errorf("unexpected cmd error: %v", err)
+	}
+	content, err := testutils_test.ReadTestKustomization(fSys)
+	if err != nil {
+		t.Errorf("unexpected read error: %v", err)
+	}
+	if !strings.Contains(string(content), "apiVersion: ") {
+		t.Errorf("expected apiVersion in kustomization")
+	}
+	if !strings.Contains(string(content), "kind: Kustomization") {
+		t.Errorf("expected kind in kustomization")
+	}
+
+	if diff := cmp.Diff(expected, content); diff != "" {
+		t.Errorf("Mismatch (-expected, +actual):\n%s", diff)
+	}
+}
+
+func TestRenameAndKeepOutdatedPatchesField(t *testing.T) {
+	kustomizationContentWithOutdatedPatchesFieldTitle := []byte(`
+patchesJson6902:
+- path: patch1.yaml
+  target:
+    kind: Deployment
+patches:
+- path: patch2.yaml
+  target:
+    kind: Deployment
+- path: patch3.yaml
+  target:
+    kind: Service
+`)
+
+	expected := []byte(`
+patches:
+- path: patch2.yaml
+  target:
+    kind: Deployment
+- path: patch3.yaml
+  target:
+    kind: Service
+- path: patch1.yaml
+  target:
+    kind: Deployment
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+`)
+	fSys := filesys.MakeFsInMemory()
+	testutils_test.WriteTestKustomizationWith(fSys, kustomizationContentWithOutdatedPatchesFieldTitle)
+	cmd := NewCmdFix(fSys)
+	err := cmd.RunE(cmd, nil)
+	if err != nil {
+		t.Errorf("unexpected cmd error: %v", err)
+	}
+	content, err := testutils_test.ReadTestKustomization(fSys)
+	if err != nil {
+		t.Errorf("unexpected read error: %v", err)
+	}
+	if !strings.Contains(string(content), "apiVersion: ") {
+		t.Errorf("expected apiVersion in kustomization")
+	}
+	if !strings.Contains(string(content), "kind: Kustomization") {
+		t.Errorf("expected kind in kustomization")
+	}
+
+	if diff := cmp.Diff(expected, content); diff != "" {
+		t.Errorf("Mismatch (-expected, +actual):\n%s", diff)
+	}
+}
diff --git a/kustomize/internal/commands/edit/set/setimage_test.go b/kustomize/internal/commands/edit/set/setimage_test.go
@@ -145,6 +145,47 @@ func TestSetImage(t *testing.T) {
 					"  newTag: my-tag2",
 				}},
 		},
+		{
+			description: "override file with patch",
+			given: given{
+				args: []string{"image1=foo.bar.foo:8800/foo/image1:foo-bar"},
+				infileImages: []string{
+					"images:",
+					"- name: image1",
+					"  newName: my-image1",
+					"  newTag: my-tag",
+					"- name: image2",
+					"  newName: my-image2",
+					"  newTag: my-tag2",
+					"patchesJson6902:",
+					"- patch: |-",
+					"    - op: remove",
+					"      path: /spec/selector",
+					"  target:",
+					"    kind: Service",
+					"    name: foo",
+					"    version: v1",
+				},
+			},
+			expected: expected{
+				fileOutput: []string{
+					"images:",
+					"- name: image1",
+					"  newName: foo.bar.foo:8800/foo/image1",
+					"  newTag: foo-bar",
+					"- name: image2",
+					"  newName: my-image2",
+					"  newTag: my-tag2",
+					"patchesJson6902:",
+					"- patch: |-",
+					"    - op: remove",
+					"      path: /spec/selector",
+					"  target:",
+					"    kind: Service",
+					"    name: foo",
+					"    version: v1",
+				}},
+		},
 		{
 			description: "override new tag and new name with just a new tag",
 			given: given{

diff --git a/kustomize/internal/commands/kustfile/kustomizationfile.go b/kustomize/internal/commands/kustfile/kustomizationfile.go
@@ -170,7 +170,6 @@ func (mf *kustomizationFile) Write(kustomization *types.Kustomization) error {
 	if kustomization == nil {
 		return errors.New("util: kustomization file arg is nil")
 	}
-	kustomization.FixKustomizationPreMarshalling()
 	data, err := mf.marshal(kustomization)
 	if err != nil {
 		return err

diff --git a/kustomize/internal/commands/kustfile/kustomizationfile_test.go b/kustomize/internal/commands/kustfile/kustomizationfile_test.go
@@ -338,103 +338,6 @@ kind: Kustomization
 	}
 }
 
-func TestRenameAndKeepOutdatedPatchesField(t *testing.T) {
-	kustomizationContentWithOutdatedPatchesFieldTitle := []byte(`
-patchesJson6902:
-- path: patch1.yaml
-  target:
-    kind: Deployment
-patches:
-- path: patch2.yaml
-  target:
-    kind: Deployment
-- path: patch3.yaml
-  target:
-    kind: Service
-`)
-
-	expected := []byte(`
-patches:
-- path: patch2.yaml
-  target:
-    kind: Deployment
-- path: patch3.yaml
-  target:
-    kind: Service
-- path: patch1.yaml
-  target:
-    kind: Deployment
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
-`)
-	fSys := filesys.MakeFsInMemory()
-	testutils_test.WriteTestKustomizationWith(fSys, kustomizationContentWithOutdatedPatchesFieldTitle)
-	mf, err := NewKustomizationFile(fSys)
-	if err != nil {
-		t.Fatalf("Unexpected Error: %v", err)
-	}
-
-	kustomization, err := mf.Read()
-	if err != nil {
-		t.Fatalf("Unexpected Error: %v", err)
-	}
-	if err = mf.Write(kustomization); err != nil {
-		t.Fatalf("Unexpected Error: %v", err)
-	}
-	bytes, _ := fSys.ReadFile(mf.path)
-
-	if diff := cmp.Diff(expected, bytes); diff != "" {
-		t.Errorf("Mismatch (-expected, +actual):\n%s", diff)
-	}
-}
-
-func TestFixOutdatedPatchesFieldTitle(t *testing.T) {
-	kustomizationContentWithOutdatedPatchesFieldTitle := []byte(`
-patchesJson6902:
-- path: patch1.yaml
-  target:
-    kind: Service
-- path: patch2.yaml
-  target:
-    group: apps
-    kind: Deployment
-    version: v1
-`)
-
-	expected := []byte(`
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
-patches:
-- path: patch1.yaml
-  target:
-    kind: Service
-- path: patch2.yaml
-  target:
-    group: apps
-    kind: Deployment
-    version: v1
-`)
-	fSys := filesys.MakeFsInMemory()
-	testutils_test.WriteTestKustomizationWith(fSys, kustomizationContentWithOutdatedPatchesFieldTitle)
-	mf, err := NewKustomizationFile(fSys)
-	if err != nil {
-		t.Fatalf("Unexpected Error: %v", err)
-	}
-
-	kustomization, err := mf.Read()
-	if err != nil {
-		t.Fatalf("Unexpected Error: %v", err)
-	}
-	if err = mf.Write(kustomization); err != nil {
-		t.Fatalf("Unexpected Error: %v", err)
-	}
-	bytes, _ := fSys.ReadFile(mf.path)
-
-	if diff := cmp.Diff(expected, bytes); diff != "" {
-		t.Errorf("Mismatch (-expected, +actual):\n%s", diff)
-	}
-}
-
 func TestUnknownFieldInKustomization(t *testing.T) {
 	kContent := []byte(`
 foo: