@catladder/pipeline 3.30.5 → 3.32.0

package/dist/build/custom/testJob.js

@@ -55,7 +55,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;
+  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
   // TODO: this will be replaced by using rules
   if (context.trigger === "taggedRelease") {
@@ -69,7 +69,6 @@ var createCustomTestJobs = function (context) {
     variables: __assign({
       APP_PATH: context.build.dir
     }, context.environment.jobOnlyVars.build.envVars),
-    runnerVariables: RUNNER_CUSTOM_TEST_VARIABLES,
     services: buildConfig.jobServices,
     cache: (0, createJobCache_1.createJobCacheFromConfig)(context, buildConfig),
     stage: "test",
@@ -78,23 +77,26 @@ var createCustomTestJobs = function (context) {
   var auditJob = buildConfig.audit ? __assign(__assign(__assign({
     name: "🛡 audit"
   }, base), {
-    image: (_b = (_a = buildConfig.audit) === null || _a === void 0 ? void 0 : _a.jobImage) !== null && _b !== void 0 ? _b : buildConfig.jobImage,
+    runnerVariables: __assign(__assign({}, RUNNER_CUSTOM_TEST_VARIABLES), (_b = (_a = buildConfig.audit) === null || _a === void 0 ? void 0 : _a.runnerVariables) !== null && _b !== void 0 ? _b : {}),
+    image: (_d = (_c = buildConfig.audit) === null || _c === void 0 ? void 0 : _c.jobImage) !== null && _d !== void 0 ? _d : buildConfig.jobImage,
     cache: undefined,
-    script: __spreadArray([], __read((0, utils_1.ensureArray)((_c = buildConfig.audit) === null || _c === void 0 ? void 0 : _c.command)), false),
+    script: __spreadArray([], __read((0, utils_1.ensureArray)((_e = buildConfig.audit) === null || _e === void 0 ? void 0 : _e.command)), false),
     allow_failure: true
-  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, (_d = buildConfig.audit) === null || _d === void 0 ? void 0 : _d.artifactsReports, (_e = buildConfig.audit) === null || _e === void 0 ? void 0 : _e.artifacts)) : null;
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, (_f = buildConfig.audit) === null || _f === void 0 ? void 0 : _f.artifactsReports, (_g = buildConfig.audit) === null || _g === void 0 ? void 0 : _g.artifacts)) : null;
   var lintJob = buildConfig.lint ? __assign(__assign(__assign({
     name: "👮 lint"
   }, base), {
-    image: (_g = (_f = buildConfig.lint) === null || _f === void 0 ? void 0 : _f.jobImage) !== null && _g !== void 0 ? _g : buildConfig.jobImage,
-    script: __spreadArray([], __read((0, utils_1.ensureArray)((_h = buildConfig.lint) === null || _h === void 0 ? void 0 : _h.command)), false)
-  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, (_j = buildConfig.lint) === null || _j === void 0 ? void 0 : _j.artifactsReports, (_k = buildConfig.lint) === null || _k === void 0 ? void 0 : _k.artifacts)) : null;
+    runnerVariables: __assign(__assign({}, RUNNER_CUSTOM_TEST_VARIABLES), (_j = (_h = buildConfig.lint) === null || _h === void 0 ? void 0 : _h.runnerVariables) !== null && _j !== void 0 ? _j : {}),
+    image: (_l = (_k = buildConfig.lint) === null || _k === void 0 ? void 0 : _k.jobImage) !== null && _l !== void 0 ? _l : buildConfig.jobImage,
+    script: __spreadArray([], __read((0, utils_1.ensureArray)((_m = buildConfig.lint) === null || _m === void 0 ? void 0 : _m.command)), false)
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.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: (_m = (_l = buildConfig.test) === null || _l === void 0 ? void 0 : _l.jobImage) !== null && _m !== void 0 ? _m : buildConfig.jobImage,
-    script: __spreadArray([], __read((0, utils_1.ensureArray)((_o = buildConfig.test) === null || _o === void 0 ? void 0 : _o.command)), false)
-  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, (_p = buildConfig.test) === null || _p === void 0 ? void 0 : _p.artifactsReports, (_q = buildConfig.test) === null || _q === void 0 ? void 0 : _q.artifacts)) : null;
+    runnerVariables: __assign(__assign({}, RUNNER_CUSTOM_TEST_VARIABLES), (_r = (_q = buildConfig.test) === null || _q === void 0 ? void 0 : _q.runnerVariables) !== null && _r !== void 0 ? _r : {}),
+    image: (_t = (_s = buildConfig.test) === null || _s === void 0 ? void 0 : _s.jobImage) !== null && _t !== void 0 ? _t : buildConfig.jobImage,
+    script: __spreadArray([], __read((0, utils_1.ensureArray)((_u = buildConfig.test) === null || _u === void 0 ? void 0 : _u.command)), false)
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.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.createCustomTestJobs = createCustomTestJobs;

package/dist/build/docker.d.ts

@@ -64,6 +64,6 @@ export declare const createDockerBuildJobBase: (context: ComponentContextWithBui
   ...def
 }: DockerBuildJobDefinition) => CatladderJob;
 export declare const gitlabDockerLogin: (context: ComponentContext) => string[];
