@catladder/pipeline 0.0.0-fix-scripts-set-e-ae9c708f → 0.0.0-fix-values-as-files-73f39da5

package/dist/catladder-gitlab.js

@@ -25,6 +25,8 @@ var __rest = this && this.__rest || function (s, e) {
   return t;
 };
 
+var _a;
+
 exports.__esModule = true;
 
 var fs_1 = require("fs");
@@ -37,11 +39,11 @@ var constants_1 = require("./constants");
 
 var pipeline_1 = require("./pipeline");
 
-var _a = process.env,
-    CI_MERGE_REQUEST_ID = _a.CI_MERGE_REQUEST_ID,
-    CI_COMMIT_TAG = _a.CI_COMMIT_TAG,
-    CI_COMMIT_BRANCH = _a.CI_COMMIT_BRANCH,
-    CI_DEFAULT_BRANCH = _a.CI_DEFAULT_BRANCH;
+var _b = process.env,
+    CI_MERGE_REQUEST_ID = _b.CI_MERGE_REQUEST_ID,
+    CI_COMMIT_TAG = _b.CI_COMMIT_TAG,
+    CI_COMMIT_BRANCH = _b.CI_COMMIT_BRANCH,
+    CI_DEFAULT_BRANCH = _b.CI_DEFAULT_BRANCH;
 var isDefaultBranch = Boolean(CI_DEFAULT_BRANCH) && CI_COMMIT_BRANCH === CI_DEFAULT_BRANCH;
 var isHotfixBranch = false; // TODO:  $CI_COMMIT_BRANCH =~ /^[0-9]+\.([0-9]+|x)\.x$/
 
