feat(config): allow skipping source template rendering in generateFiles

In many cases, it's not desirable to pass files specified under
`generateFiles[].sourcePath` through template resolution. This adds a
flag to control that behavior explicitly.

core/src/config/module.ts

@@ -71,6 +71,7 @@ export interface BaseBuildSpec {
 export interface ModuleFileSpec {
   sourcePath?: string
   targetPath: string
+  resolveTemplates: boolean
   value?: string
 }
 
@@ -129,6 +130,13 @@ const generatedFileSchema = () =>
           Note that any existing file with the same name will be overwritten. If the path contains one or more directories, they will be automatically created if missing.
           `
         ),
+      resolveTemplates: joi
+        .boolean()
+        // TODO: flip this default in 0.13?
+        .default(true)
+        .description(
+          "By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the `value` field, since that's resolved earlier when parsing the configuration."
+        ),
       value: joi.string().description("The desired file contents as a string."),
     })
     .xor("value", "sourcePath")

core/src/resolve-module.ts

@@ -429,10 +429,23 @@ export class ModuleResolver {
       if (fileSpec.sourcePath) {
         const configDir = resolvedConfig.configPath ? dirname(resolvedConfig.configPath) : resolvedConfig.path
         const sourcePath = resolve(configDir, fileSpec.sourcePath)
-        contents = (await readFile(sourcePath)).toString()
+
+        try {
+          contents = (await readFile(sourcePath)).toString()
+        } catch (err) {
+          throw new ConfigurationError(
+            `Unable to read file at ${sourcePath}, specified under generateFiles in module ${resolvedConfig.name}: ${err}`,
+            {
+              sourcePath,
+            }
+          )
+        }
       }
 
-      const resolvedContents = resolveTemplateString(contents, configContext, { unescape: true })
+      const resolvedContents = fileSpec.resolveTemplates
+        ? resolveTemplateString(contents, configContext, { unescape: true })
+        : contents
+
       const targetDir = resolve(resolvedConfig.path, ...posix.dirname(fileSpec.targetPath).split(posix.sep))
       const targetPath = resolve(resolvedConfig.path, ...fileSpec.targetPath.split(posix.sep))
 

core/test/unit/src/config/module-template.ts

@@ -250,7 +250,7 @@ describe("module templates", () => {
             {
               type: "test",
               name: "foo",
-              generateFiles: [{ sourcePath: "foo/bar.txt", targetPath: "foo.txt" }],
+              generateFiles: [{ sourcePath: "foo/bar.txt", targetPath: "foo.txt", resolveTemplates: true }],
             },
           ],
         },

core/test/unit/src/garden.ts

@@ -3102,6 +3102,7 @@ describe("Garden", () => {
             {
               value: "Project name: ${project.name}, Escaped string: $${var.foo}",
               targetPath,
+              resolveTemplates: true,
             },
           ],
         },
@@ -3114,6 +3115,88 @@ describe("Garden", () => {
       expect(contents.toString()).to.equal("Project name: test-project-a, Escaped string: ${var.foo}")
     })
 
+    it("optionally skips resolving template strings when reading a source file", async () => {
+      const garden = await makeTestGardenA()
+
+      const sourcePath = randomString(8) + ".log"
+      const sourceFullPath = join(pathFoo, sourcePath)
+      const value = "Project name: ${project.name}, Escaped string: $${var.foo}"
+
+      await writeFile(sourceFullPath, value)
+
+      const targetPath = "targetfile.log"
+
+      garden.setModuleConfigs([
+        {
+          apiVersion: DEFAULT_API_VERSION,
+          name: "module-a",
+          type: "test",
+          allowPublish: false,
+          build: { dependencies: [] },
+          disabled: false,
+          include: [],
+          path: pathFoo,
+          serviceConfigs: [],
+          taskConfigs: [],
+          testConfigs: [],
+          spec: {},
+          generateFiles: [
+            {
+              sourcePath,
+              targetPath,
+              resolveTemplates: false,
+            },
+          ],
+        },
+      ])
+
+      const module = await garden.resolveModule("module-a")
+      const expectedTargetPath = join(module.path, targetPath)
+      const contents = await readFile(expectedTargetPath)
+
+      expect(contents.toString()).to.equal(value)
+    })
+
+    it("throws helpful error is sourcePath doesn't contain globs and can't be found", async () => {
+      const garden = await makeTestGardenA()
+
+      garden.setModuleConfigs([
+        {
+          apiVersion: DEFAULT_API_VERSION,
+          name: "module-a",
+          type: "test",
+          allowPublish: false,
+          build: { dependencies: [] },
+          disabled: false,
+          include: [],
+          path: pathFoo,
+          serviceConfigs: [],
+          taskConfigs: [],
+          testConfigs: [],
+          spec: {},
+          generateFiles: [
+            {
+              sourcePath: "blorg",
+              targetPath: "targetfile.log",
+              resolveTemplates: false,
+            },
+          ],
+        },
+      ])
+
+      await expectError(
+        () => garden.resolveModule("module-a"),
+        (err) =>
+          expect(stripAnsi(err.message)).to.equal(
+            dedent`
+            Failed resolving one or more modules:
+
+            module-a: Unable to read file at ${pathFoo}/blorg, specified under generateFiles in module module-a: Error: ENOENT: no such file or directory, open '${pathFoo}/blorg'
+            `
+          )
+      )
+    })
+
     it("resolves and writes a module file in a remote module", async () => {
       const garden = await makeTestGarden(pathFoo, {
         config: {
@@ -3157,6 +3240,7 @@ describe("Garden", () => {
               {
                 sourcePath,
                 targetPath,
+                resolveTemplates: true,
               },
             ],
           },
@@ -3220,6 +3304,7 @@ describe("Garden", () => {
               {
                 sourcePath,
                 targetPath,
+                resolveTemplates: true,
               },
             ],
           },

docs/reference/commands.md

@@ -1474,6 +1474,11 @@ providers:
             # directories, they will be automatically created if missing.
             targetPath:
 
+            # By default, Garden will attempt to resolve any Garden template strings in source files. Set this to
+            # false to skip resolving template strings. Note that this does not apply when setting the `value` field,
+            # since that's resolved earlier when parsing the configuration.
+            resolveTemplates:
+
             # The desired file contents as a string.
             value:
 
@@ -1748,6 +1753,11 @@ moduleConfigs:
         # directories, they will be automatically created if missing.
         targetPath:
 
+        # By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to
+        # skip resolving template strings. Note that this does not apply when setting the `value` field, since that's
+        # resolved earlier when parsing the configuration.
+        resolveTemplates:
+
         # The desired file contents as a string.
         value:
 
@@ -2252,6 +2262,11 @@ modules:
         # directories, they will be automatically created if missing.
         targetPath:
 
+        # By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to
+        # skip resolving template strings. Note that this does not apply when setting the `value` field, since that's
+        # resolved earlier when parsing the configuration.
+        resolveTemplates:
+
         # The desired file contents as a string.
         value:
 

docs/reference/module-template-config.md

@@ -147,6 +147,11 @@ modules:
         # directories, they will be automatically created if missing.
         targetPath:
 
+        # By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to
+        # skip resolving template strings. Note that this does not apply when setting the `value` field, since that's
+        # resolved earlier when parsing the configuration.
+        resolveTemplates: true
+
         # The desired file contents as a string.
         value:
 
@@ -470,6 +475,16 @@ Note that any existing file with the same name will be overwritten. If the path
 | ----------- | -------- |
 | `posixPath` | Yes      |
 
+### `modules[].generateFiles[].resolveTemplates`
+
+[modules](#modules) > [generateFiles](#modulesgeneratefiles) > resolveTemplates
+
+By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the `value` field, since that's resolved earlier when parsing the configuration.
+
+| Type      | Default | Required |
+| --------- | ------- | -------- |
+| `boolean` | `true`  | No       |
+
 ### `modules[].generateFiles[].value`
 
 [modules](#modules) > [generateFiles](#modulesgeneratefiles) > value

docs/reference/module-types/configmap.md

@@ -122,6 +122,11 @@ generateFiles:
     # directories, they will be automatically created if missing.
     targetPath:
 
+    # By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to
+    # skip resolving template strings. Note that this does not apply when setting the `value` field, since that's
+    # resolved earlier when parsing the configuration.
+    resolveTemplates: true
+
     # The desired file contents as a string.
     value:
 
@@ -378,6 +383,16 @@ Note that any existing file with the same name will be overwritten. If the path
 | ----------- | -------- |
 | `posixPath` | Yes      |
 
+### `generateFiles[].resolveTemplates`
+
+[generateFiles](#generatefiles) > resolveTemplates
+
+By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the `value` field, since that's resolved earlier when parsing the configuration.
+
+| Type      | Default | Required |
+| --------- | ------- | -------- |
+| `boolean` | `true`  | No       |
+
 ### `generateFiles[].value`
 
 [generateFiles](#generatefiles) > value

docs/reference/module-types/conftest.md

@@ -125,6 +125,11 @@ generateFiles:
     # directories, they will be automatically created if missing.
     targetPath:
 
+    # By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to
+    # skip resolving template strings. Note that this does not apply when setting the `value` field, since that's
+    # resolved earlier when parsing the configuration.
+    resolveTemplates: true
+
     # The desired file contents as a string.
     value:
 
@@ -389,6 +394,16 @@ Note that any existing file with the same name will be overwritten. If the path
 | ----------- | -------- |
 | `posixPath` | Yes      |
 
+### `generateFiles[].resolveTemplates`
+
+[generateFiles](#generatefiles) > resolveTemplates
+
+By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the `value` field, since that's resolved earlier when parsing the configuration.
+
+| Type      | Default | Required |
+| --------- | ------- | -------- |
+| `boolean` | `true`  | No       |
+
 ### `generateFiles[].value`
 
 [generateFiles](#generatefiles) > value

docs/reference/module-types/container.md

@@ -137,6 +137,11 @@ generateFiles:
     # directories, they will be automatically created if missing.
     targetPath:
 
+    # By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to
+    # skip resolving template strings. Note that this does not apply when setting the `value` field, since that's
+    # resolved earlier when parsing the configuration.
+    resolveTemplates: true
+
     # The desired file contents as a string.
     value:
 
@@ -904,6 +909,16 @@ Note that any existing file with the same name will be overwritten. If the path
 | ----------- | -------- |
 | `posixPath` | Yes      |
 
+### `generateFiles[].resolveTemplates`
+
+[generateFiles](#generatefiles) > resolveTemplates
+
+By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the `value` field, since that's resolved earlier when parsing the configuration.
+
+| Type      | Default | Required |
+| --------- | ------- | -------- |
+| `boolean` | `true`  | No       |
+
 ### `generateFiles[].value`
 
 [generateFiles](#generatefiles) > value

docs/reference/module-types/exec.md

@@ -135,6 +135,11 @@ generateFiles:
     # directories, they will be automatically created if missing.
     targetPath:
 
+    # By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to
+    # skip resolving template strings. Note that this does not apply when setting the `value` field, since that's
+    # resolved earlier when parsing the configuration.
+    resolveTemplates: true
+
     # The desired file contents as a string.
     value:
 
@@ -548,6 +553,16 @@ Note that any existing file with the same name will be overwritten. If the path
 | ----------- | -------- |
 | `posixPath` | Yes      |
 
+### `generateFiles[].resolveTemplates`
+
+[generateFiles](#generatefiles) > resolveTemplates
+
+By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the `value` field, since that's resolved earlier when parsing the configuration.
+
+| Type      | Default | Required |
+| --------- | ------- | -------- |
+| `boolean` | `true`  | No       |
+
 ### `generateFiles[].value`
 
 [generateFiles](#generatefiles) > value

docs/reference/module-types/hadolint.md

@@ -128,6 +128,11 @@ generateFiles:
     # directories, they will be automatically created if missing.
     targetPath:
 
+    # By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to
+    # skip resolving template strings. Note that this does not apply when setting the `value` field, since that's
+    # resolved earlier when parsing the configuration.
+    resolveTemplates: true
+
     # The desired file contents as a string.
     value:
 
@@ -377,6 +382,16 @@ Note that any existing file with the same name will be overwritten. If the path
 | ----------- | -------- |
 | `posixPath` | Yes      |
 
+### `generateFiles[].resolveTemplates`
+
+[generateFiles](#generatefiles) > resolveTemplates
+
+By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the `value` field, since that's resolved earlier when parsing the configuration.
+
+| Type      | Default | Required |
+| --------- | ------- | -------- |
+| `boolean` | `true`  | No       |
+
 ### `generateFiles[].value`
 
 [generateFiles](#generatefiles) > value