@catladder/pipeline 0.0.0-node16-ddfae617 → 0.0.0-prettier-cbceeed9

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

@@ -0,0 +1,276 @@
+import type { AllowUnknownProps, DeployConfigBase } from "./base";
+export declare type DeployConfigKubernetesClusterGCloud = {
+  type: "gcloud";
+  /**
+   * gcoud name of the cluster
+   */
+  name: string;
+  /**
+   * google cloud project id
+   */
+  projectId: string;
+  /**
+   * region
+   */
+  region: string;
+  /**
+   * domain of the cluster, for canonical domains without custom host (e.g. review and dev apps)
+   */
+  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[];
+};
+export declare type KubernetesResourcesDef = {
+  limits?: {
+    cpu?: string;
+    memory?: string;
+  };
+  requests?: {
+    cpu?: string;
+    memory?: string;
+  };
+};
+declare type KubernetesHealthDef = {
+  httpGet?: {
+    path?: string;
+    port?: number;
+    httpHeaders?: {
+      name: string;
+      value: string;
+    }[];
+    failureThreshold?: number;
+    timeoutSeconds?: number;
+    periodSeconds?: number;
+    successThreshold?: number;
+  };
+};
+export declare type KubernetesUpdateStrategy = {
+  rollingUpdate: {
+    /**
+     * how many pods can be created additionally to the target number
+     * can be absolute number or percentage.
+     * defaults to 1 (kube default is 25%)
+     */
+    maxSurge: number | string;
+    /**
+     * how many pods are allowed to be unavailable
+     * can be absolute number or percentage
+     * defaults to 0 (kube default is 25%)
+     */
+    maxUnavailable: number | string;
+  };
+  type: "RollingUpdate";
+};
+export declare type KubernetesWorkerDef = {
+  enabled: boolean;
+  /**
+   * which command to run. defaults to `yarn start`
+   */
+  command?: string;
+  resources?: KubernetesResourcesDef;
+  service?: {
+    enabled?: boolean;
+  };
+};
+export declare type DeployConfigMongodbBase = {
+  enabled?: boolean;
+  dbName?: string;
+  persistence?: {
+    /**
+     * set premium-rwo for ssd
+     */
+    storageClass?: "standard-rwo" | "premium-rwo";
+    /**
+     * size of the volume, defaults to 8Gi
+     */
+    size?: string;
+  };
+  resources?: KubernetesResourcesDef;
+};
+export declare type DeployConfigMongodbStandalone = {
+  architecture: "standalone";
+};
+export declare type DeployConfigMongodbReplicaset = {
+  architecture: "replicaset";
+  /**
+   * defaults to 2
+   */
+  replicaCount?: number;
+};
+export declare type DeployConfigMongodb = DeployConfigMongodbBase & (DeployConfigMongodbStandalone | DeployConfigMongodbReplicaset);
+export declare type DeployConfigKubernetesValues = AllowUnknownProps<{
+  /**
+   * enable cloudsql db. Currently you have to manually set it up
+   */
+  cloudsql?: {
+    enabled: boolean;
+    instanceId?: string;
+    projectId?: string;
+    region?: string;
+  };
+  /**
+   * enable mongodb. The mongodb is deployed using a helm chart.
+   * See https://github.com/bitnami/charts/tree/master/bitnami/mongodb
+   */
+  mongodb?: DeployConfigMongodb;
+  /**
+   * enable mailhog. Mailhog is a virtual mail server that catches all outgoing mailsl and show them in a mailbox.
+   * This is great for development as it prevents to accidentially send out real emails and helps with debugging outgoing mails.
+   *
+   * It will automaticaly inject a MAIL_URL env var.
+   *
+   * Turn it of for production.
+   */
+  mailhog?: {
+    enabled: boolean;
+  };
+  /**
+   * post-install/upgrade jobs. These use the app image and have all env vars available.
+   * Typically used for migrations and seeds
+   */
+  jobs?: Record<string, false | AllowUnknownProps<{
+    /**
+     * the command to execute
+     */
+    command: string;
+    /**
+     * comma-separated list of helm hooks, see https://helm.sh/docs/topics/charts_hooks/
+     *
+     * defaults to post-install,post-upgrade
+     */
+    hook?: string;
+  }>>;
+  /**
+   * cronjobs that run periodically. These use the app image have all env vars available.
+   */
+  cronjobs?: Record<string, false | AllowUnknownProps<{
+    schedule: string;
+    command: string;
+    concurrencyPolicy?: "Forbid" | "Allow" | "Replace";
+  }>>;
+  /**
+   * configuration for the application ("Deployment" in kubernetes)
+   */
+  application?: false | AllowUnknownProps<{
+    /**
+     * command to start, defaults to build's startCommand
+     */
+    command?: string;
+    /**
+     * enable, disable app deployment, defaults to true
+     */
+    enabled?: boolean;
+    /**
+     * redirects
+     */
+    redirects?: AllowUnknownProps<{
+      host: string;
+    }>[];
+    /**
+     * Host aliases
+     */
+    hostAliases?: string[];
+    /**
+     * how many pods will be started
+     */
+    replicas?: number;
+    /**
+     * autoscale the pods horizontally
+     */
+    autoscale?: KubernetesAutoscale;
+    /**
+     * the update strategy, see https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#rolling-update-deployment
+     */
+    updateStrategy?: KubernetesUpdateStrategy;
+    /**
+     * kubernetes resources
+     */
+    resources?: KubernetesResourcesDef;
+    healthRoute?: string;
+    startupProbe?: KubernetesHealthDef;
+    readinessProbe?: KubernetesHealthDef;
+    livenessProbe?: KubernetesHealthDef;
+    /**
+     * specify a worker. A worker is a separate deployment that runs continously in the background.
+     * The worker pod can use the same entry point as the app or a different one (specify command).
+     * It has the same environment variables as the application and an additional IS_WORKER="true" variable
+     */
+    worker?: KubernetesWorkerDef;
+    /**
+     * kubernetes resources for jobs and cronjobs
+     */
+    jobDefaults?: {
+      resources: KubernetesResourcesDef;
+    };
+  }>;
+  /**
+   * load secrets from other components.
+   * Use this only in cases where the secret is not known on pipeline-time
+   * and only if the component is also in the same cluster.
+   *
+   * a typical case is reusing mongo_url from other component
+   *
+   * also make sure that the other component deploys first
+   *
+   * in all other cases use normal env var handling
+   */
+  secretsFromOtherComponent?: {
+    [envVar: string]: string;
+  };
+  /**
+   * map another services internal endpoint into a env var.
+   */
+  mapServiceUrlToEnv?: {
+    [envVar: string]: string;
+  };
+  /**
+   * Mount secrets as files in the filesystem.
+   * These secrets are still available as env vars, but will contain the path of the file instead
+   *
+   * @deprecated this will be removed in the future, because its very niche and not used
+   */
+  secretsAsFile?: string[];
+}>;
+export declare type DeployConfigKubernetes = {
+  type: "kubernetes";
+  /**
+   * cluster config to use.
+   */
+  cluster: DeployConfigKubernetesCluster;
+  /**
+   * prints out debug info (helm --debug)
+   */
+  debug?: boolean;
+  additionalHelmArgs?: string[];
+  /**
+   * values to configure the app
+   */
+  values?: DeployConfigKubernetesValues;
+  /**
+   * Custom Helm chart location.
+   * Not recommended to use.
+   */
+  chartName?: string;
+} & DeployConfigBase;
+export {};

