@catladder/pipeline 1.110.0 → 1.110.2

package/examples/__snapshots__/kubernetes-with-cloud-sql.ts.snap

@@ -123,6 +123,7 @@ cloudsql:
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -532,6 +533,7 @@ cloudsql:
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -832,6 +834,7 @@ cloudsql:
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -1241,6 +1244,7 @@ cloudsql:
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {

package/examples/__snapshots__/kubernetes-with-jobs.ts.snap

@@ -119,6 +119,7 @@ cronjobs:
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -518,6 +519,7 @@ cronjobs:
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -735,6 +737,7 @@ application:
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -1120,6 +1123,7 @@ application:
       },
       "www 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -1413,6 +1417,7 @@ cronjobs: {}
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -1806,6 +1811,7 @@ cronjobs: {}
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -2023,6 +2029,7 @@ application:
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -2408,6 +2415,7 @@ application:
       },
       "www 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {

package/examples/__snapshots__/kubernetes-with-mongodb.ts.snap

@@ -139,6 +139,7 @@ mongodb:
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -580,6 +581,7 @@ mongodb:
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -896,6 +898,7 @@ mongodb:
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -1337,6 +1340,7 @@ mongodb:
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {

package/examples/__snapshots__/native-app.ts.snap

@@ -22,6 +22,7 @@ exports[`matches snapshot 1`] = `
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -352,6 +353,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_ID","BUILD_INF
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -479,6 +481,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_ID","BUILD_INF
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -701,6 +704,7 @@ EOF",
       },
       "app 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -904,6 +908,7 @@ EOF",
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -1234,6 +1239,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_ID","BUILD_INF
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -1361,6 +1367,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_ID","BUILD_INF
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -1583,6 +1590,7 @@ EOF",
       },
       "app 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {

package/examples/__snapshots__/node-build-with-custom-image.ts.snap

@@ -22,6 +22,7 @@ exports[`matches snapshot 1`] = `
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -352,6 +353,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_ID","BUILD_INF
       },
       "www 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -551,6 +553,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_ID","BUILD_INF
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -881,6 +884,7 @@ _ALL_ENV_VAR_KEYS: '["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_ID","BUILD_INF
       },
       "www 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {

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

@@ -22,6 +22,7 @@ exports[`matches snapshot 1`] = `
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -181,6 +182,7 @@ exports[`matches snapshot 1`] = `
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -308,6 +310,7 @@ exports[`matches snapshot 1`] = `
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -471,6 +474,7 @@ exports[`matches snapshot 1`] = `
       },
       "www 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -670,6 +674,7 @@ exports[`matches snapshot 1`] = `
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -829,6 +834,7 @@ exports[`matches snapshot 1`] = `
       },
       "api 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -956,6 +962,7 @@ exports[`matches snapshot 1`] = `
             "policy": "pull-push",
           },
         ],
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {
@@ -1119,6 +1126,7 @@ exports[`matches snapshot 1`] = `
       },
       "www 🛡 audit": {
         "allow_failure": true,
+        "image": "path/to/docker/jobs-default:the-version",
         "interruptible": true,
         "needs": [],
         "retry": {

package/package.json

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

package/src/build/base/__tests__/__snapshots__/createArtifactsConfig.test.ts.snap

@@ -0,0 +1,49 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createArtifactsConfig merges junit files if both given 1`] = `
+{
+  "artifacts": {
+    "paths": [
+      "testpath",
+    ],
+    "reports": {
+      "junit": [
+        "partial-report.xml",
+        "full-report.xml",
+      ],
+      "terraform": "something",
+    },
+  },
+}
+`;
+
+exports[`createArtifactsConfig returns artifacts if no artifactsReports 1`] = `
+{
+  "artifacts": {
+    "paths": [
+      "testpath",
+    ],
+    "reports": {
+      "coverage_report": {
+        "coverage_format": "cobertura",
+        "path": "some",
+      },
+      "junit": [],
+      "terraform": "something",
+    },
+  },
+}
+`;
+
+exports[`createArtifactsConfig returns junit parts of artifactsReports 1`] = `
+{
+  "artifacts": {
+    "paths": [],
+    "reports": {
+      "junit": [
+        "report.xml",
+      ],
+    },
+  },
+}
+`;

