@catladder/pipeline 1.94.2 → 1.96.0

package/examples/custom-build-job-with-tests.ts

@@ -0,0 +1,40 @@
+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",
+        },
+        lint: {
+          command: "lint",
+          jobImage: "lint-image",
+        },
+        test: {
+          command: "test",
+          jobImage: "test-image",
+        },
+        audit: {
+          command: "audit",
+          jobImage: "audit-image",
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/package.json

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

package/src/build/custom/index.ts

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

package/src/build/custom/testJob.ts

@@ -0,0 +1,66 @@
+import type { Context } from "../../types/context";
+import type { CatladderJob } from "../../types/jobs";
+import { ensureArray, notNil } from "../../utils";
+import { isOfBuildType } from "../types";
+
+const RUNNER_CUSTOM_TEST_VARIABLES = {
+  KUBERNETES_CPU_REQUEST: "0.5",
+  KUBERNETES_CPU_LIMIT: "2",
+  KUBERNETES_MEMORY_REQUEST: "2Gi",
+  KUBERNETES_MEMORY_LIMIT: "4Gi",
+};
+
+export const createCustomTestJobs = (context: Context): CatladderJob[] => {
+  // don't run tests after release
+  if (context.commitInfo?.trigger === "taggedRelease") {
+    return [];
+  }
+
+  const buildConfig = context.componentConfig.build;
+
+  if (!isOfBuildType(buildConfig, "custom")) {
+    throw new Error("deploy config is not custom");
+  }
+
+  const base: Omit<CatladderJob, "script" | "name"> = {
+    variables: {
+      APP_PATH: context.componentConfig.dir,
+      ...RUNNER_CUSTOM_TEST_VARIABLES,
+      ...(buildConfig.extraVars ?? {}),
+    },
+    cache: buildConfig.jobCache,
+    stage: "test",
+    needs: [],
+    envMode: "none",
+  };
+  const auditJob: CatladderJob | null = buildConfig.audit
+    ? {
+        name: "🛡 audit",
+        ...base,
+        image: buildConfig.audit?.jobImage ?? buildConfig.jobImage,
+        cache: undefined,
+        script: [...(ensureArray(buildConfig.audit?.command) ?? [])],
+        allow_failure: true,
+      }
+    : null;
+
+  const lintJob: CatladderJob | null = buildConfig.lint
+    ? {
+        name: "👮 lint",
+
+        ...base,
+        image: buildConfig.lint?.jobImage ?? buildConfig.jobImage,
+        script: [...(ensureArray(buildConfig.lint?.command) ?? [])],
+      }
+    : null;
+  const testJob: CatladderJob | null = buildConfig.test
+    ? {
+        name: "🧪 test",
+
+        ...base,
+        image: buildConfig.test?.jobImage ?? buildConfig.jobImage,
+        script: [...(ensureArray(buildConfig.test?.command) ?? [])],
+      }
+    : null;
+  return [auditJob, lintJob, testJob].filter(notNil);
+};

package/src/build/types.ts

@@ -111,7 +111,10 @@ export type BuildConfigCustomDocker = BuildConfigBase["docker"] &
       }
   );
 
-export type BuildConfigCustom = BuildConfigBase & {
+export type BuildConfigCustom = Omit<
+  BuildConfigBase,
+  "lint" | "test" | "audit"
+> & {
   type: "custom";
   jobImage: string;
   jobServices?: GitlabJobService[];
@@ -122,6 +125,30 @@ export type BuildConfigCustom = BuildConfigBase & {
    * customize cache for the job
    */
   jobCache?: CatladderJob["cache"];
+
+  /**
+   * custom lint, disabled when not set
+   */
+  lint?: {
+    command?: string | string[];
+    jobImage?: GitlabJobImage;
+  };
+
+  /**
+   * custom test, disabled when not set
+   */
+  test?: {
+    command?: string | string[];
+    jobImage?: GitlabJobImage;
+  };
+
+  /**
+   * custom audit, disabled when not set
+   */
+  audit?: {
+    command?: string | string[];
+    jobImage?: GitlabJobImage;
+  };
 };
 
 export type BuildConfigRails = BuildConfigBase & {