@catladder/pipeline 1.82.2 → 1.83.1

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/rails-k8s-with-worker.ts

@@ -0,0 +1,94 @@
+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: {
+          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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catladder/pipeline",
-  "version": "1.82.2",
+  "version": "1.83.1",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/build/index.ts

@@ -51,6 +51,12 @@ export const BUILD_TYPES: BuildTypes = {
   },
   rails: {
     jobs: createRailsJobs,
-    defaults: () => ({}),
+    defaults: () => ({
+      startCommand: "/cnb/process/web",
+      cnbBuilder: {
+        image: "heroku/buildpacks:20",
+        packVersion: "0.28.0",
+      }
+    }),
   },
 };

package/src/build/rails/build.ts

@@ -1,27 +1,34 @@
 import type { Context } from "../..";
+import { isOfBuildType } from "../types";
 import type { CatladderJob } from "../../types/jobs";
 import { createDockerBuildJobBase, gitlabDockerLogin } from "../docker";
 
 export const createRailsBuildJobs = (context: Context): CatladderJob[] => {
+  const buildConfig = context.componentConfig.build
+  if (!isOfBuildType(buildConfig, "rails")) {
+    // should not happen
+    throw new Error("build type is not rails");
+  }
+
+  const cnbConf = buildConfig.cnbBuilder;
+
+  // backwards compatabilty with CNB_ENV_VARS
+  // TODO: remove when all projects are migrated
+  const packEnvArgs = buildConfig.extraVars?.CNB_ENV_VARS?.split(" ").map(v => `--env '${v}'`)
+    ?? Object.entries(cnbConf?.buildVars ?? {}).map(([k, v]) => `--env '${k}${v ? `=${v}` : ""}'`)
+
   return [
     createDockerBuildJobBase(context, {
-      variables: {
-        CNB_BUILDER: "heroku/buildpacks:18",
-        CNB_ENV_VARS: "BUNDLE_GIT__PANTER__CH",
-        CNB_EXTRA_ARGS: "",
-        CNB_PACK_VERSION: "0.20.0",
-        ...context.componentConfig.build.extraVars,
-      },
+      variables: context.componentConfig.build.extraVars,
       // custom script
       script: [
         gitlabDockerLogin,
         `docker pull $DOCKER_CACHE_IMAGE || true`,
-        `wget --output-document=- https://github.com/buildpacks/pack/releases/download/v$CNB_PACK_VERSION/pack-v$CNB_PACK_VERSION-linux.tgz | tar -zx --directory /usr/local/bin pack`,
+        `wget --output-document=- https://github.com/buildpacks/pack/releases/download/v${cnbConf?.packVersion}/pack-v${cnbConf?.packVersion}-linux.tgz | tar -zx --directory /usr/local/bin pack`,
         `chmod +x /usr/local/bin/pack`,
         //  replace private git ssh gem sources with https to make bundler with credentials via env var work
         `sed --in-place 's|git@\\([^:]*\\):|https://\\1/|g' Gemfile Gemfile.lock`,
-        `for v in $CNB_ENV_VARS; do env_args="$env_args --env $v"; done`,
-        `pack build $DOCKER_IMAGE:$DOCKER_IMAGE_TAG --builder $CNB_BUILDER --publish --cache-image $DOCKER_CACHE_IMAGE $env_args $CNB_EXTRA_ARGS`,
+        `pack build "$DOCKER_IMAGE:$DOCKER_IMAGE_TAG" --builder '${cnbConf?.image}' --publish --cache-image "$DOCKER_CACHE_IMAGE" ${packEnvArgs.join(" ")} ${cnbConf?.packExtraArgs?.join(" ") ?? ""}`
       ],
     }),
   ];

package/src/build/rails/index.ts

@@ -1,5 +1,5 @@
-import { Context } from "../../types";
-import { CatladderJob } from "../../types/jobs";
+import type { Context } from "../../types";
+import type { CatladderJob } from "../../types/jobs";
 import { createRailsBuildJobs } from "./build";
 import { createRailsTestJobs } from "./test";
 

package/src/build/types.ts

@@ -118,6 +118,33 @@ export type BuildConfigCustom = BuildConfigBase & {
 
 export type BuildConfigRails = BuildConfigBase & {
   type: "rails";
+  cnbBuilder?: {
+    /**
+     * The Cloud Native Buildpacks builder image to use.
+     * See e.g. https://github.com/heroku/builder or others.
+     * Default: heroku/buildpacks:20
+     */
+    image?: string;
+    /**
+     * The version of the Cloud Native Buildpacks pack command to use.
+     * See https://buildpacks.io/docs/tools/pack/
+     * Default: 0.28.0
+     */
+    packVersion?: string;
+    /**
+     * Additional command arguments passed to the pack command.
+     * See https://buildpacks.io/docs/tools/pack/
+     */
+    packExtraArgs?: string[];
+    /**
+     * Variables needed for Bundler and Rails asset precompilation.
+     * 
+     * Specify a key with the value `undefined` to inherit it from the EnvVars.
+     * 
+     * See https://github.com/rails/rails/issues/32947
+     */
+    buildVars?: Record<string, string | undefined>
+  }
 };
 
 export type BuildConfigStorybook = BuildConfigNodeBase & {

package/src/context/getEnvironment.ts

@@ -31,6 +31,7 @@ export const getEnvironment = async (
       url,
     },
     fullName: envContext.fullName,
+    slugPrefix: envContext.environmentSlugPrefix,
     slug: envContext.environmentSlug,
     shortName: env,
     envVars,

package/src/context/getEnvironmentContext.ts

@@ -5,17 +5,16 @@ import type { EnvironmentContext } from "../types/environmentContext";
 import { getEnvConfig } from "./getEnvConfig";
 import { getEnvType } from "./getEnvType";
 
-const getEnvironmentSlug = (
+const getEnvironmentSlugPrefix = (
   envConfig: EnvConfigWithComponent,
   env: string,
-  componentName: string,
   commitInfo?: CommitInfo
 ) => {
   const envType = getEnvType(env, envConfig);
 
   return envType === "review" && commitInfo
-    ? `${env}-${commitInfo.reviewSlug}-${componentName}`
-    : `${env}-${componentName}`;
+    ? `${env}-${commitInfo.reviewSlug}`
+    : `${env}`;
 };
 
 export const getEnvironmentContext = (
@@ -27,13 +26,13 @@ export const getEnvironmentContext = (
   const envConfigRaw = getEnvConfig(config, componentName, env);
   const envType = getEnvType(env, envConfigRaw);
 
-  const environmentSlug = getEnvironmentSlug(
+  const environmentSlugPrefix = getEnvironmentSlugPrefix(
     envConfigRaw,
     env,
-    componentName,
     commitInfo
   );
 
+  const environmentSlug = `${environmentSlugPrefix}-${componentName}`;
   const gitlabEnvironmentName =
     envType === "review" && commitInfo
       ? `${env}/${commitInfo.refName}/${componentName}`
@@ -45,6 +44,7 @@ export const getEnvironmentContext = (
     envConfigRaw,
     deployConfigRaw: envConfigRaw.deploy,
     buildConfigRaw: envConfigRaw.build,
+    environmentSlugPrefix,
     environmentSlug,
     gitlabEnvironmentName,
     fullName,

package/src/deploy/cloudRun/index.ts

@@ -12,7 +12,7 @@ export const GCLOUD_RUN_CANONICAL_HOST_SUFFIX =
 
 const getCloudSqlVariables = ({
   deployConfigRaw,
-  environmentSlug,
+  environmentSlugPrefix,
   env,
   componentName,
   fullConfig,
@@ -21,7 +21,8 @@ const getCloudSqlVariables = ({
     const DB_NAME = [
       deployConfigRaw.cloudSql.dbNamePrefix ??
         `${fullConfig.customerName}-${fullConfig.appName}`,
-      environmentSlug,
+      environmentSlugPrefix,
+      deployConfigRaw.cloudSql.dbBaseName ?? componentName,
     ]
       .filter(Boolean)
       .join("-");

package/src/deploy/types/googleCloudRun.ts

@@ -46,11 +46,16 @@ export type DeployConfigCloudRunCloudSql = {
   dbUser?: string;
 
   /**
-   * the prefix of the database, the full db name is this plus the environment slug
+   * the prefix of the database, the full db name is this plus the environment slug prefix plus the componentName
    *
    * defaults to customerName-appName
    */
   dbNamePrefix?: string | false;
+
+  /**
+   * the base name of the db, defaults to the componentName
+   */
+  dbBaseName?: string;
   /**
    * whether to delete the database if the environment is stopped
    * defaults to true for review envs, to false for every other environment

package/src/types/context.ts

@@ -18,6 +18,7 @@ export type Environment = {
     url: string;
   };
   shortName: string;
+  slugPrefix: string;
   slug: string;
   /**
    * env vars contain all build-time env vars. secrets have to be resolved (they are stored in gitlab)

package/src/types/environmentContext.ts

@@ -16,6 +16,13 @@ export type EnvironmentContext<
   envType: EnvType;
   componentName: string;
   fullName: string;
+  /**
+   * the environment slug without component name.
+   */
+  environmentSlugPrefix: string;
+  /**
+   * the full environment slug, including the componentName
+   */
   environmentSlug: string;
   gitlabEnvironmentName: string;