package/src/build/base/__tests__/createArtifactsConfig.test.ts

@@ -0,0 +1,41 @@
+import { createArtifactsConfig } from "../createArtifactsConfig";
+
+describe("createArtifactsConfig", () => {
+  it("returns undefined if no artifacts or artifactsReports", () => {
+    expect(createArtifactsConfig(".")).toBeUndefined();
+  });
+
+  it("returns artifacts if no artifactsReports", () => {
+    expect(
+      createArtifactsConfig(".", undefined, {
+        paths: ["testpath"],
+        reports: {
+          coverage_report: { coverage_format: "cobertura", path: "some" },
+          terraform: "something",
+        },
+      })
+    ).toMatchSnapshot();
+  });
+
+  it("returns junit parts of artifactsReports", () => {
+    expect(
+      createArtifactsConfig(".", { junit: ["report.xml"] })
+    ).toMatchSnapshot();
+  });
+
+  it("merges junit files if both given", () => {
+    const result = createArtifactsConfig(
+      ".",
+      { junit: ["partial-report.xml"] },
+      {
+        paths: ["testpath"],
+        reports: {
+          junit: "full-report.xml",
+          terraform: "something",
+        },
+      }
+    );
+    expect(result).toMatchSnapshot();
+    expect(result?.artifacts?.reports?.junit).toHaveLength(2);
+  });
+});

package/src/build/base/createArtifactsConfig.ts

@@ -0,0 +1,34 @@
+import { join } from "path";
+import type { BuildConfigArtifactsReports } from "../types";
+import type { Artifacts } from "../../types";
+import type { OptionalArtifacts } from "../custom/testJob";
+
+export const createArtifactsConfig = (
+  rootPath: string,
+  artifactsReports?: BuildConfigArtifactsReports,
+  artifacts?: Artifacts
+): OptionalArtifacts =>
+  artifactsReports || artifacts
+    ? {
+        artifacts: {
+          paths: [],
+          ...artifacts,
+          reports: {
+            ...artifacts?.reports,
+            junit: [
+              artifactsReports?.junit,
+              Array.isArray(artifacts?.reports?.junit) &&
+                artifacts?.reports?.junit,
+              typeof artifacts?.reports?.junit === "string" && [
+                artifacts?.reports?.junit,
+              ],
+            ]
+              .filter(Array.isArray)
+              .reduce(
+                (acc, curr) => [...acc, ...curr.map((p) => join(rootPath, p))],
+                []
+              ),
+          },
+        },
+      }
+    : undefined;

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

@@ -0,0 +1,32 @@
+import type { Context } 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 = {
+    componentName: "testComponent",
+    environment: {
+      jobOnlyVars: {
+        build: {},
+      },
+    },
+    componentConfig,
+  } as Context;
+
+  it("throws error when not build type custom", () => {
+    componentConfig.build.type = "node";
+    expect(() => createCustomTestJobs(baseContext)).toThrowError(
+      "deploy config is not custom"
+    );
+    componentConfig.build.type = "custom";
+  });
+
+  it("returns empty array if no audit, lint, and test definition", () => {
+    const jobs = createCustomTestJobs(baseContext);
+    expect(jobs).toEqual([]);
+  });
+});

package/src/build/custom/testJob.ts

@@ -1,10 +1,9 @@
-import { join } from "path";
 import type { Context } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { ensureArray, notNil } from "../../utils";
 import { isOfBuildType } from "../types";
-import type { BuildConfigArtifactsReports } from "../types";
 import type { Artifacts } from "../../types";
+import { createArtifactsConfig } from "../base/createArtifactsConfig";
 
 const RUNNER_CUSTOM_TEST_VARIABLES = {
   KUBERNETES_CPU_REQUEST: "0.5",
@@ -48,7 +47,8 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
         allow_failure: true,
         ...createArtifactsConfig(
           context.componentConfig.dir,
-          buildConfig.audit?.artifactsReports
+          buildConfig.audit?.artifactsReports,
+          buildConfig.audit?.artifacts
         ),
       }
     : null;
@@ -62,7 +62,8 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
         script: [...(ensureArray(buildConfig.lint?.command) ?? [])],
         ...createArtifactsConfig(
           context.componentConfig.dir,
-          buildConfig.lint?.artifactsReports
+          buildConfig.lint?.artifactsReports,
+          buildConfig.lint?.artifacts
         ),
       }
     : null;
