add missing optional prop

Author: noxify

.changeset/tough-rings-laugh.md

@@ -0,0 +1,5 @@
+---
+"@noxify/gitlab-ci-builder": patch
+---
+
+add missing `optional` prop for `needs:`

src/types/needs.ts

@@ -9,12 +9,20 @@ type NeedsDefinition =
        * @see https://docs.gitlab.com/ee/ci/yaml/#artifact-downloads-with-needs
        */
       artifacts?: boolean
+      /**
+       * @see https://docs.gitlab.com/ee/ci/yaml/#needsoptional
+       */
+      optional?: boolean
     }[]
   | {
       /**
        * @see https://docs.gitlab.com/ee/ci/yaml/#complex-trigger-syntax-for-multi-project-pipelines
        */
       pipeline: string
+      /**
+       * @see https://docs.gitlab.com/ee/ci/yaml/#needsoptional
+       */
+      optional?: boolean
     }
 
 export type { NeedsDefinition }

tests/export.test.ts

@@ -251,5 +251,35 @@ describe("export", () => {
         "Write failed",
       )
     })
+
+    it("should export needs with optional property", () => {
+      const config = new Config()
+      config.job("generate_version", {
+        script: ["echo version"],
+      })
+      config.job("unit_tests", {
+        script: ["npm test"],
+      })
+      config.job("deploy", {
+        script: ["echo deploying"],
+        needs: [
+          {
+            job: "generate_version",
+            optional: true,
+          },
+          {
+            job: "unit_tests",
+          },
+        ],
+      })
+
+      const yaml = toYaml(config.getPlainObject())
+
+      expect(yaml).toContain("deploy:")
+      expect(yaml).toContain("needs:")
+      expect(yaml).toContain("- job: generate_version")
+      expect(yaml).toContain("optional: true")
+      expect(yaml).toContain("- job: unit_tests")
+    })
   })
 })

tests/import.test.ts

@@ -398,5 +398,33 @@ build:
       expect(ts).toContain('config.job("build",')
       expect(ts).toContain('extends: [".base1", ".base2"]')
     })
+
+    it("should handle needs with optional property", () => {
+      const yaml = `
+generate_version:
+  script:
+    - echo version
+
+unit_tests:
+  script:
+    - npm test
+
+deploy:
+  script:
+    - echo deploying
+  needs:
+    - job: generate_version
+      optional: true
+    - job: unit_tests
+`
+
+      const ts = fromYaml(yaml)
+
+      expect(ts).toContain('config.job("deploy",')
+      expect(ts).toContain("needs:")
+      expect(ts).toContain('job: "generate_version"')
+      expect(ts).toContain("optional: true")
+      expect(ts).toContain('job: "unit_tests"')
+    })
   })
 })

tests/needs.test.ts

@@ -0,0 +1,141 @@
+import { describe, expect, it } from "vitest"
+
+import { Config } from "../src"
+
+describe("needs", () => {
+  it("should support needs as simple string array", () => {
+    const cfg = new Config()
+
+    cfg.job("build", {
+      script: ["npm run build"],
+    })
+
+    cfg.job("test", {
+      script: ["npm test"],
+      needs: ["build"],
+    })
+
+    const plain = cfg.getPlainObject()
+
+    expect(plain.jobs?.test?.needs).toEqual(["build"])
+  })
+
+  it("should support needs with job objects", () => {
+    const cfg = new Config()
+
+    cfg.job("build", {
+      script: ["npm run build"],
+    })
+
+    cfg.job("test", {
+      script: ["npm test"],
+      needs: [
+        {
+          job: "build",
+        },
+      ],
+    })
+
+    const plain = cfg.getPlainObject()
+
+    expect(plain.jobs?.test?.needs).toEqual([{ job: "build" }])
+  })
+
+  it("should support needs with artifacts property", () => {
+    const cfg = new Config()
+
+    cfg.job("build", {
+      script: ["npm run build"],
+    })
+
+    cfg.job("test", {
+      script: ["npm test"],
+      needs: [
+        {
+          job: "build",
+          artifacts: false,
+        },
+      ],
+    })
+
+    const plain = cfg.getPlainObject()
+
+    expect(plain.jobs?.test?.needs).toEqual([{ job: "build", artifacts: false }])
+  })
+
+  it("should support needs with optional property", () => {
+    const cfg = new Config()
+
+    cfg.job("generate_version", {
+      script: ["echo version"],
+    })
+
+    cfg.job("unit_tests", {
+      script: ["npm test"],
+    })
+
+    cfg.job("deploy", {
+      script: ["echo deploying"],
+      needs: [
+        {
+          job: "generate_version",
+          optional: true,
+        },
+        {
+          job: "unit_tests",
+        },
+      ],
+    })
+
+    const plain = cfg.getPlainObject()
+
+    expect(plain.jobs?.deploy?.needs).toEqual([
+      { job: "generate_version", optional: true },
+      { job: "unit_tests" },
+    ])
+  })
+
+  it("should support needs with both optional and artifacts", () => {
+    const cfg = new Config()
+
+    cfg.job("build", {
+      script: ["npm run build"],
+    })
+
+    cfg.job("deploy", {
+      script: ["echo deploying"],
+      needs: [
+        {
+          job: "build",
+          artifacts: true,
+          optional: true,
+        },
+      ],
+    })
+
+    const plain = cfg.getPlainObject()
+
+    expect(plain.jobs?.deploy?.needs).toEqual([
+      { job: "build", artifacts: true, optional: true },
+    ])
+  })
+
+  it("should support pipeline needs with optional", () => {
+    const cfg = new Config()
+
+    cfg.job("deploy", {
+      script: ["echo deploying"],
+      needs: {
+        pipeline: "other-project/pipeline",
+        optional: true,
+      },
+    })
+
+    const plain = cfg.getPlainObject()
+
+    expect(plain.jobs?.deploy?.needs).toEqual({
+      pipeline: "other-project/pipeline",
+      optional: true,
+    })
+  })
+})