@catladder/pipeline 1.110.0 → 1.110.2

package/dist/build/base/__tests__/createArtifactsConfig.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/build/base/__tests__/createArtifactsConfig.test.js

@@ -0,0 +1,40 @@
+"use strict";
+
+exports.__esModule = true;
+var createArtifactsConfig_1 = require("../createArtifactsConfig");
+describe("createArtifactsConfig", function () {
+  it("returns undefined if no artifacts or artifactsReports", function () {
+    expect((0, createArtifactsConfig_1.createArtifactsConfig)(".")).toBeUndefined();
+  });
+  it("returns artifacts if no artifactsReports", function () {
+    expect((0, createArtifactsConfig_1.createArtifactsConfig)(".", undefined, {
+      paths: ["testpath"],
+      reports: {
+        coverage_report: {
+          coverage_format: "cobertura",
+          path: "some"
+        },
+        terraform: "something"
+      }
+    })).toMatchSnapshot();
+  });
+  it("returns junit parts of artifactsReports", function () {
+    expect((0, createArtifactsConfig_1.createArtifactsConfig)(".", {
+      junit: ["report.xml"]
+    })).toMatchSnapshot();
+  });
+  it("merges junit files if both given", function () {
+    var _a, _b;
+    var result = (0, createArtifactsConfig_1.createArtifactsConfig)(".", {
+      junit: ["partial-report.xml"]
+    }, {
+      paths: ["testpath"],
+      reports: {
+        junit: "full-report.xml",
+        terraform: "something"
+      }
+    });
+    expect(result).toMatchSnapshot();
+    expect((_b = (_a = result === null || result === void 0 ? void 0 : result.artifacts) === null || _a === void 0 ? void 0 : _a.reports) === null || _b === void 0 ? void 0 : _b.junit).toHaveLength(2);
+  });
+});

package/dist/build/base/createArtifactsConfig.d.ts

@@ -0,0 +1,4 @@
+import type { BuildConfigArtifactsReports } from "../types";
+import type { Artifacts } from "../../types";
+import type { OptionalArtifacts } from "../custom/testJob";
+export declare const createArtifactsConfig: (rootPath: string, artifactsReports?: BuildConfigArtifactsReports | undefined, artifacts?: Artifacts | undefined) => OptionalArtifacts;

package/dist/build/base/createArtifactsConfig.js

@@ -0,0 +1,63 @@
+"use strict";
+
+var __assign = this && this.__assign || function () {
+  __assign = Object.assign || function (t) {
+    for (var s, i = 1, n = arguments.length; i < n; i++) {
+      s = arguments[i];
+      for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+    }
+    return t;
+  };
+  return __assign.apply(this, arguments);
+};
+var __read = this && this.__read || function (o, n) {
+  var m = typeof Symbol === "function" && o[Symbol.iterator];
+  if (!m) return o;
+  var i = m.call(o),
+    r,
+    ar = [],
+    e;
+  try {
+    while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+  } catch (error) {
+    e = {
+      error: error
+    };
+  } finally {
+    try {
+      if (r && !r.done && (m = i["return"])) m.call(i);
+    } finally {
+      if (e) throw e.error;
+    }
+  }
+  return ar;
+};
+var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
+  if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+    if (ar || !(i in from)) {
+      if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+      ar[i] = from[i];
+    }
+  }
+  return to.concat(ar || Array.prototype.slice.call(from));
+};
+exports.__esModule = true;
+exports.createArtifactsConfig = void 0;
+var path_1 = require("path");
+var createArtifactsConfig = function (rootPath, artifactsReports, artifacts) {
+  var _a, _b, _c, _d;
+  return artifactsReports || artifacts ? {
+    artifacts: __assign(__assign({
+      paths: []
+    }, artifacts), {
+      reports: __assign(__assign({}, artifacts === null || artifacts === void 0 ? void 0 : artifacts.reports), {
+        junit: [artifactsReports === null || artifactsReports === void 0 ? void 0 : artifactsReports.junit, Array.isArray((_a = artifacts === null || artifacts === void 0 ? void 0 : artifacts.reports) === null || _a === void 0 ? void 0 : _a.junit) && ((_b = artifacts === null || artifacts === void 0 ? void 0 : artifacts.reports) === null || _b === void 0 ? void 0 : _b.junit), typeof ((_c = artifacts === null || artifacts === void 0 ? void 0 : artifacts.reports) === null || _c === void 0 ? void 0 : _c.junit) === "string" && [(_d = artifacts === null || artifacts === void 0 ? void 0 : artifacts.reports) === null || _d === void 0 ? void 0 : _d.junit]].filter(Array.isArray).reduce(function (acc, curr) {
+          return __spreadArray(__spreadArray([], __read(acc), false), __read(curr.map(function (p) {
+            return (0, path_1.join)(rootPath, p);
+          })), false);
+        }, [])
+      })
+    })
+  } : undefined;
+};
+exports.createArtifactsConfig = createArtifactsConfig;