@@ -75,30 +76,16 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
         script: [...(ensureArray(buildConfig.test?.command) ?? [])],
         ...createArtifactsConfig(
           context.componentConfig.dir,
-          buildConfig.test?.artifactsReports
+          buildConfig.test?.artifactsReports,
+          buildConfig.test?.artifacts
         ),
       }
     : null;
   return [auditJob, lintJob, testJob].filter(notNil);
 };
 
-type OptionalArtifacts =
+export type OptionalArtifacts =
   | {
       artifacts: Artifacts;
     }
   | undefined;
-
-const createArtifactsConfig = (
-  rootPath: string,
-  artifactsReports?: BuildConfigArtifactsReports
-): OptionalArtifacts =>
-  artifactsReports
-    ? {
-        artifacts: {
-          paths: [],
-          reports: {
-            junit: artifactsReports?.junit?.map((p) => join(rootPath, p)) ?? [],
-          },
-        },
-      }
-    : undefined;

package/src/build/node/testJob.ts

@@ -5,6 +5,7 @@ import { ensureArray, notNil } from "../../utils";
 import { getNodeCache } from "./cache";
 import { NODE_RUNNER_BUILD_VARIABLES } from "./constants";
 import { getYarnInstall } from "./yarn";
+import { createArtifactsConfig } from "../base/createArtifactsConfig";
 
 export const createNodeTestJobs = (context: Context): CatladderJob[] => {
   // don't run tests after release
@@ -13,7 +14,7 @@ export const createNodeTestJobs = (context: Context): CatladderJob[] => {
   }
 
   const buildConfig = context.componentConfig.build;
-
+  const defaultImage = getRunnerImage("jobs-default");
   const base: Omit<CatladderJob, "script" | "name"> = {
     variables: {
       APP_PATH: context.componentConfig.dir,
@@ -30,8 +31,8 @@ export const createNodeTestJobs = (context: Context): CatladderJob[] => {
     buildConfig.audit !== false
       ? {
           name: "🛡 audit",
-
           ...base,
+          image: buildConfig.audit?.jobImage ?? defaultImage,
           cache: undefined, // audit does not need yarn install and no cache
           script: [
             `cd ${context.componentConfig.dir}`,
@@ -42,6 +43,11 @@ export const createNodeTestJobs = (context: Context): CatladderJob[] => {
             ]),
           ],
           allow_failure: true,
+          ...createArtifactsConfig(
+            context.componentConfig.dir,
+            buildConfig.audit?.artifactsReports,
+            buildConfig.audit?.artifacts
+          ),
         }
       : null;
 
@@ -49,14 +55,19 @@ export const createNodeTestJobs = (context: Context): CatladderJob[] => {
     buildConfig.lint !== false
       ? {
           name: "👮 lint",
-
           ...base,
+          image: buildConfig.lint?.jobImage ?? defaultImage,
           cache: getNodeCache(context),
           script: [
             `cd ${context.componentConfig.dir}`,
             ...yarnInstall,
             ...(ensureArray(buildConfig.lint?.command) ?? ["yarn lint"]),
           ],
+          ...createArtifactsConfig(
+            context.componentConfig.dir,
+            buildConfig.lint?.artifactsReports,
+            buildConfig.lint?.artifacts
+          ),
         }
       : null;
   const testJob: CatladderJob | null =
@@ -65,13 +76,19 @@ export const createNodeTestJobs = (context: Context): CatladderJob[] => {
           name: "🧪 test",
 
           ...base,
-          image: getRunnerImage("jobs-testing-chrome"),
+          image:
+            buildConfig.test?.jobImage ?? getRunnerImage("jobs-testing-chrome"),
           cache: getNodeCache(context),
           script: [
             `cd ${context.componentConfig.dir}`,
             ...yarnInstall,
             ...(ensureArray(buildConfig.test?.command) ?? ["yarn test"]),
           ],
+          ...createArtifactsConfig(
+            context.componentConfig.dir,
+            buildConfig.test?.artifactsReports,
+            buildConfig.test?.artifacts
+          ),
         }
       : null;
   return [auditJob, lintJob, testJob].filter(notNil);