@catladder/pipeline 0.0.0-refactore-catenv-command-validates-argument-78d05852 → 0.0.0-reference-database-url-1befbbee

package/examples/cloud-run-service-custom-vpc.ts

@@ -0,0 +1,39 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+
+        service: {
+          network: "my-network",
+          subnet: "my-subnet",
+          vpcEgress: "all-traffic",
+        },
+        jobs: {
+          myjob: {
+            command: "echo hello",
+            network: "my-network",
+            subnet: "my-subnet",
+            vpcEgress: "all-traffic",
+          },
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Service with custom vpc settings",
+};

package/examples/cloud-run-service-gen2.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-service-gen2";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-service-gen2 local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/cloud-run-service-gen2.ts

@@ -1,6 +1,6 @@
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
-const config: Config = {
+
+const config = {
   appName: "test-app",
   customerName: "pan",
   components: {
@@ -20,8 +20,10 @@ const config: Config = {
       },
     },
   },
-};
+} satisfies Config;
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export default config;
+
+export const information = {
+  title: "Cloud Run: Service Gen2",
+};

package/examples/cloud-run-service-increase-timout.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-service-increase-timout";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-service-increase-timout local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/cloud-run-service-increase-timout.ts

@@ -0,0 +1,29 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+
+        service: {
+          timeout: "10m20s",
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Service Increase Timout",
+};

package/examples/cloud-run-service-with-volumes.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-service-with-volumes";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-service-with-volumes local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/cloud-run-service-with-volumes.ts

@@ -0,0 +1,64 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+
+        service: {
+          volumes: {
+            myMount: {
+              type: "cloud-storage",
+              bucket: "my-bucket",
+              mountPath: "/mnt/my-mount",
+            },
+
+            myOtherMount: {
+              type: "cloud-storage",
+              bucket: "some-other-bucket",
+              mountPath: "/mnt/my-second-mount",
+              readonly: true,
+            },
+          },
+        },
+
+        jobs: {
+          migrate: {
+            command: "migrate",
+
+            volumes: {
+              myMount: {
+                type: "cloud-storage",
+                bucket: "my-bucket",
+                mountPath: "/mnt/my-mount",
+              },
+            },
+          },
+        },
+
+        execute: {
+          migrate: {
+            type: "job",
+            job: "migrate",
+            when: "postDeploy",
+          },
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Service with Volumes",
+};

package/examples/cloud-run-storybook.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-storybook";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-storybook local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/cloud-run-storybook.ts

@@ -0,0 +1,33 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "app",
+      build: {
+        type: "node",
+        buildCommand: "yarn build-storybook --quiet -o ./dist",
+        startCommand: "",
+        docker: {
+          type: "nginx",
+        },
+        test: false,
+        lint: false,
+        audit: false,
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Storybook",
+};

package/examples/cloud-run-with-gpu.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-with-gpu";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-with-gpu local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

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

@@ -0,0 +1,30 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west4", // verify in which regions GPUs are available, europe-west6 is not supported as of time of writing
+        service: {
+          gpu: 1,
+          gpuType: "nvidia-l4",
+          memory: "32Gi",
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: With GPU",
+};

package/examples/cloud-run-with-ngnix.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-with-ngnix";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-with-ngnix local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

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

