@catladder/pipeline 0.0.0-refactore-catenv-command-validates-argument-78d05852 → 0.0.0-reference-database-url-1befbbee

package/src/config/readConfig.ts

@@ -1,6 +1,8 @@
 import { existsSync, readFileSync } from "fs";
-import { register } from "ts-node";
-import { load } from "js-yaml";
+
+const tsx = require("tsx/cjs/api");
+
+import { parse } from "yaml";
 import type { Config } from "../types";
 
 // allows us to load ts files
@@ -8,39 +10,30 @@ import type { Config } from "../types";
 const fullPath = (directory: string, ext: string) =>
   directory + "/catladder." + ext;
 
-function requireUncached(module: string) {
-  delete require.cache[require.resolve(module)];
-  return require(module);
-}
-
-export const readConfigSync = (
-  directory: string = process.cwd()
-): { config: Config; path: string; ext: string } | null => {
-  register({
-    cwd: directory,
-    transpileOnly: true,
-    compilerOptions: {
-      module: "commonjs",
-    },
-  });
-
+export const readConfig = async (
+  directory: string = process.cwd(),
+): Promise<{ config: Config; path: string; ext: string } | null> => {
   const found = ["ts", "js", "yml", "yaml"].find((extension) =>
-    existsSync(fullPath(directory, extension))
+    existsSync(fullPath(directory, extension)),
   );
+
   if (found) {
     const filePath = fullPath(directory, found);
     if (found === "ts" || found === "js") {
+      const result = await tsx.require(filePath, directory);
+
+      // weird: if target project is esm, result is under result.default, but if its commonjs, its under result.default.default
+      const config = result.default.default || result.default;
       return {
         path: filePath,
         ext: found,
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        config: requireUncached(filePath).default,
+        config,
       };
     } else {
       return {
         path: filePath,
         ext: found,
-        config: load(readFileSync(filePath, { encoding: "utf-8" })) as Config,
+        config: parse(readFileSync(filePath, { encoding: "utf-8" })) as Config,
       };
     }
   }

package/src/constants.ts

@@ -1,2 +1,5 @@
-export const PIPELINE_IMAGE_TAG = process.env.INLINE_PIPELINE_IMAGE_TAG || "";
-export const DOCKER_REGISTRY = process.env.INLINE_DOCKER_REGISTRY || "";
+export const PIPELINE_IMAGE_TAG =
+  process.env.INLINE_PIPELINE_IMAGE_TAG || "latest";
+export const DOCKER_REGISTRY =
+  process.env.INLINE_DOCKER_REGISTRY ||
+  "git.panter.ch:5001/catladder/catladder";

package/src/context/createAllComponentsContext.ts

@@ -0,0 +1,31 @@
+import { getAllEnvsByTrigger } from "../config/configruedEnvs";
+import type { ComponentContext, PipelineType } from "../types";
+import type { Config, PipelineTrigger } from "../types/config";
+import { createComponentContext } from "./createComponentContext";
+
+export type CreateAllComponentsContextProps = {
+  config: Config;
+  trigger: PipelineTrigger;
+  pipelineType: PipelineType;
+};
+
+export const createAllComponentsContext = async ({
+  config,
+  trigger,
+  pipelineType,
+}: CreateAllComponentsContextProps): Promise<Array<ComponentContext>> => {
+  return await Promise.all(
+    Object.keys(config.components).flatMap((componentName) => {
+      const envs = getAllEnvsByTrigger(config, componentName, trigger);
+      return envs.map(async (env) => {
+        return await createComponentContext({
+          config,
+          componentName,
+          env,
+          trigger,
+          pipelineType,
+        });
+      });
+    }),
+  );
+};

package/src/context/createComponentContext.ts

@@ -0,0 +1,148 @@
+import { isFunction } from "lodash";
+import { BUILD_TYPES, isStandaloneBuildConfig } from "../build";
+import type { BuildConfig } from "../build/types";
+import { DEPLOY_TYPES } from "../deploy";
+import type { DeployConfig, DeployConfigType } from "../deploy/types";
+import { getPackageManagerInfoForComponent } from "../pipeline/packageManager";
+import type { PipelineType } from "../types";
+import type { Config, PipelineTrigger } from "../types/config";
+import type {
+  BuildContext,
+  BuildContextComponent,
+  ComponentContext,
+} from "../types/context";
+import type { PartialDeep } from "../types/utils";
+import { mergeWithMergingArrays } from "../utils";
+import { getEnvironment } from "./getEnvironment";
+import { getEnvironmentContext } from "./getEnvironmentContext";
+
+export type CreateComponentContextContext = {
+  config: Config;
+  componentName: string;
+  env: string;
+  pipelineType?: PipelineType;
+  trigger?: PipelineTrigger;
+};
+
+export const createComponentContext = async (
+  ctx: CreateComponentContextContext,
+): Promise<ComponentContext> => {
+  if (!/^[a-z0-9-]+$/.test(ctx.componentName)) {
+    throw new Error(
+      "componentName may only contain lower case letters, numbers and -",
+    );
+  }
+
+  const packageManagerInfo = await getPackageManagerInfoForComponent(
+    ctx.config,
+    ctx.componentName,
+  );
+
+  const envContext = getEnvironmentContext(ctx);
+
+  const componentConfigWithoutDefaults = envContext.envConfigRaw;
+
+  const resolvedBuildType =
+    componentConfigWithoutDefaults.build === false
+      ? false
+      : isStandaloneBuildConfig(componentConfigWithoutDefaults.build)
+        ? componentConfigWithoutDefaults.build.type
+        : ctx.config.builds?.[componentConfigWithoutDefaults.build.from].type;
+  if (resolvedBuildType === undefined) {
+    throw new Error("build type not found, is the build config correct?");
+  }
+  const defaults: {
+    build: PartialDeep<BuildConfig | false>;
+    deploy: PartialDeep<DeployConfig>;
+  } = componentConfigWithoutDefaults.deploy
+    ? {
+        build:
+          resolvedBuildType &&
+          BUILD_TYPES[resolvedBuildType].defaults(envContext),
+        deploy: DEPLOY_TYPES[
+          componentConfigWithoutDefaults.deploy.type as DeployConfigType
+        ].defaults(envContext as any),
+      }
+    : {
+        build:
+          resolvedBuildType &&
+          BUILD_TYPES[resolvedBuildType].defaults(envContext),
+        deploy: {},
+      };
+
+  const componentConfig = mergeWithMergingArrays(
+    defaults,
+    componentConfigWithoutDefaults,
+  );
+
+  const environment = await getEnvironment(ctx);
+  const { deploy, build, customJobs, dir } = componentConfig;
+  const getComponentDirs: BuildContext["getComponentDirs"] = (mode) => [
+    dir,
+    // also copy workspace dependencies in monorepo if packages are shared and they create build artifacts
+    ...(mode === "all"
+      ? (packageManagerInfo.currentWorkspaceDependencies ?? [])
+      : []),
+  ];
+  const _getBuildContext = (): BuildContextComponent => {
+    if (build === false) {
+      return {
+        type: "disabled",
+        getComponentDirs,
+        dir,
+      };
+    }
+
+    if (isStandaloneBuildConfig(build)) {
+      return {
+        dir: dir,
+        getComponentDirs,
+        config: build,
+        buildType: build.type,
+        type: "standalone",
+      };
+    }
+    // must be shared build
+    const referencedBuild = ctx.config.builds?.[build.from];
+    if (!referencedBuild) {
+      throw new Error("build.from not found in config");
+    }
+    return {
+      dir: dir,
+      getComponentDirs,
+      config: build,
+      workspaceBuildConfig: referencedBuild,
+      workspaceName: build.from,
+      buildType: referencedBuild.type,
+      type: "fromWorkspace",
+    };
+  };
+  const buildContext: BuildContextComponent = _getBuildContext();
+  const context: Omit<ComponentContext, "customJobs"> = {
+    type: "component",
+    name: ctx.componentName,
+    env: ctx.env,
+    fullConfig: ctx.config,
+    componentConfig,
+
+    build: buildContext,
+    deploy: deploy
+      ? {
+          config: deploy,
+        }
+      : null,
+
+    environment,
+    packageManagerInfo: packageManagerInfo,
+    pipelineType: ctx.pipelineType,
+    trigger: ctx.trigger,
+  };
+
+  const resolvedCustomJobs = isFunction(customJobs)
+    ? customJobs(context)
+    : customJobs;
+  return {
+    ...context,
+    customJobs: resolvedCustomJobs,
+  };
+};

package/src/context/createWorkspaceContext.ts

@@ -0,0 +1,56 @@
+import {
+  WORKSPACE_BUILD_TYPES,
+  type Config,
+  type PipelineTrigger,
+  type PipelineType,
+  type WorkspaceContext,
+} from "..";
+import { getPackageManagerInfoBase } from "../pipeline/packageManager";
+import { mergeWithMergingArrays } from "../utils";
+import { uniq } from "lodash";
+
+export async function createWorkspaceContext({
+  env,
+  components,
+  workspaceName,
+  config,
+  pipelineType,
+  trigger,
+}: {
+  env: string;
+  components: WorkspaceContext["components"];
+  workspaceName: string;
+  config: Config;
+  pipelineType: PipelineType;
+  trigger: PipelineTrigger;
+}): Promise<WorkspaceContext> {
+  const workspaceConfigRaw = config.builds?.[workspaceName];
+  if (!workspaceConfigRaw) {
+    throw new Error(`Workspace ${workspaceName} not found in config`);
+  }
+
+  const defaults = WORKSPACE_BUILD_TYPES[workspaceConfigRaw.type].defaults();
+
+  const workspaceConfig = mergeWithMergingArrays(defaults, workspaceConfigRaw);
+  return {
+    name: workspaceName,
+    pipelineType,
+    trigger,
+    type: "workspace",
+
+    workspaceConfig,
+
+    env,
+    components,
+    fullConfig: config,
+    packageManagerInfo: await getPackageManagerInfoBase(),
+    build: {
+      type: "workspace",
+      dir: workspaceConfig.dir ?? ".",
+      getComponentDirs: (mode) =>
+        uniq(components.flatMap((c) => c.build.getComponentDirs(mode))),
+      buildType: workspaceConfig.type,
+      config: workspaceConfig,
+    },
+  };
+}

package/src/context/getBuildInfoVariables.ts

@@ -0,0 +1,36 @@
+import { BashExpression } from "../bash/BashExpression";
+import type { BashExpressionPerPipelineType } from "../bash/bashExpressionPerPipelineType";
+import { getBashExpressionPerPipelineType } from "../bash/bashExpressionPerPipelineType";
+import type { EnvironmentContext } from "../types/environmentContext";
+
+const BUILD_VARIABLES = {
+  BUILD_INFO_BUILD_ID: {
+    default: new BashExpression(
+      `$(git describe --tags 2>/dev/null || git rev-parse HEAD)`,
+    ),
+  },
+  BUILD_INFO_BUILD_TIME: {
+    default: "unknown-build-time",
+    gitlab: new BashExpression(`$CI_JOB_STARTED_AT`),
+  },
+  BUILD_INFO_CURRENT_VERSION: {
+    default: new BashExpression(
+      // because we do shallow fetch, we need to ask the origin
+      `$(tag=$(git ls-remote origin "refs/tags/v*[0-9]" 2>/dev/null | cut -f 2- | sort -V | tail -1 | sed 's/refs\\/tags\\/v//'); [ -z "$tag" ] && echo "0.0.0" || echo "$tag")`,
+    ),
+  },
+} satisfies {
+  [key: string]: BashExpressionPerPipelineType;
+};
+
+export const ALL_BUILD_VARIABLES = Object.keys(BUILD_VARIABLES);
+export const getBuildInfoVariables = (ctx: EnvironmentContext) => {
+  const { pipelineType } = ctx;
+
+  return Object.fromEntries(
+    Object.entries(BUILD_VARIABLES).map(([key, value]) => [
+      key,
+      getBashExpressionPerPipelineType(value, pipelineType),
+    ]),
+  );
+};

package/src/context/getEnvConfig.ts

@@ -1,11 +1,10 @@
+import { cloneDeep, mergeWith } from "lodash";
 import type { Config, EnvConfigWithComponent } from "../types/config";
 
-import { mergeWithMergingArrays } from "../utils";
-
 export const getEnvConfig = (
   config: Config,
   componentName: string,
-  env: string
+  env: string,
 ): EnvConfigWithComponent => {
   const defaultConfig = config.components[componentName];
   if (!defaultConfig) {
@@ -14,8 +13,29 @@ export const getEnvConfig = (
 
   const envCustomizations = defaultConfig.env?.[env] ?? {};
   if (envCustomizations === false) {
-    throw new Error("env is disabled: " + env + ":" + componentName);
+    // env is disabled, still return the default config
+    return defaultConfig;
   }
+  /**
+   * env config is merged with default. Arrays are not merged.
+   * you can customize this by providing a function that takes the default value as argument
+   */
+  return mergeWith(
+    // mergeWith unfortunatly mutates the first object, so we need to clone it.
+    // Passing empty object also doesn't work for us, because that will mess with the customizer function (second argument isn't nessecary the customized value)
+    cloneDeep(defaultConfig),
+    envCustomizations,
+    (defaultValue, customValue, key, obj, source) => {
+      // check if custom value is a function (and default is not),
+      // we currently don't have config options, that are functions, but we might in the future (customJobs is an exception)
+      if (
+        typeof customValue === "function" &&
+        typeof defaultValue !== "function"
+      ) {
+        return customValue(defaultValue);
+      }
 
-  return mergeWithMergingArrays(defaultConfig, envCustomizations);
+      return undefined;
+    },
+  );
 };

package/src/context/getEnvType.ts

@@ -5,7 +5,7 @@ export const getEnvType = (
   env: string,
   envConfig: {
     type?: EnvType;
-  }
+  },
 ): EnvType => {
   if (envConfig.type) return envConfig.type;
 

package/src/context/getEnvironment.ts

@@ -1,42 +1,26 @@
-import type { Config } from "../types/config";
+import type { CreateComponentContextContext } from "..";
 
-import type { CommitInfo, Environment } from "../types/context";
+import type { Environment } from "../types/context";
 import { getEnvironmentContext } from "./getEnvironmentContext";
 import { getEnvironmentVariables } from "./getEnvironmentVariables";
 
 export const getEnvironment = async (
-  config: Config,
-  componentName: string,
-  env: string,
-  commitInfo?: CommitInfo
+  ctx: CreateComponentContextContext,
 ): Promise<Environment> => {
-  const variables = await getEnvironmentVariables(
-    config,
-    componentName,
-    env,
-    commitInfo
-  );
+  const { env } = ctx;
+  const variables = await getEnvironmentVariables(ctx);
 
-  const envContext = getEnvironmentContext(
-    config,
-    env,
-    componentName,
-    commitInfo
-  );
+  const envContext = getEnvironmentContext(ctx);
 
   const envType = envContext.envType;
 
   return {
     envType,
-
-    gitlabEnvironment: {
-      name: envContext.gitlabEnvironmentName,
-      url: variables.url,
-    },
     fullName: envContext.fullName,
     slugPrefix: envContext.environmentSlugPrefix,
+    reviewSlug: envContext.reviewSlug,
     slug: envContext.environmentSlug,
-    shortName: env,
+
     ...variables,
   };
 };

package/src/context/getEnvironmentContext.ts

@@ -1,44 +1,40 @@
-import type { Config, EnvConfigWithComponent } from "../types/config";
+import type { CreateComponentContextContext } from "..";
+import type { StringOrBashExpression } from "../bash/BashExpression";
+import { joinBashExpressions } from "../bash/BashExpression";
 
-import type { CommitInfo } from "../types/context";
 import type { EnvironmentContext } from "../types/environmentContext";
 import { getEnvConfig } from "./getEnvConfig";
 import { getEnvType } from "./getEnvType";
+import { getReviewSlug } from "./getReviewSlug";
 
 const getEnvironmentSlugPrefix = (
-  envConfig: EnvConfigWithComponent,
   env: string,
-  commitInfo?: CommitInfo
-) => {
-  const envType = getEnvType(env, envConfig);
-
-  return envType === "review" && commitInfo
-    ? `${env}-${commitInfo.reviewSlug}`
-    : `${env}`;
+  reviewSlug: StringOrBashExpression | null,
+): StringOrBashExpression => {
+  if (reviewSlug) {
+    return joinBashExpressions([env, reviewSlug], "-");
+  }
+  return env;
 };
 
-export const getEnvironmentContext = (
-  config: Config,
-  env: string,
-  componentName: string,
-  commitInfo?: CommitInfo
-): EnvironmentContext<any, any> => {
+export const getEnvironmentContext = ({
+  env,
+  componentName,
+  config,
+  pipelineType,
+}: CreateComponentContextContext): EnvironmentContext => {
   const envConfigRaw = getEnvConfig(config, componentName, env);
   const envType = getEnvType(env, envConfigRaw);
+  const reviewSlug = getReviewSlug(envConfigRaw, env, pipelineType);
 
-  const environmentSlugPrefix = getEnvironmentSlugPrefix(
-    envConfigRaw,
-    env,
-    commitInfo
-  );
+  const environmentSlugPrefix = getEnvironmentSlugPrefix(env, reviewSlug);
 
-  const environmentSlug = `${environmentSlugPrefix}-${componentName}`;
-  const gitlabEnvironmentName =
-    envType === "review" && commitInfo
-      ? `${env}/${commitInfo.refName}/${componentName}`
-      : `${env}/${componentName}`;
+  const environmentSlug = environmentSlugPrefix.concat(`-${componentName}`);
 
-  const fullName = `${config.customerName}-${config.appName}-${environmentSlug}`;
+  const fullName = joinBashExpressions(
+    [config.customerName, config.appName, environmentSlug],
+    "-",
+  );
 
   return {
     envConfigRaw,
@@ -46,10 +42,10 @@ export const getEnvironmentContext = (
     buildConfigRaw: envConfigRaw.build,
     environmentSlugPrefix,
     environmentSlug,
-    gitlabEnvironmentName,
+    reviewSlug,
+    pipelineType,
     fullName,
     envType,
-    commitInfo,
     componentName,
     env,
     fullConfig: config,