@catladder/pipeline 0.0.0-node16-ddfae617 → 0.0.0-perf-cli-reduce-bundle-size-with-tsconfig-optimization-3556aaa4

package/src/build/types.ts

@@ -1,87 +1,361 @@
+import type { Artifacts, EnvVars, GitlabJobImage } from "../types";
+import type { Services } from "../types/gitlab-ci-yml";
+
+import type { CatladderJob } from "../types/jobs";
+
+export type BuildConfigArtifactsReports = {
+  /**
+   * The junit report collects JUnit report format XML files.
+   * The collected Unit test reports upload to GitLab as an artifact.
+   * Paths are prefixed with component's root folder.
+   * eg. `["dist/test-results/TEST-*.xml", "dist/rspec.xml", ...]`
+   */
+  junit?: string[];
+};
+
+export type TestJobCustom = {
+  command?: string | string[];
+  jobImage?: GitlabJobImage;
+  /**
+   * additional CI/CD artifacts reports,
+   * use to display information in merge requests, pipeline views and security dashboards.
+   */
+  artifactsReports?: BuildConfigArtifactsReports;
+  /**
+   * GitLab {@link Artifacts} configuration.
+   *
+   * {@link TestJobCustom.artifacts}.reports.junit is merged with {@link TestJobCustom.artifactsReports} in case both given.
+   */
+  artifacts?: Artifacts;
+};
+
 export type BuildConfigBase = {
   /**
    * command to run on the image to start the app (e.g. yarn start)
    */
   startCommand?: string;
+
+  /**
+   * vars that only exist in the build jobs.
+   * Can curently not reference other variables from other components
+   */
+  jobVars?: EnvVars;
   /**
    * additional env vars for the buid jobs
+   *
+   * @deprecated use jobVars or runnerVariables
    */
   extraVars?: Record<string, string>;
+
   /**
-   * define the build command
+   * additional vars only for the runner.
+   * Also if you use services: that require env vars, you need to set them here.
+   *
    */
-  buildCommand?: string | string[] | null;
-
+  runnerVariables?: Record<string, string>;
   /**
-   * customize docker build
+   * define the build command
    */
-  docker?: {
-    additionsBegin?: string[];
-    additionsEnd?: string[];
-  };
+  buildCommand?: string | string[] | null;
 
   /**
    * customize lint, set false to disable
    */
-  lint?:
-    | false
-    | {
-        command?: string | string[];
-      };
+  lint?: false | TestJobCustom;
 
   /**
    * customize test, set false to disable
    */
-  test?:
-    | false
-    | {
-        command?: string | string[];
-      };
+  test?: false | TestJobCustom;
 
   /**
    * customize audit, set false to disable
    */
-  audit?:
-    | false
-    | {
-        command?: string | string[];
-      };
+  audit?: false | TestJobCustom;
 
   /**
    * additional paths for artifacts,
    * by default "dist" and ".next" are allways included
    */
   artifactsPaths?: string[];
+
+  /**
+   * additional CI/CD artifacts reports,
+   * use to display information in merge requests, pipeline views and security dashboards.
+   */
+  artifactsReports?: BuildConfigArtifactsReports;
+
+  /**
+   * customize cache for the job
+   */
+  jobCache?: CatladderJob["cache"];
+
+  /**
+   * tags for the underlying job runner (e.g gitlab)
+   */
+  jobTags?: string[];
+  /**
+   * custom image to use
+   */
+  jobImage?: GitlabJobImage;
 };
 
