feat: (re)release process-templates flag override input

action.yml

@@ -17,6 +17,10 @@ inputs:
   settings:
     description: The settings to extract.
     required: false
+  process-templates:
+    description: "Enable/disable processing of Go templates in Atmos stacks manifests."
+    required: false
+    default: "true"
 outputs:
   value:
     description: "The value of the setting when a single setting is returned."

atmos.yaml

@@ -66,6 +66,14 @@ logs:
   verbose: false
   colors: true
 
+templates:
+  settings:
+    enabled: true
+    sprig:
+      enabled: true
+    gomplate:
+      enabled: true
+
 # Custom CLI commands
 commands:
   - name: tf

dist/index.js

@@ -28877,9 +28877,9 @@ exports.NEVER = parseUtil_1.INVALID;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.runAtmosDescribeComponent = void 0;
 const node_child_process_1 = __nccwpck_require__(7718);
-const runAtmosDescribeComponent = async (component, stack, cwd) => {
+const runAtmosDescribeComponent = async (component, stack, processTemplates, cwd) => {
     const options = cwd ? { cwd } : {};
-    const command = `atmos describe component ${component} -s ${stack} --format=json`;
+    const command = `atmos describe component ${component} -s ${stack} --format=json --process-templates=${String(processTemplates)}`;
     const atmos = (0, node_child_process_1.execSync)(command, options);
     return atmos.toString();
 };
@@ -28944,8 +28944,8 @@ exports.SettingInput = zod_1.z.object({
     outputPath: zod_1.z.string().trim().min(1)
 });
 exports.SettingsInput = zod_1.z.array(exports.SettingInput).min(1);
-const getSetting = async (component, stack, settingsPath) => {
-    const cmdOutput = await (0, atmos_1.runAtmosDescribeComponent)(component, stack);
+const getSetting = async (component, stack, settingsPath, processTemplates) => {
+    const cmdOutput = await (0, atmos_1.runAtmosDescribeComponent)(component, stack, processTemplates);
     const json = JSON.parse(cmdOutput);
     return (0, exports.getNestedValue)(json, settingsPath);
 };
@@ -28987,8 +28987,9 @@ const core = __importStar(__nccwpck_require__(2186));
 const _useCase_1 = __nccwpck_require__(9264);
 (async () => {
     try {
-        const singleResult = await (0, _useCase_1.processSingleSetting)();
-        const multipleResult = await (0, _useCase_1.processMultipleSettings)();
+        const processTemplates = core.getBooleanInput("process-templates");
+        const singleResult = await (0, _useCase_1.processSingleSetting)(processTemplates);
+        const multipleResult = await (0, _useCase_1.processMultipleSettings)(processTemplates);
         if (singleResult || multipleResult) {
             core.info("result returned successfully");
         }
@@ -29065,7 +29066,7 @@ exports.processMultipleSettings = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const _lib_1 = __nccwpck_require__(6791);
 const YAML = __importStar(__nccwpck_require__(4083));
-const processMultipleSettings = async () => {
+const processMultipleSettings = async (processTemplates) => {
     const settingsInput = core.getInput("settings");
     if (settingsInput) {
         const yaml = YAML.parse(settingsInput);
@@ -29075,7 +29076,7 @@ const processMultipleSettings = async () => {
             const output = await settings.reduce(async (accPromise, item) => {
                 const acc = await accPromise;
                 const { outputPath, ...rest } = item;
-                const result = await (0, _lib_1.getSetting)(item.component, item.stack, item.settingsPath);
+                const result = await (0, _lib_1.getSetting)(item.component, item.stack, item.settingsPath, processTemplates);
                 return { ...acc, [outputPath]: result };
             }, Promise.resolve({}));
             core.setOutput("settings", JSON.stringify(output));
@@ -29121,7 +29122,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.processSingleSetting = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const _lib_1 = __nccwpck_require__(6791);
-const processSingleSetting = async () => {
+const processSingleSetting = async (processTemplates) => {
     const component = core.getInput("component");
     const stack = core.getInput("stack");
     const settingsPath = core.getInput("settings-path");
@@ -29132,7 +29133,7 @@ const processSingleSetting = async () => {
     };
     const parseResult = _lib_1.SingleSettingInput.safeParse(singleSetting);
     if (parseResult.success) {
-        const value = await (0, _lib_1.getSetting)(parseResult.data.component, parseResult.data.stack, parseResult.data["settings-path"]);
+        const value = await (0, _lib_1.getSetting)(parseResult.data.component, parseResult.data.stack, parseResult.data["settings-path"], processTemplates);
         core.setOutput("value", value);
         return true;
     }

src/lib/atmos.test.ts

@@ -2,7 +2,7 @@ import { runAtmosDescribeComponent } from "./atmos";
 
 describe("runAtmosDescribeComponent", () => {
   it("should return a string", async () => {
-    const result = JSON.parse(await runAtmosDescribeComponent("foo", "core-ue1-dev"));
+    const result = JSON.parse(await runAtmosDescribeComponent("foo", "core-ue1-dev", true));
     expect(result.atmos_component).toEqual("foo");
     expect(result.atmos_stack).toEqual("core-ue1-dev");
   });

src/lib/atmos.ts

@@ -1,9 +1,8 @@
 import { execSync } from "node:child_process";
 
-export const runAtmosDescribeComponent = async (component: string, stack: string, cwd?: string) => {
+export const runAtmosDescribeComponent = async (component: string, stack: string, processTemplates: boolean, cwd?: string) => {
   const options = cwd ? { cwd } : {};
-
-  const command = `atmos describe component ${component} -s ${stack} --format=json`;
+  const command = `atmos describe component ${component} -s ${stack} --format=json --process-templates=${String(processTemplates)}`;
   const atmos = execSync(command, options);
   return atmos.toString();
 };

src/lib/settings.test.ts

@@ -29,8 +29,8 @@ describe("getSingleSetting", () => {
     const settingValue = await getSetting(
       "foo",
       "core-ue1-dev",
-      "atmos_cli_config.components.terraform.base_path"
-    );
+      "atmos_cli_config.components.terraform.base_path",
+      true);
     expect(settingValue).toEqual("components/terraform");
   });
 });

src/lib/settings.ts

@@ -31,9 +31,10 @@ export type SettingsInput = z.infer<typeof SettingsInput>;
 export const getSetting = async (
   component: string,
   stack: string,
-  settingsPath: string
+  settingsPath: string,
+  processTemplates: boolean
 ) => {
-  const cmdOutput = await runAtmosDescribeComponent(component, stack);
+  const cmdOutput = await runAtmosDescribeComponent(component, stack, processTemplates);
   const json = JSON.parse(cmdOutput);
 
   return getNestedValue(json, settingsPath);

src/main.ts

@@ -3,8 +3,9 @@ import { processMultipleSettings, processSingleSetting } from "@useCase";
 
 (async () => {
   try {
-    const singleResult = await processSingleSetting();
-    const multipleResult = await processMultipleSettings();
+    const processTemplates = core.getBooleanInput("process-templates");
+    const singleResult = await processSingleSetting(processTemplates);
+    const multipleResult = await processMultipleSettings(processTemplates);
 
     if (singleResult || multipleResult) {
       core.info("result returned successfully");

src/useCase/process-multiple-settings.test.ts

@@ -46,7 +46,7 @@ describe("multipleSettings", () => {
   });
 
   it("should return an object", async () => {
-    const result = await processMultipleSettings();
+    const result = await processMultipleSettings(true);
     expect(outputs["settings"]).toEqual(
       '{"prop1":"components/terraform","secretArn":"arn:aws:secretsmanager:us-east-1:000000000000:secret:MySecret-PlMes3"}'
     );

src/useCase/process-multiple-settings.ts

@@ -2,7 +2,7 @@ import * as core from "@actions/core";
 import { getSetting, SettingsInput } from "@lib";
 import * as YAML from "yaml";
 
-export const processMultipleSettings = async () => {
+export const processMultipleSettings = async (processTemplates: boolean) => {
   const settingsInput = core.getInput("settings");
 
   if (settingsInput) {
@@ -18,8 +18,8 @@ export const processMultipleSettings = async () => {
         const result = await getSetting(
           item.component,
           item.stack,
-          item.settingsPath
-        );
+          item.settingsPath,
+          processTemplates);
         return { ...acc, [outputPath]: result };
       }, Promise.resolve({}));
 

src/useCase/process-single-setting.test.ts

@@ -12,7 +12,7 @@ describe("singleSetting", () => {
     const mockValues: any = {
       component: "foo",
       stack: "core-ue1-dev",
-      "settings-path": "atmos_cli_config.components.terraform.base_path"
+      "settings-path": "atmos_cli_config.components.terraform.base_path",
     };
 
     jest
@@ -35,7 +35,83 @@ describe("singleSetting", () => {
   });
 
   it("should return a value", async () => {
-    const result = await processSingleSetting();
+    const result = await processSingleSetting(true);
     expect(outputs["value"]).toEqual("components/terraform");
   });
 });
+
+describe("singleSettingWithTemplatesEnabled", () => {
+  let outputs: any = {};
+
+  beforeEach(() => {
+    outputs = {};
+    const mockValues: any = {
+      component: "hello",
+      stack: "core-ue1-dev",
+      "settings-path": "settings.level1.example",
+    };
+
+    jest
+      .spyOn(core, "getInput")
+      .mockImplementation(
+        (name: string, options?: core.InputOptions | undefined) => {
+          return mockValues[name];
+        }
+      );
+
+    jest
+      .spyOn(core, "setOutput")
+      .mockImplementation((name: string, value: any) => {
+        outputs[name] = value;
+      });
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it("should return a templated value", async () => {
+    const result = await processSingleSetting(true);
+    expect(outputs["value"]).toEqual(
+      "core-ue1-dev"
+    );
+  });
+});
+
+describe("singleSettingWithTemplatesDisabled", () => {
+  let outputs: any = {};
+
+  beforeEach(() => {
+    outputs = {};
+    const mockValues: any = {
+      component: "hello",
+      stack: "core-ue1-dev",
+      "settings-path": "settings.level1.example"
+    };
+
+    jest
+      .spyOn(core, "getInput")
+      .mockImplementation(
+        (name: string, options?: core.InputOptions | undefined) => {
+          return mockValues[name];
+        }
+      );
+
+    jest
+      .spyOn(core, "setOutput")
+      .mockImplementation((name: string, value: any) => {
+        outputs[name] = value;
+      });
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it("should return a template placeholder", async () => {
+    const result = await processSingleSetting(false);
+    expect(outputs["value"]).toEqual(
+      "{{ (printf \"%s-%s-%s\" .vars.tenant .vars.environment .vars.stage) }}"
+    );
+  });
+});

src/useCase/process-single-setting.ts

@@ -2,7 +2,7 @@ import * as core from "@actions/core";
 import { getSetting, SingleSettingInput } from "@lib";
 import * as YAML from "yaml";
 
-export const processSingleSetting = async () => {
+export const processSingleSetting = async (processTemplates: boolean) => {
   const component = core.getInput("component");
   const stack = core.getInput("stack");
   const settingsPath = core.getInput("settings-path");
@@ -19,8 +19,8 @@ export const processSingleSetting = async () => {
     const value = await getSetting(
       parseResult.data.component,
       parseResult.data.stack,
-      parseResult.data["settings-path"]
-    );
+      parseResult.data["settings-path"],
+      processTemplates);
     core.setOutput("value", value);
     return true;
   }

stacks/orgs/demo/dev/templates.yaml

@@ -0,0 +1,12 @@
+components:
+  terraform:
+    hello:
+      settings:
+        level1:
+          example: '{{ (printf "%s-%s-%s" .vars.tenant .vars.environment .vars.stage) }}'
+      vars:
+        namespace: demo
+        tenant: core
+        environment: ue1
+        stage: dev
+        hello: world