@catladder/pipeline 1.0.4 → 1.1.2

package/dist/build/node/testJob.d.ts

@@ -0,0 +1,3 @@
+import { Context } from "../../types/context";
+import { GitlabJobs } from "../../types/gitlab-types";
+export declare const createNodeTestJobs: (context: Context) => GitlabJobs;

package/dist/build/node/testJob.js

@@ -0,0 +1,112 @@
+"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 __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;
+};
+
+var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
+  if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+    if (ar || !(i in from)) {
+      if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+      ar[i] = from[i];
+    }
+  }
+  return to.concat(ar || Array.prototype.slice.call(from));
+};
+
+exports.__esModule = true;
+exports.createNodeTestJobs = void 0;
+
+var defaults_1 = require("../../defaults");
+
+var utils_1 = require("../../utils");
+
+var cache_1 = require("./cache");
+
+var constants_1 = require("./constants");
+
+var yarn_1 = require("./yarn");
+
+var createNodeTestJobs = function (context) {
+  var _a, _b, _c, _d, _e, _f, _g, _h; // don't run tests after release
+
+
+  if (((_a = context.commitInfo) === null || _a === void 0 ? void 0 : _a.trigger) === "taggedRelease") {
+    return [];
+  }
+
+  var buildConfig = context.componentConfig.build;
+  var base = {
+    variables: __assign(__assign({
+      APP_PATH: context.componentConfig.dir
+    }, constants_1.NODE_RUNNER_BUILD_VARIABLES), (_b = buildConfig.extraVars) !== null && _b !== void 0 ? _b : {}),
+    stage: "test",
+    interruptible: true,
+    needs: [],
+    retry: defaults_1.BASE_RETRY
+  };
+  var yarnInstall = (0, yarn_1.getYarnInstall)(context);
+  var auditJob = buildConfig.audit !== false ? {
+    name: "🛡 audit",
+    envMode: "none",
+    job: __assign(__assign({}, base), {
+      cache: undefined,
+      script: __spreadArray(["cd ".concat(context.componentConfig.dir)], __read((_d = (0, utils_1.ensureArray)((_c = buildConfig.audit) === null || _c === void 0 ? void 0 : _c.command)) !== null && _d !== void 0 ? _d : ["yarn audit"]), false),
+      allow_failure: true
+    })
+  } : null;
+  var lintJob = buildConfig.lint !== false ? {
+    name: "👮 lint",
+    envMode: "none",
+    job: __assign(__assign({}, base), {
+      cache: (0, cache_1.getNodeCache)(context),
+      script: __spreadArray(__spreadArray(["cd ".concat(context.componentConfig.dir)], __read(yarnInstall), false), __read((_f = (0, utils_1.ensureArray)((_e = buildConfig.lint) === null || _e === void 0 ? void 0 : _e.command)) !== null && _f !== void 0 ? _f : ["yarn lint"]), false)
+    })
+  } : null;
+  var testJob = buildConfig.test !== false ? {
+    name: "🧪 test",
+    envMode: "none",
+    job: __assign(__assign({}, base), {
+      cache: (0, cache_1.getNodeCache)(context),
+      script: __spreadArray(__spreadArray(["cd ".concat(context.componentConfig.dir)], __read(yarnInstall), false), __read((_h = (0, utils_1.ensureArray)((_g = buildConfig.test) === null || _g === void 0 ? void 0 : _g.command)) !== null && _h !== void 0 ? _h : ["yarn test"]), false)
+    })
+  } : null;
+  return [auditJob, lintJob, testJob].filter(utils_1.notNil);
+};
+
+exports.createNodeTestJobs = createNodeTestJobs;

package/dist/build/node/yarn.d.ts

@@ -0,0 +1,2 @@
+import { Context } from "../../types";
+export declare const getYarnInstall: (context: Context) => string[];

package/dist/build/node/yarn.js

@@ -0,0 +1,12 @@
+"use strict";
+
+exports.__esModule = true;
+exports.getYarnInstall = void 0;
+
+var getYarnInstall = function (context) {
+  var _a;
+
+  return ["if [ -f ./.nvmrc ]; then source /root/.nvm/nvm.sh && nvm install <<< .nvmrc; fi", ((_a = context.yarnInfo) === null || _a === void 0 ? void 0 : _a.isClassic) ? "yarn install --frozen-lockfile" : "yarn install --immutable"];
+};
+
+exports.getYarnInstall = getYarnInstall;