@@ -0,0 +1,29 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "app",
+      build: {
+        type: "node",
+        startCommand: "",
+        docker: {
+          type: "nginx",
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: With Nginx",
+};

package/examples/cloud-run-with-sql-legacy-jobs.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-with-sql-legacy-jobs";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-with-sql-legacy-jobs local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

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

@@ -0,0 +1,49 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        // optional, set min and max instances
+        // defaults to 0-100
+        service: {
+          minInstances: 0,
+          maxInstances: 5,
+        },
+        cloudSql: {
+          type: "unmanaged",
+          instanceConnectionName: "projectId:region:instancename",
+          dbUser: "my-user",
+        },
+        jobs: {
+          migration: {
+            when: "preDeploy",
+            command: "yarn migrate",
+            waitForCompletion: true,
+          },
+          ["send-reminders"]: {
+            when: "schedule",
+            command: "yarn job:send-reminders",
+            schedule: "0 * * * *",
+            timeout: "15m",
+          },
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: With SQL",
+};

package/examples/cloud-run-with-sql-multiple-dbs.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-with-sql-multiple-dbs";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-with-sql-multiple-dbs local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

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

@@ -0,0 +1,87 @@
+import type {
+  ComponentConfig,
+  Config,
+  DeployConfigCloudRunCloudSql,
+} from "../src";
+
+// both dbs currently need to run on the same instance
+const CLOUD_SQL_BASE: DeployConfigCloudRunCloudSql = {
+  type: "unmanaged",
+  instanceConnectionName: "projectId:region:instancename",
+  dbUser: "my-user",
+};
+
+const DbComponent = (name: string): ComponentConfig => ({
+  dir: "packages/" + name,
+  build: {
+    type: "node",
+  },
+  deploy: {
+    type: "google-cloudrun",
+    projectId: "google-project-id",
+    region: "europe-west6",
+    cloudSql: {
+      ...CLOUD_SQL_BASE,
+      /*
+      there is a flaw in the current implementation, 
+      that the db-url does not embed the env vars like DB_NAME, DB_USER, DB_PASSWORD, etc, 
+      This leads to the problem that if you reference the DATABASE_URL from another component,
+      it will not work properly, as it only contains var names instead of the actual values.
+      Setting this to "embedded" will embed the actual values into the db-url, which solves this problem.
+      */
+      dbConnectionStringVariablesMode: "embedded",
+    },
+    service: false,
+    jobs: {
+      migrate: {
+        command: "yarn migrate",
+      },
+    },
+    execute: {
+      migrate: {
+        type: "job",
+        job: "migrate",
+        when: "preDeploy",
+      },
+    },
+  },
+});
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    // its good practise to have separated db components
+    db1: DbComponent("db1"),
+    db2: DbComponent("db2"),
+
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+        buildCommand: "yarn build:worker",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        cloudSql: {
+          // currently one db is the default, as it injects additional env vars
+          ...CLOUD_SQL_BASE,
+          dbBaseName: "db1",
+        },
+      },
+      vars: {
+        public: {
+          // we reference the second db-url
+          DATABASE_URL_2: "${db2:DATABASE_URL}",
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: With SQL Reuse DB",
+};

package/examples/cloud-run-with-sql-reuse-db.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-with-sql-reuse-db";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-with-sql-reuse-db local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

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

@@ -1,12 +1,11 @@
 import type { Config, DeployConfigCloudRunCloudSql } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
 
 const CLOUD_SQL: DeployConfigCloudRunCloudSql = {
   type: "unmanaged",
   instanceConnectionName: "projectId:region:instancename",
   dbUser: "my-user",
 };
-const config: Config = {
+const config = {
   appName: "test-app",
   customerName: "pan",
   components: {
@@ -47,8 +46,10 @@ const config: Config = {
       },
     },
   },
-};
+} satisfies Config;
+
+export default config;
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export const information = {
+  title: "Cloud Run: With SQL Reuse DB",
+};

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

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-with-sql";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-with-sql local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

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

@@ -1,6 +1,6 @@
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
-const config: Config = {
+
+const config = {
   appName: "test-app",
   customerName: "pan",
   components: {
@@ -25,38 +25,59 @@ const config: Config = {
           dbUser: "my-user",
         },
         jobs: {
-          migration: {
-            when: "postDeploy",
+          migrate: {
             command: "yarn migrate",
           },
           ["send-reminders"]: {
-            when: "schedule",
             command: "yarn job:send-reminders",
+            args: ["--verbose=false"],
+          },
+        },
+        execute: {
+          migrate: {
+            type: "job",
+            job: "migrate",
+            when: "preDeploy",
+            waitForCompletion: true,
+            args: ["--verbose=true", "--create-db"],
+          },
+          ["send-reminders-admins"]: {
+            type: "job",
+            when: "schedule",
+            job: "send-reminders",
+            args: ["--only-admins", "--verbose=true"],
+            schedule: "0 * * * *",
+          },
+          ["send-reminders"]: {
+            type: "job",
+            when: "schedule",
+            job: "send-reminders",
+            schedule: "0 * * * *",
+          },
+          ["call-http-endpoint"]: {
+            type: "http",
+            url: "${ROOT_URL}/myEndpoint",
+            when: "schedule",
             schedule: "0 * * * *",
-            timeout: "15m",
+            method: "GET",
           },
         },
       },
-    },
-    www: {
-      dir: "www",
-      build: {
-        type: "node",
-      },
-      deploy: {
-        type: "google-cloudrun",
-        projectId: "google-project-id",
-        region: "europe-west6",
-      },
-      vars: {
-        public: {
-          API_URL: "${api:ROOT_URL}/graphql",
+      env: {
+        review: {
+          deploy: {
+            execute: {
+              "send-reminders": null, // disable on this env
+            },
+          },
         },
       },
     },
   },
-};
+} satisfies Config;
+
+export default config;
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export const information = {
+  title: "Cloud Run: With SQL",
+};

package/examples/cloud-run-with-worker.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-with-worker";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-with-worker local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

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

@@ -1,6 +1,6 @@
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
-const config: Config = {
+
+const config = {
   appName: "test-app",
   customerName: "pan",
   components: {
@@ -28,8 +28,10 @@ const config: Config = {
       },
     },
   },
-};
+} satisfies Config;
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export default config;
+
+export const information = {
+  title: "Cloud Run: With Worker",
+};