fix: resolve multiline variables in kubernetes manifests correctly (#…

…5270)

* fix: resolve multiline variables in kubernetes manifests correctly

Co-authored-by: Steffen Neubauer <[email protected]>
Co-authored-by: Mikael Högqvist Tabor
 <[email protected]>

* chore: remove context to fix test

---------

Co-authored-by: Steffen Neubauer <[email protected]>
Co-authored-by: Mikael Högqvist Tabor <[email protected]>

core/package.json

@@ -270,7 +270,7 @@
     "check-package-lock": "git diff-index --quiet HEAD -- package-lock.json || (echo 'package-lock.json is dirty!' && exit 1)",
     "check-types": "tsc -p . --noEmit",
     "clean": "shx rm -rf build",
-    "dev": "nodemon --watch src/template-string/*.pegjs --exec yarn build",
+    "dev": "nodemon --watch src/template-string/*.pegjs --exec npm run build",
     "fix-format": "npm run lint -- --fix --quiet",
     "lint": "eslint --ignore-pattern 'src/lib/**' --ext .ts src/ test/",
     "migration:generate": "typeorm migration:generate --config ormconfig.js -n",
@@ -292,4 +292,4 @@
     "fsevents": "^2.3.3"
   },
   "gitHead": "b0647221a4d2ff06952bae58000b104215aed922"
-}
+}

core/src/plugins/kubernetes/kubernetes-type/common.ts

@@ -424,13 +424,14 @@ async function readFileManifests(
       resolvedFiles.map(async (path): Promise<DeclaredManifest[]> => {
         const absPath = resolve(manifestPath, path)
         log.debug(`Reading manifest for ${action.longDescription()} from path ${absPath}`)
-        const str = (await readFile(absPath)).toString()
-        const resolved = ctx.resolveTemplateStrings(str, { allowPartial: true, unescape: true })
+        // parse manifests as yaml before resolving the template strings
+        // to avoid the whole yaml file being treated as single string.
         const manifests = await parseKubernetesManifests(
-          resolved,
+          (await readFile(absPath)).toString(),
           `${basename(absPath)} in directory ${dirname(absPath)} (specified in ${action.longDescription()})`
         )
-        return manifests.map((manifest, index) => ({
+        const resolved = ctx.resolveTemplateStrings(manifests, { allowPartial: true, unescape: true })
+        return resolved.map((manifest, index) => ({
           declaration: {
             type: "file",
             filename: absPath,

core/test/data/test-projects/kubernetes-type/multiline-var-in-manifest/deployment.yml

@@ -0,0 +1,6 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test-configmap
+data:
+  hello: ${var.multiline-var}

core/test/data/test-projects/kubernetes-type/multiline-var-in-manifest/garden.yml

@@ -0,0 +1,11 @@
+kind: Deploy
+type: kubernetes
+name: multiline-var-in-manifest-deploy
+spec:
+  files: [ "deployment.yml" ]
+variables:
+  multiline-var: |
+    this is a
+    multiline
+    variable
+  foo: bar

core/test/integ/src/plugins/kubernetes/kubernetes-type/common.ts

@@ -9,16 +9,18 @@
 import { expect } from "chai"
 import cloneDeep from "fast-copy"
 
+import dedent from "dedent"
+import { omit } from "lodash"
+import { dirname, join } from "path"
+import { Resolved } from "../../../../../../src/actions/types"
+import { ProviderConfigContext } from "../../../../../../src/config/template-contexts/provider"
 import { ConfigGraph } from "../../../../../../src/graph/config-graph"
 import { PluginContext } from "../../../../../../src/plugin-context"
-import { getManifests } from "../../../../../../src/plugins/kubernetes/kubernetes-type/common"
-import { expectError, getDataDir, getExampleDir, makeTestGarden, TestGarden } from "../../../../../helpers"
-import { KubernetesDeployAction } from "../../../../../../src/plugins/kubernetes/kubernetes-type/config"
-import { Resolved } from "../../../../../../src/actions/types"
 import { KubeApi } from "../../../../../../src/plugins/kubernetes/api"
 import { KubernetesProvider } from "../../../../../../src/plugins/kubernetes/config"
-import dedent from "dedent"
-import { dirname, join } from "path"
+import { getManifests } from "../../../../../../src/plugins/kubernetes/kubernetes-type/common"
+import { KubernetesDeployAction } from "../../../../../../src/plugins/kubernetes/kubernetes-type/config"
+import { expectError, getDataDir, getExampleDir, makeTestGarden, TestGarden } from "../../../../../helpers"
 
 let kubernetesTestGarden: TestGarden
 
@@ -149,6 +151,50 @@ describe("getManifests", () => {
     })
   })
 
+  context("resolve template strings in manifests", () => {
+    let action: Resolved<KubernetesDeployAction>
+
+    before(async () => {
+      garden = await getKubernetesTestGarden()
+    })
+
+    beforeEach(async () => {
+      graph = await garden.getConfigGraph({ log: garden.log, emit: false })
+    })
+
+    it("resolves multi-line template strings in the manifests correctly", async () => {
+      action = await garden.resolveAction<KubernetesDeployAction>({
+        action: cloneDeep(graph.getDeploy("multiline-var-in-manifest-deploy")),
+        log: garden.log,
+        graph,
+      })
+      const provider = (await garden.resolveProvider(garden.log, "local-kubernetes")) as KubernetesProvider
+      ctx = await garden.getPluginContext({
+        provider,
+        templateContext: new ProviderConfigContext(garden, provider.dependencies, action.getVariables()),
+        events: undefined,
+      })
+      api = await KubeApi.factory(garden.log, ctx, provider)
+
+      const manifests = await getManifests({ ctx, api, action, log: garden.log, defaultNamespace })
+      const configmap = manifests.find((m) => m.metadata.name === "test-configmap")
+      const expectedConfigMap = {
+        ...configmap,
+        // remove annotations/labels added by garden
+        metadata: omit(configmap?.metadata, ["annotations", "labels"]),
+      }
+      expect(expectedConfigMap).eql({
+        apiVersion: "v1",
+        kind: "ConfigMap",
+        metadata: {
+          name: "test-configmap",
+          namespace: "foobar",
+        },
+        data: { hello: "this is a\nmultiline\nvariable\n" },
+      })
+    })
+  })
+
   context("kustomize", () => {
     const exampleDir = getExampleDir("kustomize")