@catladder/pipeline 1.145.0 → 1.146.0

package/src/deploy/kubernetes/deployJob.ts

@@ -15,7 +15,7 @@ import { collapseableSection } from "../../utils/gitlab";
 
 const ALL_VALUES_FILE = "__all_values.yml";
 export const createKubernetesDeployJobs = (
-  context: Context
+  context: Context,
 ): CatladderJob[] => {
   const deployConfig = context.componentConfig.deploy;
   if (deployConfig === false) {
@@ -59,14 +59,14 @@ export const createKubernetesDeployJobs = (
   const connectContext = [
     `kubectl config set-cluster "${clusterName}" --server="$${getSecretVarNameForContext(
       context,
-      "KUBE_URL"
+      "KUBE_URL",
     )}" --certificate-authority <(echo $${getSecretVarNameForContext(
       context,
-      "KUBE_CA_PEM"
+      "KUBE_CA_PEM",
     )} | base64 -d) --embed-certs=true`,
     `kubectl config set-credentials "${clusterName}" --token="$${getSecretVarNameForContext(
       context,
-      "KUBE_TOKEN"
+      "KUBE_TOKEN",
     )}"`,
     `kubectl config set-context "${clusterName}" --cluster="${clusterName}" --user="${clusterName}" --namespace="${context.environment.envVars.KUBE_NAMESPACE}"`,
     `kubectl config use-context "${clusterName}"`,
@@ -79,9 +79,9 @@ export const createKubernetesDeployJobs = (
         ...connectContext,
         ...collapseableSection(
           "writeallvalues",
-          "Write " + ALL_VALUES_FILE + " for helm deployment"
+          "Write " + ALL_VALUES_FILE + " for helm deployment",
         )(
-          writeBashYamlToFileScript(createKubeValues(context), ALL_VALUES_FILE)
+          writeBashYamlToFileScript(createKubeValues(context), ALL_VALUES_FILE),
         ),
         "kubernetesCreateSecret",
         "kubernetesDeploy",

package/src/deploy/kubernetes/index.ts

@@ -37,7 +37,7 @@ export const KUBERNETES_DEPLOY_TYPE: DeployTypeDefinition<"kubernetes"> = {
         fullConfig.customerName,
         domainCanonical,
       ],
-      "."
+      ".",
     ); // default for kubernetes and rest
     return {
       KUBE_NAMESPACE,

package/src/deploy/kubernetes/kubeEnv.ts

@@ -43,7 +43,7 @@ export const createKubeEnv = (context: Context) => {
     {
       secret: {},
       public: {},
-    }
+    },
   );
 
   return env;

package/src/deploy/kubernetes/kubeValues.ts

@@ -15,7 +15,7 @@ import { processSecretsAsFiles } from "./processSecretsAsFiles";
 
 const createAppConfig = (
   context: Context,
-  application: DeployConfigKubernetesValues["application"]
+  application: DeployConfigKubernetesValues["application"],
 ): DeployConfigKubernetesValues["application"] => {
   if (application === false) {
     return {
@@ -45,14 +45,14 @@ const createAppConfig = (
         },
       },
     }, // default
-    rest // merge rest in
+    rest, // merge rest in
   );
 };
 
 const removeFalsy = <T>(record?: Record<string, false | T>) => {
   if (!record) return undefined;
   return Object.fromEntries(
-    Object.entries(record).filter(([, value]) => value !== false)
+    Object.entries(record).filter(([, value]) => value !== false),
   );
 };
 
@@ -84,7 +84,7 @@ export const createKubeValues = (context: Context) => {
       : {},
     deployConfig.values?.mongodb?.enabled
       ? createMongodbBaseConfig(context)
-      : {}
+      : {},
   );
 
   const kubeValues = processSecretsAsFiles(
@@ -93,7 +93,7 @@ export const createKubeValues = (context: Context) => {
       cronjobs: removeFalsy(cronjobs),
 
       ...rest,
-    })
+    }),
   );
 
   return kubeValues;

package/src/deploy/kubernetes/mongodb.ts

