feat: support variables:expand (#1691)

Author: ANGkeith

src/data-expander.ts

@@ -221,13 +221,7 @@ export function inheritDefault (gitlabData: any) {
 
 function normalizeGlobalVariables (gitlabData: any) {
     for (const [key, value] of Object.entries<any>(gitlabData.variables ?? {})) {
-        if (value === null) {
-            gitlabData.variables[key] = ""; // variable's values are nullable
-        } else if (Utils.isObject(value)) {
-            gitlabData.variables[key] = String(value["value"]);
-        } else {
-            gitlabData.variables[key] = String(value);
-        }
+        gitlabData.variables[key] = Utils.normalizeVariables(value);
     }
 }
 

src/parser.ts

@@ -138,14 +138,8 @@ export class Parser {
             assert(jobData.when !== "never",
                 chalk`This GitLab CI configuration is invalid: jobs:${jobName} when:never can only be used in a rules section or workflow:rules`,
             );
-            for (const [key, _value] of Object.entries(jobData.variables || {})) {
-                let value = _value;
-                if (value === null) value = ""; // variable's values are nullable
-                assert(
-                    typeof value === "string" || typeof value === "number" || typeof value === "boolean",
-                    chalk`{blueBright ${jobName}} has invalid variables hash of key value pairs. ${key}=${value}`,
-                );
-                jobData.variables[key] = String(value);
+            for (const [key, value] of Object.entries(jobData.variables ?? {})) {
+                jobData.variables[key] = Utils.normalizeVariables(value);
             }
 
             for (let i = 0; i < (jobData.services ?? []).length; i++) {

src/utils.ts

@@ -460,4 +460,17 @@ export class Utils {
         }
         return {};
     }
+
+    static normalizeVariables (variable: any) {
+        if (variable === null) {
+            return ""; // variable's values are nullable
+        } else if (Utils.isObject(variable)) {
+            if (variable["expand"] === false) {
+                return String(variable["value"]).replaceAll("$", () => "$$");
+            }
+            return String(variable["value"]);
+        } else {
+            return String(variable);
+        }
+    }
 }

tests/test-cases/variable-expansion/.gitlab-ci-4.yml

@@ -0,0 +1,36 @@
+---
+variables:
+  DEFAULT_VAR_1: "1"
+  DEFAULT_VAR_2:
+    value: 2 $DEFAULT_VAR_1
+    expand: false
+  DEFAULT_VAR_3:
+    value: 3 $DEFAULT_VAR_1
+    expand: true
+  DEFAULT_VAR_4:
+    # expect expand to be true by default
+    value: 4 $DEFAULT_VAR_1
+
+job:
+  stage: build
+  image: busybox
+  variables:
+    JOB_VAR_1: "1"
+    JOB_VAR_2:
+      value: 2 $JOB_VAR_1
+      expand: false
+    JOB_VAR_3:
+      value: 3 $JOB_VAR_1
+      expand: true
+    JOB_VAR_4:
+      # expect expand to be true by default
+      value: 4 $JOB_VAR_1
+  script:
+    - echo $DEFAULT_VAR_1  # 1
+    - echo $DEFAULT_VAR_2  # 2 $DEFAULT_VAR_1
+    - echo $DEFAULT_VAR_3  # 3 1
+    - echo $DEFAULT_VAR_4  # 4 1
+    - echo $JOB_VAR_1  # 1
+    - echo $JOB_VAR_2  # 2 $JOB_VAR_1
+    - echo $JOB_VAR_3  # 3 1
+    - echo $JOB_VAR_4  # 4 1

tests/test-cases/variable-expansion/integration.test.ts

@@ -103,3 +103,26 @@ test("should expand variables referencing dotenv artifact variables", async () =
     const filteredStdout = writeStreams.stdoutLines.filter(f => f.startsWith("job2 >")).join("\n");
     expect(filteredStdout).toEqual(expected);
 });
+
+test("should support variables:expand", async () => {
+    const writeStreams = new WriteStreamsMock();
+    await handler({
+        cwd: "tests/test-cases/variable-expansion",
+        file: ".gitlab-ci-4.yml",
+        noColor: true,
+    }, writeStreams);
+
+    const expected = `
+job > 1
+job > 2 $DEFAULT_VAR_1
+job > 3 1
+job > 4 1
+job > 1
+job > 2 $JOB_VAR_1
+job > 3 1
+job > 4 1
+`;
+
+    const filteredStdout = writeStreams.stdoutLines.filter(f => f.startsWith("job >")).join("\n");
+    expect(filteredStdout).toEqual(expected.trim());
+});