@catladder/pipeline 1.89.0 → 1.89.2

package/src/build/rails/test.ts

@@ -17,66 +17,70 @@ export const createRailsTestJobs = (context: Context): CatladderJob[] => {
     envMode: "none",
   };
   const defaultImage = "docker.io/ruby";
-  const bundlerCacheDir = "tmp/cache"
+  const bundlerCacheDir = "tmp/cache";
   const bundlerInstall = [
     `bundle config set path '${bundlerCacheDir}'`,
-    "bundle install -j $(nproc)"
-  ]
+    "bundle install -j $(nproc)",
+  ];
   const bundlerCache = {
     key: {
       files: ["Gemfile.lock"],
-      prefix: "$CI_JOB_IMAGE" // a changed image might have different OS libraries which no longer work with the cached gems
+      prefix: "$CI_JOB_IMAGE", // a changed image might have different OS libraries which no longer work with the cached gems
     },
-    paths: [bundlerCacheDir]
-  }
+    paths: [bundlerCacheDir],
+  };
   const auditJob: CatladderJob | null =
     buildConfig.audit !== false
       ? {
-        name: "🛡 audit",
+          name: "🛡 audit",
 
-        ...base,
-        cache: undefined, // audit does not need bundle install and no cache
-        image: buildConfig.audit?.jobImage ?? defaultImage,
-        script: [
-          `cd ${context.componentConfig.dir}`,
-          ...(ensureArray(buildConfig.audit?.command) ?? [
-            "gem install bundler-audit",
-            "bundle audit check"
-          ]),
-        ],
-        allow_failure: true,
-      }
+          ...base,
+          cache: undefined, // audit does not need bundle install and no cache
+          image: buildConfig.audit?.jobImage ?? defaultImage,
+          script: [
+            `cd ${context.componentConfig.dir}`,
+            ...(ensureArray(buildConfig.audit?.command) ?? [
+              "gem install bundler-audit",
+              "bundle audit check",
+            ]),
+          ],
+          allow_failure: true,
+        }
       : null;
 
   const lintJob: CatladderJob | null =
     buildConfig.lint !== false
       ? {
-        name: "👮 lint",
+          name: "👮 lint",
 
-        ...base,
-        cache: bundlerCache,
-        image: buildConfig.lint?.jobImage ?? defaultImage,
-        script: [
-          `cd ${context.componentConfig.dir}`,
-          ...bundlerInstall,
-          ...(ensureArray(buildConfig.lint?.command) ?? ["bundle exec rubocop"]),
-        ],
-      }
+          ...base,
+          cache: bundlerCache,
+          image: buildConfig.lint?.jobImage ?? defaultImage,
+          script: [
+            `cd ${context.componentConfig.dir}`,
+            ...bundlerInstall,
+            ...(ensureArray(buildConfig.lint?.command) ?? [
+              "bundle exec rubocop",
+            ]),
+          ],
+        }
       : null;
   const testJob: CatladderJob | null =
     buildConfig.test !== false
       ? {
-        name: "🧪 test",
+          name: "🧪 test",
 
-        ...base,
-        cache: bundlerCache,
-        image: buildConfig.test?.jobImage ?? defaultImage,
-        script: [
-          `cd ${context.componentConfig.dir}`,
-          ...bundlerInstall,
-          ...(ensureArray(buildConfig.test?.command) ?? ["bundle exec rspec"]),
-        ],
-      }
+          ...base,
+          cache: bundlerCache,
+          image: buildConfig.test?.jobImage ?? defaultImage,
+          script: [
+            `cd ${context.componentConfig.dir}`,
+            ...bundlerInstall,
+            ...(ensureArray(buildConfig.test?.command) ?? [
+              "bundle exec rspec",
+            ]),
+          ],
+        }
       : null;
   return [auditJob, lintJob, testJob].filter(notNil);
 };

package/src/config/configruedEnvs.ts

@@ -1,11 +1,5 @@
-import type {
-  Config,
-  EnvType,
-  PipelineTrigger} from "../types";
-import {
-  DEFAULT_ENV_TYPES,
-  getEnvTypesByTrigger
-} from "../types";
+import type { Config, EnvType, PipelineTrigger } from "../types";
+import { DEFAULT_ENV_TYPES, getEnvTypesByTrigger } from "../types";
 
 const getConfiguredAndDefaultEnvs = (
   config: Config,

package/src/deploy/kubernetes/deployJob.ts

@@ -40,7 +40,8 @@ export const createKubernetesDeployJobs = (
         quotingType: "'",
         forceQuotes: true,
       }),