-export declare const getDockerBuildScriptWithBuiltInDockerFile: (context: ComponentContextWithBuild, defaultType?: BuildConfigDocker["type"]) => (string | undefined)[];
+export declare const getDockerBuildScriptWithBuiltInDockerFile: (context: ComponentContextWithBuild, fallbackType?: BuildConfigDocker["type"]) => (string | undefined)[];
 export declare const getDockerBuildDefaultScript: (context: ComponentContext, ensureDockerFileScript?: string | null) => (string | undefined)[];
 export declare const hasDockerfile: (context: ComponentContext) => boolean;

package/dist/build/docker.js

@@ -168,10 +168,22 @@ var BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS = {
   nginx: "ensureNginxDockerfile",
   custom: null
 };
-var getDockerBuildScriptWithBuiltInDockerFile = function (context, defaultType) {
-  var _a;
-  var type = "docker" in context.build.config && context.build.config.docker && "type" in context.build.config.docker ? (_a = context.build.config.docker) === null || _a === void 0 ? void 0 : _a.type : defaultType;
-  return (0, exports.getDockerBuildDefaultScript)(context, type ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[type] : null);
+var getEnsureDockerFileScript = function (context, fallbackType) {
+  var _a, _b, _c, _d, _e, _f;
+  if ("docker" in context.build.config && context.build.config.docker && "type" in context.build.config.docker) {
+    if (((_a = context.build.config.docker) === null || _a === void 0 ? void 0 : _a.type) === "custom") {
+      if ((_b = context.build.config.docker) === null || _b === void 0 ? void 0 : _b.dockerfileContent) {
+        // we need to create a script that creates a Dockerfile in the current directory
+        return "\necho \"Creating Dockerfile\"\ncat >$APP_DIR/Dockerfile <<EOF\n".concat((_d = (_c = context.build.config.docker) === null || _c === void 0 ? void 0 : _c.dockerfileContent) === null || _d === void 0 ? void 0 : _d.join("\n"), "\nEOF");
+      }
+    }
+    var type = (_f = (_e = context.build.config.docker) === null || _e === void 0 ? void 0 : _e.type) !== null && _f !== void 0 ? _f : fallbackType;
+    return type ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[type] : null;
+  }
+  return fallbackType ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[fallbackType] : null;
+};
+var getDockerBuildScriptWithBuiltInDockerFile = function (context, fallbackType) {
+  return (0, exports.getDockerBuildDefaultScript)(context, getEnsureDockerFileScript(context, fallbackType));
 };
 exports.getDockerBuildScriptWithBuiltInDockerFile = getDockerBuildScriptWithBuiltInDockerFile;
 var getDockerBuildDefaultScript = function (context, ensureDockerFileScript) {

package/dist/build/node/testJob.js

@@ -54,7 +54,7 @@ var constants_1 = require("./constants");
 var yarn_1 = require("./yarn");
 var createJobCache_1 = require("../cache/createJobCache");
 var createNodeTestJobs = function (context) {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z;
   // don't run tests after release
   // TODO: this will be replaced by using rules
   if (context.trigger === "taggedRelease") {
@@ -69,7 +69,6 @@ var createNodeTestJobs = function (context) {
     variables: __assign({
       APP_PATH: context.build.dir
     }, context.type === "component" ? __assign({}, context.environment.jobOnlyVars.build.envVars) : {}),
-    runnerVariables: constants_1.NODE_RUNNER_BUILD_VARIABLES,
     stage: "test",
     needs: []
   };
@@ -78,26 +77,29 @@ var createNodeTestJobs = function (context) {
   var auditJob = buildConfig.audit !== false ? __assign(__assign(__assign({
     name: "🛡 audit"
   }, base), {
-    image: (_b = (_a = buildConfig.audit) === null || _a === void 0 ? void 0 : _a.jobImage) !== null && _b !== void 0 ? _b : defaultImage,
+    runnerVariables: __assign(__assign({}, constants_1.NODE_RUNNER_BUILD_VARIABLES), (_b = (_a = buildConfig.audit) === null || _a === void 0 ? void 0 : _a.runnerVariables) !== null && _b !== void 0 ? _b : {}),
+    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.build.dir)], __read((_d = (0, utils_1.ensureArrayOrNull)((_c = buildConfig.audit) === null || _c === void 0 ? void 0 : _c.command)) !== null && _d !== void 0 ? _d : [context.packageManagerInfo.isClassic ? "yarn audit" : "yarn npm audit --environment production" // yarn 2
+    script: __spreadArray(["cd ".concat(context.build.dir)], __read((_f = (0, utils_1.ensureArrayOrNull)((_e = buildConfig.audit) === null || _e === void 0 ? void 0 : _e.command)) !== null && _f !== void 0 ? _f : [context.packageManagerInfo.isClassic ? "yarn audit" : "yarn npm audit --environment production" // yarn 2
     ]), false),
     allow_failure: true
-  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, (_e = buildConfig.audit) === null || _e === void 0 ? void 0 : _e.artifactsReports, (_f = buildConfig.audit) === null || _f === void 0 ? void 0 : _f.artifacts)) : null;
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.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 !== false ? __assign(__assign(__assign({
     name: "👮 lint"
   }, base), {
-    image: (_h = (_g = buildConfig.lint) === null || _g === void 0 ? void 0 : _g.jobImage) !== null && _h !== void 0 ? _h : defaultImage,
+    runnerVariables: __assign(__assign({}, constants_1.NODE_RUNNER_BUILD_VARIABLES), (_k = (_j = buildConfig.lint) === null || _j === void 0 ? void 0 : _j.runnerVariables) !== null && _k !== void 0 ? _k : {}),
+    image: (_m = (_l = buildConfig.lint) === null || _l === void 0 ? void 0 : _l.jobImage) !== null && _m !== void 0 ? _m : defaultImage,
     cache: (0, createJobCache_1.createJobCacheFromCacheConfigs)(context, (0, cache_1.getNodeCache)(context)),
-    script: __spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read((0, yarn_1.ensureNodeVersion)(context)), false), ["cd ".concat(context.build.dir)], false), __read(yarnInstall), false), __read((_k = (0, utils_1.ensureArrayOrNull)((_j = buildConfig.lint) === null || _j === void 0 ? void 0 : _j.command)) !== null && _k !== void 0 ? _k : ["yarn lint"]), false)
-  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, (_l = buildConfig.lint) === null || _l === void 0 ? void 0 : _l.artifactsReports, (_m = buildConfig.lint) === null || _m === void 0 ? void 0 : _m.artifacts)) : null;
+    script: __spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read((0, yarn_1.ensureNodeVersion)(context)), false), ["cd ".concat(context.build.dir)], false), __read(yarnInstall), false), __read((_p = (0, utils_1.ensureArrayOrNull)((_o = buildConfig.lint) === null || _o === void 0 ? void 0 : _o.command)) !== null && _p !== void 0 ? _p : ["yarn lint"]), false)
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, (_q = buildConfig.lint) === null || _q === void 0 ? void 0 : _q.artifactsReports, (_r = buildConfig.lint) === null || _r === void 0 ? void 0 : _r.artifacts)) : null;
   var testJob = buildConfig.test !== false ? __assign(__assign(__assign({
     name: "🧪 test"
   }, base), {
-    image: (_p = (_o = buildConfig.test) === null || _o === void 0 ? void 0 : _o.jobImage) !== null && _p !== void 0 ? _p : (0, runner_1.getRunnerImage)("jobs-testing-chrome"),
+    runnerVariables: __assign(__assign({}, constants_1.NODE_RUNNER_BUILD_VARIABLES), (_t = (_s = buildConfig.test) === null || _s === void 0 ? void 0 : _s.runnerVariables) !== null && _t !== void 0 ? _t : {}),
+    image: (_v = (_u = buildConfig.test) === null || _u === void 0 ? void 0 : _u.jobImage) !== null && _v !== void 0 ? _v : (0, runner_1.getRunnerImage)("jobs-testing-chrome"),
     cache: (0, createJobCache_1.createJobCacheFromCacheConfigs)(context, (0, cache_1.getNodeCache)(context)),
-    script: __spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read((0, yarn_1.ensureNodeVersion)(context)), false), ["cd ".concat(context.build.dir)], false), __read(yarnInstall), false), __read((_r = (0, utils_1.ensureArrayOrNull)((_q = buildConfig.test) === null || _q === void 0 ? void 0 : _q.command)) !== null && _r !== void 0 ? _r : ["yarn test"]), false)
-  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, (_s = buildConfig.test) === null || _s === void 0 ? void 0 : _s.artifactsReports, (_t = buildConfig.test) === null || _t === void 0 ? void 0 : _t.artifacts)) : null;
+    script: __spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read((0, yarn_1.ensureNodeVersion)(context)), false), ["cd ".concat(context.build.dir)], false), __read(yarnInstall), false), __read((_x = (0, utils_1.ensureArrayOrNull)((_w = buildConfig.test) === null || _w === void 0 ? void 0 : _w.command)) !== null && _x !== void 0 ? _x : ["yarn test"]), false)
+  }), (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, (_y = buildConfig.test) === null || _y === void 0 ? void 0 : _y.artifactsReports, (_z = buildConfig.test) === null || _z === void 0 ? void 0 : _z.artifacts)) : null;
   return [auditJob, lintJob, testJob].filter(utils_1.notNil);
 };
 exports.createNodeTestJobs = createNodeTestJobs;