@@ -19,7 +19,7 @@ const getMongodbReplicasetHost = (context: Context, index: number) => {
   const fullAppname = context.environment.envVars.KUBE_APP_NAME;
   return getMongodbHost(
     context,
-    `${fullAppname}-mongodb-${index}.${fullAppname}-mongodb-headless`
+    `${fullAppname}-mongodb-${index}.${fullAppname}-mongodb-headless`,
   );
 };
 const createMongodbUrl = (context: Context, dbName: string) => {

package/src/deploy/kubernetes/processSecretsAsFiles.ts

@@ -7,9 +7,9 @@ export const processSecretsAsFiles = <
     env: {
       secret: Record<string, StringOrBashExpression>;
     };
-  } & DeployConfigKubernetesValues
+  } & DeployConfigKubernetesValues,
 >(
-  values: T
+  values: T,
 ): T => {
   if (!values.secretsAsFile || values.secretsAsFile.length === 0) {
     return values;
@@ -27,7 +27,7 @@ export const processSecretsAsFiles = <
           values.secretsAsFile.map((key) => [
             key + "_content",
             values.env.secret[key],
-          ])
+          ]),
         ),
       },
     },

package/src/deploy/utils.ts

@@ -3,7 +3,7 @@ import type { DeployConfigKubernetesCluster } from "./types";
 import { isOfDeployType } from "./types";
 
 export const getFullKubernetesClusterName = (
-  cluster: DeployConfigKubernetesCluster
+  cluster: DeployConfigKubernetesCluster,
 ) => {
   if (cluster.type === "gcloud") {
     return `gke_${cluster.projectId}_${cluster.region}_${cluster.name}`;
@@ -12,7 +12,7 @@ export const getFullKubernetesClusterName = (
 
 export const getKubernetesNamespace = (
   config: Pick<Config, "customerName" | "appName">,
-  env: string
+  env: string,
 ) => {
   return `${config.customerName}-${config.appName}-${env}`;
 };

package/src/pipeline/createAllJobs.ts

@@ -42,11 +42,11 @@ export const createAllJobs = async ({
                   trigger,
                   pipelineType,
                 }),
-              ])
-            )
+              ]),
+            ),
           ),
         ];
-      })
-    )
+      }),
+    ),
   );
 };

package/src/pipeline/createChildPipeline.ts

@@ -10,7 +10,7 @@ import { createGitlabPipelineWithDefaults } from "./gitlab/createGitlabPipeline"
 export const createChildPipeline = async <T extends PipelineType>(
   pipelineType: T,
   trigger: PipelineTrigger,
-  config: Config
+  config: Config,
 ): Promise<Pipeline<T>> => {
   const jobs = await createAllJobs({
     config,
@@ -27,7 +27,7 @@ export const createChildPipeline = async <T extends PipelineType>(
       },
       stages,
       jobs: Object.fromEntries(
-        gitlabJobs.map(({ gitlabJob, name }) => [name, gitlabJob])
+        gitlabJobs.map(({ gitlabJob, name }) => [name, gitlabJob]),
       ),
     }) as Pipeline<T>;
   }

package/src/pipeline/createJobsForComponent.ts