-      HELM_GITLAB_CHART_NAME: deployConfig.chartName ?? "/helm-charts/the-panter-chart",
+      HELM_GITLAB_CHART_NAME:
+        deployConfig.chartName ?? "/helm-charts/the-panter-chart",
       HELM_ARGS: [
         ...(deployConfig.debug ? ["--debug"] : []),
         ...(deployConfig.additionalHelmArgs ?? []),

package/src/pipeline/createAllJobs.ts

@@ -0,0 +1,38 @@
+import { getAllEnvsByTrigger } from "../config";
+import type { Config, PipelineTrigger } from "../types";
+import type { CatladderJob } from "../types/jobs";
+import { createJobsForComponent } from "./createJobsForComponent";
+
+export type AllCatladderJobs = {
+  [componentName: string]: {
+    [env: string]: Array<CatladderJob>;
+  };
+};
+export const createAllJobs = async (
+  config: Config,
+  trigger: PipelineTrigger
+): Promise<AllCatladderJobs> => {
+  return Object.fromEntries(
+    await Promise.all(
+      Object.keys(config.components).map(async (componentName) => {
+        const envs = getAllEnvsByTrigger(config, componentName, trigger);
+        return [
+          componentName,
+          Object.fromEntries(
+            await Promise.all(
+              envs.map(async (env) => [
+                env,
+                await createJobsForComponent(
+                  config,
+                  componentName,
+                  env,
+                  trigger
+                ),
+              ])
+            )
+          ),
+        ];
+      })
+    )
+  );
+};

package/src/pipeline/createChildPipeline.ts

@@ -1,34 +1,18 @@
-import { getAllEnvsByTrigger, getAllEnvsInAllComponents } from "../config";
+import { getAllEnvsInAllComponents } from "../config";
 import { RULES_ALWAYS } from "../rules";
 import { getRunnerImage } from "../runner";
-import type {
-  GitlabPipeline,
-  Pipeline,
-  PipelineJob,
-  PipelineType,
-} from "../types";
+import type { GitlabPipeline, Pipeline, PipelineType } from "../types";
 import type { Config, PipelineTrigger } from "../types/config";
 import { BASE_STAGES } from "../types/jobs";
-import { createJobs } from "./createJobs";
+import { createAllJobs } from "./createAllJobs";
+import { createGitlabJobs } from "./gitlab/createGitlabJobs";
 
 export const createChildPipeline = async <T extends PipelineType>(
   type: T,
   trigger: PipelineTrigger,
   config: Config
 ): Promise<Pipeline<T>> => {
-  const components = Object.keys(config.components);
-
-  // 2. write the triggering pipeline
-  const jobs = await components.reduce<Promise<Record<string, PipelineJob<T>>>>(
-    async (acc, componentName) => {
-      const envs = getAllEnvsByTrigger(config, componentName, trigger);
-      return {
-        ...(await acc),
-        ...(await createJobs(type, envs, config, componentName, trigger)),
-      };
-    },
-    Promise.resolve({})
-  );
+  const jobs = await createAllJobs(config, trigger);
 
   // while technically not required, we group different envs in its own stage
   // each job from `createJobs` that is defined as `envMode: "stagePerEnv"` will have `deploy dev`, etc. instead of just `deploy`
@@ -53,7 +37,7 @@ export const createChildPipeline = async <T extends PipelineType>(
         rules: RULES_ALWAYS,
       },
       stages,
-      jobs,
+      jobs: await createGitlabJobs(jobs),
     };
     return pipeline as Pipeline<T>;
   }

package/src/pipeline/createJobsForComponent.ts

