@catladder/pipeline 1.80.2 → 1.80.4

package/examples/__snapshots__/custom-build-job.ts.snap

@@ -151,7 +151,7 @@ exports[`matches snapshot 1`] = `
           "docker tag $DOCKER_IMAGE:$DOCKER_IMAGE_TAG asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
           "docker push asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
           "echo "$ENV_VARS" > ____envvars.yaml",
-          "gcloud run deploy pan-test-app-dev-www  --image asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project asdf --region=asia-east1  --labels customer-name=pan,app-name=test-app,env-type=dev,env-name=dev,build-type=custom --env-vars-file=____envvars.yaml --allow-unauthenticated",
+          "gcloud run deploy pan-test-app-dev-www --image=asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=asdf --region=asia-east1 --labels=customer-name=pan,app-name=test-app,env-type=dev,env-name=dev,build-type=custom --env-vars-file=____envvars.yaml --allow-unauthenticated",
           "docker image rm asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
         ],
         "services": [
@@ -231,7 +231,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","HOST","ROOT_URL","HOST_CA
           "echo $CL_dev_www_GCLOUD_DEPLOY_credentialsKey > ./____keyfile.json
           ",
           "gcloud auth activate-service-account --key-file="./____keyfile.json"",
-          "gcloud run services delete pan-test-app-dev-www --project asdf --region=asia-east1",
+          "gcloud run services delete pan-test-app-dev-www --project=asdf --region=asia-east1",
         ],
         "stage": "stop dev",
         "variables": {
@@ -461,7 +461,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","HOST","ROOT_URL","HOST_CA
           "docker tag $DOCKER_IMAGE:$DOCKER_IMAGE_TAG asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
           "docker push asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
           "echo "$ENV_VARS" > ____envvars.yaml",
-          "gcloud run deploy pan-test-app-review-mr1234-www  --image asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project asdf --region=asia-east1  --labels customer-name=pan,app-name=test-app,env-type=review,env-name=review,build-type=custom --env-vars-file=____envvars.yaml --allow-unauthenticated",
+          "gcloud run deploy pan-test-app-review-mr1234-www --image=asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=asdf --region=asia-east1 --labels=customer-name=pan,app-name=test-app,env-type=review,env-name=review,build-type=custom --env-vars-file=____envvars.yaml --allow-unauthenticated",
           "docker image rm asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
         ],
         "services": [
@@ -541,7 +541,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","HOST","ROOT_URL","HOST_CA
           "echo $CL_review_www_GCLOUD_DEPLOY_credentialsKey > ./____keyfile.json
           ",
           "gcloud auth activate-service-account --key-file="./____keyfile.json"",
-          "gcloud run services delete pan-test-app-review-mr1234-www --project asdf --region=asia-east1",
+          "gcloud run services delete pan-test-app-review-mr1234-www --project=asdf --region=asia-east1",
         ],
         "stage": "stop review",
         "variables": {
@@ -868,7 +868,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","HOST","ROOT_URL","HOST_CA
           "docker tag $DOCKER_IMAGE:$DOCKER_IMAGE_TAG asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
           "docker push asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
           "echo "$ENV_VARS" > ____envvars.yaml",
-          "gcloud run deploy pan-test-app-prod-www  --image asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project asdf --region=asia-east1  --labels customer-name=pan,app-name=test-app,env-type=prod,env-name=prod,build-type=custom --env-vars-file=____envvars.yaml --allow-unauthenticated",
+          "gcloud run deploy pan-test-app-prod-www --image=asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=asdf --region=asia-east1 --labels=customer-name=pan,app-name=test-app,env-type=prod,env-name=prod,build-type=custom --env-vars-file=____envvars.yaml --allow-unauthenticated",
           "docker image rm asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
         ],
         "services": [
@@ -966,7 +966,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","HOST","ROOT_URL","HOST_CA
           "docker tag $DOCKER_IMAGE:$DOCKER_IMAGE_TAG asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
           "docker push asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
           "echo "$ENV_VARS" > ____envvars.yaml",
-          "gcloud run deploy pan-test-app-stage-www  --image asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project asdf --region=asia-east1  --labels customer-name=pan,app-name=test-app,env-type=stage,env-name=stage,build-type=custom --env-vars-file=____envvars.yaml --allow-unauthenticated",
+          "gcloud run deploy pan-test-app-stage-www --image=asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG --project=asdf --region=asia-east1 --labels=customer-name=pan,app-name=test-app,env-type=stage,env-name=stage,build-type=custom --env-vars-file=____envvars.yaml --allow-unauthenticated",
           "docker image rm asia-east1-docker.pkg.dev/asdf/catladder-deploy/pan-test-app/$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG",
         ],
         "services": [
@@ -1046,7 +1046,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","HOST","ROOT_URL","HOST_CA
           "echo $CL_prod_www_GCLOUD_DEPLOY_credentialsKey > ./____keyfile.json
           ",
           "gcloud auth activate-service-account --key-file="./____keyfile.json"",
-          "gcloud run services delete pan-test-app-prod-www --project asdf --region=asia-east1",
+          "gcloud run services delete pan-test-app-prod-www --project=asdf --region=asia-east1",
         ],
         "stage": "stop prod",
         "variables": {
@@ -1089,7 +1089,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","HOST","ROOT_URL","HOST_CA
           "echo $CL_stage_www_GCLOUD_DEPLOY_credentialsKey > ./____keyfile.json
           ",
           "gcloud auth activate-service-account --key-file="./____keyfile.json"",
-          "gcloud run services delete pan-test-app-stage-www --project asdf --region=asia-east1",
+          "gcloud run services delete pan-test-app-stage-www --project=asdf --region=asia-east1",
         ],
         "stage": "stop stage",
         "variables": {

package/examples/cloud-run-with-sql.ts

@@ -37,6 +37,22 @@ const config: Config = {
         },
       },
     },
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+      },
+      vars: {
+        public: {
+          API_URL: "${api:ROOT_URL}",
+        },
+      },
+    },
   },
 };
 

package/package.json

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

package/src/deploy/cloudRun/deployJob.ts

@@ -21,11 +21,13 @@ import {
 } from "./utils/database";
 import { allowFailureInScripts } from "../../utils/gitlab";
 import { getCloudRunJobName } from "./utils/jobName";
+import { createArgsString } from "./utils/createArgsString";
 
 const setExtraVarsScripts = (deployConfig: DeployConfigCloudRun) => [
   `export GCLOUD_PROJECT_NUMBER=$(gcloud projects describe ${deployConfig.projectId} --format="value(projectNumber)")`,
   `echo "GCLOUD_PROJECT_NUMBER: $GCLOUD_PROJECT_NUMBER"`,
 ];
+
 export const createGoogleCloudRunDeployJobs = (
   context: Context
 ): CatladderJob[] => {
@@ -60,11 +62,20 @@ export const createGoogleCloudRunDeployJobs = (
     .map(([key, value]) => `${key}=${value}`)
     .join(",");
 
-  const commonArgs = `--project ${deployConfig.projectId} --region=${deployConfig.region}`;
-  const cloudRunArgs = deployConfig.cloudSql
-    ? `--set-cloudsql-instances=${deployConfig.cloudSql.instanceConnectionName}`
-    : "";
-  const commonDeployArgs = `--image ${gcloudImageName} ${commonArgs} ${cloudRunArgs} --labels ${labelsString}`;
+  const commonArgs = {
+    project: deployConfig.projectId,
+    region: deployConfig.region,
+  };
+
+  const commonDeployArgs = {
+    image: gcloudImageName,
+    ...commonArgs,
+    "set-cloudsql-instances": deployConfig.cloudSql
+      ? deployConfig.cloudSql.instanceConnectionName
+      : undefined,
+    labels: labelsString,
+  };
+
   const serviceName = context.environment.fullName.toLowerCase();
 
   const getFullJobName = (name: string) =>
@@ -104,25 +115,16 @@ export const createGoogleCloudRunDeployJobs = (
         ? service?.command ?? context.componentConfig.build.startCommand
         : undefined;
 
-    const commandArg = command
-      ? `--command="${command.split(" ").join(",")}"`
-      : "";
-
-    const args = {
+    const argsString = createArgsString({
+      command: command ? '"' + command.split(" ").join(",") + '"' : undefined, // not sure if quotes are needed
+      ...commonDeployArgs,
+      "env-vars-file": "____envvars.yaml",
       "allow-unauthenticated": true,
       "min-instances": customConfig?.minInstances,
       "max-instances": customConfig?.maxInstances,
       "no-cpu-throttling": customConfig?.noCpuThrottling,
-    } as const;
-
-    const argsString = Object.entries(args)
-      .filter(([, value]) => !isNil(value))
-      .map(([key, value]) => `--${key}${value !== true ? `=${value}` : ""}`)
-      .join(" ");
-
-    return `gcloud run deploy ${serviceName}${
-      nameSuffix ?? ""
-    } ${commandArg} ${commonDeployArgs} --env-vars-file=____envvars.yaml ${argsString}`;
+    });
+    return `gcloud run deploy ${serviceName}${nameSuffix ?? ""} ${argsString}`;
   };
 
   const getJobCreateScriptsForJob = (
@@ -133,22 +135,28 @@ export const createGoogleCloudRunDeployJobs = (
     // lucky, update on the other hand accepts it... so let's just imediatly update it
 
     // also we cannot upsert a job, so we have to create it and catch the error and then update
-    const args = `${jobName} --command="${job.command
-      .split(" ")
-      .join(",")}" ${commonDeployArgs} --memory=${job.memory || "512Mi"}`;
+    const commonDeployArgsString = createArgsString({
+      command: '"' + job.command.split(" ").join(",") + '"',
+      ...commonDeployArgs,
+      memory: job.memory || "512Mi",
+    });
+
+    const argsString = `${jobName} ${commonDeployArgsString}`;
     return [
-      ...allowFailureInScripts([`gcloud beta run jobs create ${args}`]),
-      `gcloud beta run jobs update ${args} --env-vars-file=____envvars.yaml`,
+      ...allowFailureInScripts([`gcloud beta run jobs create ${argsString}`]),
+      `gcloud beta run jobs update ${argsString} --env-vars-file=____envvars.yaml`,
     ];
   };
 