package/dist/build/tests/storybook.test.d.ts

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

package/dist/build/tests/storybook.test.js

@@ -0,0 +1,221 @@
+"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
+    };
+  }
+};
+
+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;
+};
+
+exports.__esModule = true;
+
+var __1 = require("../../");
+
+describe("storybook build", function () {
+  describe("creates two build jobs", function () {
+    var config = {
+      appName: "test",
+      customerName: "pan",
+      components: {
+        "my-app": {
+          dir: "myapp",
+          build: {
+            type: "storybook"
+          },
+          deploy: {
+            type: "kubernetes"
+          }
+        }
+      }
+    };
+    it("creates a pipeline for storybook that does not contain test stages", function () {
+      return __awaiter(void 0, void 0, void 0, function () {
+        var _a, image, stages, workflow, jobs;
+
+        return __generator(this, function (_b) {
+          switch (_b.label) {
+            case 0:
+              return [4
+              /*yield*/
+              , (0, __1.createChildPipeline)("mainBranch", config)];
+
+            case 1:
+              _a = _b.sent(), image = _a.image, stages = _a.stages, workflow = _a.workflow, jobs = __rest(_a, ["image", "stages", "workflow"]);
+              expect(Object.keys(jobs)).toEqual(["dev my-app app-build", "dev my-app docker-build", "dev my-app deploy-to-kubernetes", "dev my-app kubernetes-stop"]);
+              return [2
+              /*return*/
+              ];
+          }
+        });
+      });
+    });
+    it("runs build and renames folder", function () {
+      return __awaiter(void 0, void 0, void 0, function () {
+        var _a, image, stages, workflow, jobs, buildJob;
+
+        return __generator(this, function (_b) {
+          switch (_b.label) {
+            case 0:
+              return [4
+              /*yield*/
+              , (0, __1.createChildPipeline)("mainBranch", config)];
+
+            case 1:
+              _a = _b.sent(), image = _a.image, stages = _a.stages, workflow = _a.workflow, jobs = __rest(_a, ["image", "stages", "workflow"]);
+              buildJob = jobs["dev my-app app-build"];
+              expect(buildJob.script).toContain("yarn storybook");
+              expect(buildJob.script).toContain("mv ./storybook-out /dist");
+              return [2
+              /*return*/
+              ];
+          }
+        });
+      });
+    });
+  });
+});

package/dist/build/types.d.ts

@@ -0,0 +1,63 @@
+export declare type BuildConfigBase = {
+  startCommand?: string;
+  extraVars?: Record<string, string>;
+  /**
+   * define the build command
+   */
+
+  buildCommand?: string | string[] | null;
+  /**
+   * customize docker build
+   */
+
+  docker?: {
+    additionsBegin?: string[];
+    additionsEnd?: string[];
+  };
+  /**
+   * customize lint, set false to disable
+   */
+
+  lint?: false | {
+    command?: string | string[];
+  };
+  /**
+   * customize test, set false to disable
+   */
+
+  test?: false | {
+    command?: string | string[];
+  };
+  /**
+   * customize audit, set false to disable
+   */
+
+  audit?: false | {
+    command?: string | string[];
+  };
+};
+export declare type BuildConfigNodeBase = BuildConfigBase;
+export declare type BuildConfigNode = {
+  type: "node";
+} & BuildConfigNodeBase;
+export declare type BuildConfigNodeStatic = BuildConfigNodeBase & {
+  type: "node-static";
+  startCommand?: never;
+};
+export declare type BuildConfigMeteor = BuildConfigNodeBase & {
+  type: "meteor";
+};
+export declare type BuildConfigStorybook = BuildConfigNodeBase & {
+  type: "storybook";
+  startCommand?: never;
+};
+export declare type BuildConfig = BuildConfigNode | BuildConfigNodeStatic | BuildConfigStorybook | BuildConfigMeteor;
+export declare const isOfBuildType: <T extends ("node" | "node-static" | "meteor" | "storybook")[]>(t: BuildConfig, ...types: T) => t is Extract<BuildConfigNode, {
+  type: T[number];
+}> | Extract<BuildConfigNodeStatic, {
+  type: T[number];
+}> | Extract<BuildConfigMeteor, {
+  type: T[number];
+}> | Extract<BuildConfigStorybook, {
+  type: T[number];
+}>;