package/dist/build/custom/__tests__/testJob.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/build/custom/__tests__/testJob.test.js

@@ -0,0 +1,37 @@
+"use strict";
+
+exports.__esModule = true;
+var testJob_1 = require("../testJob");
+describe("createCustomTestJobs", function () {
+  var componentConfig = {
+    dir: ".",
+    build: {
+      type: "custom",
+      docker: {
+        type: "custom"
+      },
+      jobImage: ""
+    },
+    deploy: {}
+  };
+  var baseContext = {
+    componentName: "testComponent",
+    environment: {
+      jobOnlyVars: {
+        build: {}
+      }
+    },
+    componentConfig: componentConfig
+  };
+  it("throws error when not build type custom", function () {
+    componentConfig.build.type = "node";
+    expect(function () {
+      return (0, testJob_1.createCustomTestJobs)(baseContext);
+    }).toThrowError("deploy config is not custom");
+    componentConfig.build.type = "custom";
+  });
+  it("returns empty array if no audit, lint, and test definition", function () {
+    var jobs = (0, testJob_1.createCustomTestJobs)(baseContext);
+    expect(jobs).toEqual([]);
+  });
+});

package/dist/build/custom/testJob.d.ts

@@ -1,3 +1,7 @@
 import type { Context } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
-export declare const createCustomTestJobs: (context: Context) => CatladderJob[];
+import type { Artifacts } from "../../types";
+export declare const createCustomTestJobs: (context: Context) => CatladderJob[];
+export declare type OptionalArtifacts = {
+  artifacts: Artifacts;
+} | undefined;

package/dist/build/custom/testJob.js

@@ -43,9 +43,9 @@ var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
 };
 exports.__esModule = true;
 exports.createCustomTestJobs = void 0;
-var path_1 = require("path");
 var utils_1 = require("../../utils");
 var types_1 = require("../types");
