@catladder/pipeline 1.110.1 → 1.110.3

package/examples/__snapshots__/wait-for-other-deploy.ts.snap

@@ -142,6 +142,10 @@ exports[`matches snapshot 1`] = `
             "artifacts": false,
             "job": "api 🧪 test",
           },
+          {
+            "artifacts": true,
+            "job": "api 🧾 sbom | dev ",
+          },
           {
             "artifacts": false,
             "job": "api 🛡 audit",
@@ -162,6 +166,8 @@ exports[`matches snapshot 1`] = `
         "script": [
           "cd api",
           "yarn deploy",
+          "echo Uploading SBOM to Dependency Track",
+          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy dev",
         "variables": {
@@ -248,26 +254,6 @@ exports[`matches snapshot 1`] = `
           "KUBERNETES_MEMORY_REQUEST": "2Gi",
         },
       },
-      "api 🧾 sbom upload | dev ": {
-        "allow_failure": true,
-        "image": "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-        "interruptible": true,
-        "needs": [
-          "api 🧾 sbom | dev ",
-        ],
-        "retry": {
-          "max": 2,
-          "when": [
-            "runner_system_failure",
-            "stuck_or_timeout_failure",
-          ],
-        },
-        "script": [
-          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "dev" "__sbom.json" vex.json",
-        ],
-        "stage": "verify",
-        "variables": {},
-      },
       "api 🧾 sbom | dev ": {
         "allow_failure": true,
         "artifacts": {
@@ -277,9 +263,7 @@ exports[`matches snapshot 1`] = `
         },
         "image": "aquasec/trivy:0.38.3",
         "interruptible": true,
-        "needs": [
-          "api 🚀 Deploy | dev ",
-        ],
+        "needs": [],
         "retry": {
           "max": 2,
           "when": [
@@ -290,7 +274,7 @@ exports[`matches snapshot 1`] = `
         "script": [
           "trivy fs --quiet --format cyclonedx --output "__sbom.json" api",
         ],
-        "stage": "verify",
+        "stage": "build",
         "variables": {},
       },
       "www 👮 lint": {
@@ -434,6 +418,10 @@ exports[`matches snapshot 1`] = `
             "artifacts": false,
             "job": "www 🧪 test",
           },
+          {
+            "artifacts": true,
+            "job": "www 🧾 sbom | dev ",
+          },
           {
             "artifacts": false,
             "job": "www 🛡 audit",
@@ -454,6 +442,8 @@ exports[`matches snapshot 1`] = `
         "script": [
           "cd www",
           "yarn deploy",
+          "echo Uploading SBOM to Dependency Track",
+          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy dev",
         "variables": {
@@ -540,26 +530,6 @@ exports[`matches snapshot 1`] = `
           "KUBERNETES_MEMORY_REQUEST": "2Gi",
         },
       },
-      "www 🧾 sbom upload | dev ": {
-        "allow_failure": true,
-        "image": "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-        "interruptible": true,
-        "needs": [
-          "www 🧾 sbom | dev ",
-        ],
-        "retry": {
-          "max": 2,
-          "when": [
-            "runner_system_failure",
-            "stuck_or_timeout_failure",
-          ],
-        },
-        "script": [
-          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "dev" "__sbom.json" vex.json",
-        ],
-        "stage": "verify",
-        "variables": {},
-      },
       "www 🧾 sbom | dev ": {
         "allow_failure": true,
         "artifacts": {
@@ -569,9 +539,7 @@ exports[`matches snapshot 1`] = `
         },
         "image": "aquasec/trivy:0.38.3",
         "interruptible": true,
-        "needs": [
-          "www 🚀 Deploy | dev ",
-        ],
+        "needs": [],
         "retry": {
           "max": 2,
           "when": [
@@ -582,7 +550,7 @@ exports[`matches snapshot 1`] = `
         "script": [
           "trivy fs --quiet --format cyclonedx --output "__sbom.json" www",
         ],
-        "stage": "verify",
+        "stage": "build",
         "variables": {},
       },
     },
@@ -794,6 +762,10 @@ exports[`matches snapshot 1`] = `
             "artifacts": false,
             "job": "api 🧪 test",
           },
+          {
+            "artifacts": true,
+            "job": "api 🧾 sbom | review ",
+          },
           {
             "artifacts": false,
             "job": "api 🛡 audit",
@@ -814,6 +786,8 @@ exports[`matches snapshot 1`] = `
         "script": [
           "cd api",
           "yarn deploy",
+          "echo Uploading SBOM to Dependency Track",
+          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy review",
         "variables": {
@@ -900,26 +874,6 @@ exports[`matches snapshot 1`] = `
           "KUBERNETES_MEMORY_REQUEST": "2Gi",
         },
       },
-      "api 🧾 sbom upload | review ": {
-        "allow_failure": true,
-        "image": "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-        "interruptible": true,
-        "needs": [
-          "api 🧾 sbom | review ",
-        ],
-        "retry": {
-          "max": 2,
-          "when": [
-            "runner_system_failure",
-            "stuck_or_timeout_failure",
-          ],
-        },
-        "script": [
-          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "review" "__sbom.json" vex.json",
-        ],
-        "stage": "verify",
-        "variables": {},
-      },
       "api 🧾 sbom | review ": {
         "allow_failure": true,
         "artifacts": {
@@ -929,9 +883,7 @@ exports[`matches snapshot 1`] = `
         },
         "image": "aquasec/trivy:0.38.3",
         "interruptible": true,
-        "needs": [
-          "api 🚀 Deploy | review ",
-        ],
+        "needs": [],
         "retry": {
           "max": 2,
           "when": [
@@ -942,7 +894,7 @@ exports[`matches snapshot 1`] = `
         "script": [
           "trivy fs --quiet --format cyclonedx --output "__sbom.json" api",
         ],
-        "stage": "verify",
+        "stage": "build",
         "variables": {},
       },
       "www 👮 lint": {
@@ -1086,6 +1038,10 @@ exports[`matches snapshot 1`] = `
             "artifacts": false,
             "job": "www 🧪 test",
           },
+          {
+            "artifacts": true,
+            "job": "www 🧾 sbom | review ",
+          },
           {
             "artifacts": false,
             "job": "www 🛡 audit",
@@ -1106,6 +1062,8 @@ exports[`matches snapshot 1`] = `
         "script": [
           "cd www",
           "yarn deploy",
+          "echo Uploading SBOM to Dependency Track",
+          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy review",
         "variables": {
@@ -1192,26 +1150,6 @@ exports[`matches snapshot 1`] = `
           "KUBERNETES_MEMORY_REQUEST": "2Gi",
         },
       },
-      "www 🧾 sbom upload | review ": {
-        "allow_failure": true,
-        "image": "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-        "interruptible": true,
-        "needs": [
-          "www 🧾 sbom | review ",
-        ],
-        "retry": {
-          "max": 2,
-          "when": [
-            "runner_system_failure",
-            "stuck_or_timeout_failure",
-          ],
-        },
-        "script": [
-          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "review" "__sbom.json" vex.json",
-        ],
-        "stage": "verify",
-        "variables": {},
-      },
       "www 🧾 sbom | review ": {
         "allow_failure": true,
         "artifacts": {
@@ -1221,9 +1159,7 @@ exports[`matches snapshot 1`] = `
         },
         "image": "aquasec/trivy:0.38.3",
         "interruptible": true,
-        "needs": [
-          "www 🚀 Deploy | review ",
-        ],
+        "needs": [],
         "retry": {
           "max": 2,
           "when": [
@@ -1234,7 +1170,7 @@ exports[`matches snapshot 1`] = `
         "script": [
           "trivy fs --quiet --format cyclonedx --output "__sbom.json" www",
         ],
-        "stage": "verify",
+        "stage": "build",
         "variables": {},
       },
     },
@@ -1467,6 +1403,10 @@ exports[`matches snapshot 1`] = `
             "artifacts": true,
             "job": "api 🔨 app | prod ",
           },
+          {
+            "artifacts": true,
+            "job": "api 🧾 sbom | prod ",
+          },
         ],
         "retry": {
           "max": 2,
@@ -1483,6 +1423,8 @@ exports[`matches snapshot 1`] = `
         "script": [
           "cd api",
           "yarn deploy",
+          "echo Uploading SBOM to Dependency Track",
+          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy prod",
         "variables": {
@@ -1515,6 +1457,10 @@ exports[`matches snapshot 1`] = `
             "artifacts": true,
             "job": "api 🔨 app | stage ",
           },
+          {
+            "artifacts": true,
+            "job": "api 🧾 sbom | stage ",
+          },
         ],
         "retry": {
           "max": 2,
@@ -1531,6 +1477,8 @@ exports[`matches snapshot 1`] = `
         "script": [
           "cd api",
           "yarn deploy",
+          "echo Uploading SBOM to Dependency Track",
+          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy stage",
         "variables": {
@@ -1549,46 +1497,6 @@ exports[`matches snapshot 1`] = `
           "_ALL_ENV_VAR_KEYS": "["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_ID","BUILD_INFO_BUILD_TIME","BUILD_INFO_CURRENT_VERSION","HOST","ROOT_URL"]",
         },
       },
-      "api 🧾 sbom upload | prod ": {
-        "allow_failure": true,
-        "image": "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-        "interruptible": true,
-        "needs": [
-          "api 🧾 sbom | prod ",
-        ],
-        "retry": {
-          "max": 2,
-          "when": [
-            "runner_system_failure",
-            "stuck_or_timeout_failure",
-          ],
-        },
-        "script": [
-          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "prod" "__sbom.json" vex.json",
-        ],
-        "stage": "verify",
-        "variables": {},
-      },
-      "api 🧾 sbom upload | stage ": {
-        "allow_failure": true,
-        "image": "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-        "interruptible": true,
-        "needs": [
-          "api 🧾 sbom | stage ",
-        ],
-        "retry": {
-          "max": 2,
-          "when": [
-            "runner_system_failure",
-            "stuck_or_timeout_failure",
-          ],
-        },
-        "script": [
-          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "stage" "__sbom.json" vex.json",
-        ],
-        "stage": "verify",
-        "variables": {},
-      },
       "api 🧾 sbom | prod ": {
         "allow_failure": true,
         "artifacts": {
@@ -1598,9 +1506,7 @@ exports[`matches snapshot 1`] = `
         },
         "image": "aquasec/trivy:0.38.3",
         "interruptible": true,
-        "needs": [
-          "api 🚀 Deploy | prod ",
-        ],
+        "needs": [],
         "retry": {
           "max": 2,
           "when": [
@@ -1611,7 +1517,7 @@ exports[`matches snapshot 1`] = `
         "script": [
           "trivy fs --quiet --format cyclonedx --output "__sbom.json" api",
         ],
-        "stage": "verify",
+        "stage": "build",
         "variables": {},
       },
       "api 🧾 sbom | stage ": {
@@ -1623,9 +1529,7 @@ exports[`matches snapshot 1`] = `
         },
         "image": "aquasec/trivy:0.38.3",
         "interruptible": true,
-        "needs": [
-          "api 🚀 Deploy | stage ",
-        ],
+        "needs": [],
         "retry": {
           "max": 2,
           "when": [
@@ -1636,7 +1540,7 @@ exports[`matches snapshot 1`] = `
         "script": [
           "trivy fs --quiet --format cyclonedx --output "__sbom.json" api",
         ],
-        "stage": "verify",
+        "stage": "build",
         "variables": {},
       },
       "www 🔨 app | prod ": {
@@ -1801,6 +1705,10 @@ exports[`matches snapshot 1`] = `
             "artifacts": true,
             "job": "www 🔨 app | prod ",
           },
+          {
+            "artifacts": true,
+            "job": "www 🧾 sbom | prod ",
+          },
         ],
         "retry": {
           "max": 2,
@@ -1817,6 +1725,8 @@ exports[`matches snapshot 1`] = `
         "script": [
           "cd www",
           "yarn deploy",
+          "echo Uploading SBOM to Dependency Track",
+          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy prod",
         "variables": {
@@ -1853,6 +1763,10 @@ exports[`matches snapshot 1`] = `
             "artifacts": true,
             "job": "www 🔨 app | stage ",
           },
+          {
+            "artifacts": true,
+            "job": "www 🧾 sbom | stage ",
+          },
         ],
         "retry": {
           "max": 2,
@@ -1869,6 +1783,8 @@ exports[`matches snapshot 1`] = `
         "script": [
           "cd www",
           "yarn deploy",
+          "echo Uploading SBOM to Dependency Track",
+          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy stage",
         "variables": {
@@ -1887,46 +1803,6 @@ exports[`matches snapshot 1`] = `
           "_ALL_ENV_VAR_KEYS": "["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_ID","BUILD_INFO_BUILD_TIME","BUILD_INFO_CURRENT_VERSION","HOST","ROOT_URL"]",
         },
       },
-      "www 🧾 sbom upload | prod ": {
-        "allow_failure": true,
-        "image": "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-        "interruptible": true,
-        "needs": [
-          "www 🧾 sbom | prod ",
-        ],
-        "retry": {
-          "max": 2,
-          "when": [
-            "runner_system_failure",
-            "stuck_or_timeout_failure",
-          ],
-        },
-        "script": [
-          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "prod" "__sbom.json" vex.json",
-        ],
-        "stage": "verify",
-        "variables": {},
-      },
-      "www 🧾 sbom upload | stage ": {
-        "allow_failure": true,
-        "image": "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-        "interruptible": true,
-        "needs": [
-          "www 🧾 sbom | stage ",
-        ],
-        "retry": {
-          "max": 2,
-          "when": [
-            "runner_system_failure",
-            "stuck_or_timeout_failure",
-          ],
-        },
-        "script": [
-          "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "stage" "__sbom.json" vex.json",
-        ],
-        "stage": "verify",
-        "variables": {},
-      },
       "www 🧾 sbom | prod ": {
         "allow_failure": true,
         "artifacts": {
@@ -1936,9 +1812,7 @@ exports[`matches snapshot 1`] = `
         },
         "image": "aquasec/trivy:0.38.3",
         "interruptible": true,
-        "needs": [
-          "www 🚀 Deploy | prod ",
-        ],
+        "needs": [],
         "retry": {
           "max": 2,
           "when": [
@@ -1949,7 +1823,7 @@ exports[`matches snapshot 1`] = `
         "script": [
           "trivy fs --quiet --format cyclonedx --output "__sbom.json" www",
         ],
-        "stage": "verify",
+        "stage": "build",
         "variables": {},
       },
       "www 🧾 sbom | stage ": {
@@ -1961,9 +1835,7 @@ exports[`matches snapshot 1`] = `
         },
         "image": "aquasec/trivy:0.38.3",
         "interruptible": true,
-        "needs": [
-          "www 🚀 Deploy | stage ",
-        ],
+        "needs": [],
         "retry": {
           "max": 2,
           "when": [
@@ -1974,7 +1846,7 @@ exports[`matches snapshot 1`] = `
         "script": [
           "trivy fs --quiet --format cyclonedx --output "__sbom.json" www",
         ],
-        "stage": "verify",
+        "stage": "build",
         "variables": {},
       },
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catladder/pipeline",
-  "version": "1.110.1",
+  "version": "1.110.3",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/build/base/__tests__/__snapshots__/createArtifactsConfig.test.ts.snap

@@ -0,0 +1,49 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createArtifactsConfig merges junit files if both given 1`] = `
+{
+  "artifacts": {
+    "paths": [
+      "testpath",
+    ],
+    "reports": {
+      "junit": [
+        "partial-report.xml",
+        "full-report.xml",
+      ],
+      "terraform": "something",
+    },
+  },
+}
+`;
+
+exports[`createArtifactsConfig returns artifacts if no artifactsReports 1`] = `
+{
+  "artifacts": {
+    "paths": [
+      "testpath",
+    ],
+    "reports": {
+      "coverage_report": {
+        "coverage_format": "cobertura",
+        "path": "some",
+      },
+      "junit": [],
+      "terraform": "something",
+    },
+  },
+}
+`;
+
+exports[`createArtifactsConfig returns junit parts of artifactsReports 1`] = `
+{
+  "artifacts": {
+    "paths": [],
+    "reports": {
+      "junit": [
+        "report.xml",
+      ],
+    },
+  },
+}
+`;

package/src/build/base/__tests__/createArtifactsConfig.test.ts

@@ -0,0 +1,41 @@
+import { createArtifactsConfig } from "../createArtifactsConfig";
+
+describe("createArtifactsConfig", () => {
+  it("returns undefined if no artifacts or artifactsReports", () => {
+    expect(createArtifactsConfig(".")).toBeUndefined();
+  });
+
+  it("returns artifacts if no artifactsReports", () => {
+    expect(
+      createArtifactsConfig(".", undefined, {
+        paths: ["testpath"],
+        reports: {
+          coverage_report: { coverage_format: "cobertura", path: "some" },
+          terraform: "something",
+        },
+      })
+    ).toMatchSnapshot();
+  });
+
+  it("returns junit parts of artifactsReports", () => {
+    expect(
+      createArtifactsConfig(".", { junit: ["report.xml"] })
+    ).toMatchSnapshot();
+  });
+
+  it("merges junit files if both given", () => {
+    const result = createArtifactsConfig(
+      ".",
+      { junit: ["partial-report.xml"] },
+      {
+        paths: ["testpath"],
+        reports: {
+          junit: "full-report.xml",
+          terraform: "something",
+        },
+      }
+    );
+    expect(result).toMatchSnapshot();
+    expect(result?.artifacts?.reports?.junit).toHaveLength(2);
+  });
+});

package/src/build/base/createArtifactsConfig.ts

@@ -0,0 +1,34 @@
+import { join } from "path";
+import type { BuildConfigArtifactsReports } from "../types";
+import type { Artifacts } from "../../types";
+import type { OptionalArtifacts } from "../custom/testJob";
+
+export const createArtifactsConfig = (
+  rootPath: string,
+  artifactsReports?: BuildConfigArtifactsReports,
+  artifacts?: Artifacts
+): OptionalArtifacts =>
+  artifactsReports || artifacts
+    ? {
+        artifacts: {
+          paths: [],
+          ...artifacts,
+          reports: {
+            ...artifacts?.reports,
+            junit: [
+              artifactsReports?.junit,
+              Array.isArray(artifacts?.reports?.junit) &&
+                artifacts?.reports?.junit,
+              typeof artifacts?.reports?.junit === "string" && [
+                artifacts?.reports?.junit,
+              ],
+            ]
+              .filter(Array.isArray)
+              .reduce(
+                (acc, curr) => [...acc, ...curr.map((p) => join(rootPath, p))],
+                []
+              ),
+          },
+        },
+      }
+    : undefined;

package/src/build/custom/__tests__/testJob.test.ts

@@ -0,0 +1,32 @@
+import type { Context } from "../../..";
+import { createCustomTestJobs } from "../testJob";
+
+describe("createCustomTestJobs", () => {
+  const componentConfig: Context["componentConfig"] = {
+    dir: ".",
+    build: { type: "custom", docker: { type: "custom" }, jobImage: "" },
+    deploy: {},
+  } as Context["componentConfig"];
+  const baseContext: Context = {
+    componentName: "testComponent",
+    environment: {
+      jobOnlyVars: {
+        build: {},
+      },
+    },
+    componentConfig,
+  } as Context;
+
+  it("throws error when not build type custom", () => {
+    componentConfig.build.type = "node";
+    expect(() => createCustomTestJobs(baseContext)).toThrowError(
+      "deploy config is not custom"
+    );
+    componentConfig.build.type = "custom";
+  });
+
+  it("returns empty array if no audit, lint, and test definition", () => {
+    const jobs = createCustomTestJobs(baseContext);
+    expect(jobs).toEqual([]);
+  });
+});

package/src/build/custom/buildJob.ts

@@ -7,6 +7,8 @@ import { createDockerBuildJobDefault, requiresDockerBuild } from "../docker";
 import { isOfBuildType } from "../types";
 
 import type { CatladderJob } from "../../types/jobs";
+import { createSbomBuildJob } from "../sbom";
+import { sbomDeactivated } from "../../deploy/sbom";
 
 const RUNNER_BUILD_VARIABLES = {
   KUBERNETES_CPU_REQUEST: "0.5",
@@ -61,5 +63,6 @@ export const createCustomBuildJobs = (context: Context): CatladderJob[] => {
           }),
         ]
       : []),
+    ...(sbomDeactivated(context) ? [] : [createSbomBuildJob(context)]),
   ];
 };