@catladder/pipeline 1.110.2 → 1.110.3

package/src/deploy/custom/deployJob.ts

@@ -6,6 +6,10 @@ import type { Context } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { getBaseDeploymentJob, getBaseDeploymentStopJob } from "../base";
 import { isOfDeployType } from "../types";
+import {
+  getDependencyTrackDeleteScript,
+  getDependencyTrackUploadScript,
+} from "../sbom";
 
 export const createCustomDeployJobs = (context: Context): CatladderJob[] => {
   const deployConfig = context.componentConfig.deploy;
@@ -27,13 +31,17 @@ export const createCustomDeployJobs = (context: Context): CatladderJob[] => {
         `cd ${context.componentConfig.dir}`,
         ...(deployConfig.requiresYarnInstall ? yarnInstall : []),
         ...deployConfig.script,
+        ...getDependencyTrackUploadScript(context),
       ],
     }),
     ...(deployConfig.stopScript
       ? [
           merge({}, getBaseDeploymentStopJob(context), {
             image: deployConfig.jobImage ?? getRunnerImage("jobs-default"),
-            script: deployConfig.stopScript,
+            script: [
+              ...deployConfig.stopScript,
+              ...getDependencyTrackDeleteScript(context),
+            ],
           }),
         ]
       : []),

package/src/deploy/kubernetes/deployJob.ts

@@ -11,6 +11,10 @@ import {
 } from "../base";
 import { isOfDeployType } from "../types";
 import { createKubeValues } from "./kubeValues";
+import {
+  getDependencyTrackDeleteScript,
+  getDependencyTrackUploadScript,
+} from "../sbom";
 
 export const createKubernetesDeployJobs = (
   context: Context
@@ -76,6 +80,7 @@ export const createKubernetesDeployJobs = (
         ...connectContext,
         "kubernetesCreateSecret",
         "kubernetesDeploy",
+        ...getDependencyTrackUploadScript(context),
         "echo deployment successful 😻",
       ],
       environment: {
@@ -83,7 +88,11 @@ export const createKubernetesDeployJobs = (
       },
     }),
     merge({}, baseStopJob, shared, {
-      script: [...connectContext, "kubernetesDelete"],
+      script: [
+        ...connectContext,
+        "kubernetesDelete",
+        ...getDependencyTrackDeleteScript(context),
+      ],
       environment: {
         kubernetes: kubernetesEnvironment,
       },

package/src/deploy/sbom.ts

@@ -0,0 +1,24 @@
+import type { Context } from "../types/context";
+import { SBOM_FILE } from "../build/sbom";
+
+export const sbomDeactivated = (context: Context) =>
+  context.componentConfig.build.type === "custom" &&
+  context.componentConfig.build.sbom === false;
+
+export const getDependencyTrackUploadScript = (context: Context): string[] => {
+  return sbomDeactivated(context)
+    ? []
+    : [
+        "echo Uploading SBOM to Dependency Track",
+        `/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "${context.fullConfig.customerName}-${context.fullConfig.appName}/${context.componentName}" "${context.environment.url}" "${SBOM_FILE}" vex.json || true`,
+      ];
+};
+
+export const getDependencyTrackDeleteScript = (context: Context): string[] => {
+  return sbomDeactivated(context)
+    ? []
+    : [
+        "echo Disabling component in Dependency Track",
+        `/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "${context.fullConfig.customerName}-${context.fullConfig.appName}/${context.componentName}" "${context.environment.url}" || true`,
+      ];
+};

package/src/pipeline/createJobsForComponent.ts

@@ -1,6 +1,5 @@
 import { isFunction } from "lodash";
 import { BUILD_TYPES } from "../build";
-import { createReportingJobs } from "../verify/reporting";
 import { createContext } from "../context";
 import { DEPLOY_TYPES } from "../deploy";
 import type { Config, PipelineTrigger } from "../types/config";
@@ -36,10 +35,9 @@ const createRawJobs = (context: Context): CatladderJob[] => {
     context.componentConfig.deploy !== false
       ? DEPLOY_TYPES[context.componentConfig.deploy.type].jobs(context)
       : [];
-  const reportingJobs = createReportingJobs(context);
 
   const customJobs = getCustomJobs(context);
-  return [...buildJobs, ...deployJobs, ...reportingJobs, ...customJobs];
+  return [...buildJobs, ...deployJobs, ...customJobs];
 };
 export const createJobsForComponent = async (
   config: Config,

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -72,10 +72,10 @@ export const makeGitlabJob = (
     }));
   });
   const cleanedNeeds: CatladderJob["needs"] = [
+    ...(needsFromStages ?? []),
     ...(needs ?? []),
     // pull in legacy needs from other component, which is now identical to needs
     ...(needsOtherComponent ?? []),
-    ...(needsFromStages ?? []),
   ];
 
   const gitlabNeeds: GitlabJobDef["needs"] = cleanedNeeds
@@ -94,6 +94,10 @@ export const makeGitlabJob = (
     ) // sort in a predictable manner for snapshot tests
     .sort((a, b) => getJobName(a).localeCompare(getJobName(b)));
 
+  const deduplicatedGitlabNeeds: GitlabJobDef["needs"] = [
+    ...new Map(gitlabNeeds.map((n) => [isObject(n) ? n.job : n, n])).values(),
+  ];
+
   const fullJobName = getFullJobName(
     name,
     componentName,
@@ -116,7 +120,7 @@ export const makeGitlabJob = (
         }
       : job.environment,
     // sort in a predictable manner for snapshot tests
-    needs: gitlabNeeds,
+    needs: deduplicatedGitlabNeeds,
     retry: BASE_RETRY,
     interruptible: true,
   });

package/dist/verify/reporting.d.ts

