@catladder/pipeline 2.2.4 → 2.4.0

package/examples/custom-verify-job.ts

@@ -0,0 +1,64 @@
+import type { Config } from "../src";
+
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+      env: {
+        review: {
+          deploy: {
+            script: ['ROOT_URL="$(my deploy command)"'],
+          },
+        },
+      },
+      customJobs: [
+        {
+          name: `e2e`,
+          stage: "verify",
+          needsStages: [{ stage: "deploy" }],
+          envMode: "jobPerEnv",
+          cache: {
+            key: "cypress",
+            policy: "pull-push",
+            paths: [".yarn/cache", "node_modules/", "cache/cypress"],
+          },
+          image: "cypress/browsers",
+          script: [
+            "yarn install --frozen-lockfile",
+            `CYPRESS_BASE_URL=$CI_ENVIRONMENT_URL yarn cypress:run:ci`,
+          ],
+          environment: {
+            action: "access",
+          },
+          variables: {
+            CYPRESS_CACHE_FOLDER: "$CI_PROJECT_DIR/cache/cypress",
+          },
+          artifacts: {
+            expire_in: "1 week",
+            when: "always",
+            reports: {
+              junit: [`cypress/results/report-*.xml`],
+            },
+            paths: [`cypress/results`, `cypress/screenshots`, `cypress/videos`],
+          },
+        },
+      ],
+    },
+  },
+};
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Job",
+};

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "2.2.4",
+  "version": "2.4.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables",

package/src/deploy/base/deploy.ts

@@ -124,7 +124,7 @@ export const createDeployJob = (
           on_stop: STOP_JOB_NAME,
           auto_stop_in: autoStop,
         }
-      : undefined,
+      : {},
     jobTags: deployConfig ? deployConfig.jobTags : undefined,
   };
 };

package/src/deploy/cloudRun/createJobs/cloudRunJobs.ts

@@ -69,16 +69,19 @@ export const getJobRunScripts = (
   when: DeployConfigCloudRunJob["when"],
 ) => {
   const jobsWithNames = getCloudRunJobsWithNames(context);
+
   return jobsWithNames
     .filter(({ job }) => job.when === when)
-    .map(({ jobName }) =>
-      getJobRunScriptForJob(
-        context,
-        jobName,
-        // wait for completin on stop jobs, since stop will delete the jobs afterwards, so they will fail
-        ["preStop", "postStop"].includes(when),
-      ),
-    );
+    .map(({ jobName, job }) => {
+      // always wait for completion for preStop and postStop jobs
+      // since stop will delete the jobs afterwards, so they will fail
+      const waitForCompletion = ["preStop", "postStop"].includes(when)
+        ? true
+        : "waitForCompletion" in job
+          ? (job.waitForCompletion ?? false)
+          : false;
+      return getJobRunScriptForJob(context, jobName, waitForCompletion);
+    });
 };
 
 export const getJobCreateScripts = (context: ComponentContext): string[] =>

package/src/deploy/sbom.ts

@@ -1,3 +1,4 @@
+import { getBashVariable } from "../bash/BashExpression";
 import { SBOM_FILE } from "../build/sbom";
 import {
   componentContextIsStandaloneBuild,
@@ -16,7 +17,7 @@ export const getDependencyTrackUploadScript = (
     ? []
     : [
         "echo 'Uploading SBOM to Dependency Track'",
-        `/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "${context.fullConfig.customerName}-${context.fullConfig.appName}/${context.name}" "${context.environment.envVars.ROOT_URL}" "${SBOM_FILE}" vex.json || true`,
+        `/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "${context.fullConfig.customerName}-${context.fullConfig.appName}/${context.name}" "${getBashVariable("ROOT_URL")}" "${SBOM_FILE}" vex.json || true`,
       ];
 };
 
@@ -27,6 +28,6 @@ export const getDependencyTrackDeleteScript = (
     ? []
     : [
         "echo 'Disabling component in Dependency Track'",
-        `/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "${context.fullConfig.customerName}-${context.fullConfig.appName}/${context.name}" "${context.environment.envVars.ROOT_URL}" || true`,
+        `/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "${context.fullConfig.customerName}-${context.fullConfig.appName}/${context.name}" "${getBashVariable("CI_ENVIRONMENT_URL")}" || true`,
       ];
 };

package/src/deploy/types/googleCloudRun.ts

@@ -241,6 +241,12 @@ export type DeployConfigCloudRunJobWithSchedule =
 
 export type DeployConfigCloudRunJobNormal = DeployConfigCloudRunJobBase & {
   when: "manual" | "preDeploy" | "postDeploy" | "preStop" | "postStop";
+  /**
+   * wait for completion of the job on preDeploy and postDeploy
+   *
+   * has no effect on preStop and postStop (which always wait for completion)
+   */
+  waitForCompletion?: boolean;
 };
 
 export type DeployConfigCloudRunWithVolumes = {

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -13,6 +13,7 @@ import { notNil } from "../../utils";
 import { collapseableSection } from "../../utils/gitlab";
 import { removeUndefined } from "../../utils/removeUndefined";
 import type { AllCatladderJobs } from "../createAllJobs";
+import { getBashVariable } from "../../bash/BashExpression";
 
 export type GitlabJobWithContext = {
   gitlabJob: GitlabJobDef;
@@ -229,7 +230,7 @@ const addGitlabEnvironment = (
   const dotEnvFile = "gitlab_environment.env";
 
   const scriptToAdd = [
-    `echo "${GITLAB_ENVIRONMENT_URL_VARIABLE}=${envVars.ROOT_URL}" >> ${dotEnvFile}`,
+    `echo "${GITLAB_ENVIRONMENT_URL_VARIABLE}=${getBashVariable("ROOT_URL")}" >> ${dotEnvFile}`,
   ];
 
   // this is NOT a bashVariable since it NEEDS to be used as a string in gitlab
@@ -242,7 +243,10 @@ const addGitlabEnvironment = (
     ...job,
     environment: {
       name: gitlabEnvironmentName,
-      url: `$${GITLAB_ENVIRONMENT_URL_VARIABLE}`,
+      ...(!catladderJobEnvironment.action ||
+      catladderJobEnvironment.action === "start"
+        ? { url: `$${GITLAB_ENVIRONMENT_URL_VARIABLE}` }
+        : {}),
       ...(on_stop
         ? {
             on_stop: getFullReferencedJobNameFromComponent(