feat: implement inherit:variables (#1384)

* feat: implement inherit:variables

* chore: add warning message for inherit:default

Author: ANGkeith

src/job.ts

@@ -100,7 +100,12 @@ export class Job {
     readonly exists: string[];
     readonly pipelineIid: number;
     readonly gitData: GitData;
+    readonly inherit: {
+        variables?: boolean | string[];
+        default?: boolean | string[];
+    };
 
+    private readonly _globalVariables: {[key: string]: string} = {};
     private readonly _variables: {[key: string]: string} = {};
     private _dotenvVariables: {[key: string]: string} = {};
     private _prescriptsExitCode: number | null = null;
@@ -126,7 +131,6 @@ export class Job {
         const jobData = opt.data;
         const gitData = opt.gitData;
         const jobVariables = jobData.variables ?? {};
-        const globalVariables = opt.globalVariables ?? {};
         const variablesFromFiles = opt.variablesFromFiles;
         const argv = opt.argv;
         const cwd = argv.cwd;
@@ -143,6 +147,15 @@ export class Job {
         this.jobId = this.generateJobId();
         this.jobData = opt.data;
         this.pipelineIid = opt.pipelineIid;
+        this._globalVariables = opt.globalVariables;
+
+        this.inherit = {};
+        this.inherit.variables = this.jobData.inherit?.variables ?? true;
+        this.inherit.default = this.jobData.inherit?.default ?? true;
+
+        if (this.inherit.default === false) {
+            this.writeStreams.memoStdout(chalk`{black.bgYellowBright  WARN } \`.inherit.default\` has not been implemented!\n`);
+        }
 
         this.when = jobData.when || "on_success";
         this.exists = jobData.exists || [];
@@ -153,7 +166,7 @@ export class Job {
 
         const matrixVariables = opt.matrixVariables ?? {};
         const fileVariables = Utils.findEnvMatchedVariables(variablesFromFiles, this.fileVariablesDir);
-        this._variables = {...globalVariables, ...jobVariables, ...matrixVariables, ...predefinedVariables, ...fileVariables, ...argvVariables};
+        this._variables = {...this.globalVariables, ...jobVariables, ...matrixVariables, ...predefinedVariables, ...fileVariables, ...argvVariables};
 
         let ciProjectDir = `${cwd}`;
         if (this.jobData["image"]) {
@@ -209,14 +222,14 @@ export class Job {
         const envMatchedVariables = Utils.findEnvMatchedVariables(variablesFromFiles, this.fileVariablesDir, this.environment);
 
         // Merge and expand after finding env matched variables
-        this._variables = {...globalVariables, ...jobVariables, ...matrixVariables, ...predefinedVariables, ...envMatchedVariables, ...argvVariables};
+        this._variables = {...this.globalVariables, ...jobVariables, ...matrixVariables, ...predefinedVariables, ...envMatchedVariables, ...argvVariables};
 
         // Set {when, allowFailure} based on rules result
         if (this.rules) {
             const ruleResult = Utils.getRulesResult({cwd, rules: this.rules, variables: this._variables}, this.gitData, this.when, this.allowFailure);
             this.when = ruleResult.when;
             this.allowFailure = ruleResult.allowFailure;
-            this._variables = {...globalVariables, ...jobVariables, ...ruleResult.variables, ...matrixVariables, ...predefinedVariables, ...envMatchedVariables, ...argvVariables};
+            this._variables = {...this.globalVariables, ...jobVariables, ...ruleResult.variables, ...matrixVariables, ...predefinedVariables, ...envMatchedVariables, ...argvVariables};
         }
         // Delete variables the user intentionally wants unset
         for (const unsetVariable of argv.unsetVariables) {
@@ -450,6 +463,18 @@ export class Job {
         return `/tmp/gitlab-ci-local-file-variables-${this._variables["CI_PROJECT_PATH_SLUG"]}-${this.jobId}`;
     }
 
+    get globalVariables () {
+        if (this.inherit.variables === false) {
+            return {};
+        } else if (Array.isArray(this.inherit.variables)) {
+            const inheritVariables = this.inherit.variables;
+            return Object.fromEntries(
+                Object.entries(this._globalVariables).filter(([k]) => inheritVariables.includes(k))
+            );
+        }
+        return this._globalVariables;
+    }
+
     async start (): Promise<void> {
         this._running = true;
 

src/write-streams.ts

@@ -1,10 +1,26 @@
 export interface WriteStreams {
     stdout: (txt: string) => void;
+    memoStdout: (txt: string) => void;
     stderr: (txt: string) => void;
     flush: () => void;
 }
 
-export class WriteStreamsProcess implements WriteStreams {
+abstract class AbstractWriteStreams implements WriteStreams {
+    abstract stdout (txt: string): void;
+    abstract stderr (txt: string): void;
+    abstract flush (): void;
+
+    memoStdout = (() => {
+        const cache = new Map();
+        return (message: string) => {
+            if (cache.has(message)) return;
+            cache.set(message, null);
+            this.stdout(message);
+        };
+    })();
+}
+
+export class WriteStreamsProcess extends AbstractWriteStreams {
     stderr (txt: string): void {
         process.stderr.write(txt);
     }
@@ -18,7 +34,7 @@ export class WriteStreamsProcess implements WriteStreams {
     }
 }
 
-export class WriteStreamsMock implements WriteStreams {
+export class WriteStreamsMock extends AbstractWriteStreams {
     private currentStderr = "";
     private currentStdout = "";
 

tests/test-cases/inherit/.gitlab-ci-inherit-variables.yml

@@ -0,0 +1,22 @@
+---
+default:
+  image: busybox
+
+variables:
+  GCL_TESTS_VAR1: "This is variable 1"
+  GCL_TESTS_VAR2: "This is variable 2"
+  GCL_TESTS_VAR3: "This is variable 3"
+
+job1:
+  inherit:
+    variables: false
+  script:
+    - env | grep GCL_TESTS
+
+job2:
+  inherit:
+    variables:
+      - GCL_TESTS_VAR1
+      - GCL_TESTS_VAR2
+  script:
+    - env | grep GCL_TESTS

tests/test-cases/inherit/integration.test.ts

@@ -0,0 +1,40 @@
+import {WriteStreamsMock} from "../../../src/write-streams.js";
+import {handler} from "../../../src/handler.js";
+import {initSpawnSpy} from "../../mocks/utils.mock.js";
+import {WhenStatics} from "../../mocks/when-statics.js";
+
+beforeAll(() => {
+    initSpawnSpy(WhenStatics.all);
+});
+
+
+describe("inherit:variables", () => {
+    test("false should disable inheritance of all global variables", async () => {
+        const writeStreams = new WriteStreamsMock();
+        await handler({
+            file: ".gitlab-ci-inherit-variables.yml",
+            cwd: "tests/test-cases/inherit",
+            noColor: true,
+            job: ["job1"],
+        }, writeStreams);
+
+        const filteredStdout = writeStreams.stdoutLines.filter(f => f.startsWith("job1 >")).join("\n");
+        expect(filteredStdout).toEqual("");
+    });
+
+    test("list of specific variables should only inheritance the respective global variables", async () => {
+        const writeStreams = new WriteStreamsMock();
+        await handler({
+            file: ".gitlab-ci-inherit-variables.yml",
+            cwd: "tests/test-cases/inherit",
+            noColor: true,
+            job: ["job2"],
+        }, writeStreams);
+
+        const expected = `job2 > GCL_TESTS_VAR1=This is variable 1
+job2 > GCL_TESTS_VAR2=This is variable 2`;
+
+        const filteredStdout = writeStreams.stdoutLines.filter(f => f.startsWith("job2 >")).join("\n");
+        expect(filteredStdout).toEqual(expected);
+    });
+});