@catladder/pipeline 1.99.0 → 1.100.0

package/src/build/custom/testJob.ts

@@ -1,7 +1,10 @@
+import { join } from "path";
 import type { Context } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { ensureArray, notNil } from "../../utils";
 import { isOfBuildType } from "../types";
+import type { BuildConfigArtifactsReports } from "../types";
+import type { Artifacts } from "../../types";
 
 const RUNNER_CUSTOM_TEST_VARIABLES = {
   KUBERNETES_CPU_REQUEST: "0.5",
@@ -42,6 +45,10 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
         cache: undefined,
         script: [...(ensureArray(buildConfig.audit?.command) ?? [])],
         allow_failure: true,
+        ...createArtifactsConfig(
+          context.componentConfig.dir,
+          buildConfig.audit?.artifactsReports
+        ),
       }
     : null;
 
@@ -52,6 +59,10 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
         ...base,
         image: buildConfig.lint?.jobImage ?? buildConfig.jobImage,
         script: [...(ensureArray(buildConfig.lint?.command) ?? [])],
+        ...createArtifactsConfig(
+          context.componentConfig.dir,
+          buildConfig.lint?.artifactsReports
+        ),
       }
     : null;
   const testJob: CatladderJob | null = buildConfig.test
@@ -61,7 +72,32 @@ export const createCustomTestJobs = (context: Context): CatladderJob[] => {
         ...base,
         image: buildConfig.test?.jobImage ?? buildConfig.jobImage,
         script: [...(ensureArray(buildConfig.test?.command) ?? [])],
+        ...createArtifactsConfig(
+          context.componentConfig.dir,
+          buildConfig.test?.artifactsReports
+        ),
       }
     : null;
   return [auditJob, lintJob, testJob].filter(notNil);
 };
+
+type OptionalArtifacts =
+  | {
+      artifacts: Artifacts;
+    }
+  | undefined;
+
+const createArtifactsConfig = (
+  rootPath: string,
+  artifactsReports?: BuildConfigArtifactsReports
+): OptionalArtifacts =>
+  artifactsReports
+    ? {
+        artifacts: {
+          paths: [],
+          reports: {
+            junit: artifactsReports?.junit?.map((p) => join(rootPath, p)) ?? [],
+          },
+        },
+      }
+    : undefined;

package/src/build/node/buildJob.ts

@@ -7,7 +7,7 @@ import { join } from "path";
 import { isOfBuildType } from "../types";
 import { getNextCache, getNodeCache, getYarnCache } from "./cache";
 import { NODE_RUNNER_BUILD_VARIABLES } from "./constants";
-import { getYarnInstall, getYarnInstallCommand } from "./yarn";
+import { getDockerAppCopyAndBuildScript, getYarnInstall } from "./yarn";
 import type { CatladderJob } from "../../types/jobs";
 
 export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