+var createArtifactsConfig_1 = require("../base/createArtifactsConfig");
 var RUNNER_CUSTOM_TEST_VARIABLES = {
   KUBERNETES_CPU_REQUEST: "0.5",
   KUBERNETES_CPU_LIMIT: "2",
@@ -53,7 +53,7 @@ var RUNNER_CUSTOM_TEST_VARIABLES = {
   KUBERNETES_MEMORY_LIMIT: "4Gi"
 };
 var createCustomTestJobs = function (context) {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
   // don't run tests after release
   if (((_a = context.commitInfo) === null || _a === void 0 ? void 0 : _a.trigger) === "taggedRelease") {
     return [];
@@ -79,32 +79,19 @@ var createCustomTestJobs = function (context) {
     cache: undefined,
     script: __spreadArray([], __read((_f = (0, utils_1.ensureArray)((_e = buildConfig.audit) === null || _e === void 0 ? void 0 : _e.command)) !== null && _f !== void 0 ? _f : []), false),
     allow_failure: true
-  }), createArtifactsConfig(context.componentConfig.dir, (_g = buildConfig.audit) === null || _g === void 0 ? void 0 : _g.artifactsReports)) : null;
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.componentConfig.dir, (_g = buildConfig.audit) === null || _g === void 0 ? void 0 : _g.artifactsReports, (_h = buildConfig.audit) === null || _h === void 0 ? void 0 : _h.artifacts)) : null;
   var lintJob = buildConfig.lint ? __assign(__assign(__assign({
     name: "👮 lint"
   }, base), {
-    image: (_j = (_h = buildConfig.lint) === null || _h === void 0 ? void 0 : _h.jobImage) !== null && _j !== void 0 ? _j : buildConfig.jobImage,
-    script: __spreadArray([], __read((_l = (0, utils_1.ensureArray)((_k = buildConfig.lint) === null || _k === void 0 ? void 0 : _k.command)) !== null && _l !== void 0 ? _l : []), false)
-  }), createArtifactsConfig(context.componentConfig.dir, (_m = buildConfig.lint) === null || _m === void 0 ? void 0 : _m.artifactsReports)) : null;
+    image: (_k = (_j = buildConfig.lint) === null || _j === void 0 ? void 0 : _j.jobImage) !== null && _k !== void 0 ? _k : buildConfig.jobImage,
+    script: __spreadArray([], __read((_m = (0, utils_1.ensureArray)((_l = buildConfig.lint) === null || _l === void 0 ? void 0 : _l.command)) !== null && _m !== void 0 ? _m : []), false)
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.componentConfig.dir, (_o = buildConfig.lint) === null || _o === void 0 ? void 0 : _o.artifactsReports, (_p = buildConfig.lint) === null || _p === void 0 ? void 0 : _p.artifacts)) : null;
   var testJob = buildConfig.test ? __assign(__assign(__assign({
     name: "🧪 test"
   }, base), {
-    image: (_p = (_o = buildConfig.test) === null || _o === void 0 ? void 0 : _o.jobImage) !== null && _p !== void 0 ? _p : buildConfig.jobImage,
-    script: __spreadArray([], __read((_r = (0, utils_1.ensureArray)((_q = buildConfig.test) === null || _q === void 0 ? void 0 : _q.command)) !== null && _r !== void 0 ? _r : []), false)
-  }), createArtifactsConfig(context.componentConfig.dir, (_s = buildConfig.test) === null || _s === void 0 ? void 0 : _s.artifactsReports)) : null;
+    image: (_r = (_q = buildConfig.test) === null || _q === void 0 ? void 0 : _q.jobImage) !== null && _r !== void 0 ? _r : buildConfig.jobImage,
+    script: __spreadArray([], __read((_t = (0, utils_1.ensureArray)((_s = buildConfig.test) === null || _s === void 0 ? void 0 : _s.command)) !== null && _t !== void 0 ? _t : []), false)
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.componentConfig.dir, (_u = buildConfig.test) === null || _u === void 0 ? void 0 : _u.artifactsReports, (_v = buildConfig.test) === null || _v === void 0 ? void 0 : _v.artifacts)) : null;
   return [auditJob, lintJob, testJob].filter(utils_1.notNil);
 };
-exports.createCustomTestJobs = createCustomTestJobs;
-var createArtifactsConfig = function (rootPath, artifactsReports) {
-  var _a, _b;
-  return artifactsReports ? {
-    artifacts: {
-      paths: [],
-      reports: {
-        junit: (_b = (_a = artifactsReports === null || artifactsReports === void 0 ? void 0 : artifactsReports.junit) === null || _a === void 0 ? void 0 : _a.map(function (p) {
-          return (0, path_1.join)(rootPath, p);
-        })) !== null && _b !== void 0 ? _b : []
-      }
-    }
-  } : undefined;
-};
+exports.createCustomTestJobs = createCustomTestJobs;

package/dist/build/node/testJob.js

@@ -48,13 +48,15 @@ var utils_1 = require("../../utils");
 var cache_1 = require("./cache");
 var constants_1 = require("./constants");
 var yarn_1 = require("./yarn");
