Port fix to release v2

Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>

internal/release/v2/util/manifest.go

@@ -21,6 +21,7 @@ import (
 	"regexp"
 	"strconv"
 	"strings"
+	"unicode"
 )
 
 // SimpleHead defines what the structure of the head of a manifest file
@@ -35,7 +36,16 @@ type SimpleHead struct {
 
 var sep = regexp.MustCompile("(?:^|\\s*\n)---\\s*")
 
-// SplitManifests takes a string of manifest and returns a map contains individual manifests
+// SplitManifests takes a string of manifest and returns a map that contains individual manifests
+//
+// **Note for Chart API v3**: This function (due to the regex above) has allowed _WRONG_
+// Go templates to be defined inside charts across the years. The generated text from Go
+// templates may contain `---apiVersion: v1`, and this function magically splits this back
+// to `---\napiVersion: v1`. This has caused issues recently after Helm 4 introduced
+// kio.ParseAll to inject annotations when post-renderers are used. In Chart API v3,
+// we should kill this regex with fire (or change it) and expose charts doing the wrong
+// thing Go template-wise. Helm should say a big _NO_ to charts doing the wrong thing,
+// with or without post-renderers.
 func SplitManifests(bigFile string) map[string]string {
 	// Basically, we're quickly splitting a stream of YAML documents into an
 	// array of YAML docs. The file name is just a place holder, but should be
@@ -44,15 +54,15 @@ func SplitManifests(bigFile string) map[string]string {
 	tpl := "manifest-%d"
 	res := map[string]string{}
 	// Making sure that any extra whitespace in YAML stream doesn't interfere in splitting documents correctly.
-	bigFileTmp := strings.TrimSpace(bigFile)
+	bigFileTmp := strings.TrimLeftFunc(bigFile, unicode.IsSpace)
 	docs := sep.Split(bigFileTmp, -1)
 	var count int
 	for _, d := range docs {
-		if d == "" {
+		if strings.TrimSpace(d) == "" {
 			continue
 		}
 
-		d = strings.TrimSpace(d)
+		d = strings.TrimLeftFunc(d, unicode.IsSpace)
 		res[fmt.Sprintf(tpl, count)] = d
 		count = count + 1
 	}

internal/release/v2/util/manifest_test.go

@@ -21,7 +21,15 @@ import (
 	"testing"
 )
 
-const mockManifestFile = `
+func TestSplitManifests(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    string
+		expected map[string]string
+	}{
+		{
+			name: "single doc with leading separator and whitespace",
+			input: `
 
 ---
 apiVersion: v1
@@ -35,9 +43,9 @@ spec:
   - name: nemo-test
     image: fake-image
     cmd: fake-command
-`
+`,
-
+			expected: map[string]string{
-const expectedManifest = `apiVersion: v1
+				"manifest-0": `apiVersion: v1
 kind: Pod
 metadata:
   name: finding-nemo,
@@ -47,15 +55,460 @@ spec:
   containers:
   - name: nemo-test
     image: fake-image
-    cmd: fake-command`
+    cmd: fake-command
+`,
+			},
+		},
+		{
+			name:     "empty input",
+			input:    "",
+			expected: map[string]string{},
+		},
+		{
+			name:     "whitespace only",
+			input:    "  \n\n  \n",
+			expected: map[string]string{},
+		},
+		{
+			name:  "whitespace-only doc after separator is skipped",
+			input: "---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n  name: cm1\n---\n  \n",
+			expected: map[string]string{
+				"manifest-0": "apiVersion: v1\nkind: ConfigMap\nmetadata:\n  name: cm1",
+			},
+		},
+		{
+			name: "single doc no separator",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+`,
+			},
+		},
+		{
+			name: "two docs with proper separator",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm2
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1`,
+				"manifest-1": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm2
+`,
+			},
+		},
 
-func TestSplitManifest(t *testing.T) {
+		// Block scalar chomping tests: verify that trailing newlines
-	manifests := SplitManifests(mockManifestFile)
+		// are preserved through SplitManifests for single-doc inputs.
-	if len(manifests) != 1 {
+
-		t.Errorf("Expected 1 manifest, got %v", len(manifests))
+		// | (clip)
+		{
+			name: "block scalar clip (|) with 0 trailing newlines",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |
+    hello`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |
+    hello`,
+			},
+		},
+		{
+			name: "block scalar clip (|) with 1 trailing newline",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |
+    hello
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |
+    hello
+`,
+			},
+		},
+		{
+			name: "block scalar clip (|) with 2 trailing newlines",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |
+    hello
+
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |
+    hello
+
+`,
+			},
+		},
+
+		// |- (strip)
+		{
+			name: "block scalar strip (|-) with 0 trailing newlines",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |-
+    hello`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |-
+    hello`,
+			},
+		},
+		{
+			name: "block scalar strip (|-) with 1 trailing newline",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |-
+    hello
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |-
+    hello
+`,
+			},
+		},
+		{
+			name: "block scalar strip (|-) with 2 trailing newlines",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |-
+    hello
+
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |-
+    hello
+
+`,
+			},
+		},
+
+		// |+ (keep)
+		{
+			name: "block scalar keep (|+) with 0 trailing newlines",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |+
+    hello`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |+
+    hello`,
+			},
+		},
+		{
+			name: "block scalar keep (|+) with 1 trailing newline",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |+
+    hello
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |+
+    hello
+`,
+			},
+		},
+		{
+			name: "block scalar keep (|+) with 2 trailing newlines",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |+
+    hello
+
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |+
+    hello
+
+`,
+			},
+		},
+
+		// Multi-doc with block scalars: the regex consumes \s*\n before ---,
+		// so trailing newlines from non-last docs are stripped.
+		{
+			name: "multi-doc block scalar clip (|) before separator",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |
+    hello
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test2
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |
+    hello`,
+				"manifest-1": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test2
+`,
+			},
+		},
+		{
+			name: "multi-doc block scalar keep (|+) with 2 trailing newlines before separator",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |+
+    hello
+
+
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test2
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  key: |+
+    hello`,
+				"manifest-1": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test2
+`,
+			},
+		},
+
+		// **Note for Chart API v3**: The following tests exercise the lenient
+		// regex that splits `---apiVersion` back into separate documents.
+		// In Chart API v3, these inputs should return an _ERROR_ instead.
+		// See the comment on the SplitManifests function for more details.
+		{
+			name: "leading glued separator (---apiVersion)",
+			input: `
+---apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1
+`,
+			},
+		},
+		{
+			name: "mid-content glued separator (---apiVersion)",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1
+---apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm2
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1`,
+				"manifest-1": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm2
+`,
+			},
+		},
+		{
+			name: "multiple glued separators",
+			input: `
+---apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1
+---apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm2
+---apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm3
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1`,
+				"manifest-1": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm2`,
+				"manifest-2": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm3
+`,
+			},
+		},
+		{
+			name: "mixed glued and proper separators",
+			input: `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm2
+---apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm3
+`,
+			expected: map[string]string{
+				"manifest-0": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1`,
+				"manifest-1": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm2`,
+				"manifest-2": `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm3
+`,
+			},
+		},
 	}
-	expected := map[string]string{"manifest-0": expectedManifest}
+
-	if !reflect.DeepEqual(manifests, expected) {
+	for _, tt := range tests {
-		t.Errorf("Expected %v, got %v", expected, manifests)
+		t.Run(tt.name, func(t *testing.T) {
+			result := SplitManifests(tt.input)
+			if !reflect.DeepEqual(result, tt.expected) {
+				t.Errorf("SplitManifests() =\n%v\nwant:\n%v", result, tt.expected)
+			}
+		})
 	}
 }