@catladder/pipeline 1.111.4 → 1.112.1

package/src/deploy/cloudRun/deployJob.ts

@@ -6,7 +6,12 @@ import { getLabels } from "../../context/getLabels";
 import { getRunnerImage } from "../../runner";
 import type { Context } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
-import { getBaseDeploymentJob, getBaseDeploymentStopJob } from "../base";
+import { allowFailureInScripts } from "../../utils/gitlab";
+import { createDeployementJobs } from "../base";
+import {
+  getDependencyTrackDeleteScript,
+  getDependencyTrackUploadScript,
+} from "../sbom";
 import type {
   DeployConfigCloudRun,
   DeployConfigCloudRunJob,
@@ -14,18 +19,13 @@ import type {
   DeployConfigCloudRunService,
 } from "../types";
 import { isOfDeployType } from "../types";
-import { gcloudServiceAccountLoginCommands } from "./utils/gcloudServiceAccountLoginCommands";
+import { createArgsString } from "./utils/createArgsString";
 import {
   getDatabaseCreateScript,
   getDatabaseDeleteScript,
 } from "./utils/database";
-import { allowFailureInScripts } from "../../utils/gitlab";
+import { gcloudServiceAccountLoginCommands } from "./utils/gcloudServiceAccountLoginCommands";
 import { getCloudRunJobName } from "./utils/jobName";
-import { createArgsString } from "./utils/createArgsString";
-import {
-  getDependencyTrackDeleteScript,
-  getDependencyTrackUploadScript,
-} from "../sbom";
 
 const setExtraVarsScripts = (deployConfig: DeployConfigCloudRun) => [
   `export GCLOUD_PROJECT_NUMBER=$(gcloud projects describe ${deployConfig.projectId} --format="value(projectNumber)")`,
@@ -43,7 +43,6 @@ export const createGoogleCloudRunDeployJobs = (
     // should not happen
     throw new Error("deploy config is wrong");
   }
-  const baseDeploymentJob = getBaseDeploymentJob(context);
 
   const fullAppName = `${context.fullConfig.customerName}-${context.fullConfig.appName}`;
   const dockerUrl = `${deployConfig.region}-docker.pkg.dev/${deployConfig.projectId}/catladder-deploy/${fullAppName}`;
@@ -257,8 +256,8 @@ export const createGoogleCloudRunDeployJobs = (
       : []),
     ...getDependencyTrackDeleteScript(context),
   ];
-  return [
-    merge({}, baseDeploymentJob, getDockerJobBaseProps(context), {
+  return createDeployementJobs(context, {
+    deploy: merge(getDockerJobBaseProps(context), {
       artifacts: { paths: ["____envvars.yaml"] },
       variables: {
         CLOUDSDK_CORE_DISABLE_PROMPTS: "1",
@@ -271,13 +270,12 @@ export const createGoogleCloudRunDeployJobs = (
       image: getRunnerImage("gcloud"),
       script: deployScripts,
     }),
-
-    merge({}, getBaseDeploymentStopJob(context), {
+    stop: {
       image: getRunnerImage("gcloud"),
       variables: {
         CLOUDSDK_CORE_DISABLE_PROMPTS: "1",
       },
       script: allowFailureInScripts(stopScripts),
-    }),
-  ];
+    },
+  });
 };

package/src/deploy/custom/deployJob.ts

@@ -1,15 +1,13 @@
-import { merge } from "lodash";
-
 import { getYarnInstall } from "../../build/node/yarn";
 import { getRunnerImage } from "../../runner";
 import type { Context } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
-import { getBaseDeploymentJob, getBaseDeploymentStopJob } from "../base";
-import { isOfDeployType } from "../types";
+import { createDeployementJobs } from "../base";
 import {
   getDependencyTrackDeleteScript,
   getDependencyTrackUploadScript,
 } from "../sbom";
+import { isOfDeployType } from "../types";
 
 export const createCustomDeployJobs = (context: Context): CatladderJob[] => {
   const deployConfig = context.componentConfig.deploy;
@@ -20,11 +18,10 @@ export const createCustomDeployJobs = (context: Context): CatladderJob[] => {
     // should not happen
     throw new Error("deploy config is not custom");
   }
-  const baseDeploymentJob = getBaseDeploymentJob(context);
   // FIXME: custom deploy currently assumes yarn-based project
   const yarnInstall = getYarnInstall(context, { noCustomPostInstall: true });
-  return [
-    merge({}, baseDeploymentJob, {
+  return createDeployementJobs(context, {
+    deploy: {
       image: deployConfig.jobImage ?? getRunnerImage("jobs-default"),
       cache: deployConfig.jobCache ?? [],
       script: [
@@ -33,17 +30,17 @@ export const createCustomDeployJobs = (context: Context): CatladderJob[] => {
         ...deployConfig.script,
         ...getDependencyTrackUploadScript(context),
       ],
-    }),
-    ...(deployConfig.stopScript
-      ? [
-          merge({}, getBaseDeploymentStopJob(context), {
-            image: deployConfig.jobImage ?? getRunnerImage("jobs-default"),
-            script: [
-              ...deployConfig.stopScript,
-              ...getDependencyTrackDeleteScript(context),
-            ],
-          }),
-        ]
-      : []),
-  ];
+      variables: {},
+    },
+    stop: deployConfig.stopScript
+      ? {
+          image: deployConfig.jobImage ?? getRunnerImage("jobs-default"),
+          script: [
+            ...deployConfig.stopScript,
+            ...getDependencyTrackDeleteScript(context),
+          ],
+          variables: {},
+        }
+      : undefined,
+  });
 };

package/src/deploy/dockerTag/deployJob.ts

@@ -1,9 +1,8 @@
-import { merge } from "lodash";
 import { getDockerJobBaseProps, gitlabDockerLogin } from "../../build/docker";
 
 import type { Context } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
-import { getBaseDeploymentJob } from "../base";
+import { createDeployementJobs } from "../base";
 import { isOfDeployType } from "../types";
 
 export const createDockerTagDeployJobs = (context: Context): CatladderJob[] => {
@@ -15,10 +14,10 @@ export const createDockerTagDeployJobs = (context: Context): CatladderJob[] => {
     // should not happen
     throw new Error("deploy config is not dockerTag");
   }
-  const baseDeploymentJob = getBaseDeploymentJob(context);
   const tag = deployConfig.tag;
-  return [
-    merge({}, baseDeploymentJob, getDockerJobBaseProps(context), {
+  return createDeployementJobs(context, {
+    deploy: {
+      ...getDockerJobBaseProps(context),
       script: [
         gitlabDockerLogin,
         `docker pull $DOCKER_IMAGE:$DOCKER_IMAGE_TAG`,
@@ -26,6 +25,6 @@ export const createDockerTagDeployJobs = (context: Context): CatladderJob[] => {
         `docker push $DOCKER_IMAGE:${tag}`,
         `echo "pushed as $DOCKER_IMAGE:${tag}"`,
       ],
-    }),
-  ];
+    },
+  });
 };

package/src/deploy/kubernetes/deployJob.ts

@@ -1,20 +1,15 @@
 import { dump } from "js-yaml";
-import { merge } from "lodash";
-import { getSecretVarNameForContext } from "../..";
 import { getRunnerImage } from "../../runner";
 import type { Context } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
-import {
-  getBaseDeploymentJob,
-  getBaseDeploymentStopJob,
-  getBaseRollbackJob,
-} from "../base";
-import { isOfDeployType } from "../types";
-import { createKubeValues } from "./kubeValues";
+import { createDeployementJobs } from "../base";
 import {
   getDependencyTrackDeleteScript,
   getDependencyTrackUploadScript,
 } from "../sbom";
+import { isOfDeployType } from "../types";
+import { createKubeValues } from "./kubeValues";
+import { getSecretVarNameForContext } from "../../context/getEnvironmentVariables";
 
 export const createKubernetesDeployJobs = (
   context: Context
@@ -29,10 +24,7 @@ export const createKubernetesDeployJobs = (
   }
 
   const kubeValues = createKubeValues(context);
-  const kubernetesEnvironment = {
-    namespace: context.environment.envVars.KUBE_NAMESPACE,
-  };
-  const shared = {
+  const shared: Pick<CatladderJob, "image" | "variables"> = {
     image: getRunnerImage("kubernetes"),
     variables: {
       ...context.environment.envVars,
@@ -55,9 +47,6 @@ export const createKubernetesDeployJobs = (
     },
   };
 
-  const baseDeploymentJob = getBaseDeploymentJob(context);
-  const baseStopJob = getBaseDeploymentStopJob(context);
-  const baseRollbackJob = getBaseRollbackJob(context);
   const clusterName = `kube-${context.environment.fullName}`;
   const connectContext = [
     `kubectl config set-cluster "${clusterName}" --server="$${getSecretVarNameForContext(
@@ -74,8 +63,10 @@ export const createKubernetesDeployJobs = (
     `kubectl config set-context "${clusterName}" --cluster="${clusterName}" --user="${clusterName}" --namespace="${context.environment.envVars.KUBE_NAMESPACE}"`,
     `kubectl config use-context "${clusterName}"`,
   ];
-  return [
-    merge({}, baseDeploymentJob, shared, {
+
+  return createDeployementJobs(context, {
+    deploy: {
+      ...shared,
       script: [
         ...connectContext,
         "kubernetesCreateSecret",
@@ -83,26 +74,18 @@ export const createKubernetesDeployJobs = (
         ...getDependencyTrackUploadScript(context),
         "echo deployment successful 😻",
       ],
-      environment: {
-        kubernetes: kubernetesEnvironment,
-      },
-    }),
-    merge({}, baseStopJob, shared, {
+    },
+    stop: {
+      ...shared,
       script: [
         ...connectContext,
         "kubernetesDelete",
         ...getDependencyTrackDeleteScript(context),
       ],
-      environment: {
-        kubernetes: kubernetesEnvironment,
-      },
-    }),
-
-    merge({}, baseRollbackJob, shared, {
+    },
+    rollback: {
+      ...shared,
       script: [...connectContext, "kubernetesRollback"],
-      environment: {
-        kubernetes: kubernetesEnvironment,
-      },
-    }),
-  ];
+    },
+  });
 };

package/src/deploy/kubernetes/mongodb.ts

@@ -1,6 +1,7 @@
 import { range } from "lodash";
-import type { Context } from "../..";
-import { getSecretVarNameForContext, isOfDeployType } from "../..";
+import { getSecretVarNameForContext } from "../../context/getEnvironmentVariables";
+import type { Context } from "../../types/context";
+import { isOfDeployType } from "../types";
 
 const getCredentialString = (context: Context) =>
   `root:$${getSecretVarNameForContext(context, "MONGODB_ROOT_PASSWORD")}@`;

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -3,6 +3,7 @@ import { BASE_RETRY } from "../../defaults";
 import type { GitlabJobDef } from "../../types";
 import type { CatladderJob, CatladderJobNeed } from "../../types/jobs";
 import type { AllCatladderJobs } from "../createAllJobs";
+import { notNil } from "../../utils";
 
 type AllGitlabJobs = Record<string, GitlabJobDef>;
 
@@ -52,6 +53,7 @@ export const makeGitlabJob = (
     name,
     needs,
     jobTags,
+    script,
     ...job
   }: CatladderJob<string>,
   allJobs: AllCatladderJobs
@@ -106,6 +108,7 @@ export const makeGitlabJob = (
 
   const gitlabJob: GitlabJobDef = removeUndefined({
     ...job,
+    script: script?.filter(notNil),
     tags: jobTags,
     stage,
     environment: job.environment?.on_stop