@catladder/pipeline 1.101.4 → 1.103.0

package/dist/constants.js

@@ -2,5 +2,5 @@
 
 exports.__esModule = true;
 exports.DOCKER_REGISTRY = exports.PIPELINE_IMAGE_TAG = void 0;
-exports.PIPELINE_IMAGE_TAG = "v1-101-4-692356fd" || "";
+exports.PIPELINE_IMAGE_TAG = "v1-103-0-dd05e19b" || "";
 exports.DOCKER_REGISTRY = "git.panter.ch:5001/catladder/catladder" || "";

package/dist/context/getEnvironment.js

@@ -1,5 +1,15 @@
 "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 __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
   function adopt(value) {
     return value instanceof P ? value : new P(function (resolve) {
@@ -121,30 +131,26 @@ var getEnvironmentContext_1 = require("./getEnvironmentContext");
 var getEnvironmentVariables_1 = require("./getEnvironmentVariables");
 var getEnvironment = function (config, componentName, env, commitInfo) {
   return __awaiter(void 0, void 0, void 0, function () {
-    var _a, envVars, secretEnvVarKeys, host, url, envContext, envType;
-    return __generator(this, function (_b) {
-      switch (_b.label) {
+    var variables, envContext, envType;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
         case 0:
           return [4 /*yield*/, (0, getEnvironmentVariables_1.getEnvironmentVariables)(config, componentName, env, commitInfo)];
         case 1:
-          _a = _b.sent(), envVars = _a.envVars, secretEnvVarKeys = _a.secretEnvVarKeys, host = _a.host, url = _a.url;
+          variables = _a.sent();
           envContext = (0, getEnvironmentContext_1.getEnvironmentContext)(config, env, componentName, commitInfo);
           envType = envContext.envType;
-          return [2 /*return*/, {
+          return [2 /*return*/, __assign({
             envType: envType,
-            host: host,
-            url: url,
             gitlabEnvironment: {
               name: envContext.gitlabEnvironmentName,
-              url: url
+              url: variables.url
             },
             fullName: envContext.fullName,
             slugPrefix: envContext.environmentSlugPrefix,
             slug: envContext.environmentSlug,
-            shortName: env,
-            envVars: envVars,
-            secretEnvVarKeys: secretEnvVarKeys
-          }];
+            shortName: env
+          }, variables)];
       }
     });
   });

package/dist/context/getEnvironmentVariables.d.ts

@@ -1,14 +1,9 @@
-import type { CommitInfo, Context } from "../types";
+import type { CommitInfo, Context, EnvironmentEnvVarPart as EnvironmentVariables } from "../types";
 import type { Config } from "../types/config";
 export declare type SecretEnvVar = {
   key: string;
   hidden?: boolean;
 };
-export declare const getEnvironmentVariables: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined, alreadyVisited?: Record<string, Record<string, boolean>>) => Promise<{
-  envVars: Record<string, string>;
-  secretEnvVarKeys: SecretEnvVar[];
-  host: string;
-  url: string;
-}>;
+export declare const getEnvironmentVariables: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined, alreadyVisited?: Record<string, Record<string, boolean>>) => Promise<EnvironmentVariables>;
 export declare const getSecretVarName: (env: string, componentName: string, key: string) => string;
 export declare const getSecretVarNameForContext: (context: Context, key: string) => string;

package/dist/context/getEnvironmentVariables.js

@@ -162,19 +162,22 @@ var lodash_1 = require("lodash");
 var deploy_1 = require("../deploy");
 var getEnvironmentContext_1 = require("./getEnvironmentContext");
 var resolveReferences_1 = require("./resolveReferences");
+var envVars_1 = require("./utils/envVars");
+var transformJobOnlyVars_1 = require("./transformJobOnlyVars");
 var getEnvironmentVariables = function (config, componentName, env, commitInfo, alreadyVisited // to prevent endless loop
 ) {
   if (alreadyVisited === void 0) {
     alreadyVisited = {};
   }
   return __awaiter(void 0, void 0, void 0, function () {
-    var environmentContext, envConfigRaw, deployConfigRaw, envType, basePredefinedVariables, predefinedVariables, host, url, devLocalConfig, port, additionalEnvVars, publicEnvVarsRaw, additionalSecretKeys, secretEnvVarKeys, secretEnvVars, legacyFromComponents, publicEnvVarsRawWithLegasyFromComponents, publicEnvVarsRawSanitized, envVarsRaw, envVars;
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-    return __generator(this, function (_k) {
-      switch (_k.label) {
+    var environmentContext, envConfigRaw, deployConfigRaw, buildConfigRaw, envType, basePredefinedVariables, predefinedVariables, host, url, devLocalConfig, port, additionalEnvVars, publicEnvVarsRaw, additionalSecretKeys, secretEnvVarKeys, secretEnvVars, legacyFromComponents, publicEnvVarsRawWithLegacyFromComponents, publicEnvVarsRawSanitized, envVarsRaw, envVars;
+    var _a, _b;
+    var _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    return __generator(this, function (_m) {
+      switch (_m.label) {
         case 0:
           environmentContext = (0, getEnvironmentContext_1.getEnvironmentContext)(config, env, componentName, commitInfo);
-          envConfigRaw = environmentContext.envConfigRaw, deployConfigRaw = environmentContext.deployConfigRaw, envType = environmentContext.envType;
+          envConfigRaw = environmentContext.envConfigRaw, deployConfigRaw = environmentContext.deployConfigRaw, buildConfigRaw = environmentContext.buildConfigRaw, envType = environmentContext.envType;
           basePredefinedVariables = {
             ENV_SHORT: env,
             APP_DIR: envConfigRaw.dir,
@@ -185,7 +188,7 @@ var getEnvironmentVariables = function (config, componentName, env, commitInfo,
           };
           if (envType === "local") {
             devLocalConfig = envConfigRaw;
-            port = (_a = devLocalConfig.port) !== null && _a !== void 0 ? _a : 3000;
+            port = (_c = devLocalConfig.port) !== null && _c !== void 0 ? _c : 3000;
             host = "localhost:" + port;
             url = "http://" + host;
             predefinedVariables = {
@@ -195,7 +198,7 @@ var getEnvironmentVariables = function (config, componentName, env, commitInfo,
             };
           } else {
             additionalEnvVars = deployConfigRaw ? deploy_1.DEPLOY_TYPES[deployConfigRaw.type].getAdditionalEnvVars(environmentContext) : {};
-            host = (_c = (_b = envConfigRaw === null || envConfigRaw === void 0 ? void 0 : envConfigRaw.host) !== null && _b !== void 0 ? _b : additionalEnvVars.HOST_CANONICAL) !== null && _c !== void 0 ? _c : "unknown-host.example.com";
+            host = (_e = (_d = envConfigRaw === null || envConfigRaw === void 0 ? void 0 : envConfigRaw.host) !== null && _d !== void 0 ? _d : additionalEnvVars.HOST_CANONICAL) !== null && _e !== void 0 ? _e : "unknown-host.example.com";
             url = "https://".concat(host);
             predefinedVariables = __assign(__assign(__assign(__assign({}, basePredefinedVariables), config.components[componentName].build.type === "rails" ? {} : {
               HOST: host
@@ -203,25 +206,13 @@ var getEnvironmentVariables = function (config, componentName, env, commitInfo,
               ROOT_URL: url
             }), additionalEnvVars);
           }
-          publicEnvVarsRaw = (_e = (_d = envConfigRaw.vars) === null || _d === void 0 ? void 0 : _d.public) !== null && _e !== void 0 ? _e : {};
+          publicEnvVarsRaw = (_g = (_f = envConfigRaw.vars) === null || _f === void 0 ? void 0 : _f.public) !== null && _g !== void 0 ? _g : {};
           additionalSecretKeys = deployConfigRaw ? deploy_1.DEPLOY_TYPES[deployConfigRaw.type].additionalSecretKeys(environmentContext) : [];
-          secretEnvVarKeys = __spreadArray(__spreadArray([], __read(((_g = (_f = envConfigRaw.vars) === null || _f === void 0 ? void 0 : _f.secret) !== null && _g !== void 0 ? _g : []).map(function (key) {
-            return {
-              key: key
-            };
-          })), false), __read(additionalSecretKeys), false);
-          secretEnvVars = Object.fromEntries(secretEnvVarKeys.map(function (_a) {
-            var key = _a.key;
-            return [key, "$".concat((0, exports.getSecretVarName)(env, componentName, key))];
-          }));
-          legacyFromComponents = (_j = (_h = envConfigRaw.vars) === null || _h === void 0 ? void 0 : _h.fromComponents) !== null && _j !== void 0 ? _j : {};
-          publicEnvVarsRawWithLegasyFromComponents = (0, lodash_1.merge)({}, (0, resolveReferences_1.translateLegacyFromComponents)(legacyFromComponents), publicEnvVarsRaw);
-          publicEnvVarsRawSanitized = Object.fromEntries(Object.entries(publicEnvVarsRawWithLegasyFromComponents).map(function (_a) {
-            var _b = __read(_a, 2),
-              key = _b[0],
-              value = _b[1];
-            return [key, (0, lodash_1.isObject)(value) ? JSON.stringify(value) : "".concat(value)];
-          }));
+          secretEnvVarKeys = __spreadArray(__spreadArray([], __read((0, envVars_1.stringListToSecreteEnvVarList)((_j = (_h = envConfigRaw.vars) === null || _h === void 0 ? void 0 : _h.secret) !== null && _j !== void 0 ? _j : [])), false), __read(additionalSecretKeys), false);
+          secretEnvVars = (0, envVars_1.makeSecretEnvVarMapping)(env, componentName, secretEnvVarKeys);
+          legacyFromComponents = (_l = (_k = envConfigRaw.vars) === null || _k === void 0 ? void 0 : _k.fromComponents) !== null && _l !== void 0 ? _l : {};
+          publicEnvVarsRawWithLegacyFromComponents = (0, lodash_1.merge)({}, (0, resolveReferences_1.translateLegacyFromComponents)(legacyFromComponents), publicEnvVarsRaw);
+          publicEnvVarsRawSanitized = (0, envVars_1.stringifyValues)(publicEnvVarsRawWithLegacyFromComponents);
           envVarsRaw = addIndexVar(__assign(__assign(__assign({}, predefinedVariables), secretEnvVars), publicEnvVarsRawSanitized));
           return [4 /*yield*/, (0, resolveReferences_1.resolveReferences)(envVarsRaw, function (otherComponentName, alreadyVisited) {
             return __awaiter(void 0, void 0, void 0, function () {
@@ -238,13 +229,18 @@ var getEnvironmentVariables = function (config, componentName, env, commitInfo,
             });
           }, alreadyVisited)];
         case 1:
-          envVars = _k.sent();
-          return [2 /*return*/, {
+          envVars = _m.sent();
+          _a = {
             envVars: envVars,
-            secretEnvVarKeys: secretEnvVarKeys,
-            host: host,
-            url: url
-          }];
+            secretEnvVarKeys: secretEnvVarKeys
+          };
+          _b = {};
+          return [4 /*yield*/, (0, transformJobOnlyVars_1.transformJobOnlyVars)(env, componentName, buildConfigRaw && buildConfigRaw.jobVars || null)];
+        case 2:
+          _b.build = _m.sent();
+          return [4 /*yield*/, (0, transformJobOnlyVars_1.transformJobOnlyVars)(env, componentName, deployConfigRaw && deployConfigRaw.jobVars || null)];
+        case 3:
+          return [2 /*return*/, (_a.jobOnlyVars = (_b.deploy = _m.sent(), _b), _a.host = host, _a.url = url, _a)];
       }
     });
   });

package/dist/context/transformJobOnlyVars.d.ts

@@ -0,0 +1,10 @@
+import type { EnvironmentEnvVars } from "..";
+import type { EnvVars } from "../types/config";
+/**
+ * transform EnvVars for environment.
+ *
+ * currently does not resolve references and is only used for additional job-only-vars
+ * @param vars
+ * @returns
+ */
+export declare const transformJobOnlyVars: (env: string, componentName: string, vars: EnvVars | null) => Promise<EnvironmentEnvVars>;

package/dist/context/transformJobOnlyVars.js

@@ -0,0 +1,160 @@
+"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 __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
+  function adopt(value) {
+    return value instanceof P ? value : new P(function (resolve) {
+      resolve(value);
+    });
+  }
+  return new (P || (P = Promise))(function (resolve, reject) {
+    function fulfilled(value) {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+    function rejected(value) {
+      try {
+        step(generator["throw"](value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+    function step(result) {
+      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+    }
+    step((generator = generator.apply(thisArg, _arguments || [])).next());
+  });
+};
+var __generator = this && this.__generator || function (thisArg, body) {
+  var _ = {
+      label: 0,
+      sent: function () {
+        if (t[0] & 1) throw t[1];
+        return t[1];
+      },
+      trys: [],
+      ops: []
+    },
+    f,
+    y,
+    t,
+    g;
+  return g = {
+    next: verb(0),
+    "throw": verb(1),
+    "return": verb(2)
+  }, typeof Symbol === "function" && (g[Symbol.iterator] = function () {
+    return this;
+  }), g;
+  function verb(n) {
+    return function (v) {
+      return step([n, v]);
+    };
+  }
+  function step(op) {
+    if (f) throw new TypeError("Generator is already executing.");
+    while (_) try {
+      if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+      if (y = 0, t) op = [op[0] & 2, t.value];
+      switch (op[0]) {
+        case 0:
+        case 1:
+          t = op;
+          break;
+        case 4:
+          _.label++;
+          return {
+            value: op[1],
+            done: false
+          };
+        case 5:
+          _.label++;
+          y = op[1];
+          op = [0];
+          continue;
+        case 7:
+          op = _.ops.pop();
+          _.trys.pop();
+          continue;
+        default:
+          if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+            _ = 0;
+            continue;
+          }
+          if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+            _.label = op[1];
+            break;
+          }
+          if (op[0] === 6 && _.label < t[1]) {
+            _.label = t[1];
+            t = op;
+            break;
+          }
+          if (t && _.label < t[2]) {
+            _.label = t[2];
+            _.ops.push(op);
+            break;
+          }
+          if (t[2]) _.ops.pop();
+          _.trys.pop();
+          continue;
+      }
+      op = body.call(thisArg, _);
+    } catch (e) {
+      op = [6, e];
+      y = 0;
+    } finally {
+      f = t = 0;
+    }
+    if (op[0] & 5) throw op[1];
+    return {
+      value: op[0] ? op[1] : void 0,
+      done: true
+    };
+  }
+};
+exports.__esModule = true;
+exports.transformJobOnlyVars = void 0;
+var envVars_1 = require("./utils/envVars");
+/**
+ * transform EnvVars for environment.
+ *
+ * currently does not resolve references and is only used for additional job-only-vars
+ * @param vars
+ * @returns
+ */
+var transformJobOnlyVars = function (env, componentName, vars) {
+  return __awaiter(void 0, void 0, void 0, function () {
+    var publicVars, secretEnvVarKeys, deployJobOnlySecretEnvVars, envVars;
+    var _a, _b;
+    return __generator(this, function (_c) {
+      if (!vars) {
+        return [2 /*return*/, {
+          envVars: {},
+          secretEnvVarKeys: []
+        }];
+      }
+      publicVars = (0, envVars_1.stringifyValues)((_a = vars === null || vars === void 0 ? void 0 : vars.public) !== null && _a !== void 0 ? _a : {});
+      secretEnvVarKeys = (0, envVars_1.stringListToSecreteEnvVarList)((_b = vars === null || vars === void 0 ? void 0 : vars.secret) !== null && _b !== void 0 ? _b : []);
+      deployJobOnlySecretEnvVars = (vars === null || vars === void 0 ? void 0 : vars.secret) ? (0, envVars_1.makeSecretEnvVarMapping)(env, componentName, secretEnvVarKeys) : {};
+      envVars = __assign(__assign({}, deployJobOnlySecretEnvVars), publicVars);
+      return [2 /*return*/, {
+        envVars: envVars,
+        secretEnvVarKeys: secretEnvVarKeys
+      }];
+    });
+  });
+};
+exports.transformJobOnlyVars = transformJobOnlyVars;

package/dist/context/utils/envVars.d.ts

@@ -0,0 +1,8 @@
+import type { SecretEnvVar } from "../getEnvironmentVariables";
+export declare const stringifyValues: (obj: Record<string, unknown>) => {
+  [k: string]: string;
+};
+export declare const stringListToSecreteEnvVarList: (keys: string[]) => SecretEnvVar[];
+export declare const makeSecretEnvVarMapping: (env: string, componentName: string, secretEnvVars: SecretEnvVar[]) => {
+  [k: string]: string;
+};

package/dist/context/utils/envVars.js

@@ -0,0 +1,52 @@
+"use strict";
+
+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;
+};
+exports.__esModule = true;
+exports.makeSecretEnvVarMapping = exports.stringListToSecreteEnvVarList = exports.stringifyValues = void 0;
+var lodash_1 = require("lodash");
+var getEnvironmentVariables_1 = require("../getEnvironmentVariables");
+var stringifyValues = function (obj) {
+  return Object.fromEntries(Object.entries(obj).map(function (_a) {
+    var _b = __read(_a, 2),
+      key = _b[0],
+      value = _b[1];
+    return [key, (0, lodash_1.isObject)(value) ? JSON.stringify(value) : "".concat(value)];
+  }));
+};
+exports.stringifyValues = stringifyValues;
+var stringListToSecreteEnvVarList = function (keys) {
+  return keys.map(function (key) {
+    return {
+      key: key
+    };
+  });
+};
+exports.stringListToSecreteEnvVarList = stringListToSecreteEnvVarList;
+var makeSecretEnvVarMapping = function (env, componentName, secretEnvVars) {
+  return Object.fromEntries(secretEnvVars.map(function (_a) {
+    var key = _a.key;
+    return [key, "$".concat((0, getEnvironmentVariables_1.getSecretVarName)(env, componentName, key))];
+  }));
+};
+exports.makeSecretEnvVarMapping = makeSecretEnvVarMapping;

package/dist/deploy/base.js

@@ -60,7 +60,7 @@ var getBaseDeploymentJob = function (context) {
     }],
     allow_failure: whenDeploy === "manual" ? true : false,
     stage: "deploy",
-    variables: __assign(__assign(__assign(__assign({}, DEPLOY_RUNNER_VARIABLES), context.environment.envVars), hasDocker ? (0, docker_1.getDockerImageVariables)(context) : {}), context.componentConfig.deploy ? (_d = context.componentConfig.deploy.extraVars) !== null && _d !== void 0 ? _d : {} : {}),
+    variables: __assign(__assign(__assign(__assign(__assign({}, DEPLOY_RUNNER_VARIABLES), context.environment.envVars), hasDocker ? (0, docker_1.getDockerImageVariables)(context) : {}), context.environment.jobOnlyVars.deploy.envVars), context.componentConfig.deploy ? (_d = context.componentConfig.deploy.extraVars) !== null && _d !== void 0 ? _d : {} : {}),
     environment: __assign(__assign({}, context.environment.gitlabEnvironment), isStoppable ? {
       on_stop: exports.STOP_JOB_NAME,
       auto_stop_in: autoStop
@@ -82,7 +82,7 @@ var getBaseDeploymentStopJob = function (context) {
       when: "manual",
       allow_failure: true
     }],
-    variables: __assign(__assign({}, DEPLOY_RUNNER_VARIABLES), {
+    variables: __assign(__assign(__assign({}, DEPLOY_RUNNER_VARIABLES), context.environment.jobOnlyVars.deploy.envVars), {
       GIT_STRATEGY: "none"
     }),
     stage: "stop",
@@ -101,7 +101,7 @@ var getBaseRollbackJob = function (context) {
       when: "manual",
       allow_failure: true
     }],
-    variables: __assign(__assign({}, DEPLOY_RUNNER_VARIABLES), {
+    variables: __assign(__assign(__assign({}, DEPLOY_RUNNER_VARIABLES), context.environment.jobOnlyVars.deploy.envVars), {
       GIT_STRATEGY: "none"
     }),
     stage: "rollback",

package/dist/deploy/types/base.d.ts

@@ -1,3 +1,4 @@
+import type { EnvVars } from "../../types/config";
 export declare type DeployConfigBase = {
   /**
    * whether to deploy automatically or manual. If not defined, these rules apply:
@@ -14,8 +15,15 @@ export declare type DeployConfigBase = {
    * tags for the underlying job runner (e.g gitlab)
    */
   jobTags?: string[];
+  /**
+   * vars that only exist in the deploy job.
+   * Can curently not reference other variables from other components
+   */
+  jobVars?: EnvVars;
   /**
    * additional env vars for the deploy job
+   *
+   * @deprecated use deploy.jobVars for deploy job specific variables
    */
   extraVars?: Record<string, string>;
 };