-export type BuildConfigNodeBase = BuildConfigBase;
+export type BuildConfigNodeBase = BuildConfigBase & {
+  /**
+   * runs a command after yarn install. postinstall in package.json won't work for yarn plug and play.
+   * the command will be invoked in the component dir.
+   */
+  postInstall?: string | string[];
+};
 
 export type BuildConfigNode = {
   type: "node";
+  docker?: Omit<BuildConfigDockerBuiltInNode, "type"> | BuildConfigDocker;
 } & BuildConfigNodeBase;
 
 export type BuildConfigNodeStatic = BuildConfigNodeBase & {
+  /**
+   * @deprecated use type: "node" and docker: { type: "nginx" } instead
+   */
   type: "node-static";
   startCommand?: never;
+  docker?: Omit<BuildConfigDockerBuiltInNgninx, "type"> | BuildConfigDocker;
 };
 
 export type BuildConfigMeteor = BuildConfigNodeBase & {
   type: "meteor";
+  /**
+   * whether to run yarn install inside the source folder in the docker image.
+   * This is only required if you have custom scripts in your image
+   */
+  installScripts?: boolean;
+  docker?: Omit<BuildConfigDockerBuiltInMeteor, "type"> | BuildConfigDocker;
+};
+
+export type BuildConfigNodeLike =
+  | BuildConfigNode
+  | BuildConfigNodeStatic
+  | BuildConfigStorybook
+  | BuildConfigMeteor;
+
+type BuildConfigDockerWithAdditions = {
+  /**
+   * Custom Dockerfile lines integrated in the generated Dockerfile before the standard build steps.
+   *
+   */
+  additionsBegin?: string[];
+  /**
+   * Custom Dockerfile lines integrated in the generated Dockerfile after the standard build steps.
+   *
+   */
+  additionsEnd?: string[];
+};
+
+type BuildConfigDockerBuiltInNode = {
+  type: "node";
+} & BuildConfigDockerWithAdditions;
+
+type BuildConfigDockerBuiltInMeteor = {
+  type: "meteor";
+} & BuildConfigDockerWithAdditions;
+
+type BuildConfigDockerBuiltInNgninx = {
+  /**
+   * use the built-in nginx image for simple static apps
+   */
+  type: "nginx";
+} & BuildConfigDockerWithAdditions;
+type BuildConfigDockerBuiltIn =
+  | BuildConfigDockerBuiltInNgninx
+  | BuildConfigDockerBuiltInNode
+  | BuildConfigDockerBuiltInMeteor;
+
+type BuildConfigDockerCustom = {
+  /**
+   * custom docker build, expect that a Dockerfile in your directory
+   */
+  type: "custom";
+
+  /**
+   * where to run the docker build, defaults to the root of the repo.
+   *
+   * Depending on your Dockerfile you may want to change it to "component"
+   */
+  buildContextLocation?: "root" | "component";
+};
+
+export type BuildConfigDocker =
+  | BuildConfigDockerBuiltIn
+  | BuildConfigDockerCustom;
+
+/**
+ * @deprecated this type is no longer used. Use {@link BuildConfigDocker} instead.
+ */
+export type BuildConfigCustomDocker =
+  | BuildConfigDockerCustom
+  | BuildConfigDockerBuiltInNgninx;
+
+export type BuildConfigCustom = Omit<
+  BuildConfigBase,
+  "lint" | "test" | "audit"
+> & {
+  type: "custom";
+  jobImage: GitlabJobImage;
+  /**
+   * {@link Services}s used in lint, test, audit, and build jobs.
+   */
+  jobServices?: Services;
+
+  docker: BuildConfigDocker;
+
+  /**
+   * custom lint, disabled when not set
+   */
+  lint?: TestJobCustom;
+
+  /**
+   * custom test, disabled when not set
+   */
+  test?: TestJobCustom;
+
+  /**
+   * custom audit, disabled when not set
+   */
+  audit?: TestJobCustom;
+
+  /**
+   * custom sbom (software bill of materials), set false to disable
+   */
+  sbom?:
+    | false
+    | {
+        /**
+         * needs to create a file at `/__sbom.json` in CycloneDX format
+         */
+        command: string | string[];
+        jobImage: GitlabJobImage;
+      };
+};
+
+export type BuildConfigRails = BuildConfigBase & {
+  type: "rails";
+  /**
+   * The [Cloud Native Buildpacks](https://buildpacks.io/) builder configuration.
+   *
+   * Only applies when there is no `Dockerfile`.
+   */
+  cnbBuilder?: {
+    /**
+     * The Cloud Native Buildpacks builder image to use.
+     * See e.g. https://github.com/heroku/builder or others.
+     * Default: heroku/buildpacks:20
+     */
+    image?: string;
+    /**
+     * The version of the Cloud Native Buildpacks pack command to use.
+     * See https://buildpacks.io/docs/tools/pack/
+     * Default: 0.28.0
+     */
+    packVersion?: string;
+    /**
+     * Additional command arguments passed to the pack command.
+     * See https://buildpacks.io/docs/tools/pack/
+     */
+    packExtraArgs?: string[];
+    /**
+     * Variables needed for Bundler and Rails asset precompilation.
+     *
+     * Specify a key with the value `undefined` to inherit it from the EnvVars.
+     *
+     * See https://github.com/rails/rails/issues/32947
+     */
+    buildVars?: Record<string, string | undefined>;
+  };
 };
 
 export type BuildConfigStorybook = BuildConfigNodeBase & {
+  /**
+   * @deprecated use type: "node" and docker: { type: "nginx" } instead
+   */
   type: "storybook";
   startCommand?: never;
 };
