@catladder/pipeline 0.0.0-refactor-args-c1264291 → 0.0.0-refactor-gcloud-api-60147713

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catladder/pipeline",
-  "version": "0.0.0-refactor-args-c1264291",
+  "version": "0.0.0-refactor-gcloud-api-60147713",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/deploy/cloudRun/deployJob.ts

@@ -21,13 +21,11 @@ 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[] => {
@@ -62,20 +60,11 @@ export const createGoogleCloudRunDeployJobs = (
     .map(([key, value]) => `${key}=${value}`)
     .join(",");
 
-  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 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 serviceName = context.environment.fullName.toLowerCase();
 
   const getFullJobName = (name: string) =>
@@ -115,16 +104,25 @@ export const createGoogleCloudRunDeployJobs = (
         ? service?.command ?? context.componentConfig.build.startCommand
         : undefined;
 
-    const argsString = createArgsString({
-      command: command ? '"' + command.split(" ").join(",") + '"' : undefined, // not sure if quotes are needed
-      ...commonDeployArgs,
-      "env-vars-file": "____envvars.yaml",
+    const commandArg = command
+      ? `--command="${command.split(" ").join(",")}"`
+      : "";
+
+    const args = {
       "allow-unauthenticated": true,
       "min-instances": customConfig?.minInstances,
       "max-instances": customConfig?.maxInstances,
       "no-cpu-throttling": customConfig?.noCpuThrottling,
-    });
-    return `gcloud run deploy ${serviceName}${nameSuffix ?? ""} ${argsString}`;
+    } 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}`;
   };
 
   const getJobCreateScriptsForJob = (
@@ -135,28 +133,22 @@ 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 commonDeployArgsString = createArgsString({
-      command: '"' + job.command.split(" ").join(",") + '"',
-      ...commonDeployArgs,
-      memory: job.memory || "512Mi",
-    });
-
-    const argsString = `${jobName} ${commonDeployArgsString}`;
+    const args = `${jobName} --command="${job.command
+      .split(" ")
+      .join(",")}" ${commonDeployArgs} --memory=${job.memory || "512Mi"}`;
     return [
-      ...allowFailureInScripts([`gcloud beta run jobs create ${argsString}`]),
-      `gcloud beta run jobs update ${argsString} --env-vars-file=____envvars.yaml`,
+      ...allowFailureInScripts([`gcloud beta run jobs create ${args}`]),
+      `gcloud beta run jobs update ${args} --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} ${commonArgsString}`;
+    return `gcloud beta run jobs execute ${jobName} ${commonArgs}`;
   };
 
   const getJobRunScripts = (when: DeployConfigCloudRunJob["when"]) =>
@@ -167,16 +159,11 @@ export const createGoogleCloudRunDeployJobs = (
   const getCreateScheduleScripts = () => {
     return jobsWithSchedule
       .map(({ job, jobName, schedulerName }) => {
-        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}`;
+        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`;
         return [
           ...allowFailureInScripts([
             `gcloud scheduler jobs create ${commonArgs}`,
@@ -188,15 +175,11 @@ 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} ${argsString}`,
+            `gcloud scheduler jobs delete ${schedulerName} --project=${deployConfig.projectId} --location ${deployConfig.region}`,
           ]),
         ];
       })
@@ -205,8 +188,7 @@ export const createGoogleCloudRunDeployJobs = (
 
   const getDeleteJobsScripts = () =>
     jobsWithNames.map(
-      ({ jobName }) =>
-        `gcloud beta run jobs delete ${jobName} ${commonArgsString}`
+      ({ jobName }) => `gcloud beta run jobs delete ${jobName} ${commonArgs}`
     );
 
   const deployScripts = [
@@ -235,11 +217,11 @@ export const createGoogleCloudRunDeployJobs = (
   const stopScripts = [
     ...gcloudServiceAccountLoginCommands(context),
     ...(deployConfig.service !== false
-      ? [`gcloud run services delete ${serviceName} ${commonArgsString}`]
+      ? [`gcloud run services delete ${serviceName} ${commonArgs}`]
       : []),
     ...Object.entries(deployConfig.additionalServices ?? {}).map(
       ([name]) =>
-        `gcloud run services delete ${serviceName}-${name} ${commonArgsString}`
+        `gcloud run services delete ${serviceName}-${name} ${commonArgs}`
     ),
     ...getDeleteSchedulesScripts(),
     ...getDeleteJobsScripts(),

package/dist/deploy/cloudRun/utils/createArgsString.d.ts

@@ -1,11 +0,0 @@
-/**
- * creates arguments string:
- *
- * --key=value
- *
- * - undefined or null values will get removed completly
- * - true will just be "--key"
- * @param args args record
- * @returns
- */
-export declare const createArgsString: (args: Record<string, string | number | true | undefined>) => string;

package/dist/deploy/cloudRun/utils/createArgsString.js

@@ -1,50 +0,0 @@
-"use strict";
-
-var __read = this && this.__read || function (o, n) {
-  var m = typeof Symbol === "function" && o[Symbol.iterator];
-  if (!m) return o;
-  var i = m.call(o),
-    r,
-    ar = [],
-    e;
-  try {
-    while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-  } catch (error) {
-    e = {
-      error: error
-    };
-  } finally {
-    try {
-      if (r && !r.done && (m = i["return"])) m.call(i);
-    } finally {
-      if (e) throw e.error;
-    }
-  }
-  return ar;
-};
-exports.__esModule = true;
-exports.createArgsString = void 0;
-var lodash_1 = require("lodash");
-/**
- * creates arguments string:
- *
- * --key=value
- *
- * - undefined or null values will get removed completly
- * - true will just be "--key"
- * @param args args record
- * @returns
- */
-var createArgsString = function (args) {
-  return Object.entries(args).filter(function (_a) {
-    var _b = __read(_a, 2),
-      value = _b[1];
-    return !(0, lodash_1.isNil)(value);
-  }).map(function (_a) {
-    var _b = __read(_a, 2),
-      key = _b[0],
-      value = _b[1];
-    return "--".concat(key).concat(value !== true ? "=".concat(value) : "");
-  }).join(" ");
-};
-exports.createArgsString = createArgsString;

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

@@ -1,19 +0,0 @@
-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(" ");