@@ -9,7 +9,7 @@ import { getPackageManagerInfo } from "./packageManager";
 
 const injectDefaultVarsInCustomJobs = (
   context: Context,
-  jobs: CatladderJob[]
+  jobs: CatladderJob[],
 ) =>
   jobs.map(({ variables, ...job }) => ({
     variables: {
@@ -40,11 +40,11 @@ const createRawJobs = (context: Context): CatladderJob[] => {
 };
 
 export const createJobsForComponent = async (
-  contextContext: Omit<CreateContextContext, "packageManagerInfo">
+  contextContext: Omit<CreateContextContext, "packageManagerInfo">,
 ): Promise<Array<CatladderJobWithContext>> => {
   const packageManagerInfo = await getPackageManagerInfo(
     contextContext.config,
-    contextContext.componentName
+    contextContext.componentName,
   );
 
   const context = await createContext({

package/src/pipeline/createMainPipeline.ts

@@ -20,7 +20,7 @@ import { getGitlabReleaseJobs } from "./gitlab/gitlabReleaseJobs";
 
 export const createMainPipeline = async <T extends PipelineType>(
   pipelineType: T,
-  config: Config
+  config: Config,
 ): Promise<Pipeline<T>> => {
   const stages = getPipelineStages(config);
 
@@ -32,9 +32,9 @@ export const createMainPipeline = async <T extends PipelineType>(
         async (trigger) =>
           await createGitlabJobs(
             await createAllJobs({ config, trigger, pipelineType }),
-            getGitlabRulesForTrigger(trigger)
-          )
-      )
+            getGitlabRulesForTrigger(trigger),
+          ),
+      ),
     );
 
     const allJobs = allJobsPerTrigger
@@ -48,20 +48,23 @@ export const createMainPipeline = async <T extends PipelineType>(
         return aIndex - bIndex;
       })
 
-      .reduce((acc, { gitlabJob, name }) => {
-        // merge jobs, if a job is already there, merge the rules
-        // this is currently needed because of envMode: "none", which creates the same job for all triggers, so it can appear multiple times
-        if (acc[name]) {
-          acc[name].rules = [
-            ...(acc[name].rules ?? []),
-            ...(gitlabJob.rules ?? []),
-          ];
-        } else {
-          acc[name] = gitlabJob;
-        }
+      .reduce(
+        (acc, { gitlabJob, name }) => {
+          // merge jobs, if a job is already there, merge the rules
+          // this is currently needed because of envMode: "none", which creates the same job for all triggers, so it can appear multiple times
+          if (acc[name]) {
+            acc[name].rules = [
+              ...(acc[name].rules ?? []),
+              ...(gitlabJob.rules ?? []),
+            ];
+          } else {
+            acc[name] = gitlabJob;
+          }
 
-        return acc;
-      }, {} as { [key: string]: GitlabJobDef });
+          return acc;
+        },
+        {} as { [key: string]: GitlabJobDef },
+      );
 
     return createGitlabPipelineWithDefaults({
       stages: [...stages, "release"],

package/src/pipeline/generatePipelineFiles.ts

@@ -6,7 +6,7 @@ import { getPipelineTriggerForGitlabChildPipeline } from "./gitlab/getPipelineTr
 export async function generatePipelineFiles<T extends PipelineType>(
   config: Config,
   pipelineType: T,
-  mode: PipelineMode<T>
+  mode: PipelineMode<T>,
 ) {
   if (mode === "childpipeline") {
     const trigger = getPipelineTriggerForGitlabChildPipeline();
@@ -14,14 +14,14 @@ export async function generatePipelineFiles<T extends PipelineType>(
     const { jobs, ...mainPipeline } = await createChildPipeline(
       pipelineType,
       trigger,
-      config
+      config,
     );
     // need to spread out the jobs, forgot why
     await writeYamlfile(`__pipeline.yml`, { ...jobs, ...mainPipeline });
   } else {
     const { jobs, ...mainPipeline } = await createMainPipeline(
       pipelineType,
-      config
+      config,
     );
     // need to spread out the jobs, forgot why
     await writeYamlfile(`.gitlab-ci.yml`, { ...jobs, ...mainPipeline });

package/src/pipeline/getPipelineStages.ts

@@ -16,7 +16,7 @@ export function getPipelineStages(config: Config) {
       baseStage,
       ...allEnvs.map((e) => `${baseStage} ${e}`),
     ],
-    []
+    [],
   );
   return stages;
 }

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -22,12 +22,12 @@ export type AllGitlabJobs = {
 export const GITLAB_ENVIRONMENT_URL_VARIABLE = "CL_GITLAB_ENVIRONMENT_URL";
 const removeUndefined = (obj: GitlabJobDef): GitlabJobDef =>
   Object.fromEntries(
-    Object.entries(obj).filter(([, value]) => value !== undefined)
+    Object.entries(obj).filter(([, value]) => value !== undefined),
   ) as GitlabJobDef;
 const getFullJobName = (
   name: string,
   componentName: string,
-  env?: string | null
+  env?: string | null,
 ) => {
   if (env) {
     return `${componentName} ${name} | ${env} `;
@@ -39,14 +39,14 @@ const getFullReferencedJobName = (
   referencedJobName: string,
   componentName: string,
   env: string,
-  allJobs: AllCatladderJobs
+  allJobs: AllCatladderJobs,
 ) => {
   const referencedJob = allJobs[componentName]?.[env]?.find(
-    (j) => j.name === referencedJobName
+    (j) => j.name === referencedJobName,
   );
   if (!referencedJob) {
     throw new Error(
-      `unknown job referenced: '${referencedJobName}' from '${env}:${componentName}'`
+      `unknown job referenced: '${referencedJobName}' from '${env}:${componentName}'`,
     );
   }
   const envToSet = referencedJob.envMode !== "none" ? env : null;
@@ -75,7 +75,7 @@ export const makeGitlabJob = (
     ...job
   }: CatladderJobWithContext<string>,
   allJobs: AllCatladderJobs,
-  baseRules?: GitlabRule[]
+  baseRules?: GitlabRule[],
 ): [fullName: string, job: GitlabJobDef] => {
   const stage = envMode === "stagePerEnv" ? `${job.stage} ${env}` : job.stage;
 
@@ -107,11 +107,11 @@ export const makeGitlabJob = (
               n.job,
               n.componentName ?? componentName,
               env,
-              allJobs
+              allJobs,
             ),
             artifacts: n.artifacts,
           }
-        : getFullReferencedJobName(n, componentName, env, allJobs)
+        : getFullReferencedJobName(n, componentName, env, allJobs),
     ) // sort in a predictable manner for snapshot tests
     .sort((a, b) => getJobName(a).localeCompare(getJobName(b)));
 
@@ -122,7 +122,7 @@ export const makeGitlabJob = (
   const fullJobName = getFullJobName(
     name,
     componentName,
-    envMode !== "none" ? env : undefined
+    envMode !== "none" ? env : undefined,
   );
 
   // backwards compatibility, some may still use KUBERNETES_CPU_REQUEST, KUBERNETES_MEMORY_REQUEST, etc. in variables.
@@ -137,29 +137,29 @@ export const makeGitlabJob = (
 
   const varsInjectScripts = collapseableSection(
     "injectvars",
-    "Injecting variables"
+    "Injecting variables",
   )([
     ...getInjectVarsScript(
       // remove legacy variables
       Object.fromEntries(
         Object.entries(variables ?? {}).filter(
-          ([key]) => !PIPELINE_RUNNER_VARIABLES.includes(key)
-        )
-      )
+          ([key]) => !PIPELINE_RUNNER_VARIABLES.includes(key),
+        ),
+      ),
     ),
   ]);
 
   const legacyRunnerVariables = Object.fromEntries(
     Object.entries(variables ?? {}).filter(([key]) =>
-      PIPELINE_RUNNER_VARIABLES.includes(key)
-    )
+      PIPELINE_RUNNER_VARIABLES.includes(key),
+    ),
   );
 
   if (Object.keys(legacyRunnerVariables).length > 0) {
     console.warn(
       `Legacy variables detected in ${fullJobName}: ${Object.keys(
-        legacyRunnerVariables
-      ).join(", ")}. Please move them to the runnerVariables key.`
+        legacyRunnerVariables,
+      ).join(", ")}. Please move them to the runnerVariables key.`,
     );
   }
   const rules = [
@@ -170,8 +170,8 @@ export const makeGitlabJob = (
           ...rule,
         }))
       : when
-      ? [{ when }]
-      : []),
+        ? [{ when }]
+        : []),
   ];
   const modified = addGitlabEnvironment(
     context,
@@ -194,7 +194,7 @@ export const makeGitlabJob = (
     },
     componentName,
     env,
-    allJobs
+    allJobs,
   );
 
   const gitlabJob: GitlabJobDef = removeUndefined(modified);
@@ -208,7 +208,7 @@ const addGitlabEnvironment = (
   job: GitlabJobDef,
   componentName: string,
   env: string, // TODO: we could actually pull this from contxt
-  allJobs: AllCatladderJobs
+  allJobs: AllCatladderJobs,
 ): GitlabJobDef => {
   if (!environment) {
     return job;
@@ -240,7 +240,7 @@ const addGitlabEnvironment = (
               on_stop,
               componentName,
               env,
-              allJobs
+              allJobs,
             ),
           }
         : {}),
@@ -258,7 +258,7 @@ const addGitlabEnvironment = (
 
 export const createGitlabJobs = async (
   allJobs: AllCatladderJobs,
-  baseRules?: GitlabRule[]
+  baseRules?: GitlabRule[],
 ): Promise<AllGitlabJobs> => {
   return Object.keys(allJobs).flatMap((componentName) => {
     const componentJobs = allJobs[componentName];
@@ -271,7 +271,7 @@ export const createGitlabJobs = async (
           env,
           job,
           allJobs,
-          baseRules
+          baseRules,
         );
         return {
           name: fullJobName,

package/src/pipeline/gitlab/getPipelineTriggerForGitlabChildPipeline.ts

@@ -23,10 +23,10 @@ export function getPipelineTriggerForGitlabChildPipeline() {
     isMergeRequest || isHotfixBranch
       ? "mr"
       : isDefaultBranch
-      ? "mainBranch"
-      : isTaggedRelease
-      ? "taggedRelease"
-      : null;
+        ? "mainBranch"
+        : isTaggedRelease
+          ? "taggedRelease"
+          : null;
 
   if (!trigger) {
     throw new Error(
@@ -38,8 +38,8 @@ export function getPipelineTriggerForGitlabChildPipeline() {
             isTaggedRelease,
           },
           null,
-          2
-        )
+          2,
+        ),
     );
   }
   return trigger;

package/src/pipeline/packageManager.ts

@@ -10,7 +10,7 @@ import {
 
 export const getPackageManagerInfo = async (
   config: Config,
-  componentName: string
+  componentName: string,
 ): Promise<PackageManagerInfo> => {
   // currently only supports yarn
   const version = await getYarnVersion();
@@ -20,7 +20,7 @@ export const getPackageManagerInfo = async (
   const component = config.components[componentName];
   const workspaces = await getWorkspaces(isClassic);
   const currentWorkspace = workspaces.find((w) =>
-    pathEqual(component.dir, w.location)
+    pathEqual(component.dir, w.location),
   );
   const componentIsInWorkspace = Boolean(currentWorkspace);
   const workspaceRoot = "."; // currently we assume the root folder, later on we might support nested workspaces

package/src/pipeline/yarn/yarnUtils.ts

@@ -14,7 +14,7 @@ export const getYarnVersion = memoizee(
   async () => {
     return await execOrFail("yarn --version", "");
   },
-  { promise: true }
+  { promise: true },
 );
 // export for mocking
 export const getWorkspaces = memoizee(
@@ -23,23 +23,23 @@ export const getWorkspaces = memoizee(
       ? Object.values(
           JSON.parse(
             JSON.parse(await execOrFail("yarn workspaces --json info", "{}"))
-              ?.data ?? "{}"
-          )
+              ?.data ?? "{}",
+          ),
         )
       : JSON.parse(
           `[${(await execOrFail("yarn workspaces list --json --verbose", ""))
             .trim()
             .split("\n")
-            .join(",")}]`
+            .join(",")}]`,
         );
   },
-  { promise: true }
+  { promise: true },
 );
 
 // recursivly get all workspace dependencies
 export const getWorkspaceDependencies = (
   ws: YarnWorkspace,
-  allWorkspaces: YarnWorkspace[]
+  allWorkspaces: YarnWorkspace[],
 ): string[] => {
   return ws
     ? ([...ws.workspaceDependencies, ...ws.mismatchedWorkspaceDependencies]
@@ -47,7 +47,7 @@ export const getWorkspaceDependencies = (
           // we have to do this recursivly
 
           const otherWorkspace = allWorkspaces.find(
-            (w) => w.location === location
+            (w) => w.location === location,
           );
 
           if (otherWorkspace) {

package/src/types/config.ts

@@ -11,7 +11,7 @@ export const ALL_PIPELINE_TRIGGERS = [
   "mr",
   "taggedRelease",
 ] as const;
-export type PipelineTrigger = typeof ALL_PIPELINE_TRIGGERS[number];
+export type PipelineTrigger = (typeof ALL_PIPELINE_TRIGGERS)[number];
 
 /**
  * all env types with their trigger.
@@ -43,7 +43,7 @@ export const ENV_TYPES = {
 export const getEnvTypesByTrigger = (trigger: PipelineTrigger) =>
   Object.entries(ENV_TYPES)
     .filter(([, e]) =>
-      (e.triggers as readonly PipelineTrigger[]).includes(trigger)
+      (e.triggers as readonly PipelineTrigger[]).includes(trigger),
     )
     .map(([e]) => e as EnvType);
 

package/src/types/context.ts

@@ -15,7 +15,7 @@ export type UnspecifiedEnvVars = Record<
 >;
 
 export type EnvironmentEnvVars<
-  V extends UnspecifiedEnvVars = UnspecifiedEnvVars
+  V extends UnspecifiedEnvVars = UnspecifiedEnvVars,
 > = {
   envVars: V & UnspecifiedEnvVars;
   secretEnvVarKeys: SecretEnvVar[];

package/src/types/environmentContext.ts

@@ -7,7 +7,7 @@ import type { PipelineType } from "./pipeline";
 
 export type EnvironmentContext<
   B extends BuildConfigType,
-  D extends DeployConfigType
+  D extends DeployConfigType,
 > = {
   envConfigRaw: EnvConfigWithComponent;
   buildConfigRaw: false | BuildConfigGeneric<B>;

package/src/types/jobs.ts

@@ -21,7 +21,7 @@ export const BASE_STAGES = [
   "rollback",
   "stop",
 ] as const;
-export type BaseStage = typeof BASE_STAGES[number];
+export type BaseStage = (typeof BASE_STAGES)[number];
 
 export type CatladderJobNeed =
   | string

package/src/types/utils.ts

@@ -1,7 +1,7 @@
 export type PartialDeep<T> = T extends any[]
   ? T
   : T extends Record<string, any>
-  ? {
-      [P in keyof T]?: PartialDeep<T[P]>;
-    }
-  : T;
+    ? {
+        [P in keyof T]?: PartialDeep<T[P]>;
+      }
+    : T;

package/src/utils/gitlab.ts

@@ -11,7 +11,7 @@ export const repeatOnFailure = (
   command: string,
   options: {
     pauseInSeconds: number;
-  }
+  },
 ): string => {
   return `
     until ${command}

package/src/utils/index.ts

@@ -1,7 +1,7 @@
 import { isNil, mergeWith } from "lodash";
 
 export function notNil<TValue>(
-  value: TValue | null | undefined
+  value: TValue | null | undefined,
 ): value is TValue {
   return value !== null && value !== undefined;
 }
@@ -14,6 +14,6 @@ export const mergeWithMergingArrays = <A, B>(obj1: A, obj2: B): A & B => {
   return mergeWith({}, obj1, obj2, (prop1, prop2) =>
     Array.isArray(prop1) && Array.isArray(prop2)
       ? [...prop1, ...prop2]
-      : undefined
+      : undefined,
   );
 };

package/src/utils/writeFiles.ts

@@ -21,7 +21,7 @@ export const writeGeneratedFile = async (
     commentChar,
   }: {
     commentChar: string;
-  }
+  },
 ) => {
   await writeFile(
     path,
@@ -29,7 +29,7 @@ export const writeGeneratedFile = async (
     [getAutoGeneratedHeader(commentChar), content].join("\n"),
     {
       encoding: "utf-8",
-    }
+    },
   );
 };