+var createArtifactsConfig_1 = require("../base/createArtifactsConfig");
 var createNodeTestJobs = function (context) {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
   // don't run tests after release
   if (((_a = context.commitInfo) === null || _a === void 0 ? void 0 : _a.trigger) === "taggedRelease") {
     return [];
   }
   var buildConfig = context.componentConfig.build;
+  var defaultImage = (0, runner_1.getRunnerImage)("jobs-default");
   var base = {
     variables: __assign(__assign(__assign({
       APP_PATH: context.componentConfig.dir
@@ -64,27 +66,29 @@ var createNodeTestJobs = function (context) {
     envMode: "none"
   };
   var yarnInstall = (0, yarn_1.getYarnInstall)(context);
-  var auditJob = buildConfig.audit !== false ? __assign(__assign({
+  var auditJob = buildConfig.audit !== false ? __assign(__assign(__assign({
     name: "🛡 audit"
   }, base), {
+    image: (_d = (_c = buildConfig.audit) === null || _c === void 0 ? void 0 : _c.jobImage) !== null && _d !== void 0 ? _d : defaultImage,
     cache: undefined,
-    script: __spreadArray(["cd ".concat(context.componentConfig.dir)], __read((_d = (0, utils_1.ensureArray)((_c = buildConfig.audit) === null || _c === void 0 ? void 0 : _c.command)) !== null && _d !== void 0 ? _d : [((_e = context.packageManagerInfo) === null || _e === void 0 ? void 0 : _e.isClassic) ? "yarn audit" : "yarn npm audit --environment production" // yarn 2
+    script: __spreadArray(["cd ".concat(context.componentConfig.dir)], __read((_f = (0, utils_1.ensureArray)((_e = buildConfig.audit) === null || _e === void 0 ? void 0 : _e.command)) !== null && _f !== void 0 ? _f : [((_g = context.packageManagerInfo) === null || _g === void 0 ? void 0 : _g.isClassic) ? "yarn audit" : "yarn npm audit --environment production" // yarn 2
     ]), false),
     allow_failure: true
-  }) : null;
-  var lintJob = buildConfig.lint !== false ? __assign(__assign({
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.componentConfig.dir, (_h = buildConfig.audit) === null || _h === void 0 ? void 0 : _h.artifactsReports, (_j = buildConfig.audit) === null || _j === void 0 ? void 0 : _j.artifacts)) : null;
+  var lintJob = buildConfig.lint !== false ? __assign(__assign(__assign({
     name: "👮 lint"
   }, base), {
+    image: (_l = (_k = buildConfig.lint) === null || _k === void 0 ? void 0 : _k.jobImage) !== null && _l !== void 0 ? _l : defaultImage,
     cache: (0, cache_1.getNodeCache)(context),
-    script: __spreadArray(__spreadArray(["cd ".concat(context.componentConfig.dir)], __read(yarnInstall), false), __read((_g = (0, utils_1.ensureArray)((_f = buildConfig.lint) === null || _f === void 0 ? void 0 : _f.command)) !== null && _g !== void 0 ? _g : ["yarn lint"]), false)
-  }) : null;
-  var testJob = buildConfig.test !== false ? __assign(__assign({
+    script: __spreadArray(__spreadArray(["cd ".concat(context.componentConfig.dir)], __read(yarnInstall), false), __read((_o = (0, utils_1.ensureArray)((_m = buildConfig.lint) === null || _m === void 0 ? void 0 : _m.command)) !== null && _o !== void 0 ? _o : ["yarn lint"]), false)
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.componentConfig.dir, (_p = buildConfig.lint) === null || _p === void 0 ? void 0 : _p.artifactsReports, (_q = buildConfig.lint) === null || _q === void 0 ? void 0 : _q.artifacts)) : null;
+  var testJob = buildConfig.test !== false ? __assign(__assign(__assign({
     name: "🧪 test"
   }, base), {
-    image: (0, runner_1.getRunnerImage)("jobs-testing-chrome"),
+    image: (_s = (_r = buildConfig.test) === null || _r === void 0 ? void 0 : _r.jobImage) !== null && _s !== void 0 ? _s : (0, runner_1.getRunnerImage)("jobs-testing-chrome"),
     cache: (0, cache_1.getNodeCache)(context),
-    script: __spreadArray(__spreadArray(["cd ".concat(context.componentConfig.dir)], __read(yarnInstall), false), __read((_j = (0, utils_1.ensureArray)((_h = buildConfig.test) === null || _h === void 0 ? void 0 : _h.command)) !== null && _j !== void 0 ? _j : ["yarn test"]), false)
-  }) : null;
+    script: __spreadArray(__spreadArray(["cd ".concat(context.componentConfig.dir)], __read(yarnInstall), false), __read((_u = (0, utils_1.ensureArray)((_t = buildConfig.test) === null || _t === void 0 ? void 0 : _t.command)) !== null && _u !== void 0 ? _u : ["yarn test"]), false)
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.componentConfig.dir, (_v = buildConfig.test) === null || _v === void 0 ? void 0 : _v.artifactsReports, (_w = buildConfig.test) === null || _w === void 0 ? void 0 : _w.artifacts)) : null;
   return [auditJob, lintJob, testJob].filter(utils_1.notNil);
 };
 exports.createNodeTestJobs = createNodeTestJobs;

package/dist/build/types.d.ts

@@ -1,4 +1,4 @@
-import type { EnvVars, GitlabJobImage, GitlabJobService } from "../types";
+import type { Artifacts, EnvVars, GitlabJobImage, GitlabJobService } from "../types";
 import type { CatladderJob } from "../types/jobs";
 export declare type BuildConfigArtifactsReports = {
   /**
@@ -9,6 +9,21 @@ export declare type BuildConfigArtifactsReports = {
    */
   junit?: string[];
 };
+export declare type TestJobCustom = {
+  command?: string | string[];
+  jobImage?: GitlabJobImage;
+  /**
+   * additional CI/CD artifacts reports,
+   * use to display information in merge requests, pipeline views and security dashboards.
+   */
+  artifactsReports?: BuildConfigArtifactsReports;
+  /**
+   * GitLab {@link Artifacts} configuration.
+   *
+   * {@link TestJobCustom.artifacts}.reports.junit is merged with {@link TestJobCustom.artifactsReports} in case both given.
+   */
+  artifacts?: Artifacts;
+};
 export declare type BuildConfigBase = {
   /**
    * command to run on the image to start the app (e.g. yarn start)
@@ -33,30 +48,35 @@ export declare type BuildConfigBase = {
    * customize docker build
    */
   docker?: {
+    /**
+     * Custom Dockerfile lines integrated in the generated Dockerfile before the standard build steps.
+     *
+     * - [runner-images/docker-build/scripts/ensureNodeDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureNodeDockerfile)
+     * - [runner-images/docker-build/scripts/ensureNginxDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureNginxDockerfile)
+     * - [runner-images/docker-build/scripts/ensureMeteorDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureMeteorDockerfile)
+     */
     additionsBegin?: string[];
+    /**
+     * Custom Dockerfile lines integrated in the generated Dockerfile after the standard build steps.
+     *
+     * - [runner-images/docker-build/scripts/ensureNodeDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureNodeDockerfile)
+     * - [runner-images/docker-build/scripts/ensureNginxDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureNginxDockerfile)
+     * - [runner-images/docker-build/scripts/ensureMeteorDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureMeteorDockerfile)
+     */
     additionsEnd?: string[];
   };
   /**
    * customize lint, set false to disable
    */
-  lint?: false | {
-    command?: string | string[];
-    jobImage?: GitlabJobImage;
-  };
+  lint?: false | TestJobCustom;
   /**
    * customize test, set false to disable
    */
-  test?: false | {
-    command?: string | string[];
-    jobImage?: GitlabJobImage;
-  };
+  test?: false | TestJobCustom;
   /**
    * customize audit, set false to disable
    */
-  audit?: false | {
-    command?: string | string[];
-    jobImage?: GitlabJobImage;
-  };
+  audit?: false | TestJobCustom;
   /**
    * additional paths for artifacts,
    * by default "dist" and ".next" are allways included
@@ -116,44 +136,23 @@ export declare type BuildConfigCustomDocker = BuildConfigBase["docker"] & ({
 export declare type BuildConfigCustom = Omit<BuildConfigBase, "lint" | "test" | "audit"> & {
   type: "custom";
   jobImage: GitlabJobImage;
+  /**
+   * {@link GitlabJobService}s used in lint, test, audit, and build jobs.
+   */
   jobServices?: GitlabJobService[];
   docker: BuildConfigCustomDocker;
   /**
    * custom lint, disabled when not set
    */
-  lint?: {
-    command?: string | string[];
-    jobImage?: GitlabJobImage;
-    /**
-     * additional CI/CD artifacts reports,
-     * use to display information in merge requests, pipeline views and security dashboards.
-     */
-    artifactsReports?: BuildConfigArtifactsReports;
-  };
+  lint?: TestJobCustom;
   /**
    * custom test, disabled when not set
    */
-  test?: {
-    command?: string | string[];
-    jobImage?: GitlabJobImage;
-    /**
-     * additional CI/CD artifacts reports,
-     * use to display information in merge requests, pipeline views and security dashboards.
-     */
-    artifactsReports?: BuildConfigArtifactsReports;
-  };
+  test?: TestJobCustom;
   /**
    * custom audit, disabled when not set
    */
-  audit?: {
-    command?: string | string[];
-    jobImage?: GitlabJobImage;
-    /**
-     * additional CI/CD artifacts reports,
-     * use to display information in merge requests, pipeline views and security dashboards.
-     */
-    artifactsReports?: BuildConfigArtifactsReports;
-  };
+  audit?: TestJobCustom;
   /**
    * custom sbom (software bill of materials), set false to disable
    */