@catladder/pipeline 3.30.5 → 3.32.0

package/examples/custom-docker-file.test.ts

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

package/examples/custom-docker-file.ts

@@ -0,0 +1,36 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+        jobImage: "foo",
+        docker: {
+          type: "custom",
+          dockerfileContent: [
+            "FROM node:22",
+            "USER node",
+            "$DOCKER_COPY_WORKSPACE_FILES",
+            "WORKDIR /app/$APP_DIR",
+            "$DOCKER_COPY_AND_INSTALL_APP",
+          ],
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Custom Dockerfile",
+};

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "3.30.5",
+  "version": "3.32.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables",
@@ -88,6 +88,6 @@
     "yaml": "^2.5.0"
   },
   "dependencies": {
-    "tsx": "^4.19.0"
+    "tsx": "^4.21.0"
   }
 }

package/src/build/custom/testJob.ts

@@ -32,7 +32,6 @@ export const createCustomTestJobs = (
       APP_PATH: context.build.dir,
       ...context.environment.jobOnlyVars.build.envVars,
     },
-    runnerVariables: RUNNER_CUSTOM_TEST_VARIABLES,
     services: buildConfig.jobServices,
     cache: createJobCacheFromConfig(context, buildConfig),
     stage: "test",
@@ -42,6 +41,10 @@ export const createCustomTestJobs = (
     ? {
         name: "🛡 audit",
         ...base,
+        runnerVariables: {
+          ...RUNNER_CUSTOM_TEST_VARIABLES,
+          ...(buildConfig.audit?.runnerVariables ?? {}),
+        },
         image: buildConfig.audit?.jobImage ?? buildConfig.jobImage,
         cache: undefined,
         script: [...ensureArray(buildConfig.audit?.command)],
@@ -59,6 +62,10 @@ export const createCustomTestJobs = (
         name: "👮 lint",
 
         ...base,
+        runnerVariables: {
+          ...RUNNER_CUSTOM_TEST_VARIABLES,
+          ...(buildConfig.lint?.runnerVariables ?? {}),
+        },
         image: buildConfig.lint?.jobImage ?? buildConfig.jobImage,
         script: [...ensureArray(buildConfig.lint?.command)],
         ...createArtifactsConfig(
@@ -73,6 +80,10 @@ export const createCustomTestJobs = (
         name: "🧪 test",
 
         ...base,
+        runnerVariables: {
+          ...RUNNER_CUSTOM_TEST_VARIABLES,
+          ...(buildConfig.test?.runnerVariables ?? {}),
+        },
         image: buildConfig.test?.jobImage ?? buildConfig.jobImage,
         script: [...ensureArray(buildConfig.test?.command)],
         ...createArtifactsConfig(

package/src/build/docker.ts

@@ -166,19 +166,39 @@ const BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS = {
   [type in BuildConfigDocker["type"]]: string | null;
 };
 
-export const getDockerBuildScriptWithBuiltInDockerFile = (
+const getEnsureDockerFileScript = (
   context: ComponentContextWithBuild,
-  defaultType?: BuildConfigDocker["type"],
+  fallbackType?: BuildConfigDocker["type"],
 ) => {
-  const type =
+  if (
     "docker" in context.build.config &&
     context.build.config.docker &&
     "type" in context.build.config.docker
-      ? context.build.config.docker?.type
-      : defaultType;
+  ) {
+    if (context.build.config.docker?.type === "custom") {
+      if (context.build.config.docker?.dockerfileContent) {
+        // we need to create a script that creates a Dockerfile in the current directory
+        return `
+echo "Creating Dockerfile"
+cat >$APP_DIR/Dockerfile <<EOF
+${context.build.config.docker?.dockerfileContent?.join("\n")}
+EOF`;
+      }
+    }
+
+    const type = context.build.config.docker?.type ?? fallbackType;
+    return type ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[type] : null;
+  }
+  return fallbackType ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[fallbackType] : null;
+};
+
+export const getDockerBuildScriptWithBuiltInDockerFile = (
+  context: ComponentContextWithBuild,
+  fallbackType?: BuildConfigDocker["type"],
+) => {
   return getDockerBuildDefaultScript(
     context,
-    type ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[type] : null,
+    getEnsureDockerFileScript(context, fallbackType),
   );
 };
 export const getDockerBuildDefaultScript = (

package/src/build/node/testJob.ts

@@ -39,7 +39,6 @@ export const createNodeTestJobs = (
         : {}),
     },
 
-    runnerVariables: NODE_RUNNER_BUILD_VARIABLES,
     stage: "test",
     needs: [],
   };
@@ -50,6 +49,10 @@ export const createNodeTestJobs = (
       ? {
           name: "🛡 audit",
           ...base,
+          runnerVariables: {
+            ...NODE_RUNNER_BUILD_VARIABLES,
+            ...(buildConfig.audit?.runnerVariables ?? {}),
+          },
           image: buildConfig.audit?.jobImage ?? defaultImage,
           cache: undefined, // audit does not need yarn install and no cache
           script: [
@@ -68,12 +71,15 @@ export const createNodeTestJobs = (
           ),
         }
       : null;
-
   const lintJob: CatladderJob | null =
     buildConfig.lint !== false
       ? {
           name: "👮 lint",
           ...base,
+          runnerVariables: {
+            ...NODE_RUNNER_BUILD_VARIABLES,
+            ...(buildConfig.lint?.runnerVariables ?? {}),
+          },
           image: buildConfig.lint?.jobImage ?? defaultImage,
           cache: createJobCacheFromCacheConfigs(context, getNodeCache(context)),
           script: [
@@ -95,6 +101,10 @@ export const createNodeTestJobs = (
           name: "🧪 test",
 
           ...base,
+          runnerVariables: {
+            ...NODE_RUNNER_BUILD_VARIABLES,
+            ...(buildConfig.test?.runnerVariables ?? {}),
+          },
           image:
             buildConfig.test?.jobImage ?? getRunnerImage("jobs-testing-chrome"),
           cache: createJobCacheFromCacheConfigs(context, getNodeCache(context)),

package/src/build/types.ts

@@ -76,6 +76,11 @@ export type TestJobCustom = {
    * {@link TestJobCustom.artifacts}.reports.junit is merged with {@link TestJobCustom.artifactsReports} in case both given.
    */
   artifacts?: Artifacts;
+
+  /**
+   * additional vars for this job runner
+   */
+  runnerVariables?: Record<string, string>;
 };
 
 export type BuildConfigBase = {
@@ -239,6 +244,16 @@ type BuildConfigDockerCustom = {
    * Depending on your Dockerfile you may want to change it to "component"
    */
   buildContextLocation?: "root" | "component";
+
+  /**
+   * EXPERIMENTAL: custom docker file content
+   *
+   * you can use some predefined variables:
+   * - $DOCKER_COPY_WORKSPACE_FILES
+   * - $DOCKER_COPY_AND_INSTALL_APP
+   * - and all default variables
+   */
+  dockerfileContent?: string[];
 };
 
 export type BuildConfigDocker =
@@ -403,7 +418,7 @@ export type WorkspaceBuildConfigBase = {
    */
   audit?: false | TestJobCustom;
   /**
-   * additional vars only for the runner.
+   * additional vars only for the build job.
    * Also if you use services: that require env vars, you need to set them here.
    *
    */

package/src/config/readConfig.ts

@@ -1,5 +1,6 @@
 import { existsSync, readFileSync } from "fs";
 
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const tsx = require("tsx/cjs/api");
 
 import { parse } from "yaml";
@@ -10,7 +11,7 @@ import type { Config } from "../types";
 const fullPath = (directory: string, ext: string) =>
   directory + "/catladder." + ext;
 
-export const readConfig = async (
+const readConfigInternal = async (
   directory: string = process.cwd(),
 ): Promise<{ config: Config; path: string; ext: string } | null> => {
   const found = ["ts", "js", "yml", "yaml"].find((extension) =>
@@ -39,3 +40,23 @@ export const readConfig = async (
   }
   return null;
 };
+
+export const readConfig = async (
+  directory: string = process.cwd(),
+): Promise<{ config: Config; path: string; ext: string } | null> => {
+  try {
+    return await readConfigInternal(directory);
+  } catch (error) {
+    console.error(`Error reading config in ${directory}:`, error);
+    console.error(`
+This may happen due to various reasons:
+  - Syntax errors in your catladder.ts file
+  - tsx (the TypeScript loader used by catladder) needs to understand the syntax in your project.
+    If your project uses newer TypeScript/JavaScript syntax, you may need to update catladder
+    to get a newer version of tsx that supports it.
+  - Missing or incorrect dependencies in your project
+  - TypeScript configuration issues in your tsconfig.json
+`);
+    return null;
+  }
+};