@catladder/pipeline 1.10.2 → 1.13.0

package/dist/context/index.js

@@ -183,7 +183,7 @@ var getEnvironment = function (config, componentName, env, commitInfo, skipRefer
 
 exports.getEnvironment = getEnvironment;
 
-var createContext = function (config, componentName, env, commitInfo, yarnInfo) {
+var createContext = function (config, componentName, env, commitInfo, packageManagerInfo) {
   var _a, _b;
 
   if (!/^[a-z0-9-]+$/.test(componentName)) {
@@ -214,7 +214,7 @@ var createContext = function (config, componentName, env, commitInfo, yarnInfo)
     componentName: componentName,
     environment: (0, exports.getEnvironment)(config, componentName, env, commitInfo),
     commitInfo: commitInfo,
-    yarnInfo: yarnInfo
+    packageManagerInfo: packageManagerInfo
   };
 };
 

package/dist/deploy/base.d.ts

@@ -1,9 +1,8 @@
-import { GitlabJob, Context, GitlabJobDef } from "../types";
+import { Context } from "../types";
+import { CatladderJob } from "../types/jobs";
 export declare const DEPLOY_JOB_NAME = "\uD83D\uDE80 Deploy";
 export declare const STOP_JOB_NAME = "\uD83D\uDED1 Stop \u26A0\uFE0F";
-declare type JobWithoutScript = Omit<GitlabJob, "job"> & {
-  job: Omit<GitlabJobDef, "script">;
-};
+declare type JobWithoutScript = Omit<CatladderJob, "script">;
 export declare const getBaseDeploymentJob: (context: Context) => JobWithoutScript;
 export declare const getBaseDeploymentStopJob: (context: Context) => JobWithoutScript;
 export {};

package/dist/deploy/base.js

@@ -49,20 +49,17 @@ var getBaseDeploymentJob = function (context) {
       stage: "test",
       artifacts: false
     }],
-    job: {
-      rules: [autoDeploy ? {
-        when: "on_success"
-      } : {
-        when: "manual"
-      }],
-      stage: "deploy",
-      dependencies: [],
-      variables: __assign({}, DEPLOY_RUNNER_VARIABLES),
-      environment: __assign(__assign({}, environment), {
-        on_stop: exports.STOP_JOB_NAME,
-        auto_stop_in: autoStop
-      })
-    }
+    rules: [autoDeploy ? {
+      when: "on_success"
+    } : {
+      when: "manual"
+    }],
+    stage: "deploy",
+    variables: __assign({}, DEPLOY_RUNNER_VARIABLES),
+    environment: __assign(__assign({}, environment), {
+      on_stop: exports.STOP_JOB_NAME,
+      auto_stop_in: autoStop
+    })
   };
 };
 
@@ -76,25 +73,22 @@ var getBaseDeploymentStopJob = function (context) {
   return {
     name: exports.STOP_JOB_NAME,
     envMode: "stagePerEnv",
-    job: {
-      needs: [exports.DEPLOY_JOB_NAME],
-      rules: [{
-        "if": "$CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/",
-        when: "on_success",
-        allow_failure: true
-      }, {
-        when: "manual",
-        allow_failure: true
-      }],
-      variables: __assign(__assign({}, DEPLOY_RUNNER_VARIABLES), {
-        GIT_STRATEGY: "none"
-      }),
-      stage: "stop",
-      dependencies: [],
-      environment: __assign(__assign({}, environment), {
-        action: "stop"
-      })
-    }
+    needs: [exports.DEPLOY_JOB_NAME],
+    rules: [{
+      "if": "$CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/",
+      when: "on_success",
+      allow_failure: true
+    }, {
+      when: "manual",
+      allow_failure: true
+    }],
+    variables: __assign(__assign({}, DEPLOY_RUNNER_VARIABLES), {
+      GIT_STRATEGY: "none"
+    }),
+    stage: "stop",
+    environment: __assign(__assign({}, environment), {
+      action: "stop"
+    })
   };
 };
 

package/dist/deploy/index.d.ts

@@ -1,11 +1,11 @@
-import { GitlabJobs } from "../types/gitlab-types";
 import { Context } from "../types/context";
