@catladder/pipeline 0.0.0-vars-07a720d0 → 0.0.0-waitfor-deploy-e64a33ba

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

@@ -0,0 +1,87 @@
+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;
+    autoscale?: import("../types").KubernetesAutoscale | 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

@@ -1,4 +1,17 @@
-export declare type DeployConfigBase = {};
+export declare type DeployConfigBase = {
+  /**
+   * whether to deploy automatically or manual. If not defined, these rules apply:
+   * - prod: manual
+   * - all other envs: auto
+   */
+  when?: "manual" | "auto";
+  /**
+   * EXPERIMENTAL
+   * wait for other components to deploy first, before doing this deployment
+   */
+
+  waitFor?: string[];
+};
 declare type AllowUnknownProps<T extends Record<string, unknown>> = T & Record<string, unknown>;
 export declare type DeployConfigKubernetesClusterGCloud = {
   type: "gcloud";
@@ -24,6 +37,29 @@ export declare type DeployConfigKubernetesClusterGCloud = {
   domainCanonical?: string;
 };
 export declare type DeployConfigKubernetesCluster = DeployConfigKubernetesClusterGCloud;
+export declare type KubernetesAutoscaleMetricResourceTarget = {
+  type: "Utilization";
+  averageUtilization: number;
+} | {
+  type: "AverageValue";
+  averageValue: number | string;
+};
+export declare type KubernetesAutoscaleMetric = {
+  type: "Resource";
+  resource: {
+    name: "cpu" | "memory";
+    target: KubernetesAutoscaleMetricResourceTarget;
+  };
+};
+export declare type KubernetesAutoscale = {
+  minReplicas: number;
+  maxReplicas: number;
+  /**
+   * declare a number of metrics (at least one). Usually you would use cpu as a metric
+   */
+
+  metrics: KubernetesAutoscaleMetric[];
+};
 declare type KubernetesHealthDef = {
   httpGet?: {
     path?: string;
@@ -101,6 +137,11 @@ export declare type DeployConfigKubernetesValues = AllowUnknownProps<{
      */
 
     replicas?: number;
+    /**
+     * autoscale the pods horizontally
+     */
+
+    autoscale?: KubernetesAutoscale;
     /**
      * kubernetes resources
      */
@@ -120,6 +161,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";
@@ -140,26 +187,16 @@ export declare type DeployConfigKubernetes = {
 
   values?: DeployConfigKubernetesValues;
 } & DeployConfigBase;
-export declare type DeployConfig = DeployConfigKubernetes;
-export declare const isOfDeployType: <T extends "kubernetes"[]>(t: DeployConfig | false, ...types: T) => t is Extract<{
-  type: "kubernetes";
-  /**
-   * cluster config to use.
-   */
-
-  cluster: DeployConfigKubernetesCluster;
-  /**
-   * prints out debug info (helm --debug)
-   */
-
-  debug?: boolean | undefined;
-  additionalHelmArgs?: string[] | undefined;
-  /**
-   * values to configure the app
-   */
-
-  values?: DeployConfigKubernetesValues | undefined;
-}, {
+declare type DeployConfigCustom = {
+  type: "custom";
+  requiresDocker: boolean;
+  script: string[];
+  stopScript?: string[];
+} & DeployConfigBase;
+export declare type DeployConfig = DeployConfigKubernetes | DeployConfigCustom;
+export declare const isOfDeployType: <T extends ("kubernetes" | "custom")[]>(t: DeployConfig | false, ...types: T) => t is Extract<DeployConfigKubernetes, {
+  type: T[number];
+}> | Extract<DeployConfigCustom, {
   type: T[number];
 }>;
 export {};

package/dist/deploy/utils.d.ts

@@ -1,4 +1,5 @@
-import { Config } from "../types";
-import type { DeployConfigKubernetesCluster } from "./types";
+import { Config, Context } from "../types";
+import { DeployConfigKubernetesCluster } from "./types";
 export declare const getFullKubernetesClusterName: (cluster: DeployConfigKubernetesCluster) => string | undefined;
-export declare const getKubernetesNamespace: (config: Pick<Config, "customerName" | "appName">, env: string) => string;
+export declare const getKubernetesNamespace: (config: Pick<Config, "customerName" | "appName">, env: string) => string;
+export declare const contextIsStoppable: (context: Context) => boolean;

package/dist/deploy/utils.js

@@ -1,7 +1,9 @@
 "use strict";
 
 exports.__esModule = true;
-exports.getKubernetesNamespace = exports.getFullKubernetesClusterName = void 0;
+exports.contextIsStoppable = exports.getKubernetesNamespace = exports.getFullKubernetesClusterName = void 0;
+
+var types_1 = require("./types");
 
 var getFullKubernetesClusterName = function (cluster) {
   if (cluster.type === "gcloud") {
@@ -15,4 +17,20 @@ var getKubernetesNamespace = function (config, env) {
   return "".concat(config.customerName, "-").concat(config.appName, "-").concat(env);
 };
 
-exports.getKubernetesNamespace = getKubernetesNamespace;
+exports.getKubernetesNamespace = getKubernetesNamespace;
+
+var contextIsStoppable = function (context) {
+  var deployConfig = context.componentConfig.deploy;
+
+  if ((0, types_1.isOfDeployType)(deployConfig, "kubernetes")) {
+    return true;
+  }
+
+  if ((0, types_1.isOfDeployType)(deployConfig, "custom") && deployConfig.stopScript) {
+    return true;
+  }
+
+  return false;
+};
+
+exports.contextIsStoppable = contextIsStoppable;

package/dist/pipeline/createJobs.js

@@ -155,6 +155,17 @@ var __generator = this && this.__generator || function (thisArg, body) {
   }
 };
 
+var __rest = this && this.__rest || function (s, e) {
+  var t = {};
+
+  for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p];
+
+  if (s != null && typeof Object.getOwnPropertySymbols === "function") for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+    if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i])) t[p[i]] = s[p[i]];
+  }
+  return t;
+};
+
 var __read = this && this.__read || function (o, n) {
   var m = typeof Symbol === "function" && o[Symbol.iterator];
   if (!m) return o;
@@ -209,6 +220,28 @@ var makeGitlabJob_1 = require("./gitlab/makeGitlabJob");
 
 var packageManager_1 = require("./packageManager");
 
+var injectDefaultVarsInCustomJobs = function (context, jobs) {
+  return jobs.map(function (_a) {
+    var _b;
+
+    var variables = _a.variables,
+        job = __rest(_a, ["variables"]);
+
+    return __assign({
+      variables: __assign(__assign({}, (_b = context.environment.envVars) !== null && _b !== void 0 ? _b : {}), variables !== null && variables !== void 0 ? variables : {})
+    }, job);
+  });
+};
+
+var getCustomJobs = function (context) {
+  if (!context.componentConfig.customJobs) {
+    return [];
+  }
+
+  var rawJobs = (0, lodash_1.isFunction)(context.componentConfig.customJobs) ? context.componentConfig.customJobs(context) : context.componentConfig.customJobs;
+  return injectDefaultVarsInCustomJobs(context, rawJobs);
+};
+
 var createRawJobs = function (context) {
   if (context.componentConfig.deploy === false) {
     return [];
@@ -216,7 +249,8 @@ var createRawJobs = function (context) {
 
   var buildJobs = build_1.BUILD_TYPES[context.componentConfig.build.type].jobs(context);
   var deployJobs = deploy_1.DEPLOY_TYPES[context.componentConfig.deploy.type].jobs(context);
-  return __spreadArray(__spreadArray([], __read(buildJobs), false), __read(deployJobs), false);
+  var customJobs = getCustomJobs(context);
+  return __spreadArray(__spreadArray(__spreadArray([], __read(buildJobs), false), __read(deployJobs), false), __read(customJobs), false);
 };
 
 var getFullJobName = function (name, componentName, env) {
@@ -243,18 +277,28 @@ var getFullReferencedJobName = function (referencedJobName, componentName, env,
 
 
 var replaceReferences = function (job, componentName, env, allRawJobs) {
-  var _a, _b;
+  var _a, _b, _c;
 
   var stage = job.envMode === "stagePerEnv" ? "".concat(job.stage, " ").concat(env) : job.stage;
+  var needsFromNeeds = (_a = job.needs) === null || _a === void 0 ? void 0 : _a.map(function (n) {
+    return (0, lodash_1.isObject)(n) ? {
+      job: getFullReferencedJobName(n.job, componentName, env, allRawJobs),
+      artifacts: n.artifacts
+    } : getFullReferencedJobName(n, componentName, env, allRawJobs);
+  });
+  var needsFromOtherComponents = (_b = job.needsOtherComponent) === null || _b === void 0 ? void 0 : _b.map(function (other) {
+    return {
+      artifacts: other.artifacts,
+      job: getFullReferencedJobName(other.job, other.componentName, env, allRawJobs)
+    };
+  });
+
+  var needs = __spreadArray(__spreadArray([], __read(needsFromNeeds !== null && needsFromNeeds !== void 0 ? needsFromNeeds : []), false), __read(needsFromOtherComponents !== null && needsFromOtherComponents !== void 0 ? needsFromOtherComponents : []), false);
+
   return __assign(__assign({}, job), {
     stage: stage,
-    needs: (_a = job.needs) === null || _a === void 0 ? void 0 : _a.map(function (n) {
-      return (0, lodash_1.isObject)(n) ? {
-        job: getFullReferencedJobName(n.job, componentName, env, allRawJobs),
-        artifacts: n.artifacts
-      } : getFullReferencedJobName(n, componentName, env, allRawJobs);
-    }),
-    environment: ((_b = job.environment) === null || _b === void 0 ? void 0 : _b.on_stop) ? __assign(__assign({}, job.environment), {
+    needs: needs,
+    environment: ((_c = job.environment) === null || _c === void 0 ? void 0 : _c.on_stop) ? __assign(__assign({}, job.environment), {
       on_stop: getFullReferencedJobName(job.environment.on_stop, componentName, env, allRawJobs)
     }) : job.environment
   });
@@ -296,14 +340,14 @@ var createJobs = function (type, envs, config, componentName, trigger) {
 
     var _a;
 
-    var _b, _c;
+    var _b;
 
-    return __generator(this, function (_d) {
-      switch (_d.label) {
+    return __generator(this, function (_c) {
+      switch (_c.label) {
         case 0:
           _a = {
             refName: (_b = process.env.CI_COMMIT_REF_NAME) !== null && _b !== void 0 ? _b : "unknown",
-            refSlug: (_c = process.env.CI_COMMIT_REF_SLUG) !== null && _c !== void 0 ? _c : "unknown",
+            reviewSlug: process.env.CI_MERGE_REQUEST_IID ? "mr".concat(process.env.CI_MERGE_REQUEST_IID) : "unknown",
             buildTime: new Date().toISOString()
           };
           return [4
@@ -313,13 +357,13 @@ var createJobs = function (type, envs, config, componentName, trigger) {
           })];
 
         case 1:
-          commitInfo = (_a.buildId = _d.sent(), _a.trigger = trigger, _a);
+          commitInfo = (_a.buildId = _c.sent(), _a.trigger = trigger, _a);
           return [4
           /*yield*/
           , (0, packageManager_1.getPackageManagerInfo)(config, componentName)];
 
         case 2:
-          packageManagerInfo = _d.sent();
+          packageManagerInfo = _c.sent();
           return [2
           /*return*/
           , envs.reduce(function (acc, env) {