package/dist/build/types.js

@@ -0,0 +1,16 @@
+"use strict";
+
+exports.__esModule = true;
+exports.isOfBuildType = void 0;
+
+var isOfBuildType = function (t) {
+  var types = [];
+
+  for (var _i = 1; _i < arguments.length; _i++) {
+    types[_i - 1] = arguments[_i];
+  }
+
+  return types.includes(t.type);
+};
+
+exports.isOfBuildType = isOfBuildType;

package/dist/catladder-gitlab.d.ts

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

package/dist/catladder-gitlab.js

@@ -0,0 +1,44 @@
+"use strict";
+
+exports.__esModule = true;
+
+var fs_1 = require("fs");
+
+var config_1 = require("./config");
+
+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 isDefaultBranch = CI_COMMIT_BRANCH == CI_DEFAULT_BRANCH;
+var isHotfixBranch = false; // TODO:  $CI_COMMIT_BRANCH =~ /^[0-9]+\.([0-9]+|x)\.x$/
+
+var isMergeRequest = Boolean(CI_MERGE_REQUEST_ID);
+var isTaggedRelease = Boolean(CI_COMMIT_TAG);
+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)();
+
+  if (!config) {
+    throw new Error("no catladder config found");
+  }
+
+  (0, pipeline_1.createChildPipeline)(trigger, config).then(function (mainPipeline) {
+    (0, fs_1.writeFileSync)("__pipeline.yml", JSON.stringify(mainPipeline, null, 2), {
+      encoding: "utf-8"
+    });
+  });
+} else {
+  throw new Error("no matching trigger: " + JSON.stringify({
+    isMergeRequest: isMergeRequest,
+    isDefaultBranch: isDefaultBranch,
+    isTaggedRelease: isTaggedRelease
+  }, null, 2));
+}

package/dist/config/configruedEnvs.d.ts

@@ -0,0 +1,4 @@
+import { Config, PipelineTrigger } from "../types";
+export declare const getAllEnvs: (config: Config, componentName: string) => string[];
+export declare const getAllEnvsInAllComponents: (config: Config) => string[];
+export declare const getAllEnvsByTrigger: (config: Config, componentName: string, trigger: PipelineTrigger) => string[];

package/dist/config/configruedEnvs.js

@@ -0,0 +1,86 @@
+"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;
+};
+
+var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
+  if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+    if (ar || !(i in from)) {
+      if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+      ar[i] = from[i];
+    }
+  }
+  return to.concat(ar || Array.prototype.slice.call(from));
+};
+
+exports.__esModule = true;
+exports.getAllEnvsByTrigger = exports.getAllEnvsInAllComponents = exports.getAllEnvs = void 0;
+
+var types_1 = require("../types");
+
+var getConfiguredAndDefaultEnvs = function (config, componentName, envTypes) {
+  var _a, _b;
+
+  var configuredEnvs = (_a = config.components[componentName].env) !== null && _a !== void 0 ? _a : {}; // the default envs have the same name as the env types
+  // these can be disabled with settimg them to `false`
+  // this is the list of all not disabled envs. These are always returned
+
+  var enabledDefaultEnvs = envTypes.filter(function (e) {
+    return configuredEnvs[e] !== false;
+  });
+  var configuredCustomEnvs = Object.entries((_b = config.components[componentName].env) !== null && _b !== void 0 ? _b : {}).filter(function (_a) {
+    var _b = __read(_a, 2),
+        config = _b[1];
+
+    return config && "type" in config && config.type && envTypes.includes(config.type);
+  }).map(function (_a) {
+    var _b = __read(_a, 1),
+        envName = _b[0];
+
+    return envName;
+  });
+  return __spreadArray([], __read(new Set(__spreadArray(__spreadArray([], __read(enabledDefaultEnvs), false), __read(configuredCustomEnvs), false))), false);
+};
+
+var getAllEnvs = function (config, componentName) {
+  return getConfiguredAndDefaultEnvs(config, componentName, types_1.DEFAULT_ENV_TYPES);
+};
+
+exports.getAllEnvs = getAllEnvs;
+
+var getAllEnvsInAllComponents = function (config) {
+  return __spreadArray([], __read(new Set(Object.keys(config.components).flatMap(function (c) {
+    return (0, exports.getAllEnvs)(config, c);
+  }))), false);
+};
+
+exports.getAllEnvsInAllComponents = getAllEnvsInAllComponents;
+
+var getAllEnvsByTrigger = function (config, componentName, trigger) {
+  var envTypesByTrigger = (0, types_1.getEnvTypesByTrigger)(trigger);
+  return getConfiguredAndDefaultEnvs(config, componentName, envTypesByTrigger);
+};
+
+exports.getAllEnvsByTrigger = getAllEnvsByTrigger;

