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

package/examples/multiline-var.ts

@@ -0,0 +1,107 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    app1: {
+      dir: "app1",
+      build: {
+        type: "node",
+      },
+      vars: {
+        public: {
+          foo: "foo-value",
+          multiline: `app1 line1
+app1 line2
+app1 line3  
+
+the url of self: "\${ROOT_URL}"
+
+
+app1 single quote: '
+app1 doouble quote: "
+`,
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+    app2: {
+      dir: "app2",
+      build: {
+        type: "node",
+      },
+      vars: {
+        public: {
+          foo: "foo-value",
+          multiline: `app2 yeah
+app2 yeah2
+app2 yeah3  
+
+app2 single quote: '
+app2 doouble quote: "
+
+the url of self: "\${ROOT_URL}"
+the url of app1: "\${app1:ROOT_URL}"
+
+value from app1:
+-------
+\${multiline_from_app1}
+--------
+`,
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+    kube: {
+      dir: "kube",
+      build: {
+        type: "node",
+      },
+      vars: {
+        public: {
+          multiline_from_app1: "${app1:multiline}",
+          multiline: `kube yeah
+kube yeah2
+kube yeah3  
+
+kube single quote: '
+kube doouble quote: "
+
+the url of self: "\${ROOT_URL}"
+the url of app1: "\${app1:ROOT_URL}"
+
+value from app1:
+-------
+\${multiline_from_app1}
+--------
+`,
+        },
+      },
+      deploy: {
+        type: "kubernetes",
+        cluster: {
+          name: "some-cluster-name",
+          region: "europe-west6",
+          projectId: "some-project-id",
+          type: "gcloud",
+          domainCanonical: "panter.cloud",
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Multiline Environment Variables",
+};

package/examples/native-app.test.ts

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

package/examples/native-app.ts

@@ -1,22 +1,21 @@
-import type { Config } from "../src";
+import type { CacheConfig, Config } from "../src";
 import type { CatladderJob } from "../src/types/jobs";
-import { createAllPipelines } from "./__utils__/helpers";
-const APP_GEM_CACHE: CatladderJob["cache"] = [
+
+const APP_GEM_CACHE: CacheConfig[] = [
   {
     key: {
-      files: ["app/Gemfile.lock"],
+      files: ["Gemfile.lock"],
     },
-    paths: ["app/vendor"],
+    paths: ["vendor"],
   },
 ];
 
-const config: Config = {
+const config = {
   appName: "test-app",
   customerName: "pan",
   components: {
     app: {
       dir: "app",
-      dotEnv: true,
       vars: {
         public: {
           GRAPHQL_URL: "${api:ROOT_URL}/graphql",
@@ -28,9 +27,11 @@ const config: Config = {
         ],
       },
       build: {
-        extraVars: {
-          LC_A: "L=en_US.UTF-8",
-          LANG: "en_US.UTF-8",
+        jobVars: {
+          public: {
+            LC_A: "L=en_US.UTF-8",
+            LANG: "en_US.UTF-8",
+          },
         },
         type: "node",
         buildCommand: [
@@ -41,14 +42,16 @@ const config: Config = {
           "bundle exec fastlane build",
         ],
         jobTags: ["mac-runner"],
-        jobCache: APP_GEM_CACHE,
+        cache: APP_GEM_CACHE,
       },
 
       deploy: {
         type: "custom",
-        extraVars: {
-          LC_A: "L=en_US.UTF-8",
-          LANG: "en_US.UTF-8",
+        jobVars: {
+          public: {
+            LC_A: "L=en_US.UTF-8",
+            LANG: "en_US.UTF-8",
+          },
         },
         requiresDocker: false,
         script: [
@@ -58,7 +61,7 @@ const config: Config = {
           "bundle exec fastlane deploy_test",
         ],
         jobTags: ["mac-runner"],
-        jobCache: APP_GEM_CACHE,
+        cache: APP_GEM_CACHE,
       },
     },
 
@@ -74,8 +77,10 @@ const config: Config = {
       },
     },
   },
-};
+} satisfies Config;
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export default config;
+
+export const information = {
+  title: "Native App",
+};

package/examples/node-build-with-custom-image.test.ts

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

package/examples/node-build-with-custom-image.ts

@@ -1,7 +1,6 @@
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
 
-const config: Config = {
+const config = {
   appName: "test-app",
   customerName: "pan",
   components: {
@@ -18,8 +17,10 @@ const config: Config = {
       },
     },
   },
-};
+} satisfies Config;
+
+export default config;
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export const information = {
+  title: "Node: Build with Custom Image",
+};

package/examples/node-build-with-docker-additions.test.ts

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

package/examples/node-build-with-docker-additions.ts

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

package/examples/override-secrets.test.ts

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

package/examples/override-secrets.ts

@@ -0,0 +1,44 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    ["my-app"]: {
+      dir: "app",
+      build: {
+        type: "node",
+      },
+      vars: {
+        secret: ["MY_SECRET"],
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "my-project-id",
+        region: "europe-west6",
+      },
+      env: {
+        local: {
+          vars: {
+            // arrays are not merged
+            // you can merge them manually, by using a function:
+            secret: (original) => [...(original ?? []), "MY_LOCAL_SECRET"],
+          },
+        },
+        review: {
+          vars: {
+            // arrays are not merged
+            // you can merge them manually, by using a function:
+            secret: (original) => [...(original ?? []), "MY_REVIEW_SECRET"],
+          },
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Multiline Environment Variables",
+};

package/examples/rails-k8s-with-worker-dockerfile.test.ts

@@ -0,0 +1,33 @@
+import { mkdir, rm, writeFile } from "fs/promises";
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./rails-k8s-with-worker";
+import { merge } from "lodash";
+import { join } from "path";
+
+it("matches snapshot with a Dockerfile", async () => {
+  const appDir = ".temp-with-dockerfile";
+  try {
+    await rm(appDir, {
+      recursive: true,
+    });
+  } catch (e) {
+    // ignore
+  }
+  await mkdir(appDir);
+  await writeFile(join(appDir, "Dockerfile"), "");
+  expect(
+    await createYamlLocalPipeline(
+      merge(config, {
+        components: {
+          app: {
+            dir: appDir,
+          },
+        },
+      }),
+    ),
+  ).toMatchSnapshot();
+
+  await rm(appDir, {
+    recursive: true,
+  });
+});

package/examples/rails-k8s-with-worker.test.ts

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

package/examples/rails-k8s-with-worker.ts

@@ -1,16 +1,16 @@
-import { rmSync, writeFileSync } from "fs";
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
 
 // the image version should match your `.ruby-version`
 const RAILS_TEST_STAGE_IMAGE = "ruby:3.2.1";
 
-const config: Config = {
+const config = {
   appName: "test-app",
   customerName: "pan",
   components: {
     app: {
       dir: ".",
+      dotEnv: false,
+      envDTs: false,
       vars: {
         public: {
           RAILS_ENV: "production",
@@ -46,7 +46,11 @@ const config: Config = {
           domainCanonical: "panter.cloud",
         },
         values: {
-          cloudsql: { enabled: true, projectId: "some-project-id" },
+          cloudsql: {
+            enabled: true,
+            type: "unmanaged",
+            instanceConnectionName: "myproject:europe-west6:instance-name",
+          },
           application: {
             // if deployed to Google Cloud Run use a gem like cloudtasker instead of a permanently running expensive worker
             worker: {
@@ -88,14 +92,10 @@ const config: Config = {
       },
     },
   },
-};
+} satisfies Config;
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export default config;
 
-it("matches snapshot with a Dockerfile", async () => {
-  writeFileSync("Dockerfile", "");
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-  rmSync("Dockerfile");
-});
+export const information = {
+  title: "K8s: Rails with Worker",
+};

package/examples/referencing-other-vars.test.ts

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

package/examples/referencing-other-vars.ts

@@ -0,0 +1,83 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    app1: {
+      dir: "app1",
+      build: {
+        type: "node",
+      },
+      vars: {
+        secret: ["SECRET1"],
+        public: {
+          foo: "foo-value",
+          bar: "bar-value",
+          foo3: "from app3: ${app3:foo3}",
+          circle:
+            'this is from app3 that has reference to app1: "${app3:transitive}"', // not officially recommended, but may work in some cases
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+    app2: {
+      dir: "app2",
+      build: {
+        type: "node",
+      },
+      vars: {
+        secret: ["SECRET2"],
+        public: {
+          foo2: "foo-value-2",
+          referencingSecret: "secret1: ${app1:SECRET1}, secret2: ${SECRET2}",
+          foo1: "this is from app1: ${app1:foo}",
+          selfReference: "this is from self: ${foo2}",
+          selfReference2: "this is from self: ${foo1}",
+          app1Api: "${app1:ROOT_URL}/graphql",
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+    app3: {
+      dir: "kube",
+      build: {
+        type: "node",
+      },
+      vars: {
+        public: {
+          foo3: "foo-value-3",
+          foo2: "this is from app2: ${app2:foo2}",
+          transitive: "this is from app2: ${app2:foo1}",
+          transitiveWithSecret: "this is from app2: ${app2:referencingSecret}",
+          someJson:
+            '[{"name": "app1", "url": "${app1:ROOT_URL}"}, {"name": "app2", "url": "${app2:ROOT_URL}"}, {"name": "app3", "url": "${ROOT_URL}"}]',
+        },
+      },
+      deploy: {
+        type: "kubernetes",
+        cluster: {
+          name: "some-cluster-name",
+          region: "europe-west6",
+          projectId: "some-project-id",
+          type: "gcloud",
+          domainCanonical: "panter.cloud",
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Multiline Environment Variables",
+};

package/examples/wait-for-other-deploy.test.ts

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

package/examples/wait-for-other-deploy.ts

@@ -1,5 +1,4 @@
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
 
 const config: Config<{ CustomEnvs: "asdf" | "bla" }> = {
   appName: "test-app",
@@ -29,8 +28,10 @@ const config: Config<{ CustomEnvs: "asdf" | "bla" }> = {
       },
     },
   },
-};
+} satisfies Config;
+
+export default config;
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export const information = {
+  title: "Wait for other deployment",
+};

package/examples/workspace-api-www-turbo-cache.test.ts

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

package/examples/workspace-api-www-turbo-cache.ts

@@ -0,0 +1,52 @@
+import type { Config, DeployConfig } from "../src";
+
+const DEPLOY_CONFIG: DeployConfig = {
+  type: "google-cloudrun",
+  projectId: "google-project-id",
+  region: "europe-west6",
+};
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  builds: {
+    myWorkspace: {
+      type: "node",
+      cache: {
+        paths: [".turbo"],
+      },
+    },
+  },
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        from: "myWorkspace",
+        cache: {
+          paths: [".component-custom-cache"],
+        },
+      },
+      deploy: DEPLOY_CONFIG,
+    },
+    www: {
+      dir: "www",
+      build: {
+        from: "myWorkspace",
+        cache: {
+          paths: [".next/cache"],
+        },
+      },
+      deploy: DEPLOY_CONFIG,
+      vars: {
+        public: {
+          API_URL: "${api:ROOT_URL}/graphql",
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Workspace API and WWW",
+};

package/examples/workspace-api-www.test.ts

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