@@ -1,3 +0,0 @@
-import type { Context } from "../types/context";
-import type { CatladderJob } from "../types/jobs";
-export declare const createReportingJobs: (context: Context) => CatladderJob<"stop" | "setup" | "test" | "build" | "deploy" | "verify" | "rollback">[];

package/dist/verify/reporting.js

@@ -1,48 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.createReportingJobs = void 0;
-var base_1 = require("../deploy/base");
-var utils_1 = require("../utils");
-var STAGE = "verify";
-var SBOM_GENERATE_JOB_NAME = "🧾 sbom";
-var SBOM_FILE = "__sbom.json";
-var createSbomGenerateJob = function (context) {
-  var _a, _b, _c, _d, _e;
-  var buildConfig = context.componentConfig.build;
-  var defaultImage = "aquasec/trivy:0.38.3";
-  var defaultScript = ["trivy fs --quiet --format cyclonedx --output \"".concat(SBOM_FILE, "\" ").concat(((_a = context.packageManagerInfo) === null || _a === void 0 ? void 0 : _a.componentIsInWorkspace) ? "." : context.componentConfig.dir)];
-  var image = buildConfig.type === "custom" && buildConfig.sbom !== false ? (_c = (_b = buildConfig.sbom) === null || _b === void 0 ? void 0 : _b.jobImage) !== null && _c !== void 0 ? _c : defaultImage : defaultImage;
-  var script = buildConfig.type === "custom" && buildConfig.sbom !== false ? (_e = (0, utils_1.ensureArray)((_d = buildConfig.sbom) === null || _d === void 0 ? void 0 : _d.command)) !== null && _e !== void 0 ? _e : defaultScript : defaultScript;
-  return {
-    name: SBOM_GENERATE_JOB_NAME,
-    stage: STAGE,
-    needs: context.componentConfig.deploy !== false ? [base_1.DEPLOY_JOB_NAME] : [],
-    envMode: "jobPerEnv",
-    variables: {},
-    cache: undefined,
-    image: image,
-    script: script,
-    allow_failure: true,
-    artifacts: {
-      paths: [SBOM_FILE]
-    }
-  };
-};
-var createSbomUploadJob = function (context) {
-  return {
-    name: "🧾 sbom upload",
-    stage: STAGE,
-    needs: [SBOM_GENERATE_JOB_NAME],
-    envMode: "jobPerEnv",
-    variables: {},
-    cache: undefined,
-    image: "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-    script: ["/dtrackuploader https://dep.panter.swiss/ \"$DT_KEY_PROD\" upload \"".concat(context.fullConfig.customerName, "-").concat(context.fullConfig.appName, "/").concat(context.componentName, "\" \"").concat(context.environment.shortName, "\" \"").concat(SBOM_FILE, "\" vex.json")],
-    allow_failure: true
-  };
-};
-var createReportingJobs = function (context) {
-  return context.componentConfig.build.type === "custom" && context.componentConfig.build.sbom === false ? [] : [createSbomGenerateJob(context), createSbomUploadJob(context)];
-};
-exports.createReportingJobs = createReportingJobs;

package/src/verify/reporting.ts

@@ -1,69 +0,0 @@
-import { DEPLOY_JOB_NAME } from "../deploy/base";
-import type { Context } from "../types/context";
-import type { CatladderJob } from "../types/jobs";
-import { ensureArray } from "../utils";
-
-const STAGE = "verify";
-const SBOM_GENERATE_JOB_NAME = "🧾 sbom";
-const SBOM_FILE = "__sbom.json";
-
-const createSbomGenerateJob = (context: Context): CatladderJob => {
-  const buildConfig = context.componentConfig.build;
-
-  const defaultImage = "aquasec/trivy:0.38.3";
-  const defaultScript = [
-    `trivy fs --quiet --format cyclonedx --output "${SBOM_FILE}" ${
-      context.packageManagerInfo?.componentIsInWorkspace
-        ? "."
-        : context.componentConfig.dir
-    }`,
-  ];
-
-  const image =
-    buildConfig.type === "custom" && buildConfig.sbom !== false
-      ? buildConfig.sbom?.jobImage ?? defaultImage
-      : defaultImage;
-
-  const script =
-    buildConfig.type === "custom" && buildConfig.sbom !== false
-      ? ensureArray(buildConfig.sbom?.command) ?? defaultScript
-      : defaultScript;
-
-  return {
-    name: SBOM_GENERATE_JOB_NAME,
-    stage: STAGE,
-    needs: context.componentConfig.deploy !== false ? [DEPLOY_JOB_NAME] : [],
-    envMode: "jobPerEnv",
-    variables: {},
-    cache: undefined,
-    image,
-    script,
-    allow_failure: true,
-    artifacts: {
-      paths: [SBOM_FILE],
-    },
-  };
-};
-
-const createSbomUploadJob = (context: Context): CatladderJob => {
-  return {
-    name: "🧾 sbom upload",
-    stage: STAGE,
-    needs: [SBOM_GENERATE_JOB_NAME],
-    envMode: "jobPerEnv",
-    variables: {},
-    cache: undefined,
-    image:
-      "git.panter.ch:5001/open-source/dependency-track-uploader:dtrackuploader-v0.2.1",
-    script: [
-      `/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "${context.fullConfig.customerName}-${context.fullConfig.appName}/${context.componentName}" "${context.environment.shortName}" "${SBOM_FILE}" vex.json`,
-    ],
-    allow_failure: true,
-  };
-};
-
-export const createReportingJobs = (context: Context) =>
-  context.componentConfig.build.type === "custom" &&
-  context.componentConfig.build.sbom === false
-    ? []
-    : [createSbomGenerateJob(context), createSbomUploadJob(context)];