msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

fix(templating): SplitManifests must preserve line endings for downstream YAML parsers

Browse Source 
Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
pull/31952/head
Matheus Pimenta 3 weeks ago
parent a27f1add79
commit 159198f928
No known key found for this signature in database
GPG Key ID: 4639F038AE28FBFF
19 changed files with 1195 additions and 30 deletions
Show Stats Download Patch File Download Diff File

667
pkg/action/action_test.go
Unescape View File

@ -418,7 +418,8 @@ func TestAnnotateAndMerge(t *testing.T) {
{
name: "single file with single manifest",
files: map[string]string{
"templates/configmap.yaml": `apiVersion: v1
"templates/configmap.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test-cm
@ -438,13 +439,15 @@ data:
{
name: "multiple files with multiple manifests",
files: map[string]string{
"templates/configmap.yaml": `apiVersion: v1
"templates/configmap.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test-cm
data:
key: value`,
"templates/secret.yaml": `apiVersion: v1
"templates/secret.yaml": `
apiVersion: v1
kind: Secret
metadata:
name: test-secret
@ -473,7 +476,8 @@ data:
{
name: "file with multiple manifests",
files: map[string]string{
"templates/multi.yaml": `apiVersion: v1
"templates/multi.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test-cm1
@ -509,7 +513,8 @@ data:
{
name: "partials and empty files are removed",
files: map[string]string{
"templates/cm.yaml": `apiVersion: v1
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test-cm1
@ -531,14 +536,16 @@ metadata:
{
name: "empty file",
files: map[string]string{
"templates/empty.yaml": "",
"templates/empty.yaml": `
`,
},
expected: ``,
},
{
name: "invalid yaml",
files: map[string]string{
"templates/invalid.yaml": `invalid: yaml: content:
"templates/invalid.yaml": `
invalid: yaml: content:
- malformed`,
},
expectedError: "parsing templates/invalid.yaml",
@ -546,7 +553,12 @@ metadata:
{
name: "leading doc separator glued to content by template whitespace trimming",
files: map[string]string{
"templates/service.yaml": "---apiVersion: v1\nkind: Service\nmetadata:\n name: test-svc\n",
"templates/service.yaml": `
---apiVersion: v1
kind: Service
metadata:
name: test-svc
`,
},
expected: `apiVersion: v1
kind: Service
@ -559,7 +571,13 @@ metadata:
{
name: "leading doc separator on its own line",
files: map[string]string{
"templates/service.yaml": "---\napiVersion: v1\nkind: Service\nmetadata:\n name: test-svc\n",
"templates/service.yaml": `
---
apiVersion: v1
kind: Service
metadata:
name: test-svc
`,
},
expected: `apiVersion: v1
kind: Service
@ -572,7 +590,14 @@ metadata:
{
name: "multiple leading doc separators",
files: map[string]string{
"templates/service.yaml": "---\n---\napiVersion: v1\nkind: Service\nmetadata:\n name: test-svc\n",
"templates/service.yaml": `
---
---
apiVersion: v1
kind: Service
metadata:
name: test-svc
`,
},
expected: `apiVersion: v1
kind: Service
@ -585,7 +610,16 @@ metadata:
{
name: "mid-content doc separator glued to content by template whitespace trimming",
files: map[string]string{
"templates/all.yaml": "apiVersion: v1\nkind: ConfigMap\nmetadata:\n name: test-cm\n---apiVersion: v1\nkind: Service\nmetadata:\n name: test-svc\n",
"templates/all.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test-cm
---apiVersion: v1
kind: Service
metadata:
name: test-svc
`,
},
expected: `apiVersion: v1
kind: ConfigMap
@ -631,7 +665,7 @@ metadata:
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/configmap.yaml'
data:
ca.crt: |-
ca.crt: |
------BEGIN CERTIFICATE------
MIICEzCCAXygAwIBAgIQMIMChMLGrR+QvmQvpwAU6zAKBggqhkjOPQQDAzASMRAw
DgYDVQQKEwdBY21lIENvMCAXDTcwMDEwMTAwMDAwMFoYDzIwODQwMTI5MTYwMDAw
@ -667,7 +701,7 @@ metadata:
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/configmap.yaml'
data:
config: |-
config: |
# ---------------------------------------------------------------------------
[section]
key = value
@ -694,7 +728,7 @@ metadata:
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/dashboard.yaml'
data:
dashboard.json: |-
dashboard.json: |
{"options":{"---------":{"color":"#292929","text":"N/A"}}}
`,
},
@ -933,6 +967,602 @@ metadata:
name: cm-12
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/many.yaml'
`,
},
// Block scalar chomping indicator tests: | (clip), |- (strip), |+ (keep)
// combined with 0, 1, and 2 trailing newlines after the block content.
// | (clip) — clips trailing newlines to exactly one
{
name: "block scalar clip (|) with 0 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |
hello`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
`,
},
{
name: "block scalar clip (|) with 1 trailing newline",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |
hello
`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |
hello
`,
},
{
name: "block scalar clip (|) with 2 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |
hello
`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |
hello
`,
},
// |- (strip) — strips all trailing newlines
{
name: "block scalar strip (|-) with 0 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |-
hello`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
`,
},
{
name: "block scalar strip (|-) with 1 trailing newline",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |-
hello
`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
`,
},
{
name: "block scalar strip (|-) with 2 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |-
hello
`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
`,
},
// |+ (keep) — preserves all trailing newlines
{
name: "block scalar keep (|+) with 0 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |+
hello`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
`,
},
{
name: "block scalar keep (|+) with 1 trailing newline",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |+
hello
`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |
hello
`,
},
{
name: "block scalar keep (|+) with 2 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |+
hello
`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |+
hello
`,
},
// Multi-doc tests: block scalar doc is NOT the last document.
// SplitManifests' regex consumes \s*\n before ---, so trailing
// newlines from non-last docs are always stripped.
// | (clip) in multi-doc (first doc)
{
name: "multi-doc block scalar clip (|) with 0 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
data:
val: simple`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
val: simple
`,
},
{
name: "multi-doc block scalar clip (|) with 1 trailing newline",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
data:
val: simple`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
val: simple
`,
},
{
name: "multi-doc block scalar clip (|) with 2 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
data:
val: simple`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
val: simple
`,
},
// |- (strip) in multi-doc (first doc)
{
name: "multi-doc block scalar strip (|-) with 0 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
data:
val: simple`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
val: simple
`,
},
{
name: "multi-doc block scalar strip (|-) with 1 trailing newline",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
data:
val: simple`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
val: simple
`,
},
{
name: "multi-doc block scalar strip (|-) with 2 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
data:
val: simple`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
val: simple
`,
},
// |+ (keep) in multi-doc (first doc)
{
name: "multi-doc block scalar keep (|+) with 0 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |+
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
data:
val: simple`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
val: simple
`,
},
{
name: "multi-doc block scalar keep (|+) with 1 trailing newline",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |+
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
data:
val: simple`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
val: simple
`,
},
{
name: "multi-doc block scalar keep (|+) with 2 trailing newlines",
files: map[string]string{
"templates/cm.yaml": `
apiVersion: v1
kind: ConfigMap
metadata:
name: test
data:
key: |+
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
data:
val: simple`,
},
expected: `apiVersion: v1
kind: ConfigMap
metadata:
name: test
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
key: |-
hello
---
apiVersion: v1
kind: ConfigMap
metadata:
name: test2
annotations:
postrenderer.helm.sh/postrender-filename: 'templates/cm.yaml'
data:
val: simple
`,
},
}
@ -1201,12 +1831,15 @@ func TestRenderResources_PostRenderer_Success(t *testing.T) {
expectedBuf := `---
# Source: yellow/templates/foodpie
foodpie: world
---
# Source: yellow/templates/with-partials
yellow: Earth
---
# Source: yellow/templates/yellow
yellow: world
`
expectedHook := `kind: ConfigMap
metadata:
@ -1214,7 +1847,8 @@ metadata:
annotations:
"helm.sh/hook": post-install,pre-delete,post-upgrade
data:
name: value`
name: value
`
assert.Equal(t, expectedBuf, buf.String())
assert.Len(t, hooks, 1)
@ -1319,14 +1953,17 @@ func TestRenderResources_PostRenderer_Integration(t *testing.T) {
# Source: hello/templates/goodbye
goodbye: world
color: blue
---
# Source: hello/templates/hello
hello: world
color: blue
---
# Source: hello/templates/with-partials
hello: Earth
color: blue
`
assert.Contains(t, output, "color: blue")
assert.Equal(t, 3, strings.Count(output, "color: blue"))

1
pkg/action/testdata/rbac.txt vendored
Unescape View File

@ -23,3 +23,4 @@ subjects:
- kind: ServiceAccount
name: schedule-agents
namespace: spaced

1
pkg/cmd/testdata/output/install-dry-run-with-secret-hidden.txt vendored
Unescape View File

@ -19,3 +19,4 @@ metadata:
data:
foo: bar

2
pkg/cmd/testdata/output/install-dry-run-with-secret.txt vendored
Unescape View File

@ -15,6 +15,7 @@ metadata:
name: test-secret
stringData:
foo: bar
---
# Source: chart-with-secret/templates/configmap.yaml
apiVersion: v1
@ -24,3 +25,4 @@ metadata:
data:
foo: bar

1
pkg/cmd/testdata/output/issue-9027.txt vendored
Unescape View File

@ -11,6 +11,7 @@ hash:
key4: 4
key5: 5
key6: 6
---
# Source: issue-9027/templates/values.yaml
global:

1
pkg/cmd/testdata/output/object-order.txt vendored
Unescape View File

@ -155,6 +155,7 @@ spec:
policyTypes:
- Egress
- Ingress
---
# Source: object-order/templates/01-a.yml
# 4 (Deployment should come after all NetworkPolicy manifests, since 'helm template' outputs in install order)

7
pkg/cmd/testdata/output/template-name-template.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/role.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -14,6 +15,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -28,6 +30,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -45,6 +48,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -62,6 +66,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -93,6 +98,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -112,3 +118,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

7
pkg/cmd/testdata/output/template-set.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/role.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -14,6 +15,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -28,6 +30,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -45,6 +48,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -62,6 +66,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -93,6 +98,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -112,3 +118,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

5
pkg/cmd/testdata/output/template-skip-tests.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/role.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -14,6 +15,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -28,6 +30,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -45,6 +48,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -62,6 +66,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1

7
pkg/cmd/testdata/output/template-subchart-cm-set-file.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/configmap.yaml
apiVersion: v1
@ -22,6 +23,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -36,6 +38,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -53,6 +56,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -70,6 +74,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -101,6 +106,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -120,3 +126,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

7
pkg/cmd/testdata/output/template-subchart-cm-set.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/configmap.yaml
apiVersion: v1
@ -22,6 +23,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -36,6 +38,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -53,6 +56,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -70,6 +74,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -101,6 +106,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -120,3 +126,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

7
pkg/cmd/testdata/output/template-subchart-cm.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/configmap.yaml
apiVersion: v1
@ -22,6 +23,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -36,6 +38,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -53,6 +56,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -70,6 +74,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -101,6 +106,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -120,3 +126,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

7
pkg/cmd/testdata/output/template-values-files.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/role.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -14,6 +15,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -28,6 +30,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -45,6 +48,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -62,6 +66,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -93,6 +98,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -112,3 +118,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

7
pkg/cmd/testdata/output/template-with-api-version.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/role.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -14,6 +15,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -28,6 +30,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -45,6 +48,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -62,6 +66,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -95,6 +100,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -114,3 +120,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

7
pkg/cmd/testdata/output/template-with-crds.txt vendored
Unescape View File

@ -21,6 +21,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/role.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -31,6 +32,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -45,6 +47,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -62,6 +65,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -79,6 +83,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -110,6 +115,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -129,3 +135,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

7
pkg/cmd/testdata/output/template-with-kube-version.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/role.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -14,6 +15,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -28,6 +30,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -45,6 +48,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -62,6 +66,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -93,6 +98,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -112,3 +118,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

7
pkg/cmd/testdata/output/template.txt vendored
Unescape View File

@ -4,6 +4,7 @@ apiVersion: v1
kind: ServiceAccount
metadata:
name: subchart-sa
---
# Source: subchart/templates/subdir/role.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -14,6 +15,7 @@ rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get","list","watch"]
---
# Source: subchart/templates/subdir/rolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
@ -28,6 +30,7 @@ subjects:
- kind: ServiceAccount
name: subchart-sa
namespace: default
---
# Source: subchart/charts/subcharta/templates/service.yaml
apiVersion: v1
@ -45,6 +48,7 @@ spec:
name: apache
selector:
app.kubernetes.io/name: subcharta
---
# Source: subchart/charts/subchartb/templates/service.yaml
apiVersion: v1
@ -62,6 +66,7 @@ spec:
name: nginx
selector:
app.kubernetes.io/name: subchartb
---
# Source: subchart/templates/service.yaml
apiVersion: v1
@ -93,6 +98,7 @@ metadata:
"helm.sh/hook": test
data:
message: Hello World
---
# Source: subchart/templates/tests/test-nothing.yaml
apiVersion: v1
@ -112,3 +118,4 @@ spec:
- echo
- "$message"
restartPolicy: Never

7
pkg/release/v1/util/manifest.go
Unescape View File

@ -21,6 +21,7 @@ import (
"regexp"
"strconv"
"strings"
"unicode"
)
// SimpleHead defines what the structure of the head of a manifest file
@ -35,7 +36,7 @@ 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
@ -53,7 +54,7 @@ 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 {
@ -61,7 +62,7 @@ func SplitManifests(bigFile string) map[string]string {
continue
}
d = strings.TrimSpace(d)
d = strings.TrimLeftFunc(d, unicode.IsSpace)
res[fmt.Sprintf(tpl, count)] = d
count = count + 1
}

470
pkg/release/v1/util/manifest_test.go
Unescape View File

@ -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
`
const expectedManifest = `apiVersion: v1
`,
expected: map[string]string{
"manifest-0": `apiVersion: v1
kind: Pod
metadata:
name: finding-nemo,
@ -47,15 +55,453 @@ 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: "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) {
manifests := SplitManifests(mockManifestFile)
if len(manifests) != 1 {
t.Errorf("Expected 1 manifest, got %v", len(manifests))
// Block scalar chomping tests: verify that trailing newlines
// are preserved through SplitManifests for single-doc inputs.
// | (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) {
t.Errorf("Expected %v, got %v", expected, manifests)
for _, tt := range tests {
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)
}
})
}
}

Write Preview
Loading…
Cancel
Save