@catladder/pipeline 1.146.1 → 1.147.0

package/examples/cloud-run-storybook.ts

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

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

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

package/package.json

@@ -52,7 +52,7 @@
     }
   ],
   "license": "MIT",
-  "version": "1.146.1",
+  "version": "1.147.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/build/base/createAppBuildJob.ts

@@ -1,6 +1,6 @@
 import { merge } from "lodash";
 import { join } from "path";
-import type { Context } from "../..";
+import type { ComponentContext } from "../..";
 import { getRunnerImage } from "../..";
 import type { CatladderJob } from "../../types/jobs";
 import { ensureArray } from "../../utils";
@@ -14,7 +14,7 @@ import { writeDotEnv } from "./writeDotEnv";
 
 export type AppBuildJobDefinition = Partial<CatladderJob>;
 export const createAppBuildJob = (
-  context: Context,
+  context: ComponentContext,
   { script, variables, runnerVariables, ...def }: AppBuildJobDefinition,
 ): CatladderJob => {
   return merge(
@@ -29,12 +29,12 @@ export const createAppBuildJob = (
         ...(variables ?? {}),
         ...context.environment.envVars,
         ...context.environment.jobOnlyVars.build.envVars,
-        ...(context.componentConfig.build.extraVars ?? {}),
+        ...(context.build.config.extraVars ?? {}),
       },
       runnerVariables: {
         ...RUNNER_BUILD_RESOURCE_VARIABLES,
         ...(runnerVariables ?? {}),
-        ...(context.componentConfig.build.runnerVariables ?? {}),
+        ...(context.build.config.runnerVariables ?? {}),
       },
 
       script: [
@@ -42,15 +42,15 @@ export const createAppBuildJob = (
           ? writeDotEnv(context)
           : []),
         ...writeBuildInfo(context),
-        ...ensureNodeVersion(context), // in pure node repos, we might want to have the nvmrc file in top-level
-        `cd ${context.componentConfig.dir}`,
+        ...ensureNodeVersion(context.build), // in pure node repos, we might want to have the nvmrc file in top-level
+        `cd ${context.build.dir}`,
         ...(ensureArray(script) ?? []),
       ],
       artifacts: {
-        paths: [join(context.componentConfig.dir, "__build_info.json")],
+        paths: [join(context.build.dir, "__build_info.json")],
         reports: {
-          junit: context.componentConfig.build.artifactsReports?.junit?.map(
-            (p) => join(context.componentConfig.dir, p),
+          junit: context.build.config.artifactsReports?.junit?.map((p) =>
+            join(context.build.dir, p),
           ),
         },
       },

package/src/build/base/index.ts

@@ -1,5 +1,5 @@
 import { sbomDeactivated } from "../../deploy/sbom";
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import type { DockerBuildJobDefinition } from "../docker";
 import { createDockerBuildJobBase, requiresDockerBuild } from "../docker";
@@ -9,7 +9,7 @@ import type { AppBuildJobDefinition } from "./createAppBuildJob";
 import { createAppBuildJob } from "./createAppBuildJob";
 
 export const createBuildJobs = (
-  context: Context,
+  context: ComponentContext,
   definitions: {
     appBuild?: AppBuildJobDefinition;
     dockerBuild: DockerBuildJobDefinition;

package/src/build/base/writeBuildInfo.ts

@@ -1,7 +1,7 @@
-import type { Context } from "../../types";
+import type { ComponentContext } from "../../types";
 
-export const writeBuildInfo = (context: Context) => {
+export const writeBuildInfo = (context: ComponentContext) => {
   return [
-    `echo '{"id":"${context.environment.envVars.BUILD_INFO_BUILD_ID}","time":"${context.environment.envVars.BUILD_INFO_BUILD_TIME}"}' > ${context.componentConfig.dir}/__build_info.json`,
+    `echo '{"id":"${context.environment.envVars.BUILD_INFO_BUILD_ID}","time":"${context.environment.envVars.BUILD_INFO_BUILD_TIME}"}' > ${context.build.dir}/__build_info.json`,
   ];
 };

package/src/build/base/writeDotEnv.ts

@@ -1,12 +1,12 @@
 import { isNil } from "lodash";
-import type { Context } from "../../types";
+import type { ComponentContext } from "../../types";
 
 /**
  * writes a .env file in the components folder
  * @param context
  * @returns
  */
-export const writeDotEnv = (context: Context) => {
+export const writeDotEnv = (context: ComponentContext) => {
   const envVars = context.environment.envVars;
 
   // make key=value and sanitize multiline
@@ -19,7 +19,7 @@ export const writeDotEnv = (context: Context) => {
     .join("\n");
 
   return [
-    `cat <<EOF > ${context.componentConfig.dir}/.env
+    `cat <<EOF > ${context.build.dir}/.env
 ${keyValueString}
 EOF`,
   ];

package/src/build/custom/__tests__/testJob.test.ts

@@ -1,28 +1,25 @@
-import type { Context } from "../../..";
+import type { ComponentContext } from "../../..";
 import { createCustomTestJobs } from "../testJob";
 
 describe("createCustomTestJobs", () => {
-  const componentConfig: Context["componentConfig"] = {
-    dir: ".",
-    build: { type: "custom", docker: { type: "custom" }, jobImage: "" },
-    deploy: {},
-  } as Context["componentConfig"];
-  const baseContext: Context = {
+  const baseContext: ComponentContext = {
     componentName: "testComponent",
     environment: {
       jobOnlyVars: {
         build: {},
       },
     },
-    componentConfig,
-  } as Context;
+    build: {
+      config: { type: "custom", docker: { type: "custom" }, jobImage: "" },
+    },
+  } as ComponentContext;
 
   it("throws error when not build type custom", () => {
-    componentConfig.build.type = "node";
+    baseContext.build.config.type = "node";
     expect(() => createCustomTestJobs(baseContext)).toThrowError(
       "deploy config is not custom",
     );
-    componentConfig.build.type = "custom";
+    baseContext.build.config.type = "custom";
   });
 
   it("returns empty array if no audit, lint, and test definition", () => {

package/src/build/custom/buildJob.ts

@@ -1,7 +1,7 @@
 import { join } from "path";
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import { ensureArray } from "../../utils";
-import { getDockerBuildDefaultScript } from "../docker";
+import { getDockerBuildScriptWithBuiltInDockerFile } from "../docker";
 import { isOfBuildType } from "../types";
 
 import type { CatladderJob } from "../../types/jobs";
@@ -13,8 +13,10 @@ const RUNNER_BUILD_VARIABLES = {
   KUBERNETES_MEMORY_LIMIT: "4Gi",
 };
 
-export const createCustomBuildJobs = (context: Context): CatladderJob[] => {
-  const buildConfig = context.componentConfig.build;
+export const createCustomBuildJobs = (
+  context: ComponentContext,
+): CatladderJob[] => {
+  const buildConfig = context.build.config;
 
   if (!isOfBuildType(buildConfig, "custom")) {
     throw new Error("deploy config is not custom");
@@ -31,10 +33,10 @@ export const createCustomBuildJobs = (context: Context): CatladderJob[] => {
             script: [...(ensureArray(buildConfig.buildCommand) ?? [])],
             artifacts: {
               paths: [
-                join(context.componentConfig.dir, "__build_info.json"),
-                join(context.componentConfig.dir, "dist"),
+                join(context.build.dir, "__build_info.json"),
+                join(context.build.dir, "dist"),
                 ...(buildConfig.artifactsPaths?.map((path) =>
-                  join(context.componentConfig.dir, path),
+                  join(context.build.dir, path),
                 ) ?? []),
               ],
               expire_in: "1 day",
@@ -42,10 +44,7 @@ export const createCustomBuildJobs = (context: Context): CatladderJob[] => {
           }
         : undefined,
     dockerBuild: {
-      script: getDockerBuildDefaultScript(
-        context,
-        buildConfig.docker?.type === "nginx" ? "ensureNginxDockerfile" : "",
-      ),
+      script: getDockerBuildScriptWithBuiltInDockerFile(context),
 
       variables: {},
     },

package/src/build/custom/index.ts

@@ -1,8 +1,8 @@
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { createCustomBuildJobs } from "./buildJob";
 import { createCustomTestJobs } from "./testJob";
 
-export const createCustomJobs = (context: Context): CatladderJob[] => {
+export const createCustomJobs = (context: ComponentContext): CatladderJob[] => {
   return [...createCustomTestJobs(context), ...createCustomBuildJobs(context)];
 };

package/src/build/custom/testJob.ts

@@ -1,4 +1,4 @@
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { ensureArray, notNil } from "../../utils";
 import { isOfBuildType } from "../types";
@@ -11,14 +11,16 @@ const RUNNER_CUSTOM_TEST_VARIABLES = {
   KUBERNETES_MEMORY_LIMIT: "4Gi",
 };
 
-export const createCustomTestJobs = (context: Context): CatladderJob[] => {
+export const createCustomTestJobs = (
+  context: ComponentContext,
+): CatladderJob[] => {
   // don't run tests after release
   // TODO: this will be replaced by using rules
   if (context.trigger === "taggedRelease") {
     return [];
   }
 
-  const buildConfig = context.componentConfig.build;
+  const buildConfig = context.build.config;
 
   if (!isOfBuildType(buildConfig, "custom")) {
     throw new Error("deploy config is not custom");
@@ -26,7 +28,7 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
 
   const base: Omit<CatladderJob, "script" | "name"> = {
     variables: {
-      APP_PATH: context.componentConfig.dir,
+      APP_PATH: context.build.dir,
       ...context.environment.jobOnlyVars.build.envVars,
       ...(buildConfig.extraVars ?? {}),
     },
@@ -46,7 +48,7 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
         script: [...(ensureArray(buildConfig.audit?.command) ?? [])],
         allow_failure: true,
         ...createArtifactsConfig(
-          context.componentConfig.dir,
+          context.build.dir,
           buildConfig.audit?.artifactsReports,
           buildConfig.audit?.artifacts,
         ),
@@ -61,7 +63,7 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
         image: buildConfig.lint?.jobImage ?? buildConfig.jobImage,
         script: [...(ensureArray(buildConfig.lint?.command) ?? [])],
         ...createArtifactsConfig(
-          context.componentConfig.dir,
+          context.build.dir,
           buildConfig.lint?.artifactsReports,
           buildConfig.lint?.artifacts,
         ),
@@ -75,7 +77,7 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
         image: buildConfig.test?.jobImage ?? buildConfig.jobImage,
         script: [...(ensureArray(buildConfig.test?.command) ?? [])],
         ...createArtifactsConfig(
-          context.componentConfig.dir,
+          context.build.dir,
           buildConfig.test?.artifactsReports,
           buildConfig.test?.artifacts,
         ),

package/src/build/docker.ts

@@ -1,17 +1,18 @@
-import { merge } from "lodash";
-import { isOfDeployType } from "../deploy";
-import { getRunnerImage } from "../runner";
-import type { Context } from "../types";
-import type { CatladderJob } from "../types/jobs";
 import { existsSync } from "fs";
+import { merge } from "lodash";
 import path from "path";
-import { collapseableSection } from "../utils/gitlab";
+import type { BuildConfig, BuildConfigDocker } from ".";
+import { isOfDeployType } from "../deploy";
 import {
   getArtifactsRegistryBuildCacheImage,
   getArtifactsRegistryHost,
   getArtifactsRegistryImageName,
 } from "../deploy/cloudRun/artifactsRegistry";
 import { gcloudServiceAccountLoginCommands } from "../deploy/cloudRun/utils/gcloudServiceAccountLoginCommands";
+import { getRunnerImage } from "../runner";
+import type { ComponentContext } from "../types";
+import type { CatladderJob } from "../types/jobs";
+import { collapseableSection } from "../utils/gitlab";
 
 const DOCKER_BUILD_RUNNER_REQUESTS = {
   KUBERNETES_CPU_REQUEST: "0.5",
@@ -19,9 +20,10 @@ const DOCKER_BUILD_RUNNER_REQUESTS = {
   KUBERNETES_MEMORY_LIMIT: "2Gi",
 };
 
-export const getDockerImageVariables = (context: Context) => {
+export const getDockerImageVariables = (context: ComponentContext) => {
+  const deployConfig = context.deploy?.config;
   return {
-    ...(isOfDeployType(context.componentConfig.deploy, "google-cloudrun")
+    ...(isOfDeployType(deployConfig, "google-cloudrun")
       ? {
           DOCKER_REGISTRY: getArtifactsRegistryHost(context),
           DOCKER_IMAGE: getArtifactsRegistryImageName(context),
@@ -46,11 +48,19 @@ export const getDockerImageVariables = (context: Context) => {
 /**
  * Weather the context requires a docker build
  */
-export const requiresDockerBuild = ({
-  componentConfig: { deploy },
-}: Context): boolean =>
-  isOfDeployType(deploy, "kubernetes", "google-cloudrun", "dockerTag") ||
-  (isOfDeployType(deploy, "custom") && deploy.requiresDocker);
+export const requiresDockerBuild = (context: ComponentContext): boolean => {
+  const deployConfig = context.deploy?.config;
+
+  return (
+    isOfDeployType(
+      deployConfig,
+      "kubernetes",
+      "google-cloudrun",
+      "dockerTag",
+    ) ||
+    (isOfDeployType(deployConfig, "custom") && deployConfig.requiresDocker)
+  );
+};
 
 // those need to be runner variables
 const getDockerBuildRunnerVariables = () => ({
@@ -60,13 +70,25 @@ const getDockerBuildRunnerVariables = () => ({
   DOCKER_BUILDKIT: "1", // see https://docs.docker.com/develop/develop-images/build_enhancements/
 });
 
-export const getDockerBuildVariables = (context: Context) => {
+const getDockerAdditions = (build: BuildConfig) => {
+  if (!("docker" in build)) return {};
+  if (!build.docker) return {};
+
   return {
     DOCKERFILE_ADDITIONS:
-      context.componentConfig.build.docker?.additionsBegin?.join("\n"),
+      "additionsBegin" in build.docker
+        ? build.docker.additionsBegin?.join("\n")
+        : undefined,
     DOCKERFILE_ADDITIONS_END:
-      context.componentConfig.build.docker?.additionsEnd?.join("\n"),
-    APP_DIR: context.componentConfig.dir,
+      "additionsEnd" in build.docker
+        ? build.docker.additionsEnd?.join("\n")
+        : undefined,
+  };
+};
+export const getDockerBuildVariables = (context: ComponentContext) => {
+  return {
+    ...getDockerAdditions(context.build.config),
+    APP_DIR: context.build.dir,
     DOCKER_DIR: ".", // relative to componentdir
 
     ...getDockerImageVariables(context),
@@ -75,9 +97,7 @@ export const getDockerBuildVariables = (context: Context) => {
 
 export const DOCKER_BUILD_JOB_NAME = "🔨 docker";
 
-export const getDockerJobBaseProps = (
-  context: Context,
-): Pick<
+export const getDockerJobBaseProps = (): Pick<
   CatladderJob,
   "image" | "services" | "variables" | "runnerVariables"
 > => {
@@ -96,7 +116,7 @@ export const getDockerJobBaseProps = (
 
 export type DockerBuildJobDefinition = Partial<CatladderJob>;
 export const createDockerBuildJobBase = (
-  context: Context,
+  context: ComponentContext,
   { script, ...def }: Partial<CatladderJob>,
 ): CatladderJob => {
   return merge(
@@ -104,7 +124,7 @@ export const createDockerBuildJobBase = (
       name: DOCKER_BUILD_JOB_NAME,
       envMode: "jobPerEnv",
       stage: "build",
-      ...getDockerJobBaseProps(context),
+      ...getDockerJobBaseProps(),
       script: script || [],
     },
     {
@@ -118,8 +138,8 @@ export const createDockerBuildJobBase = (
   );
 };
 
-export const gitlabDockerLogin = (context: Context) =>
-  isOfDeployType(context.componentConfig.deploy, "google-cloudrun")
+export const gitlabDockerLogin = (context: ComponentContext) =>
+  context.deploy && isOfDeployType(context.deploy.config, "google-cloudrun")
     ? [
         ...gcloudServiceAccountLoginCommands(context),
         `gcloud auth configure-docker ${getArtifactsRegistryHost(context)}`,
@@ -128,12 +148,36 @@ export const gitlabDockerLogin = (context: Context) =>
         "docker login --username gitlab-ci-token --password $CI_JOB_TOKEN $CI_REGISTRY",
       ];
 
+const BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS = {
+  meteor: "ensureMeteorDockerfile",
+  node: "ensureNodeDockerfile",
+  nginx: "ensureNginxDockerfile",
+  custom: null,
+} satisfies {
+  [type in BuildConfigDocker["type"]]: string | null;
+};
+
+export const getDockerBuildScriptWithBuiltInDockerFile = (
+  context: ComponentContext,
+  defaultType?: BuildConfigDocker["type"],
+) => {
+  const type =
+    "docker" in context.componentConfig.build &&
+    context.componentConfig.build.docker &&
+    "type" in context.componentConfig.build.docker
+      ? context.componentConfig.build.docker?.type
+      : defaultType;
+  return getDockerBuildDefaultScript(
+    context,
+    type ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[type] : null,
+  );
+};
 export const getDockerBuildDefaultScript = (
-  context: Context,
-  ensureDockerFileScript?: string,
+  context: ComponentContext,
+  ensureDockerFileScript?: string | null,
 ) =>
   [
-    ensureDockerFileScript,
+    ensureDockerFileScript ?? undefined,
     ...collapseableSection(
       "docker-login",
       "Docker Login",
@@ -154,5 +198,5 @@ export const getDockerBuildDefaultScript = (
     ]),
   ].filter(Boolean);
 
-export const hasDockerfile = (context: Context) =>
-  existsSync(path.join(context.componentConfig.dir, "Dockerfile"));
+export const hasDockerfile = (context: ComponentContext) =>
+  existsSync(path.join(context.build.dir, "Dockerfile"));

package/src/build/index.ts

@@ -1,4 +1,4 @@
-import type { Context } from "../types/context";
+import type { ComponentContext } from "../types/context";
 import type { EnvironmentContext } from "../types/environmentContext";
 
 import type { CatladderJob } from "../types/jobs";
@@ -12,7 +12,7 @@ export * from "./node";
 
 export type BuildTypes = {
   [type in BuildConfigType]: {
-    jobs: (context: Context) => CatladderJob[];
+    jobs: (context: ComponentContext) => CatladderJob[];
     defaults: (
       envContext: EnvironmentContext<BuildConfigType, any>,
     ) => Partial<Extract<BuildConfig, { type: type }>>;

package/src/build/node/buildJob.ts

@@ -1,24 +1,26 @@
 import { join } from "path";
 import { getRunnerImage } from "../../runner";
-import type { Context } from "../../types/context";
+import type { ComponentContext } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { ensureArray } from "../../utils";
 import { createBuildJobs } from "../base";
-import { getDockerBuildDefaultScript } from "../docker";
+import { getDockerBuildScriptWithBuiltInDockerFile } from "../docker";
 import { isOfBuildType } from "../types";
 import { getNextCache, getNodeCache, getYarnCache } from "./cache";
 import { NODE_RUNNER_BUILD_VARIABLES } from "./constants";
 import { getDockerAppCopyAndBuildScript, getYarnInstall } from "./yarn";
 
-export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
-  const buildConfig = context.componentConfig.build;
+export const createNodeBuildJobs = (
+  context: ComponentContext,
+): CatladderJob[] => {
+  const buildConfig = context.build.config;
 
   if (!isOfBuildType(buildConfig, "node", "node-static", "storybook")) {
     throw new Error("deploy config is not node, node-static or storybook");
   }
 
   const defaultImage = getRunnerImage("jobs-default");
-  const yarnInstall = getYarnInstall(context);
+  const yarnInstall = getYarnInstall(context.build);
 
   return createBuildJobs(context, {
     appBuild:
@@ -28,7 +30,7 @@ export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
             runnerVariables: NODE_RUNNER_BUILD_VARIABLES,
             cache: [
               ...(ensureArray(buildConfig.jobCache) ?? []),
-              ...getNodeCache(context),
+              ...getNodeCache(context.build),
               ...getNextCache(context),
             ],
             script: [
@@ -37,10 +39,10 @@ export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
             ],
             artifacts: {
               paths: [
-                context.componentConfig.dir,
+                context.build.dir,
                 // also copy workspace dependencies in monorepo if packages are shared and they create build artifacts
-                ...(context.packageManagerInfo?.currentWorkspaceDependencies ??
-                  []),
+                ...(context.build.packageManagerInfo
+                  ?.currentWorkspaceDependencies ?? []),
               ].flatMap((dir) => [
                 join(dir, "__build_info.json"),
                 join(dir, "dist"),
@@ -57,18 +59,20 @@ export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
         : undefined,
 
     dockerBuild: {
-      script: getDockerBuildDefaultScript(
+      script: getDockerBuildScriptWithBuiltInDockerFile(
         context,
         buildConfig.type === "node-static" || buildConfig.type === "storybook"
-          ? "ensureNginxDockerfile"
-          : "ensureNodeDockerfile",
+          ? "nginx"
+          : "node",
       ),
-      cache: [...getYarnCache(context, "pull")],
+      cache: [...getYarnCache(context.build, "pull")],
       variables: {
         // only required for non static
-        DOCKER_COPY_AND_INSTALL_APP: getDockerAppCopyAndBuildScript(context),
+        DOCKER_COPY_AND_INSTALL_APP: getDockerAppCopyAndBuildScript(
+          context.build,
+        ),
         DOCKER_COPY_WORKSPACE_FILES:
-          context.packageManagerInfo?.pathsToCopyInDocker
+          context.build.packageManagerInfo?.pathsToCopyInDocker
             .map((dir) => `COPY --chown=node:node ${dir} /app/${dir}`)
             ?.join("\n"),
       },