package/dist/deploy/types/kubernetes.js

@@ -0,0 +1,3 @@
+"use strict";
+
+exports.__esModule = true;

package/dist/deploy/utils.d.ts

@@ -1,5 +1,5 @@
-import { Config, Context } from "../types";
-import { DeployConfigKubernetesCluster } from "./types";
+import type { Config, Context } from "../types";
+import type { 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 contextIsStoppable: (context: Context) => boolean;

package/dist/deploy/utils.js

@@ -2,35 +2,28 @@
 
 exports.__esModule = true;
 exports.contextIsStoppable = exports.getKubernetesNamespace = exports.getFullKubernetesClusterName = void 0;
-
 var types_1 = require("./types");
-
 var getFullKubernetesClusterName = function (cluster) {
   if (cluster.type === "gcloud") {
     return "gke_".concat(cluster.projectId, "_").concat(cluster.region, "_").concat(cluster.name);
   }
 };
-
 exports.getFullKubernetesClusterName = getFullKubernetesClusterName;
-
 var getKubernetesNamespace = function (config, env) {
   return "".concat(config.customerName, "-").concat(config.appName, "-").concat(env);
 };
-
 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, "google-cloudrun")) {
+    return true;
+  }
   if ((0, types_1.isOfDeployType)(deployConfig, "custom") && deployConfig.stopScript) {
     return true;
   }
