@catladder/pipeline 0.0.0-node16-ddfae617 → 0.0.0-prettier-cbceeed9

package/examples/__utils__/helpers.ts

@@ -0,0 +1,14 @@
+import type { Config } from "../../src";
+import { createChildPipeline } from "../../src";
+
+const ALL_TRIGGERS = ["mainBranch", "taggedRelease", "mr"] as const;
+
+export const createAllPipelines = async (config: Config) =>
+  Object.fromEntries(
+    await Promise.all(
+      ALL_TRIGGERS.map(async (trigger) => [
+        trigger,
+        await createChildPipeline("gitlab", trigger, config),
+      ])
+    )
+  );

package/examples/cloud-run-memory-limit.ts

@@ -0,0 +1,28 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+const config: 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: {
+          // defaults to 512Mi
+          memory: "1024Mi",
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/examples/cloud-run-no-cpu-throttling.ts

@@ -0,0 +1,33 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+const config: 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: {
+          minInstances: 1,
+          // careful, this is expensive!
+          // this will always allocate the cpu
+          // use this if you have background tasks.
+
+          // consider using cloud task instead of this
+          noCpuThrottling: true,
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/examples/cloud-run-non-public.ts

@@ -0,0 +1,27 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+        service: {
+          allowUnauthenticated: false,
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

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

@@ -0,0 +1,54 @@
+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 = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        cloudSql: CLOUD_SQL,
+      },
+    },
+    worker: {
+      dir: "api",
+      build: {
+        type: "node",
+        buildCommand: "yarn build:worker",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        cloudSql: {
+          ...CLOUD_SQL,
+          // override the db base name to the other component's name
+          // if ommited, this defaults to the component's name
+          dbBaseName: "api",
+        },
+      },
+      vars: {
+        public: {
+          // need to reference the password
+          DB_PASSWORD: "${api:DB_PASSWORD}",
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

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

@@ -0,0 +1,61 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+const config: 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: "postDeploy",
+            command: "yarn migrate",
+          },
+          ["send-reminders"]: {
+            when: "schedule",
+            command: "yarn job:send-reminders",
+            schedule: "0 * * * *",
+          },
+        },
+      },
+    },
+    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",
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/examples/custom-build-job.ts