@@ -0,0 +1,64 @@
+import { isFunction } from "lodash";
+import { BUILD_TYPES } from "../build";
+import { createContext } from "../context";
+import { DEPLOY_TYPES } from "../deploy";
+import type { Config, PipelineTrigger } from "../types/config";
+import type { CommitInfo, Context } from "../types/context";
+import type { CatladderJob } from "../types/jobs";
+import { getBaseCommitInfo } from "./commitInfo/getCommitInfo";
+import { getPackageManagerInfo } from "./packageManager";
+
+const injectDefaultVarsInCustomJobs = (
+  context: Context,
+  jobs: CatladderJob[]
+) =>
+  jobs.map(({ variables, ...job }) => ({
+    variables: {
+      ...(context.environment.envVars ?? {}),
+      ...(variables ?? {}),
+    },
+    ...job,
+  }));
+const getCustomJobs = (context: Context) => {
+  if (!context.componentConfig.customJobs) {
+    return [];
+  }
+  const rawJobs = isFunction(context.componentConfig.customJobs)
+    ? context.componentConfig.customJobs(context)
+    : context.componentConfig.customJobs;
+  return injectDefaultVarsInCustomJobs(context, rawJobs);
+};
+const createRawJobs = (context: Context): CatladderJob[] => {
+  if (context.componentConfig.deploy === false) {
+    return [];
+  }
+  const buildJobs =
+    BUILD_TYPES[context.componentConfig.build.type].jobs(context);
+  const deployJobs =
+    DEPLOY_TYPES[context.componentConfig.deploy.type].jobs(context);
+
+  const customJobs = getCustomJobs(context);
+  return [...buildJobs, ...deployJobs, ...customJobs];
+};
+export const createJobsForComponent = async (
+  config: Config,
+  componentName: string,
+  env: string,
+  trigger: PipelineTrigger
+): Promise<Array<CatladderJob>> => {
+  const commitInfo: CommitInfo = {
+    ...(await getBaseCommitInfo()),
+    trigger,
+  };
+
+  const packageManagerInfo = await getPackageManagerInfo(config, componentName);
+
+  const context = await createContext(
+    config,
+    componentName,
+    env,
+    commitInfo,
+    packageManagerInfo
+  );
+  return createRawJobs(context);
+};

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -0,0 +1,149 @@
+import { isObject } from "lodash";
+import { BASE_RETRY } from "../../defaults";
+import type { GitlabJobDef } from "../../types";
+import type { CatladderJob, CatladderJobNeed } from "../../types/jobs";
+import type { AllCatladderJobs } from "../createAllJobs";
+
+type AllGitlabJobs = Record<string, GitlabJobDef>;
+
+const getFullJobName = (
+  name: string,
+  componentName: string,
+  env?: string | null
+) => {
+  if (env) {
+    return `${componentName} ${name} | ${env} `;
+  }
+  return `${componentName} ${name}`;
+};
+
+const getFullReferencedJobName = (
+  referencedJobName: string,
+  componentName: string,
+  env: string,
+  allJobs: AllCatladderJobs
+) => {
+  const referencedJob = allJobs[componentName]?.[env]?.find(
+    (j) => j.name === referencedJobName
+  );
+  if (!referencedJob) {
+    throw new Error(
+      `unknown job referenced: '${referencedJobName}' from '${env}:${componentName}'`
+    );
+  }
+  const envToSet = referencedJob.envMode !== "none" ? env : null;
+  return getFullJobName(referencedJobName, componentName, envToSet);
+};
+
+const getJobName = (need: CatladderJobNeed) =>
+  isObject(need) ? need.job : need;
+
+export const makeGitlabJob = (
+  componentName: string,
+  env: string,
+  {
+    envMode,
+    needsStages,
+    needsOtherComponent,
+    name,
+    needs,
+    ...job
+  }: CatladderJob<string>,
+  allJobs: AllCatladderJobs
+): [fullName: string, job: GitlabJobDef] => {
+  const stage = envMode === "stagePerEnv" ? `${job.stage} ${env}` : job.stage;
+
+  const needsFromStages: CatladderJob["needs"] = needsStages?.flatMap((n) => {
+    const referencedComponentName = componentName;
+    const allJobNamesFromThatStage =
+      allJobs[referencedComponentName]?.[env]
+        ?.filter((j) => j.stage === n.stage)
+        ?.map((j) => j.name) ?? [];
+
+    return allJobNamesFromThatStage.map((job) => ({
+      job,
+      artifacts: n.artifacts ?? false,
+      componentName: referencedComponentName,
+    }));
+  });
+  const cleanedNeeds: CatladderJob["needs"] = [
+    ...(needs ?? []),
+    // pull in legacy needs from other component, which is now identical to needs
+    ...(needsOtherComponent ?? []),
+    ...(needsFromStages ?? []),
+  ];
+
+  const gitlabNeeds: GitlabJobDef["needs"] = cleanedNeeds
+    ?.map((n) =>
+      isObject(n)
+        ? {
+            job: getFullReferencedJobName(
+              n.job,
+              n.componentName ?? componentName,
+              env,
+              allJobs
+            ),
+            artifacts: n.artifacts,
+          }
+        : getFullReferencedJobName(n, componentName, env, allJobs)
+    ) // sort in a predictable manner for snapshot tests
+    .sort((a, b) => getJobName(a).localeCompare(getJobName(b)));
+
+  const fullJobName = getFullJobName(
+    name,
+    componentName,
+    envMode !== "none" ? env : undefined
+  );
+
+  const gitlabJob = {
+    ...job,
+    stage,
+    environment: job.environment?.on_stop
+      ? {
+          ...job.environment,
+          on_stop: getFullReferencedJobName(
+            job.environment.on_stop,
+            componentName,
+            env,
+            allJobs
+          ),
+        }
+      : job.environment,
+    // sort in a predictable manner for snapshot tests
+    needs: gitlabNeeds,
+    retry: BASE_RETRY,
+    interruptible: true,
+  };
+
+  return [fullJobName, gitlabJob];
+};
+
+export const createGitlabJobs = async (
+  allJobs: AllCatladderJobs
+): Promise<AllGitlabJobs> => {
+  return Object.keys(allJobs).reduce((accForComponents, componentName) => {
+    const componentJobs = allJobs[componentName];
+    return {
+      ...accForComponents,
+      ...Object.keys(componentJobs).reduce((accForEnvs, env) => {
+        const jobs = componentJobs[env];
+
+        return {
+          ...accForEnvs,
+          ...jobs.reduce((accForJobs, job) => {
+            const [fullJobName, gitlabJob] = makeGitlabJob(
+              componentName,
+              env,
+              job,
+              allJobs
+            );
+            return {
+              ...accForJobs,
+              [fullJobName]: gitlabJob,
+            };
+          }, {} as AllGitlabJobs),
+        };
+      }, {} as AllGitlabJobs),
+    };
+  }, {} as AllGitlabJobs);
+};