-
   return false;
 };
-
 exports.contextIsStoppable = contextIsStoppable;

package/dist/index.js

@@ -12,25 +12,15 @@ var __createBinding = this && this.__createBinding || (Object.create ? function
   if (k2 === undefined) k2 = k;
   o[k2] = m[k];
 });
-
 var __exportStar = this && this.__exportStar || function (m, exports) {
   for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-
 exports.__esModule = true;
-
 __exportStar(require("./pipeline/"), exports);
-
 __exportStar(require("./types"), exports);
-
 __exportStar(require("./rules"), exports);
-
 __exportStar(require("./runner"), exports);
-
 __exportStar(require("./config"), exports);
-
 __exportStar(require("./context"), exports);
-
 __exportStar(require("./build"), exports);
-
 __exportStar(require("./deploy"), exports);

package/dist/pipeline/commitInfo/getBuildId.d.ts

@@ -0,0 +1 @@
+export declare const getBuildId: () => Promise<string>;

package/dist/pipeline/commitInfo/getBuildId.js

@@ -0,0 +1,135 @@
+"use strict";
+
+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.getBuildId = void 0;
+var child_process_promise_1 = require("child-process-promise");
+var getBuildId = function () {
+  return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          return [4 /*yield*/, (0, child_process_promise_1.exec)("git describe --tags || git rev-parse HEAD").then(function (s) {
+            return s.stdout.trim();
+          })];
+        case 1:
+          return [2 /*return*/, _a.sent()];
+      }
+    });
+  });
+};
+exports.getBuildId = getBuildId;

package/dist/pipeline/commitInfo/getCommitInfo.d.ts

@@ -0,0 +1,2 @@
+import type { CommitInfo } from "../../types";
+export declare const getBaseCommitInfo: () => Promise<Omit<CommitInfo, "trigger">>;

package/dist/pipeline/commitInfo/getCommitInfo.js

@@ -0,0 +1,140 @@
+"use strict";
+
+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.getBaseCommitInfo = void 0;
+var getBuildId_1 = require("./getBuildId");
+var getBaseCommitInfo = function () {
+  return __awaiter(void 0, void 0, void 0, function () {
+    var _a;
+    var _b;
+    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",
+            reviewSlug: process.env.CI_MERGE_REQUEST_IID ? "mr".concat(process.env.CI_MERGE_REQUEST_IID) : "unknown",
+            buildTime: new Date().toISOString()
+          };
+          return [4 /*yield*/, (0, getBuildId_1.getBuildId)()];
+        case 1:
+          return [2 /*return*/, (_a.buildId = _c.sent(), _a)];
+      }
+    });
+  });
+};
+exports.getBaseCommitInfo = getBaseCommitInfo;

package/dist/pipeline/createAllJobs.d.ts

@@ -0,0 +1,8 @@
+import type { Config, PipelineTrigger } from "../types";
+import type { CatladderJob } from "../types/jobs";
+export declare type AllCatladderJobs = {
+  [componentName: string]: {
+    [env: string]: Array<CatladderJob>;
+  };
+};
+export declare const createAllJobs: (config: Config, trigger: PipelineTrigger) => Promise<AllCatladderJobs>;