@@ -0,0 +1,28 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "custom",
+        jobImage: "foo",
+        docker: {
+          type: "nginx",
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/examples/custom-envs.ts

@@ -0,0 +1,31 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+
+const config: Config<{ CustomEnvs: "asdf" | "bla" }> = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: false,
+      env: {
+        local: {
+          port: 4000,
+        },
+        asdf: {
+          type: "dev",
+        },
+        bla: {
+          type: "dev",
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/examples/kubernetes-application-customization.ts

@@ -0,0 +1,57 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "kubernetes",
+        cluster: {
+          name: "some-cluster-name",
+          region: "europe-west6",
+          projectId: "some-project-id",
+          type: "gcloud",
+          domainCanonical: "panter.cloud",
+        },
+
+        values: {
+          application: {
+            command: "node main.js",
+            autoscale: {
+              minReplicas: 2,
+              maxReplicas: 5,
+              metrics: [
+                {
+                  type: "Resource",
+                  resource: {
+                    name: "cpu",
+
+                    target: {
+                      type: "Utilization",
+                      averageUtilization: 0.5,
+                    },
+                  },
+                },
+              ],
+            },
+            resources: {
+              limits: {
+                cpu: "1",
+                memory: "2048Mi",
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/examples/kubernetes-with-jobs.ts

@@ -0,0 +1,68 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "kubernetes",
+        cluster: {
+          name: "some-cluster-name",
+          region: "europe-west6",
+          projectId: "some-project-id",
+          type: "gcloud",
+          domainCanonical: "panter.cloud",
+        },
+        values: {
+          jobs: {
+            migration: {
+              command: "yarn migrate",
+            },
+          },
+          cronjobs: {
+            ["send-emails"]: {
+              command: "yarn send emails",
+              schedule: "0 * * * *",
+            },
+          },
+        },
+      },
+      env: {
+        review: {
+          deploy: {
+            values: {
+              cronjobs: {
+                ["send-emails"]: false,
+              },
+            },
+          },
+        },
+      },
+    },
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "kubernetes",
+        cluster: {
+          name: "some-cluster-name",
+          region: "europe-west6",
+          projectId: "some-project-id",
+          type: "gcloud",
+          domainCanonical: "panter.cloud",
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

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

@@ -0,0 +1,95 @@
+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 = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    app: {
+      dir: ".",
+      vars: {
+        public: {
+          RAILS_ENV: "production",
+        },
+        secret: [
+          "SECRET_KEY_BASE",
+        ]
+      },
+      build: {
+        type: "rails",
+        test: {
+          // if operating system dependencies are required you can either
+          // - build a dedicated image
+          // - use `command` to apt-get install them before running the test command
+          jobImage: RAILS_TEST_STAGE_IMAGE,
+        },
+        lint: {
+          jobImage: RAILS_TEST_STAGE_IMAGE,
+        },
+        audit: {
+          jobImage: RAILS_TEST_STAGE_IMAGE,
+        },
+        cnbBuilder: {
+          buildVars: { SECRET_KEY_BASE: "dummy-value" },
+        },
+      },
+      deploy: {
+        type: "kubernetes",
+        cluster: {
+          name: "some-cluster-name",
+          region: "europe-west6",
+          projectId: "some-project-id",
+          type: "gcloud",
+          domainCanonical: "panter.cloud",
+        },
+        values: {
+          cloudsql: { enabled: true, projectId: "some-project-id" },
+          application: {
+            // if deployed to Google Cloud Run use a gem like cloudtasker instead of a permanently running expensive worker
+            worker: {
+              enabled: true,
+              command: "launcher bundle exec rake jobs:work",
+            },
+          },
+          jobs: {
+            "db-migrate": {
+              hook: "post-install,post-upgrade",
+              command:
+                "launcher bundle exec rake db:migrate",
+            },
+          },
+        },
+      },
+      env: {
+        review: {
+          deploy: {
+            values: {
+              jobs: {
+                "db-prepare-seed": {
+                  hook: "post-install",
+                  command:
+                    "launcher bundle exec rake db:prepare db:seed",
+                },
+                "db-migrate": {
+                  hook: "post-upgrade",
+                  command:
+                    "launcher bundle exec rake db:migrate",
+                },
+              },
+            },
+          },
+        },
+        prod: {
+          host: "my-fancy-website.com"
+        }
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

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

@@ -0,0 +1,36 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+
+const config: Config<{ CustomEnvs: "asdf" | "bla" }> = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "custom",
+        requiresDocker: false,
+        script: ["yarn deploy"],
+      },
+    },
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        waitFor: ["api"],
+        type: "custom",
+        requiresDocker: false,
+        script: ["yarn deploy"],
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "@catladder/pipeline",
-  "version": "0.0.0-node16-ddfae617",
+  "version": "0.0.0-prettier-cbceeed9",
   "scripts": {
     "build:tsc": "yarn tsc",
-    "build": "yarn tsc && yarn build:inline-variables",
-    "build:watch": "yarn tsc -w",
+    "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",
+    "build:bundle": "./scripts/bundle",
+    "build:compile": "yarn tsc",
     "build:inline-variables": "yarn babel --keep-file-extension --extensions \".ts,.js\" --config-file ./babel-inline.json dist --out-dir dist",
-    "test": "jest",
+    "build:watch": "yarn tsc -w",
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix"
   },
-  "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "sideEffects": false,
   "bin": {
     "catladder-gitlab": "./bin/catladder-gitlab.js"
   },
@@ -20,22 +22,23 @@
     "@babel/core": "^7.0.0-0",
     "@babel/plugin-syntax-typescript": "^7.16.7",
     "@babel/preset-typescript": "^7.16.5",
+    "@jest/globals": "^29.3.1",
     "@types/child-process-promise": "^2.2.2",
     "@types/jest": "^27.4.0",
-    "@types/lodash": "^4.14.172",
-    "babel-plugin-transform-inline-environment-variables": "^0.4.3",
-    "eslint": "^8.7.0"
-  },
-  "dependencies": {
+    "@types/lodash": "^4.14.185",
     "@types/node": "^17.0.10",
+    "babel-plugin-transform-inline-environment-variables": "^0.4.3",
     "child-process-promise": "^2.2.1",
+    "eslint": "^8.7.0",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "memoizee": "^0.4.15",
-    "path-equal": "^1.1.3",
-    "slugify": "^1.6.3",
+    "path-equal": "1.1.3",
+    "slugify": "^1.6.3"
+  },
+  "dependencies": {
+    "string-replace-async": "^2.0.0",
     "ts-node": "^10.4.0",
-    "type-fest": "^2.10.0",
     "typescript": "^4.5.4"
   },
   "stableVersion": "0.1.0"

package/scripts/bundle

@@ -0,0 +1,2 @@
+#!/bin/bash
+ncc build dist/catladder-gitlab.js -o dist/bundles/catladder-gitlab -e 'ts-node' $( ((SHOULD_MINIFY == 1)) && printf %s '-m')

package/src/build/base/createBuildJob.ts

@@ -1,13 +1,15 @@
 import { merge } from "lodash";
-import { Context, getRunnerImage } from "../..";
-import { CatladderJob } from "../../types/jobs";
+import { join } from "path";
+import type { Context } from "../..";
+import { getRunnerImage } from "../..";
+import type { CatladderJob } from "../../types/jobs";
 import { ensureArray } from "../../utils";
 import { ensureNodeVersion } from "../node/yarn";
 import {
   APP_BUILD_JOB_NAME,
   RUNNER_BUILD_RESOURCE_VARIABLES,
 } from "./constants";
-import { getBuildInfo } from "./getBuildInfo";
+import { writeBuildInfo } from "./writeBuildInfo";
 
 export const createBuildJob = (
   context: Context,
@@ -29,13 +31,18 @@ export const createBuildJob = (
       },
 
       script: [
-        ...getBuildInfo(context),
+        ...writeBuildInfo(context),
         ...ensureNodeVersion(context), // in pure node repos, we might want to have the nvmrc file in top-level
         `cd ${context.componentConfig.dir}`,
         ...(ensureArray(script) ?? []),
       ],
       artifacts: {
-        paths: [context.componentConfig.dir + "/__build_info.json"],
+        paths: [join(context.componentConfig.dir, "__build_info.json")],
+        reports: {
+          junit: context.componentConfig.build.artifactsReports?.junit?.map(
+            (p) => join(context.componentConfig.dir, p)
+          ),
+        },
       },
     },
     def

package/src/build/base/{getBuildInfo.ts → writeBuildInfo.ts}

@@ -1,6 +1,6 @@
-import { Context } from "../../types";
+import type { Context } from "../../types";
 
-export const getBuildInfo = (context: Context) => {
+export const writeBuildInfo = (context: Context) => {
   return [
     `echo '{"id":"${context.commitInfo?.buildId}","time":"${context.commitInfo?.buildTime}"}' > ${context.componentConfig.dir}/__build_info.json`,
   ];