package/src/pipeline/index.ts

@@ -1,2 +1,2 @@
 export * from "./createChildPipeline";
-export * from "./createJobs";
+export * from "./createJobsForComponent";

package/src/types/gitlab-types.ts

@@ -5,7 +5,7 @@ export type Artifacts = {
   reports?: ArtifactReports;
 };
 // Reports won't show up on MRs until https://gitlab.com/groups/gitlab-org/-/epics/8205
-export type ArtifactReports = 
+export type ArtifactReports =
   | { accessibility: string | string[] }
   | { coverage_report: string | string[] }
   | { codequality: string | string[] }
@@ -14,7 +14,7 @@ export type ArtifactReports =
   | { junit: string | string[] }
   | { sast: string | string[] }
   | { secret_detection: string | string[] }
-  | { terraform: string | string[] }
+  | { terraform: string | string[] };
 export type GitlabJobCache = {
   key: GitlabJobCacheKey;
   policy?: string;
@@ -43,10 +43,12 @@ export type GitlabJobService = {
   alias?: string;
 };
 
-export type GitlabJobImage = string | {
-  name: string;
-  entrypoint?: string[];
-}
+export type GitlabJobImage =
+  | string
+  | {
+      name: string;
+      entrypoint?: string[];
+    };
 
 export type GitlabEnvironment = {
   url: string;

package/dist/pipeline/createJobs.d.ts

@@ -1,3 +0,0 @@
-import type { PipelineJob } from "../types";
-import type { Config, PipelineTrigger } from "../types/config";
-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/gitlab/makeGitlabJob.d.ts

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

package/dist/pipeline/gitlab/makeGitlabJob.js

@@ -1,75 +0,0 @@
-"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;
-};
-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.makeGitlabJob = void 0;
-var lodash_1 = require("lodash");
-var defaults_1 = require("../../defaults");
-var getJobName = function (need) {
-  return (0, lodash_1.isObject)(need) ? need.job : need;
-};
-var makeGitlabJob = function (_a) {
-  var envMode = _a.envMode,
-    needsStages = _a.needsStages,
-    needsOtherComponent = _a.needsOtherComponent,
-    name = _a.name,
-    needs = _a.needs,
-    rest = __rest(_a, ["envMode", "needsStages", "needsOtherComponent", "name", "needs"]);
-  return __assign(__assign({}, rest), {
-    // sort in a predictable manner for snapshot tests
-    needs: needs ? __spreadArray([], __read(needs), false).sort(function (a, b) {
-      return getJobName(a).localeCompare(getJobName(b));
-    }) : undefined,
-    retry: defaults_1.BASE_RETRY,
-    interruptible: true
-  });
-};
-exports.makeGitlabJob = makeGitlabJob;