package/dist/config/configruedEnvs.test.d.ts

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

package/dist/config/configruedEnvs.test.js

@@ -0,0 +1,103 @@
+"use strict";
+
+exports.__esModule = true;
+
+var _1 = require(".");
+
+describe("getAllEnvsByTrigger", function () {
+  var SIMPLE_CONFIG = {
+    appName: "my-app",
+    customerName: "pan",
+    components: {
+      app1: {
+        dir: "dir1",
+        build: {
+          type: "node"
+        },
+        deploy: {
+          type: "kubernetes"
+        }
+      },
+      app2: {
+        dir: "dir2",
+        build: {
+          type: "node"
+        },
+        deploy: {
+          type: "kubernetes"
+        },
+        env: {
+          dev2: {
+            type: "dev"
+          },
+          review2: {
+            type: "review"
+          },
+          stage2: {
+            type: "stage"
+          },
+          prod2: {
+            type: "prod"
+          }
+        }
+      },
+      app3: {
+        dir: "dir2",
+        build: {
+          type: "node"
+        },
+        deploy: {
+          type: "kubernetes"
+        },
+        env: {
+          dev: false,
+          review: false,
+          stage: false,
+          prod: false
+        }
+      }
+    }
+  };
+  describe("mainBranch", function () {
+    it("always includes dev if not disabled", function () {
+      var envs = (0, _1.getAllEnvsByTrigger)(SIMPLE_CONFIG, "app1", "mainBranch");
+      expect(envs).toEqual(["dev"]);
+    });
+    it("returns additional dev environments", function () {
+      var envs = (0, _1.getAllEnvsByTrigger)(SIMPLE_CONFIG, "app2", "mainBranch");
+      expect(envs).toEqual(["dev", "dev2"]);
+    });
+    it("does not include disabled envs", function () {
+      var envs = (0, _1.getAllEnvsByTrigger)(SIMPLE_CONFIG, "app3", "mainBranch");
+      expect(envs).toEqual([]);
+    });
+  });
+  describe("mr", function () {
+    it("always includes review if not disabled", function () {
+      var envs = (0, _1.getAllEnvsByTrigger)(SIMPLE_CONFIG, "app1", "mr");
+      expect(envs).toEqual(["review"]);
+    });
+    it("returns additional dev environments", function () {
+      var envs = (0, _1.getAllEnvsByTrigger)(SIMPLE_CONFIG, "app2", "mr");
+      expect(envs).toEqual(["review", "review2"]);
+    });
+    it("does not include disabled envs", function () {
+      var envs = (0, _1.getAllEnvsByTrigger)(SIMPLE_CONFIG, "app3", "mr");
+      expect(envs).toEqual([]);
+    });
+  });
+  describe("taggedRelease", function () {
+    it("always includes review if not disabled", function () {
+      var envs = (0, _1.getAllEnvsByTrigger)(SIMPLE_CONFIG, "app1", "taggedRelease");
+      expect(envs).toEqual(["stage", "prod"]);
+    });
+    it("returns additional dev environments", function () {
+      var envs = (0, _1.getAllEnvsByTrigger)(SIMPLE_CONFIG, "app2", "taggedRelease");
+      expect(envs).toEqual(["stage", "prod", "stage2", "prod2"]);
+    });
+    it("does not include disabled envs", function () {
+      var envs = (0, _1.getAllEnvsByTrigger)(SIMPLE_CONFIG, "app3", "taggedRelease");
+      expect(envs).toEqual([]);
+    });
+  });
+});

package/dist/config/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./configruedEnvs";
+export * from "./readConfig";