-export type BuildConfig =
+
+export type BuildConfigFromWorkspace = {
+  from: string;
+  docker?: BuildConfigDocker;
+  startCommand?: string;
+  /**
+   * additional paths for artifacts,
+   * by default "dist" and ".next" are allways included
+   */
+  artifactsPaths?: string[];
+};
+export type BuildConfigStandalone =
   | BuildConfigNode
   | BuildConfigNodeStatic
   | BuildConfigStorybook
-  | BuildConfigMeteor;
+  | BuildConfigMeteor
+  | BuildConfigCustom
+  | BuildConfigRails;
+
+export type BuildConfig = BuildConfigFromWorkspace | BuildConfigStandalone;
 
-export const isOfBuildType = <T extends Array<BuildConfig["type"]>>(
+export type BuildConfigStandaloneType = BuildConfigStandalone["type"];
+
+export type BuildConfigGeneric<T extends BuildConfigStandaloneType> = Extract<
+  BuildConfig,
+  { type: T }
+>;
+
+export const isStandaloneBuildConfig = (
+  t: BuildConfig | false,
+): t is BuildConfigStandalone => {
+  if (!t) return false;
+  return !("from" in t);
+};
+
+export const isOfBuildType = <T extends Array<BuildConfigStandaloneType>>(
   t: BuildConfig,
   ...types: T
 ): t is Extract<BuildConfig, { type: T[number] }> => {
+  if (!isStandaloneBuildConfig(t)) return false;
   return types.includes(t.type);
 };
+
+export type WorkspaceBuildConfigBase = {
+  dir?: string;
+  /**
+   * customize lint, set false to disable
+   */
+  lint?: false | TestJobCustom;
+
+  /**
+   * customize test, set false to disable
+   */
+  test?: false | TestJobCustom;
+
+  /**
+   * customize audit, set false to disable
+   */
+  audit?: false | TestJobCustom;
+  /**
+   * additional vars only for the runner.
+   * Also if you use services: that require env vars, you need to set them here.
+   *
+   */
+  runnerVariables?: Record<string, string>;
+
+  /**
+   * additional CI/CD artifacts reports,
+   * use to display information in merge requests, pipeline views and security dashboards.
+   */
+  artifactsReports?: BuildConfigArtifactsReports;
+};
+
+export type WorkspaceBuildConfigNode = {
+  type: "node";
+  buildCommand?: string | string[];
+} & WorkspaceBuildConfigBase;
+
+export type WorkspaceBuildConfig = WorkspaceBuildConfigNode;

package/src/catladder-gitlab.ts

@@ -1,57 +1,17 @@
-import { writeFileSync } from "fs";
-import { dump } from "js-yaml";
-import { readConfigSync } from "./config";
-import { PIPELINE_IMAGE_TAG } from "./constants";
-import { createChildPipeline } from "./pipeline";
-import { PipelineTrigger } from "./types";
+import { readConfig } from "./config";
+import { generatePipelineFiles } from "./pipeline/generatePipelineFiles";
+import type { PipelineMode } from "./types";
 
-const {
-  CI_MERGE_REQUEST_ID,
-  CI_COMMIT_TAG,
-  CI_COMMIT_BRANCH,
-  CI_DEFAULT_BRANCH,
-} = process.env;
+const mode = process.argv[2] || "local";
 
-const isDefaultBranch =
-  Boolean(CI_DEFAULT_BRANCH) && CI_COMMIT_BRANCH === CI_DEFAULT_BRANCH;
-const isHotfixBranch = false; // TODO:  $CI_COMMIT_BRANCH =~ /^[0-9]+\.([0-9]+|x)\.x$/
-const isMergeRequest = Boolean(CI_MERGE_REQUEST_ID);
-const isTaggedRelease = Boolean(CI_COMMIT_TAG);
-
-console.info(`catladder version ${PIPELINE_IMAGE_TAG}`);
-
-const trigger: PipelineTrigger | null =
-  isMergeRequest || isHotfixBranch
-    ? "mr"
-    : isDefaultBranch
-    ? "mainBranch"
-    : isTaggedRelease
-    ? "taggedRelease"
-    : null;
-if (trigger) {
-  const config = readConfigSync()?.config;
-  if (!config) {
+const config = readConfig().then(async (result) => {
+  if (!result?.config) {
     throw new Error("no catladder config found");
   }
-  createChildPipeline("gitlab", trigger, config).then(
-    ({ jobs, ...mainPipeline }) => {
-      // need to spread out the jobs
-      writeFileSync(`__pipeline.yml`, dump({ ...jobs, ...mainPipeline }), {
-        encoding: "utf-8",
-      });
-    }
-  );
-} else {
-  throw new Error(
-    "no matching trigger: " +
-      JSON.stringify(
-        {
-          isMergeRequest,
-          isDefaultBranch,
-          isTaggedRelease,
-        },
-        null,
-        2
-      )
+
+  await generatePipelineFiles(
+    result.config,
+    "gitlab",
+    mode as PipelineMode<"gitlab">,
   );
-}
+});

package/src/config/__tests__/__snapshots__/getAllEnvs.test.ts.snap

@@ -0,0 +1,31 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getAllEnvs() should return all envs for app1 1`] = `
+[
+  "dev",
+  "review",
+  "stage",
+  "prod",
+  "local",
+]
+`;
+
+exports[`getAllEnvs() should return all envs for app2 1`] = `
+[
+  "dev",
+  "review",
+  "stage",
+  "prod",
+  "local",
+  "dev2",
+  "review2",
+  "stage2",
+  "prod2",
+]
+`;
+
+exports[`getAllEnvs() should return all envs for app3 1`] = `
+[
+  "local",
+]
+`;

package/src/config/__tests__/__snapshots__/getAllEnvsInAllComponents.test.ts.snap

@@ -0,0 +1,15 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getAllEnvsInAllComponents() should return all envs for SIMPLE_CONFIG1 1`] = `
+[
+  "dev",
+  "review",
+  "stage",
+  "prod",
+  "local",
+  "dev2",
+  "review2",
+  "stage2",
+  "prod2",
+]
+`;

package/src/config/{configruedEnvs.test.ts → __tests__/configruedEnvs.test.ts}

@@ -1,6 +1,6 @@
-import { getAllEnvsByTrigger } from ".";
-import { DeployConfigKubernetesCluster } from "..";
-import { Config } from "../types";
+import { getAllEnvsByTrigger } from "..";
+import type { DeployConfigKubernetesCluster } from "../..";
+import type { Config } from "../../types";
 
 describe("getAllEnvsByTrigger", () => {
   const cluster: DeployConfigKubernetesCluster = {

package/src/config/__tests__/getAllEnvs.test.ts

@@ -0,0 +1,71 @@
+import { type DeployConfigKubernetesCluster } from "../..";
+import type { Config } from "../../types";
+import { getAllEnvs } from "../configruedEnvs";
+
+describe("getAllEnvs()", () => {
+  const cluster: DeployConfigKubernetesCluster = {
+    type: "gcloud",
+    name: "mega-cluster",
+    projectId: "super-google-project",
+    region: "ch-blabla",
+  };
+  const SIMPLE_CONFIG: Config = {
+    appName: "my-app",
+    customerName: "pan",
+    components: {
+      app1: {
+        dir: "dir1",
+        build: {
+          type: "node",
+        },
+        deploy: { type: "kubernetes", cluster },
+      },
+      app2: {
+        dir: "dir2",
+        build: {
+          type: "node",
+        },
+        deploy: { type: "kubernetes", cluster },
+        env: {
+          dev2: {
+            type: "dev",
+          },
+          review2: {
+            type: "review",
+          },
+          stage2: {
+            type: "stage",
+          },
+          prod2: {
+            type: "prod",
+          },
+        },
+      },
+      app3: {
+        dir: "dir2",
+        build: {
+          type: "node",
+        },
+        deploy: { type: "kubernetes", cluster },
+        env: {
+          dev: false,
+          review: false,
+          stage: false,
+          prod: false,
+        },
+      },
+    },
+  };
+
+  it("should return all envs for app1", () => {
+    expect(getAllEnvs(SIMPLE_CONFIG, "app1")).toMatchSnapshot();
+  });
+
+  it("should return all envs for app2", () => {
+    expect(getAllEnvs(SIMPLE_CONFIG, "app2")).toMatchSnapshot();
+  });
+
+  it("should return all envs for app3", () => {
+    expect(getAllEnvs(SIMPLE_CONFIG, "app3")).toMatchSnapshot();
+  });
+});

package/src/config/__tests__/getAllEnvsInAllComponents.test.ts

@@ -0,0 +1,63 @@
+import { type DeployConfigKubernetesCluster } from "../..";
+import type { Config } from "../../types";
+import { getAllEnvsInAllComponents } from "../configruedEnvs";
+
+describe("getAllEnvsInAllComponents()", () => {
+  const cluster: DeployConfigKubernetesCluster = {
+    type: "gcloud",
+    name: "mega-cluster",
+    projectId: "super-google-project",
+    region: "ch-blabla",
+  };
+  const SIMPLE_CONFIG1: Config = {
+    appName: "my-app",
+    customerName: "pan",
+    components: {
+      app1: {
+        dir: "dir1",
+        build: {
+          type: "node",
+        },
+        deploy: { type: "kubernetes", cluster },
+      },
+      app2: {
+        dir: "dir2",
+        build: {
+          type: "node",
+        },
+        deploy: { type: "kubernetes", cluster },
+        env: {
+          dev2: {
+            type: "dev",
+          },
+          review2: {
+            type: "review",
+          },
+          stage2: {
+            type: "stage",
+          },
+          prod2: {
+            type: "prod",
+          },
+        },
+      },
+      app3: {
+        dir: "dir2",
+        build: {
+          type: "node",
+        },
+        deploy: { type: "kubernetes", cluster },
+        env: {
+          dev: false,
+          review: false,
+          stage: false,
+          prod: false,
+        },
+      },
+    },
+  };
+
+  it("should return all envs for SIMPLE_CONFIG1", () => {
+    expect(getAllEnvsInAllComponents(SIMPLE_CONFIG1)).toMatchSnapshot();
+  });
+});