+  const commonArgsString = createArgsString(commonArgs);
+
   const getJobCreateScripts = () =>
     jobsWithNames
       .map(({ job, jobName }) => getJobCreateScriptsForJob(jobName, job))
       .flat();
 
   const getJobRunScriptForJob = (jobName: string) => {
-    return `gcloud beta run jobs execute ${jobName} ${commonArgs}`;
+    return `gcloud beta run jobs execute ${jobName} ${commonArgsString}`;
   };
 
   const getJobRunScripts = (when: DeployConfigCloudRunJob["when"]) =>
@@ -159,11 +167,16 @@ export const createGoogleCloudRunDeployJobs = (
   const getCreateScheduleScripts = () => {
     return jobsWithSchedule
       .map(({ job, jobName, schedulerName }) => {
-        const commonArgs = `http ${schedulerName} --project=${deployConfig.projectId} --location ${deployConfig.region} \
-      --schedule="${job.schedule}" \
-      --uri="https://${deployConfig.region}-run.googleapis.com/apis/run.googleapis.com/v1/namespaces/${deployConfig.projectId}/jobs/${jobName}:run" \
-      --http-method POST \
-      --oauth-service-account-email $GCLOUD_PROJECT_NUMBER-compute@developer.gserviceaccount.com`;
+        const argsString = createArgsString({
+          project: deployConfig.projectId,
+          location: deployConfig.region,
+          schedule: `"${job.schedule}"`,
+          uri: `"https://${deployConfig.region}-run.googleapis.com/apis/run.googleapis.com/v1/namespaces/${deployConfig.projectId}/jobs/${jobName}:run"`,
+          "http-method": "POST",
+          "oauth-service-account-email":
+            "$GCLOUD_PROJECT_NUMBER-compute@developer.gserviceaccount.com",
+        });
+        const commonArgs = `http ${schedulerName} ${argsString}`;
         return [
           ...allowFailureInScripts([
             `gcloud scheduler jobs create ${commonArgs}`,
@@ -175,11 +188,15 @@ export const createGoogleCloudRunDeployJobs = (
   };
 
   const getDeleteSchedulesScripts = () => {
+    const argsString = createArgsString({
+      project: deployConfig.projectId,
+      location: deployConfig.region,
+    });
     return jobsWithSchedule
       .map(({ schedulerName }) => {
         return [
           ...allowFailureInScripts([
-            `gcloud scheduler jobs delete ${schedulerName} --project=${deployConfig.projectId} --location ${deployConfig.region}`,
+            `gcloud scheduler jobs delete ${schedulerName} ${argsString}`,
           ]),
         ];
       })
@@ -188,7 +205,8 @@ export const createGoogleCloudRunDeployJobs = (
 
   const getDeleteJobsScripts = () =>
     jobsWithNames.map(
-      ({ jobName }) => `gcloud beta run jobs delete ${jobName} ${commonArgs}`
+      ({ jobName }) =>
+        `gcloud beta run jobs delete ${jobName} ${commonArgsString}`
     );
 
   const deployScripts = [
@@ -217,11 +235,11 @@ export const createGoogleCloudRunDeployJobs = (
   const stopScripts = [
     ...gcloudServiceAccountLoginCommands(context),
     ...(deployConfig.service !== false
-      ? [`gcloud run services delete ${serviceName} ${commonArgs}`]
+      ? [`gcloud run services delete ${serviceName} ${commonArgsString}`]
       : []),
     ...Object.entries(deployConfig.additionalServices ?? {}).map(
       ([name]) =>
-        `gcloud run services delete ${serviceName}-${name} ${commonArgs}`
+        `gcloud run services delete ${serviceName}-${name} ${commonArgsString}`
     ),
     ...getDeleteSchedulesScripts(),
     ...getDeleteJobsScripts(),

package/src/deploy/cloudRun/utils/createArgsString.ts

@@ -0,0 +1,19 @@
+import { isNil } from "lodash";
+
+/**
+ * creates arguments string:
+ *
+ * --key=value
+ *
+ * - undefined or null values will get removed completly
+ * - true will just be "--key"
+ * @param args args record
+ * @returns
+ */
+export const createArgsString = (
+  args: Record<string, string | number | true | undefined>
+) =>
+  Object.entries(args)
+    .filter(([, value]) => !isNil(value))
+    .map(([key, value]) => `--${key}${value !== true ? `=${value}` : ""}`)
+    .join(" ");