@catladder/pipeline 1.159.1 → 1.161.0

package/examples/kubernetes-with-cloud-sql-legacy.test.ts

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

package/examples/kubernetes-with-cloud-sql-legacy.ts

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

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

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

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

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

package/examples/kubernetes-with-jobs.test.ts

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

package/examples/kubernetes-with-jobs.ts

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

package/examples/kubernetes-with-mongodb.test.ts

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

package/examples/kubernetes-with-mongodb.ts

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

package/examples/local-dot-env.test.ts

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

package/examples/local-dot-env.ts

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

package/examples/meteor-kubernetes.test.ts

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

package/examples/meteor-kubernetes.ts

@@ -1,5 +1,4 @@
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
 
 const config: Config = {
   customerName: "pan",
@@ -60,6 +59,6 @@ const config: Config = {
 
 export default config;
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export const information = {
+  title: "K8s: Meteor",
+};

package/examples/multiline-var.test.ts

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

package/examples/multiline-var.ts

@@ -1,5 +1,4 @@
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
 
 const config: Config = {
   appName: "test-app",
@@ -59,6 +58,8 @@ doouble quote: "
   },
 };
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export default config;
+
+export const information = {
+  title: "Multiline Environment Variables",
+};

package/examples/native-app.test.ts

@@ -0,0 +1,10 @@
+import { createAllPipelines } 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", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/examples/native-app.ts

@@ -1,6 +1,6 @@
 import type { Config } from "../src";
 import type { CatladderJob } from "../src/types/jobs";
-import { createAllPipelines } from "./__utils__/helpers";
+
 const APP_GEM_CACHE: CatladderJob["cache"] = [
   {
     key: {
@@ -76,6 +76,8 @@ const config: 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,10 @@
+import { createAllPipelines } 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", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

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

@@ -1,5 +1,4 @@
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
 
 const config: Config = {
   appName: "test-app",
@@ -20,6 +19,8 @@ const config: Config = {
   },
 };
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export default config;
+
+export const information = {
+  title: "Node: Build with Custom Image",
+};

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

@@ -0,0 +1,10 @@
+import { createAllPipelines } 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", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

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

@@ -1,5 +1,4 @@
 import type { Config } from "../src";
-import { createAllPipelines } from "./__utils__/helpers";
 
 const config: Config = {
   appName: "test-app",
@@ -23,6 +22,8 @@ const config: Config = {
   },
 };
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export default config;
+
+export const information = {
+  title: "Node: Build with Docker Additions",
+};

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

@@ -0,0 +1,9 @@
+import { rmSync, writeFileSync } from "fs";
+import { createAllPipelines } from "./__utils__/helpers";
+import config from "./rails-k8s-with-worker";
+
+it("matches snapshot with a Dockerfile", async () => {
+  writeFileSync("Dockerfile", "");
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+  rmSync("Dockerfile");
+});

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

@@ -0,0 +1,10 @@
+import { createAllPipelines } 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", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

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

@@ -1,6 +1,4 @@
-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";
@@ -90,12 +88,8 @@ const config: 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/wait-for-other-deploy.test.ts

@@ -0,0 +1,10 @@
+import { createAllPipelines } 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", async () => {
+  expect(await createAllPipelines(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",
@@ -31,6 +30,8 @@ const config: Config<{ CustomEnvs: "asdf" | "bla" }> = {
   },
 };
 
-it("matches snapshot", async () => {
-  expect(await createAllPipelines(config)).toMatchSnapshot();
-});
+export default config;
+
+export const information = {
+  title: "Wait for other deployment",
+};

package/package.json

@@ -52,7 +52,7 @@
     }
   ],
   "license": "MIT",
-  "version": "1.159.1",
+  "version": "1.161.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",
@@ -62,7 +62,8 @@
     "build:watch": "yarn tsc -w",
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",
-    "generate:gitlab-ci-yml-types": "tsx ./scripts/generate-gitlab-ci-types.ts"
+    "generate:gitlab-ci-yml-types": "ts-node ./scripts/generate-gitlab-ci-types.ts",
+    "generate:examples-test": "tsx scripts/generate-examples-test.ts"
   },
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
@@ -82,11 +83,13 @@
     "@types/node": "^20.14.2",
     "babel-plugin-transform-inline-environment-variables": "^0.4.3",
     "child-process-promise": "^2.2.1",
+    "glob": "^10.4.2",
     "json-schema-to-typescript": "^13.0.2",
     "lodash": "^4.17.21",
     "memoizee": "^0.4.15",
     "path-equal": "1.1.3",
     "slugify": "^1.6.3",
+    "tsx": "^4.16.2",
     "typescript": "^5.4.5",
     "yaml": "^2.4.5"
   },

package/scripts/generate-examples-test.ts

@@ -0,0 +1,91 @@
+import { glob } from "glob";
+import { resolve, join, basename } from "path";
+import { existsSync } from "fs";
+import { readFile, writeFile, rm } from "fs/promises";
+import { format } from "prettier";
+
+const pipelineWorkspaceRoot = resolve(__dirname, "..");
+const examplesPath = join(pipelineWorkspaceRoot, "examples");
+const exampleIgnoresPath = join(examplesPath, ".test-gen-ignore");
+
+const defaultExampleIgnores = ["*.test.ts"];
+
+async function getExampleIgnores(): Promise<string[]> {
+  if (!existsSync(exampleIgnoresPath)) {
+    await writeFile(exampleIgnoresPath, defaultExampleIgnores.join("\n"));
+  }
+  try {
+    const ignoresFile = await readFile(exampleIgnoresPath, {
+      encoding: "utf-8",
+    });
+    return [
+      ...new Set([
+        ...defaultExampleIgnores,
+        ...ignoresFile
+          .split("\n")
+          .filter((line) => !line.match(/^\s*# [\s\w]*/))
+          .map((line) => line.trim())
+          .filter(Boolean),
+      ]),
+    ];
+  } catch (error) {
+    console.error(
+      `Error reading example ignores file: ${exampleIgnoresPath}`,
+      error,
+    );
+    return defaultExampleIgnores;
+  }
+}
+
+type ExampleTestLines = {
+  importLine: string;
+  testString: string;
+  kebabName: string;
+  camelName: string;
+};
+
+async function main() {
+  const exampleIgnores = await getExampleIgnores();
+  const [exampleFiles, existingTestFiles] = await Promise.all([
+    glob("*.ts", {
+      ignore: exampleIgnores,
+      cwd: examplesPath,
+    }),
+    glob("*.test.ts", {
+      ignore: ["rails-k8s-with-worker-dockerfile.test.ts"],
+      cwd: examplesPath,
+    }),
+  ]);
+  await Promise.all(
+    existingTestFiles.map((testFile) => rm(join(examplesPath, testFile))),
+  );
+  await Promise.all(
+    exampleFiles.map(async (exampleFile) => {
+      const kebabName = basename(exampleFile, ".ts");
+      const testFileContent = [
+        `import { createAllPipelines } from "./__utils__/helpers";`,
+        `import config from "./${kebabName}";`,
+        ``,
+        `/**`,
+        ` * This test is auto-generated.`,
+        ` * Modifications will be overwritten on every \`yarn test\` run!`,
+        ` */`,
+        `it("matches snapshot for ${kebabName}", async () => {`,
+        `  expect(await createAllPipelines(config)).toMatchSnapshot();`,
+        `});`,
+      ].join("\n");
+      const formattedTest = await format(testFileContent, {
+        parser: "typescript",
+      });
+      await writeFile(
+        join(examplesPath, `${kebabName}.test.ts`),
+        formattedTest,
+        {
+          encoding: "utf-8",
+        },
+      );
+    }),
+  );
+}
+
+main().catch(console.error);

package/scripts/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "target": "ES2020"
+  },
+  "include": ["**/*.ts"]
+}