@@ -55,13 +55,8 @@ export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
             cache: [...getYarnCache(context, "pull")],
             variables: {
               // only required for non static
-              YARN_INSTALL: getYarnInstallCommand(context, {
-                prodOnly: true,
-              }),
-              YARN_INSTALL_WITHOUT_SCRIPTS: getYarnInstallCommand(context, {
-                prodOnly: true,
-                noScripts: true,
-              }),
+              DOCKER_COPY_AND_INSTALL_APP:
+                getDockerAppCopyAndBuildScript(context),
               DOCKER_COPY_WORKSPACE_FILES:
                 context.packageManagerInfo?.pathsToCopyInDocker
                   .map((dir) => `COPY --chown=node:node ${dir} /app/${dir}`)

package/src/build/node/yarn.ts

@@ -1,33 +1,16 @@
 import type { Context } from "../../types";
 
-export const getYarnInstallCommand = (
-  context: Context,
-  options?: {
-    prodOnly?: boolean;
-    noScripts?: boolean;
-  }
-) => {
+const YARN_INSTALL_CLASSIC = `yarn install --frozen-lockfile`;
+
+// FIXME: check why and when rebuild is needed
+const YARN_BERRY_PROD_REBUILD = `yarn workspaces focus --production && yarn rebuild`;
+
+const getYarnInstallCommand = (context: Context) => {
   if (context.packageManagerInfo?.isClassic) {
-    return `yarn install --frozen-lockfile ${
-      options?.prodOnly ? "--production" : ""
-    } ${options?.noScripts ? "--ignore-scripts" : ""}`;
+    return YARN_INSTALL_CLASSIC;
   }
-  // is modern
 
-  // yarn >= 4 ships with build in plugins, see https://github.com/yarnpkg/berry/pull/4253
-  // trying to import those fail on this version
-  const doesNotShipWithBuiltInPlugins = ["2", "3"].some((v) =>
-    context.packageManagerInfo?.version.startsWith(v)
-  );
-  return options?.prodOnly
-    ? `${options?.noScripts ? "YARN_ENABLE_SCRIPTS=false " : ""}${
-        doesNotShipWithBuiltInPlugins
-          ? "yarn plugin import workspace-tools && "
-          : " "
-      }yarn workspaces focus --production && yarn rebuild` // needs yarn plugin import workspace-tools
-    : `${
-        options?.noScripts ? "YARN_ENABLE_SCRIPTS=false " : ""
-      }yarn install --immutable`;
+  return `yarn install --immutable`;
 };
 
 export const ensureNodeVersion = (context: Context) => [
@@ -38,3 +21,33 @@ export const getYarnInstall = (context: Context) => [
   ...ensureNodeVersion(context),
   getYarnInstallCommand(context),
 ];
+
+const DOCKER_COPY_FILES = `COPY --chown=node:node $APP_DIR .`;
+
+export const getDockerAppCopyAndBuildScript = (context: Context) => {
+  if (context.packageManagerInfo?.isClassic) {
+    return `
+RUN ${YARN_INSTALL_CLASSIC} --production --ignore-scripts
+${DOCKER_COPY_FILES}
+RUN ${YARN_INSTALL_CLASSIC} --production 
+    `.trim();
+  }
+
+  // yarn >= 4 ships with build in plugins, see https://github.com/yarnpkg/berry/pull/4253
+  // trying to import those fail on this version
+  const doesNotShipWithBuiltInPlugins = ["2", "3"].some((v) =>
+    context.packageManagerInfo?.version.startsWith(v)
+  );
+  const maybeAddWorkspaceToolsCommand = doesNotShipWithBuiltInPlugins
+    ? "RUN yarn plugin import workspace-tools"
+    : "";
+
+  // copy first everything and then install
+  // rebuild first does not work as it will run postinstall and that might require files in the app
+  return `
+${DOCKER_COPY_FILES}
+${maybeAddWorkspaceToolsCommand}
+RUN ${YARN_BERRY_PROD_REBUILD}
+
+    `.trim();
+};

package/src/build/types.ts

@@ -2,6 +2,16 @@ import type { GitlabJobImage, GitlabJobService } from "../types";
 
 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 BuildConfigBase = {
   /**
    * command to run on the image to start the app (e.g. yarn start)
@@ -64,15 +74,7 @@ export type BuildConfigBase = {
    * additional CI/CD artifacts reports,
    * use to display information in merge requests, pipeline views and security dashboards.
    */
-  artifactsReports?: {
-    /**
-     * 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[];
-  };
+  artifactsReports?: BuildConfigArtifactsReports;
 };
 
 export type BuildConfigNodeBase = BuildConfigBase;
@@ -132,6 +134,11 @@ export type BuildConfigCustom = Omit<
   lint?: {
     command?: string | string[];
     jobImage?: GitlabJobImage;
+    /**
+     * additional CI/CD artifacts reports,
+     * use to display information in merge requests, pipeline views and security dashboards.
+     */
+    artifactsReports?: BuildConfigArtifactsReports;
   };
 
   /**
@@ -140,6 +147,11 @@ export type BuildConfigCustom = Omit<
   test?: {
     command?: string | string[];
     jobImage?: GitlabJobImage;
+    /**
+     * additional CI/CD artifacts reports,
+     * use to display information in merge requests, pipeline views and security dashboards.
+     */
+    artifactsReports?: BuildConfigArtifactsReports;
   };
 
   /**
@@ -148,6 +160,11 @@ export type BuildConfigCustom = Omit<
   audit?: {
     command?: string | string[];
     jobImage?: GitlabJobImage;
+    /**
+     * additional CI/CD artifacts reports,
+     * use to display information in merge requests, pipeline views and security dashboards.
+     */
+    artifactsReports?: BuildConfigArtifactsReports;
   };
 
   /**

package/src/pipeline/packageManager.ts

@@ -29,11 +29,12 @@ export const getPackageManagerInfo = async (
     ? join(workspaceRoot, "yarn.lock")
     : join(component.dir, "yarn.lock");
   const configFiles = [".yarnrc", ".yarnrc.yml", ".npmrc", ".yarn"]; // ".yarn" is yarn 2 folder
-  const rcFiles = (
-    componentIsInWorkspace
-      ? configFiles
-      : configFiles.map((f) => join(component.dir, f))
-  ).filter((f) => existsSync(f));
+  // copy all those configFiles from workspace root and/or component folder
+
+  const configFilePaths = [
+    ...configFiles,
+    ...configFiles.map((f) => join(component.dir, f)),
+  ].filter((f) => existsSync(f));
 
   // get all folders that this workspace depend on
   // we will later copy them into the docker build
@@ -50,7 +51,7 @@ export const getPackageManagerInfo = async (
     packageJson,
     ...(workspacePackageJson ? [workspacePackageJson] : []),
     lockFile,
-    ...rcFiles,
+    ...configFilePaths,
     ...workspaceDependencies,
   ];
   return {