package/dist/build/types.d.ts

@@ -62,6 +62,10 @@ 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 = {
   /**
@@ -196,6 +200,15 @@ 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 = BuildConfigDockerBuiltIn | BuildConfigDockerCustom;
 export type BuildConfigCustom = Omit<BuildConfigBase, "lint" | "test" | "audit"> & {
@@ -329,7 +342,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/dist/config/readConfig.js

@@ -151,13 +151,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.readConfig = void 0;
 var fs_1 = require("fs");
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 var tsx = require("tsx/cjs/api");
 var yaml_1 = require("yaml");
 // allows us to load ts files
 var fullPath = function (directory, ext) {
   return directory + "/catladder." + ext;
 };
-var readConfig = function () {
+var readConfigInternal = function () {
   var args_1 = [];
   for (var _i = 0; _i < arguments.length; _i++) {
     args_1[_i] = arguments[_i];
@@ -199,4 +200,32 @@ var readConfig = function () {
     });
   });
 };
+var readConfig = function () {
+  var args_1 = [];
+  for (var _i = 0; _i < arguments.length; _i++) {
+    args_1[_i] = arguments[_i];
+  }
+  return __awaiter(void 0, __spreadArray([], __read(args_1), false), void 0, function (directory) {
+    var error_1;
+    if (directory === void 0) {
+      directory = process.cwd();
+    }
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          _a.trys.push([0, 2,, 3]);
+          return [4 /*yield*/, readConfigInternal(directory)];
+        case 1:
+          return [2 /*return*/, _a.sent()];
+        case 2:
+          error_1 = _a.sent();
+          console.error("Error reading config in ".concat(directory, ":"), error_1);
+          console.error("\nThis may happen due to various reasons:\n  - Syntax errors in your catladder.ts file\n  - tsx (the TypeScript loader used by catladder) needs to understand the syntax in your project.\n    If your project uses newer TypeScript/JavaScript syntax, you may need to update catladder\n    to get a newer version of tsx that supports it.\n  - Missing or incorrect dependencies in your project\n  - TypeScript configuration issues in your tsconfig.json\n");
+          return [2 /*return*/, null];
+        case 3:
+          return [2 /*return*/];
+      }
+    });
+  });
+};
 exports.readConfig = readConfig;

package/dist/constants.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DOCKER_REGISTRY = exports.PIPELINE_IMAGE_TAG = void 0;
-exports.PIPELINE_IMAGE_TAG = "v3-30-5-116bf090" || "latest";
+exports.PIPELINE_IMAGE_TAG = "v3-32-0-6cdca903" || "latest";
 exports.DOCKER_REGISTRY = "git.panter.ch:5001/catladder/catladder" || "git.panter.ch:5001/catladder/catladder";