feat: support needs specified inside rules (#1743)

* feat: support needs specified inside rules

Closes #1602

* refactor: simplify rule needs with optional chaining

Author: firecow

src/job.ts

@@ -81,6 +81,7 @@ export type JobRule = {
     exists?: string[];
     allow_failure?: boolean;
     variables?: {[name: string]: string};
+    needs?: any[];
 };
 
 export class Job {
@@ -205,6 +206,9 @@ export class Job {
             this.when = ruleResult.when;
             this.allowFailure = ruleResult.allowFailure;
             ruleVariables = ruleResult.variables;
+            if (ruleResult.needs) {
+                this.jobData["needs"] = ruleResult.needs;
+            }
             this._variables = {...this._variables, ...ruleVariables, ...argvVariables};
         }
 

src/utils.ts

@@ -1,7 +1,8 @@
 import "./global.js";
 import {RE2JS} from "re2js";
 import chalk from "chalk-template";
-import {Job, JobRule} from "./job.js";
+import {Job, JobRule, Need} from "./job.js";
+import {needsComplex} from "./data-expander.js";
 import fs from "fs-extra";
 import checksum from "checksum";
 import base64url from "base64url";
@@ -188,13 +189,14 @@ export class Utils {
         return envMatchedVariables;
     }
 
-    static getRulesResult (opt: RuleResultOpt, gitData: GitData, jobWhen: string = "on_success", jobAllowFailure: boolean | {exit_codes: number | number[]} = false): {when: string; allowFailure: boolean | {exit_codes: number | number[]}; variables?: {[name: string]: string}} {
+    static getRulesResult (opt: RuleResultOpt, gitData: GitData, jobWhen: string = "on_success", jobAllowFailure: boolean | {exit_codes: number | number[]} = false): {when: string; allowFailure: boolean | {exit_codes: number | number[]}; variables?: {[name: string]: string}; needs?: Need[]} {
         let when = "never";
         const {evaluateRuleChanges} = opt.argv;
 
         // optional manual jobs allowFailure defaults to true https://docs.gitlab.com/ee/ci/jobs/job_control.html#types-of-manual-jobs
         let allowFailure = jobWhen === "manual" ? true : jobAllowFailure;
         let ruleVariable: {[name: string]: string} | undefined;
+        let ruleNeeds: Need[] | undefined;
 
         for (const rule of opt.rules) {
             if (!Utils.evaluateRuleIf(rule.if, opt.variables)) continue;
@@ -204,11 +206,12 @@ export class Utils {
             when = rule.when ? rule.when : jobWhen;
             allowFailure = rule.allow_failure ?? allowFailure;
             ruleVariable = rule.variables;
+            ruleNeeds = rule.needs?.map((n: any) => needsComplex(n));
 
             break; // Early return, will not evaluate the remaining rules
         }
 
-        return {when, allowFailure, variables: ruleVariable};
+        return {when, allowFailure, variables: ruleVariable, needs: ruleNeeds};
     }
 
     static evaluateRuleIf (ruleIf: string | undefined, envs: {[key: string]: string}): boolean {

tests/test-cases/rules-needs/.gitlab-ci.yml

@@ -0,0 +1,23 @@
+---
+stages:
+  - build
+  - test
+
+build-dev:
+  stage: build
+  script: echo "build-dev"
+
+build-production:
+  stage: build
+  script: echo "build-production"
+
+test-job:
+  stage: test
+  script: echo "test-job"
+  needs:
+    - build-dev
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+      needs:
+        - build-production
+    - when: on_success

tests/test-cases/rules-needs/integration.test.ts

@@ -0,0 +1,32 @@
+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);
+});
+
+test("rules-needs - default branch uses rule needs", async () => {
+    const writeStreams = new WriteStreamsMock();
+    await handler({
+        cwd: "tests/test-cases/rules-needs",
+        variable: ["CI_COMMIT_BRANCH=main"],
+    }, writeStreams);
+
+    const output = writeStreams.stdoutLines.join("\n");
+    expect(output).toContain("test-job");
+    expect(output).not.toContain("build-dev started");
+});
+
+test("rules-needs - non-default branch uses job-level needs", async () => {
+    const writeStreams = new WriteStreamsMock();
+    await handler({
+        cwd: "tests/test-cases/rules-needs",
+        variable: ["CI_COMMIT_BRANCH=feature"],
+    }, writeStreams);
+
+    const output = writeStreams.stdoutLines.join("\n");
+    expect(output).toContain("test-job");
+    expect(output).toContain("build-dev");
+});