@@ -51,7 +53,7 @@ console.info("catladder version ".concat(constants_1.PIPELINE_IMAGE_TAG));
 var trigger = isMergeRequest || isHotfixBranch ? "mr" : isDefaultBranch ? "mainBranch" : isTaggedRelease ? "taggedRelease" : null;
 
 if (trigger) {
-  var config = (0, config_1.readConfigSync)();
+  var config = (_a = (0, config_1.readConfigSync)()) === null || _a === void 0 ? void 0 : _a.config;
 
   if (!config) {
     throw new Error("no catladder config found");

package/dist/config/readConfig.d.ts

@@ -1,2 +1,6 @@
 import { Config } from "../types";
-export declare const readConfigSync: (directory?: string) => Config | null;
+export declare const readConfigSync: (directory?: string) => {
+  config: Config;
+  path: string;
+  ext: string;
+} | null;

package/dist/config/readConfig.js

@@ -14,6 +14,11 @@ var fullPath = function (directory, ext) {
   return directory + "/catladder." + ext;
 };
 
+function requireUncached(module) {
+  delete require.cache[require.resolve(module)];
+  return require(module);
+}
+
 var readConfigSync = function (directory) {
   if (directory === void 0) {
     directory = process.cwd();
@@ -31,13 +36,23 @@ var readConfigSync = function (directory) {
   });
 
   if (found) {
+    var filePath = fullPath(directory, found);
+
     if (found === "ts" || found === "js") {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
-      return require(fullPath(directory, found))["default"];
+      return {
+        path: filePath,
+        ext: found,
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        config: requireUncached(filePath)["default"]
+      };
     } else {
-      return (0, js_yaml_1.load)((0, fs_1.readFileSync)(fullPath(directory, found), {
-        encoding: "utf-8"
-      }));
+      return {
+        path: filePath,
+        ext: found,
+        config: (0, js_yaml_1.load)((0, fs_1.readFileSync)(filePath, {
+          encoding: "utf-8"
+        }))
+      };
     }
   }
 

package/dist/constants.js

@@ -2,5 +2,5 @@
 
 exports.__esModule = true;
 exports.DOCKER_REGISTRY = exports.PIPELINE_IMAGE_TAG = void 0;
-exports.PIPELINE_IMAGE_TAG = "fix-scripts-set-e-ae9c708f" || "";
+exports.PIPELINE_IMAGE_TAG = "fix-values-as-files-73f39da5" || "";
 exports.DOCKER_REGISTRY = "git.panter.ch:5001/catladder/catladder" || "";

package/dist/context/index.d.ts

@@ -2,5 +2,5 @@ import { Config } from "../types/config";
 import { CommitInfo, Context, Environment } from "../types/context";
 export declare const getSecretVarName: (env: string, componentName: string, key: string) => string;
 export declare const getSecretVarNameForContext: (context: Context, key: string) => string;
-export declare const getEnvironment: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined, skipReferences?: boolean) => Environment;
+export declare const getEnvironment: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined) => Environment;
 export declare const createContext: (config: Config, componentName: string, env: string, commitInfo?: CommitInfo | undefined, packageManagerInfo?: import("../types/context").YarnPackageManagerInfo | undefined) => Context;

package/dist/context/index.js

@@ -48,6 +48,8 @@ var __importDefault = this && this.__importDefault || function (mod) {
 exports.__esModule = true;
 exports.createContext = exports.getEnvironment = exports.getSecretVarNameForContext = exports.getSecretVarName = void 0;
 
+var lodash_1 = require("lodash");
+
 var slugify_1 = __importDefault(require("slugify"));
 
 var build_1 = require("../build");
@@ -58,6 +60,8 @@ var config_1 = require("../types/config");
 
 var utils_1 = require("../utils");
 
+var resolveReferences_1 = require("./resolveReferences");
+
 var sanitizeForEnVar = function (s) {
   return s.replace(/-/g, "_");
 };
@@ -75,14 +79,9 @@ var getSecretVarNameForContext = function (context, key) {
 
 exports.getSecretVarNameForContext = getSecretVarNameForContext;
 
-var getEnvironment = function (config, componentName, env, commitInfo, skipReferences // to prevent infinit loop
-) {
+var getEnvironment = function (config, componentName, env, commitInfo) {
   var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
 
-  if (skipReferences === void 0) {
-    skipReferences = false;
-  }
-
   var componentConfig = config.components[componentName];
 
   if (!componentConfig) {
@@ -121,6 +120,7 @@ var getEnvironment = function (config, componentName, env, commitInfo, skipRefer
     host = "localhost:" + port;
     url = "http://" + host;
     predefinedVariables = {
+      ENV_SHORT: "local",
       ROOT_URL: url,
       PORT: port.toString()
     };
@@ -145,30 +145,28 @@ var getEnvironment = function (config, componentName, env, commitInfo, skipRefer
     });
   }
 
-  var publicEnvVars = (_h = (_g = mergedConfig.vars) === null || _g === void 0 ? void 0 : _g.public) !== null && _h !== void 0 ? _h : {};
+  var publicEnvVarsRaw = (_h = (_g = mergedConfig.vars) === null || _g === void 0 ? void 0 : _g.public) !== null && _h !== void 0 ? _h : {};
   var secretEnvVarKeys = (_k = (_j = mergedConfig.vars) === null || _j === void 0 ? void 0 : _j.secret) !== null && _k !== void 0 ? _k : [];
   var secretEnvVars = Object.fromEntries(secretEnvVarKeys.map(function (key) {
     return [key, "$".concat((0, exports.getSecretVarName)(env, componentName, key))];
-  }));
-  var referencedRaw = (_m = (_l = mergedConfig.vars) === null || _l === void 0 ? void 0 : _l.fromComponents) !== null && _m !== void 0 ? _m : {};
-  var referenced = skipReferences ? {} : Object.entries(referencedRaw).reduce(function (acc, _a) {
-    var _b = __read(_a, 2),
-        otherApp = _b[0],
-        mapping = _b[1];
+  })); // this is deprecated, we now support: $componentname:FOO
 
-    var envVars = (0, exports.getEnvironment)(config, otherApp, env, commitInfo, true // prevent infinit loop
-    ).envVars;
-    return __assign(__assign({}, acc), Object.fromEntries(Object.entries(mapping).map(function (_a) {
-      var _b = __read(_a, 2),
-          ourKey = _b[0],
-          otherKey = _b[1];
+  var legacyFromComponents = (_m = (_l = mergedConfig.vars) === null || _l === void 0 ? void 0 : _l.fromComponents) !== null && _m !== void 0 ? _m : {};
+  var publicEnvVarsRawWithLegasyFromComponents = (0, lodash_1.merge)({}, (0, resolveReferences_1.translateLegacyFromComponents)(legacyFromComponents), publicEnvVarsRaw);
+  var publicEnvVarsRawSanitized = Object.fromEntries(Object.entries(publicEnvVarsRawWithLegasyFromComponents).map(function (_a) {
+    var _b = __read(_a, 2),
+        key = _b[0],
+        value = _b[1];
 
-      return [ourKey, envVars[otherKey]];
-    })));
-  }, {});
+    return [key, (0, lodash_1.isObject)(value) ? JSON.stringify(value) : "".concat(value)];
+  }));
 
-  var envVars = __assign(__assign(__assign(__assign({}, predefinedVariables), secretEnvVars), referenced), publicEnvVars);
+  var envVarsRaw = __assign(__assign(__assign({}, predefinedVariables), secretEnvVars), publicEnvVarsRawSanitized);
 
+  var envVars = (0, resolveReferences_1.resolveReferences)(envVarsRaw, function (componentName, variableName) {
+    var envVars = (0, exports.getEnvironment)(config, componentName, env, commitInfo).envVars;
+    return envVars[variableName];
+  });
   return {
     envType: envType,
     host: host,

package/dist/context/resolveReferences.d.ts

@@ -0,0 +1,6 @@
+export declare const resolveReferences: (vars: Record<string, string>, getOtherVariables?: ((componentName: string, variableName: string) => string | null) | undefined) => {
+  [k: string]: string;
+};
+export declare const translateLegacyFromComponents: (fromComponents: Record<string, Record<string, string>>) => {
+  [k: string]: string;
+};

package/dist/context/resolveReferences.js

@@ -0,0 +1,88 @@
+"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.translateLegacyFromComponents = exports.resolveReferences = void 0;
+
+var lodash_1 = require("lodash");
+
+var REGEX = /\$\{(([^:]+):)?([^}]+)}/gm;
+
+var resolveReferences = function (vars, getOtherVariables) {
+  var replaceSingleValue = function (value, alreadyVisited) {
+    if (alreadyVisited === void 0) {
+      alreadyVisited = {};
+    }
+
+    if (REGEX.test(value)) {
+      return value.replace(REGEX, function (match, _, componentName, variableName) {
+        var _a, _b;
+
+        var _c, _d;
+
+        if ((_c = alreadyVisited[componentName]) === null || _c === void 0 ? void 0 : _c[variableName]) {
+          return match; // prevent endless loop
+        }
+
+        var result = componentName ? (_d = getOtherVariables === null || getOtherVariables === void 0 ? void 0 : getOtherVariables(componentName, variableName)) !== null && _d !== void 0 ? _d : null : vars[variableName]; // is self reference
+
+        var replaced = result !== null && result !== undefined ? replaceSingleValue(result, (0, lodash_1.merge)({}, alreadyVisited, (_a = {}, _a[componentName] = (_b = {}, _b[variableName] = true, _b), _a))) : match;
+        return replaced;
+      });
+    } else {
+      return value;
+    }
+  };
+
+  return Object.fromEntries(Object.entries(vars).map(function (_a) {
+    var _b = __read(_a, 2),
+        key = _b[0],
+        value = _b[1];
+
+    return [key, replaceSingleValue(value)];
+  }));
+};
+
+exports.resolveReferences = resolveReferences;
+
+var translateLegacyFromComponents = function (fromComponents) {
+  return Object.fromEntries(Object.entries(fromComponents).flatMap(function (_a) {
+    var _b = __read(_a, 2),
+        componentName = _b[0],
+        variables = _b[1];
+
+    return Object.entries(variables).map(function (_a) {
+      var _b = __read(_a, 2),
+          ourName = _b[0],
+          otherName = _b[1];
+
+      return [ourName, "${" + componentName + ":" + otherName + "}"];
+    });
+  }));
+};
+
+exports.translateLegacyFromComponents = translateLegacyFromComponents;

package/dist/context/resolveReferences.test.d.ts

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

package/dist/context/resolveReferences.test.js

@@ -0,0 +1,141 @@
+"use strict";
+
+exports.__esModule = true;
+
+var resolveReferences_1 = require("./resolveReferences");
+
+describe("resolveReferences", function () {
+  it("replaces occurences of ${componentName:VARIABLE_NAME}", function () {
+    var variables = {
+      a: "hello world",
+      b: "a replaced value looks like this: '${api:FOO}', nice!"
+    };
+    var otherVariables = {
+      api: {
+        FOO: "foo from api"
+      },
+      frontend: {
+        FOO: "foo from frontend"
+      }
+    };
+    var result = (0, resolveReferences_1.resolveReferences)(variables, function (componentName, variableName) {
+      var _a;
+
+      return (_a = otherVariables[componentName]) === null || _a === void 0 ? void 0 : _a[variableName];
+    });
+    expect(result).toEqual({
+      a: "hello world",
+      b: "a replaced value looks like this: 'foo from api', nice!"
+    });
+  });
+  it("replaces self references with structure ${VARIABLE_NAME}", function () {
+    var variables = {
+      FOO: "hello world",
+      BAR: "this: ${FOO}!"
+    };
+    var result = (0, resolveReferences_1.resolveReferences)(variables);
+    expect(result).toEqual({
+      FOO: "hello world",
+      BAR: "this: hello world!"
+    });
+  });
+  it("replaces self references mixed with other vars", function () {
+    var variables = {
+      FOO: "hello from ${api:FOO}",
+      BAR: "this: ${FOO}!"
+    };
+    var otherVariables = {
+      api: {
+        FOO: "foo from api"
+      }
+    };
+    var result = (0, resolveReferences_1.resolveReferences)(variables, function (componentName, variableName) {
+      var _a;
+
+      return (_a = otherVariables[componentName]) === null || _a === void 0 ? void 0 : _a[variableName];
+    });
+    expect(result).toEqual({
+      FOO: "hello from foo from api",
+      BAR: "this: hello from foo from api!"
+    });
+  });
+  it("keeps variables as is if not found (when null is returned)", function () {
+    var variables = {
+      a: "hello world",
+      b: "a not found value looks like this: '${api:FOO}'"
+    };
+    var otherVariables = {};
+    var result = (0, resolveReferences_1.resolveReferences)(variables, function (componentName, variableName) {
+      var _a;
+
+      return (_a = otherVariables[componentName]) === null || _a === void 0 ? void 0 : _a[variableName];
+    });
+    expect(result).toEqual({
+      a: "hello world",
+      b: "a not found value looks like this: '${api:FOO}'"
+    });
+  });
+  it("replaces mulitple levels deep", function () {
+    var variables = {
+      a: "value is ${frontend:FOO}!"
+    };
+    var otherVariables = {
+      api: {
+        FOO: "foo from api"
+      },
+      frontend: {
+        FOO: "hi, ${api:FOO}"
+      }
+    };
+    var result = (0, resolveReferences_1.resolveReferences)(variables, function (componentName, variableName) {
+      var _a, _b;
+
+      return (_b = (_a = otherVariables[componentName]) === null || _a === void 0 ? void 0 : _a[variableName]) !== null && _b !== void 0 ? _b : "";
+    });
+    expect(result).toEqual({
+      a: "value is hi, foo from api!"
+    });
+  });
+  it("prevents endless loops", function () {
+    var variables = {
+      a: "value is ${frontend:FOO}!"
+    };
+    var otherVariables = {
+      api: {
+        FOO: "api ${frontend:FOO}"
+      },
+      frontend: {
+        FOO: "frontend ${api:FOO}"
+      }
+    };
+    var result = (0, resolveReferences_1.resolveReferences)(variables, function (componentName, variableName) {
+      var _a, _b;
+
+      return (_b = (_a = otherVariables[componentName]) === null || _a === void 0 ? void 0 : _a[variableName]) !== null && _b !== void 0 ? _b : "";
+    });
+    expect(result).toEqual({
+      a: "value is frontend api ${frontend:FOO}!"
+    });
+  });
+});
+describe("translateLegacyFromComponents", function () {
+  it("translatetes the old `fromComponents` approach to ${componentName:variableName}", function () {
+    var fromComponents = {
+      api: {
+        API_FOO: "FOO",
+        API_BAR: "BAR"
+      },
+      www: {
+        WWW_X: "X",
+        WWW_Y: "Y"
+      }
+    };
+    var result = (0, resolveReferences_1.translateLegacyFromComponents)(fromComponents);
+    expect(result).toEqual({
+      API_FOO: "${api:FOO}",
+      API_BAR: "${api:BAR}",
+      WWW_X: "${www:X}",
+      WWW_Y: "${www:Y}"
+    });
+  });
+});

package/dist/deploy/kubernetes/deployJob.js

@@ -70,6 +70,8 @@ var cloudsql_1 = require("./cloudsql");
 
 var mongodb_1 = require("./mongodb");
 
+var processSecretsAsFiles_1 = require("./processSecretsAsFiles");
+
 var createKubernetesDeployJobs = function (context) {
   var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
 
@@ -135,7 +137,7 @@ var createKubernetesDeployJobs = function (context) {
     env: env
   }, ((_l = (_k = deployConfig.values) === null || _k === void 0 ? void 0 : _k.cloudsql) === null || _l === void 0 ? void 0 : _l.enabled) ? (0, cloudsql_1.createCloudsqlBaseConfig)(context) : {}), ((_o = (_m = deployConfig.values) === null || _m === void 0 ? void 0 : _m.mongodb) === null || _o === void 0 ? void 0 : _o.enabled) ? (0, mongodb_1.createMongodbBaseConfig)(context) : {});
 
-  var kubeValues = (0, utils_1.mergeWithMergingArrays)(defaultKubeValues, deployConfig.values);
+  var kubeValues = (0, processSecretsAsFiles_1.processSecretsAsFiles)((0, utils_1.mergeWithMergingArrays)(defaultKubeValues, deployConfig.values));
   var kubernetesEnvironment = {
     namespace: context.environment.envVars.KUBE_NAMESPACE
   };

package/dist/deploy/kubernetes/processSecretsAsFiles.d.ts

@@ -0,0 +1,86 @@
+export declare const processSecretsAsFiles: <T extends {
+  env: {
+    secret: Record<string, string>;
+  };
+} & {
+  cloudsql?: {
+    enabled: boolean;
+    instanceId?: string | undefined;
+    projectId?: string | undefined;
+    region?: string | undefined;
+  } | undefined;
+  mongodb?: ({
+    enabled: boolean;
+  } & Record<string, unknown>) | undefined;
+  mailhog?: {
+    enabled: boolean;
+  } | undefined;
+  jobs?: Record<string, {
+    command: string;
+  } & Record<string, unknown>> | undefined;
+  cronjobs?: Record<string, {
+    schedule: string;
+    command: string;
+    concurrencyPolicy?: "Forbid" | "Allow" | "Replace" | undefined;
+  } & Record<string, unknown>> | undefined;
+  application?: ({
+    redirects?: ({
+      host: string;
+    } & Record<string, unknown>)[] | undefined;
+    replicas?: number | undefined;
+    resources?: {
+      limits?: {
+        cpu?: string | undefined;
+        memory?: string | undefined;
+      } | undefined;
+      requests?: {
+        cpu?: string | undefined;
+        memory?: string | undefined;
+      } | undefined;
+    } | undefined;
+    healthRoute?: string | undefined;
+    startupProbe?: {
+      httpGet?: {
+        path?: string | undefined;
+        port?: number | undefined;
+        httpHeaders?: {
+          name: string;
+          value: string;
+        }[] | undefined;
+        failureThreshold?: number | undefined;
+        timeoutSeconds?: number | undefined;
+        periodSeconds?: number | undefined;
+        successThreshold?: number | undefined;
+      } | undefined;
+    } | undefined;
+    readinessProbe?: {
+      httpGet?: {
+        path?: string | undefined;
+        port?: number | undefined;
+        httpHeaders?: {
+          name: string;
+          value: string;
+        }[] | undefined;
+        failureThreshold?: number | undefined;
+        timeoutSeconds?: number | undefined;
+        periodSeconds?: number | undefined;
+        successThreshold?: number | undefined;
+      } | undefined;
+    } | undefined;
+    livenessProbe?: {
+      httpGet?: {
+        path?: string | undefined;
+        port?: number | undefined;
+        httpHeaders?: {
+          name: string;
+          value: string;
+        }[] | undefined;
+        failureThreshold?: number | undefined;
+        timeoutSeconds?: number | undefined;
+        periodSeconds?: number | undefined;
+        successThreshold?: number | undefined;
+      } | undefined;
+    } | undefined;
+  } & Record<string, unknown>) | undefined;
+  secretsAsFile?: string[] | undefined;
+} & Record<string, unknown>>(values: T) => T;

package/dist/deploy/kubernetes/processSecretsAsFiles.js

@@ -0,0 +1,39 @@
+"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);
+};
+
+exports.__esModule = true;
+exports.processSecretsAsFiles = void 0;
+
+var lodash_1 = require("lodash");
+
+var processSecretsAsFiles = function (values) {
+  if (!values.secretsAsFile || values.secretsAsFile.length === 0) {
+    return values;
+  } // the initial idea was that we "shadow" secrets that we mount as files,
+  // but there is a weird kubernetes  issue with that (https://github.com/kubernetes/kubernetes/issues/46861),
+  // so instead we rename the secrets and append _content, so that inside kuberentes, we can use the original name to contain the path and name+_content as the actual content
+
+
+  return __assign(__assign({}, values), {
+    env: __assign(__assign({}, values.env), {
+      secret: __assign(__assign({}, (0, lodash_1.omit)(values.env.secret, values.secretsAsFile)), Object.fromEntries(values.secretsAsFile.map(function (key) {
+        return [key + "_content", values.env.secret[key]];
+      })))
+    })
+  });
+};
+
+exports.processSecretsAsFiles = processSecretsAsFiles;

package/dist/deploy/types.d.ts

@@ -120,6 +120,12 @@ export declare type DeployConfigKubernetesValues = AllowUnknownProps<{
     readinessProbe?: KubernetesHealthDef;
     livenessProbe?: KubernetesHealthDef;
   }>;
+  /**
+   * Mount secrets as files in the filesystem.
+   * These secrets are still available as env vars, but will contain the path of the file instead
+   */
+
+  secretsAsFile?: string[];
 }>;
 export declare type DeployConfigKubernetes = {
   type: "kubernetes";