@catladder/pipeline 0.0.0-node16-ddfae617 → 0.0.0-prettier-cbceeed9

package/dist/build/rails/test.js

@@ -0,0 +1,94 @@
+"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 __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.createRailsTestJobs = void 0;
+var utils_1 = require("../../utils");
+var createRailsTestJobs = function (context) {
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+  // don't run tests after release
+  if (((_a = context.commitInfo) === null || _a === void 0 ? void 0 : _a.trigger) === "taggedRelease") {
+    return [];
+  }
+  var buildConfig = context.componentConfig.build;
+  var base = {
+    variables: (_b = buildConfig.extraVars) !== null && _b !== void 0 ? _b : {},
+    stage: "test",
+    needs: [],
+    envMode: "none"
+  };
+  var defaultImage = "docker.io/ruby";
+  var bundlerCacheDir = "tmp/cache";
+  var bundlerInstall = ["bundle config set path '".concat(bundlerCacheDir, "'"), "bundle install -j $(nproc)"];
+  var bundlerCache = {
+    key: {
+      files: ["Gemfile.lock"],
+      prefix: "$CI_JOB_IMAGE"
+    },
+    paths: [bundlerCacheDir]
+  };
+  var auditJob = buildConfig.audit !== false ? __assign(__assign({
+    name: "🛡 audit"
+  }, base), {
+    cache: undefined,
+    image: (_d = (_c = buildConfig.audit) === null || _c === void 0 ? void 0 : _c.jobImage) !== null && _d !== void 0 ? _d : defaultImage,
+    script: __spreadArray(["cd ".concat(context.componentConfig.dir)], __read((_f = (0, utils_1.ensureArray)((_e = buildConfig.audit) === null || _e === void 0 ? void 0 : _e.command)) !== null && _f !== void 0 ? _f : ["gem install bundler-audit", "bundle audit check"]), false),
+    allow_failure: true
+  }) : null;
+  var lintJob = buildConfig.lint !== false ? __assign(__assign({
+    name: "👮 lint"
+  }, base), {
+    cache: bundlerCache,
+    image: (_h = (_g = buildConfig.lint) === null || _g === void 0 ? void 0 : _g.jobImage) !== null && _h !== void 0 ? _h : defaultImage,
+    script: __spreadArray(__spreadArray(["cd ".concat(context.componentConfig.dir)], __read(bundlerInstall), false), __read((_k = (0, utils_1.ensureArray)((_j = buildConfig.lint) === null || _j === void 0 ? void 0 : _j.command)) !== null && _k !== void 0 ? _k : ["bundle exec rubocop"]), false)
+  }) : null;
+  var testJob = buildConfig.test !== false ? __assign(__assign({
+    name: "🧪 test"
+  }, base), {
+    cache: bundlerCache,
+    image: (_m = (_l = buildConfig.test) === null || _l === void 0 ? void 0 : _l.jobImage) !== null && _m !== void 0 ? _m : defaultImage,
+    script: __spreadArray(__spreadArray(["cd ".concat(context.componentConfig.dir)], __read(bundlerInstall), false), __read((_p = (0, utils_1.ensureArray)((_o = buildConfig.test) === null || _o === void 0 ? void 0 : _o.command)) !== null && _p !== void 0 ? _p : ["bundle exec rspec"]), false)
+  }) : null;
+  return [auditJob, lintJob, testJob].filter(utils_1.notNil);
+};
+exports.createRailsTestJobs = createRailsTestJobs;

package/dist/build/types.d.ts

@@ -1,3 +1,5 @@
+import type { GitlabJobImage, GitlabJobService } from "../types";
+import type { CatladderJob } from "../types/jobs";
 export declare type BuildConfigBase = {
   /**
    * command to run on the image to start the app (e.g. yarn start)
@@ -6,17 +8,14 @@ export declare type BuildConfigBase = {
   /**
    * additional env vars for the buid jobs
    */
-
   extraVars?: Record<string, string>;
   /**
    * define the build command
    */
-
   buildCommand?: string | string[] | null;
   /**
    * customize docker build
    */
-
   docker?: {
     additionsBegin?: string[];
     additionsEnd?: string[];
@@ -24,30 +23,42 @@ export declare type BuildConfigBase = {
   /**
    * customize lint, set false to disable
    */
-
   lint?: false | {
     command?: string | string[];
+    jobImage?: GitlabJobImage;
   };
   /**
    * customize test, set false to disable
    */
-
   test?: false | {
     command?: string | string[];
+    jobImage?: GitlabJobImage;
   };
   /**
    * customize audit, set false to disable
    */
-
   audit?: false | {
     command?: string | string[];
+    jobImage?: GitlabJobImage;
   };
   /**
    * 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?: {
+    /**
+     * 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 declare type BuildConfigNodeBase = BuildConfigBase;
 export declare type BuildConfigNode = {
@@ -59,18 +70,82 @@ export declare type BuildConfigNodeStatic = BuildConfigNodeBase & {
 };
 export declare 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;
+};
+export declare type BuildConfigCustomDocker = BuildConfigBase["docker"] & ({
+  /**
+   * use the built-in nginx image for simple static apps
+   */
+  type: "nginx";
+} | {
+  /**
+   * custom docker build, expect that a Dockerfile in your directory
+   */
+  type: "custom";
+});
+export declare type BuildConfigCustom = BuildConfigBase & {
+  type: "custom";
+  jobImage: string;
+  jobServices?: GitlabJobService[];
+  docker: BuildConfigCustomDocker;
+  /**
+   * customize cache for the job
+   */
+  jobCache?: CatladderJob["cache"];
+};
+export declare type BuildConfigRails = BuildConfigBase & {
+  type: "rails";
+  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 declare type BuildConfigStorybook = BuildConfigNodeBase & {
   type: "storybook";
   startCommand?: never;
 };
-export declare type BuildConfig = BuildConfigNode | BuildConfigNodeStatic | BuildConfigStorybook | BuildConfigMeteor;
-export declare const isOfBuildType: <T extends ("node" | "node-static" | "meteor" | "storybook")[]>(t: BuildConfig, ...types: T) => t is Extract<BuildConfigNode, {
+export declare type BuildConfig = BuildConfigNode | BuildConfigNodeStatic | BuildConfigStorybook | BuildConfigMeteor | BuildConfigCustom | BuildConfigRails;
+export declare type BuildConfigType = BuildConfig["type"];
+export declare type BuildConfigGeneric<T extends BuildConfigType> = Extract<BuildConfig, {
+  type: T;
+}>;
+export declare const isOfBuildType: <T extends ("node" | "node-static" | "meteor" | "custom" | "rails" | "storybook")[]>(t: BuildConfig, ...types: T) => t is Extract<BuildConfigNode, {
   type: T[number];
 }> | Extract<BuildConfigNodeStatic, {
   type: T[number];
 }> | Extract<BuildConfigMeteor, {
   type: T[number];
+}> | Extract<BuildConfigCustom, {
+  type: T[number];
+}> | Extract<BuildConfigRails, {
+  type: T[number];
 }> | Extract<BuildConfigStorybook, {
   type: T[number];
 }>;

package/dist/build/types.js

@@ -2,15 +2,11 @@
 
 exports.__esModule = true;
 exports.isOfBuildType = void 0;
-
 var isOfBuildType = function (t) {
   var types = [];
-
   for (var _i = 1; _i < arguments.length; _i++) {
     types[_i - 1] = arguments[_i];
   }
-
   return types.includes(t.type);
 };
-
 exports.isOfBuildType = isOfBuildType;