+import { CatladderJob } from "../types/jobs";
 import { DeployConfig } from "./types";
 export * from "./kubernetes";
 export * from "./types";
 export * from "./utils";
 export declare type DeployTypes = { [type in DeployConfig["type"]]: {
-  jobs: (context: Context) => GitlabJobs;
+  jobs: (context: Context) => CatladderJob[];
   defaults: () => Partial<Extract<DeployConfig, {
     type: type;
   }>>;

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

@@ -1,3 +1,3 @@
-import { GitlabJobs } from "../../types/gitlab-types";
 import { Context } from "../../types/context";
-export declare const createKubernetesDeployJobs: (context: Context) => GitlabJobs;
+import { CatladderJob } from "../../types/jobs";
+export declare const createKubernetesDeployJobs: (context: Context) => CatladderJob[];

package/dist/deploy/kubernetes/deployJob.js

@@ -52,23 +52,23 @@ var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
 exports.__esModule = true;
 exports.createKubernetesDeployJobs = void 0;
 
-var types_1 = require("../types");
+var js_yaml_1 = require("js-yaml");
 
-var runner_1 = require("../../runner");
+var lodash_1 = require("lodash");
 
-var base_1 = require("../base");
+var __1 = require("../..");
 
-var lodash_1 = require("lodash");
+var runner_1 = require("../../runner");
 
-var js_yaml_1 = require("js-yaml");
+var utils_1 = require("../../utils");
 
-var mongodb_1 = require("./mongodb");
+var base_1 = require("../base");
 
-var cloudsql_1 = require("./cloudsql");
+var types_1 = require("../types");
 
-var __1 = require("../..");
+var cloudsql_1 = require("./cloudsql");
 
-var utils_1 = require("../../utils");
+var mongodb_1 = require("./mongodb");
 
 var createKubernetesDeployJobs = function (context) {
   var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
@@ -140,43 +140,37 @@ var createKubernetesDeployJobs = function (context) {
     namespace: context.environment.envVars.KUBE_NAMESPACE
   };
   var shared = {
-    job: {
-      image: (0, runner_1.getRunnerImage)("kubernetes"),
-      variables: __assign(__assign({}, context.environment.envVars), {
-        HELM_EXPERIMENTAL_OCI: "1",
-        IMAGE_PULL_SECRET: "gitlab-registry-".concat(context.componentName),
-        KUBE_VALUES: (0, js_yaml_1.dump)(kubeValues, {
-          lineWidth: -1,
-          quotingType: "'",
-          forceQuotes: true
-        }),
-        HELM_GITLAB_CHART_NAME: "the-panter-chart",
-        HELM_ARGS: __spreadArray(__spreadArray([], __read(deployConfig.debug ? ["--debug"] : []), false), __read((_p = deployConfig.additionalHelmArgs) !== null && _p !== void 0 ? _p : []), false).join(" "),
-        COMPONENT_NAME: context.componentName,
-        BUILD_ID: (_q = context.commitInfo) === null || _q === void 0 ? void 0 : _q.buildId,
-        // TODO: unify with docker build stage
-        IMAGE_NAME: context.environment.shortName + "/" + context.componentName,
-        IMAGE_TAG: "$CI_COMMIT_SHA"
-      })
-    }
+    image: (0, runner_1.getRunnerImage)("kubernetes"),
+    variables: __assign(__assign({}, context.environment.envVars), {
+      HELM_EXPERIMENTAL_OCI: "1",
+      IMAGE_PULL_SECRET: "gitlab-registry-".concat(context.componentName),
+      KUBE_VALUES: (0, js_yaml_1.dump)(kubeValues, {
+        lineWidth: -1,
+        quotingType: "'",
+        forceQuotes: true
+      }),
+      HELM_GITLAB_CHART_NAME: "the-panter-chart",
+      HELM_ARGS: __spreadArray(__spreadArray([], __read(deployConfig.debug ? ["--debug"] : []), false), __read((_p = deployConfig.additionalHelmArgs) !== null && _p !== void 0 ? _p : []), false).join(" "),
+      COMPONENT_NAME: context.componentName,
+      BUILD_ID: (_q = context.commitInfo) === null || _q === void 0 ? void 0 : _q.buildId,
+      // TODO: unify with docker build stage
+      IMAGE_NAME: context.environment.shortName + "/" + context.componentName,
+      IMAGE_TAG: "$CI_COMMIT_SHA"
+    })
   };
   var baseDeploymentJob = (0, base_1.getBaseDeploymentJob)(context);
   var baseStopJob = (0, base_1.getBaseDeploymentStopJob)(context);
   var clusterName = "kube-".concat(context.environment.fullName);
   var connectContext = ["kubectl config set-cluster \"".concat(clusterName, "\" --server=\"$").concat((0, __1.getSecretVarNameForContext)(context, "KUBE_URL"), "\" --certificate-authority <(echo $").concat((0, __1.getSecretVarNameForContext)(context, "KUBE_CA_PEM"), " | base64 -d) --embed-certs=true"), "kubectl config set-credentials \"".concat(clusterName, "\" --token=\"$").concat((0, __1.getSecretVarNameForContext)(context, "KUBE_TOKEN"), "\""), "kubectl config set-context \"".concat(clusterName, "\" --cluster=\"").concat(clusterName, "\" --user=\"").concat(clusterName, "\" --namespace=\"").concat(context.environment.envVars.KUBE_NAMESPACE, "\""), "kubectl config use-context \"".concat(clusterName, "\"")];
   return [(0, lodash_1.merge)({}, baseDeploymentJob, shared, {
-    job: {
-      script: __spreadArray(__spreadArray([], __read(connectContext), false), ["kubernetesCreateSecret", "kubernetesDeploy", "echo deployment successful 😻"], false),
-      environment: {
-        kubernetes: kubernetesEnvironment
-      }
+    script: __spreadArray(__spreadArray([], __read(connectContext), false), ["kubernetesCreateSecret", "kubernetesDeploy", "echo deployment successful 😻"], false),
+    environment: {
+      kubernetes: kubernetesEnvironment
     }
   }), (0, lodash_1.merge)({}, baseStopJob, shared, {
-    job: {
-      script: __spreadArray(__spreadArray([], __read(connectContext), false), ["kubernetesDelete"], false),
-      environment: {
-        kubernetes: kubernetesEnvironment
-      }
+    script: __spreadArray(__spreadArray([], __read(connectContext), false), ["kubernetesDelete"], false),
+    environment: {
+      kubernetes: kubernetesEnvironment
     }
   })];
 };

package/dist/pipeline/createChildPipeline.d.ts

@@ -1,12 +1,3 @@
+import { Pipeline } from "../types";
 import { Config, PipelineTrigger } from "../types/config";
-import { GitlabJobDef } from "../types/gitlab-types";
-export declare const createChildPipeline: (trigger: PipelineTrigger, config: Config) => Promise<{
-  image: string;
-  variables: {
-    FF_USE_FASTZIP: string;
-  };
-  workflow: {
-    rules: import("../types/gitlab-types").GitlabRule[];
-  };
-  stages: string[];
-} & Record<string, GitlabJobDef>>;
+export declare const createChildPipeline: <T extends "gitlab">(type: T, trigger: PipelineTrigger, config: Config) => Promise<Pipeline<T>>;

package/dist/pipeline/createChildPipeline.js

@@ -195,17 +195,17 @@ exports.createChildPipeline = void 0;
 
 var config_1 = require("../config");
 
-var createJobs_1 = require("./createJobs");
-
 var rules_1 = require("../rules");
 
 var runner_1 = require("../runner");
 
+var createJobs_1 = require("./createJobs");
+
 var baseStages = ["setup", "test", "build", "deploy", "verify", "stop"];
 
-var createChildPipeline = function (trigger, config) {
+var createChildPipeline = function (type, trigger, config) {
   return __awaiter(void 0, void 0, void 0, function () {
-    var components, jobs, allEnvs, stages, childPipeline;
+    var components, jobs, allEnvs, stages, pipeline;
     return __generator(this, function (_a) {
       switch (_a.label) {
         case 0:
@@ -229,7 +229,7 @@ var createChildPipeline = function (trigger, config) {
                     _b = [__assign.apply(void 0, _a.concat([_c.sent()]))];
                     return [4
                     /*yield*/
-                    , (0, createJobs_1.createJobs)(envs, config, componentName, trigger)];
+                    , (0, createJobs_1.createJobs)(type, envs, config, componentName, trigger)];
 
                   case 2:
                     return [2
@@ -248,19 +248,25 @@ var createChildPipeline = function (trigger, config) {
               return "".concat(baseStage, " ").concat(e);
             })), false);
           }, []);
-          childPipeline = __assign({
-            image: (0, runner_1.getRunnerImage)("jobs-default"),
-            variables: {
-              FF_USE_FASTZIP: "true"
-            },
-            workflow: {
-              rules: rules_1.RULES_ALWAYS
-            },
-            stages: stages
-          }, jobs);
-          return [2
-          /*return*/
-          , childPipeline];
+
+          if (type === "gitlab") {
+            pipeline = {
+              image: (0, runner_1.getRunnerImage)("jobs-default"),
+              variables: {
+                FF_USE_FASTZIP: "true"
+              },
+              workflow: {
+                rules: rules_1.RULES_ALWAYS
+              },
+              stages: stages,
+              jobs: jobs
+            };
+            return [2
+            /*return*/
+            , pipeline];
+          }
+
+          throw new Error("".concat(type, " is not supported"));
       }
     });
   });

package/dist/pipeline/createChildPipeline.test.js

@@ -141,17 +141,6 @@ 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;
-};
-
 exports.__esModule = true;
 
 var createChildPipeline_1 = require("./createChildPipeline");
@@ -181,17 +170,17 @@ describe("createChildPipeline", function () {
     };
     it("creates a pipeline for a single app on the main branch", function () {
       return __awaiter(void 0, void 0, void 0, function () {
-        var _a, image, stages, workflow, jobs;
+        var _a, image, jobs;
 
         return __generator(this, function (_b) {
           switch (_b.label) {
             case 0:
               return [4
               /*yield*/
-              , (0, createChildPipeline_1.createChildPipeline)("mainBranch", config)];
+              , (0, createChildPipeline_1.createChildPipeline)("gitlab", "mainBranch", config)];
 
             case 1:
-              _a = _b.sent(), image = _a.image, stages = _a.stages, workflow = _a.workflow, jobs = __rest(_a, ["image", "stages", "workflow"]);
+              _a = _b.sent(), image = _a.image, jobs = _a.jobs;
               expect(image).toEqual("git.panter.ch:5001/catladder/catladder/base-pipeline:");
               expect(Object.keys(jobs)).toEqual(["my-app audit", "my-app lint", "my-app test", "dev my-app app-build", "dev my-app docker-build", "dev my-app deploy-to-kubernetes", "dev my-app kubernetes-stop"]);
               return [2

package/dist/pipeline/createJobs.d.ts

@@ -1,3 +1,3 @@
+import { PipelineJob } from "../types";
 import { Config, PipelineTrigger } from "../types/config";
-import { GitlabJobDef } from "../types/gitlab-types";
-export declare const createJobs: (envs: string[], config: Config, componentName: string, trigger: PipelineTrigger) => Promise<Record<string, GitlabJobDef>>;
+export declare const createJobs: <T extends "gitlab">(type: T, envs: string[], config: Config, componentName: string, trigger: PipelineTrigger) => Promise<Record<string, PipelineJob<T>>>;

package/dist/pipeline/createJobs.js

@@ -205,7 +205,9 @@ var deploy_1 = require("../deploy");
 
 var utils_1 = require("../utils");
 
-var yarnInfo_1 = require("./yarnInfo");
+var makeGitlabJob_1 = require("./gitlab/makeGitlabJob");
+
+var packageManager_1 = require("./packageManager");
 
 var createRawJobs = function (context) {
   if (context.componentConfig.deploy === false) {
@@ -241,24 +243,20 @@ var getFullReferencedJobName = function (referencedJobName, componentName, env,
 
 
 var replaceReferences = function (job, componentName, env, allRawJobs) {
-  var _a, _b, _c;
+  var _a, _b;
 
-  var def = job.job;
-  var stage = job.envMode === "stagePerEnv" ? "".concat(def.stage, " ").concat(env) : def.stage;
-  return __assign(__assign({}, def), {
+  var stage = job.envMode === "stagePerEnv" ? "".concat(job.stage, " ").concat(env) : job.stage;
+  return __assign(__assign({}, job), {
     stage: stage,
-    needs: (_a = def.needs) === null || _a === void 0 ? void 0 : _a.map(function (n) {
+    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 = def.environment) === null || _b === void 0 ? void 0 : _b.on_stop) ? __assign(__assign({}, def.environment), {
-      on_stop: getFullReferencedJobName(def.environment.on_stop, componentName, env, allRawJobs)
-    }) : def.environment,
-    dependencies: (_c = def.dependencies) === null || _c === void 0 ? void 0 : _c.map(function (n) {
-      return getFullReferencedJobName(n, componentName, env, allRawJobs);
-    })
+    environment: ((_b = job.environment) === null || _b === void 0 ? void 0 : _b.on_stop) ? __assign(__assign({}, job.environment), {
+      on_stop: getFullReferencedJobName(job.environment.on_stop, componentName, env, allRawJobs)
+    }) : job.environment
   });
 }; // this can be removed once https://gitlab.com/gitlab-org/gitlab/-/issues/220758 is resolved
 
@@ -276,7 +274,7 @@ var addStageNeeds = function (jobs) {
       var _a, _b;
 
       var neededStage = (_a = job.needsStages) === null || _a === void 0 ? void 0 : _a.find(function (s) {
-        return j.job.stage === s.stage;
+        return j.stage === s.stage;
       });
 
       if (neededStage) {
@@ -287,16 +285,14 @@ var addStageNeeds = function (jobs) {
       }
     }).filter(utils_1.notNil);
     return __assign(__assign({}, job), {
-      job: __assign(__assign({}, job.job), {
-        needs: __spreadArray(__spreadArray([], __read((_a = job.job.needs) !== null && _a !== void 0 ? _a : []), false), __read(neededJobs), false)
-      })
+      needs: __spreadArray(__spreadArray([], __read((_a = job.needs) !== null && _a !== void 0 ? _a : []), false), __read(neededJobs), false)
     });
   });
 };
 
-var createJobs = function (envs, config, componentName, trigger) {
+var createJobs = function (type, envs, config, componentName, trigger) {
   return __awaiter(void 0, void 0, void 0, function () {
-    var commitInfo, yarnInfo;
+    var commitInfo, packageManagerInfo;
 
     var _a;
 
@@ -320,20 +316,30 @@ var createJobs = function (envs, config, componentName, trigger) {
           commitInfo = (_a.buildId = _d.sent(), _a.trigger = trigger, _a);
           return [4
           /*yield*/
-          , (0, yarnInfo_1.getYarnInfo)(config, componentName)];
+          , (0, packageManager_1.getPackageManagerInfo)(config, componentName)];
 
         case 2:
-          yarnInfo = _d.sent();
+          packageManagerInfo = _d.sent();
           return [2
           /*return*/
           , envs.reduce(function (acc, env) {
-            var context = (0, context_1.createContext)(config, componentName, env, commitInfo, yarnInfo);
+            var context = (0, context_1.createContext)(config, componentName, env, commitInfo, packageManagerInfo);
             var jobs = addStageNeeds(createRawJobs(context));
-            return __assign(__assign({}, acc), jobs.reduce(function (acc, job) {
+
+            var result = __assign(__assign({}, acc), jobs.reduce(function (acc, job) {
               var _a;
 
-              return __assign(__assign({}, acc), (_a = {}, _a[getFullJobName(job.name, componentName, job.envMode !== "none" ? env : undefined)] = replaceReferences(job, componentName, env, jobs), _a));
+              var jobWithResolvedReferences = replaceReferences(job, componentName, env, jobs);
+              var jobName = getFullJobName(job.name, componentName, job.envMode !== "none" ? env : undefined);
+
+              if (type === "gitlab") {
+                return __assign(__assign({}, acc), (_a = {}, _a[jobName] = (0, makeGitlabJob_1.makeGitlabJob)(jobWithResolvedReferences), _a));
+              }
+
+              throw new Error("not supported");
             }, {}));
+
+            return result;
           }, {})];
       }
     });

package/dist/pipeline/gitlab/makeGitlabJob.d.ts

@@ -0,0 +1,8 @@
+import { GitlabJobDef } from "../../types";
+import { CatladderJob } from "../../types/jobs";
+export declare const makeGitlabJob: ({
+  envMode,
+  needsStages,
+  name,
+  ...rest
+}: CatladderJob<string>) => GitlabJobDef;

package/dist/pipeline/gitlab/makeGitlabJob.js

@@ -0,0 +1,45 @@
+"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 __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;
+exports.makeGitlabJob = void 0;
+
+var defaults_1 = require("../../defaults");
+
+var makeGitlabJob = function (_a) {
+  var envMode = _a.envMode,
+      needsStages = _a.needsStages,
+      name = _a.name,
+      rest = __rest(_a, ["envMode", "needsStages", "name"]);
+
+  return __assign(__assign({}, rest), {
+    retry: defaults_1.BASE_RETRY,
+    interruptible: true
+  });
+};
+
+exports.makeGitlabJob = makeGitlabJob;

package/dist/pipeline/packageManager.d.ts

@@ -0,0 +1,2 @@
+import { Config, PackageManagerInfo } from "../types";
+export declare const getPackageManagerInfo: (config: Config, componentName: string) => Promise<PackageManagerInfo>;