@qawolf/ci-utils 1.0.0

package/.eslintrc.json

@@ -0,0 +1,13 @@
+/**
+ * ESLint config files allow comments, so please comment all changes you make here.
+ * Unless you are changing a rule for reasons very specific to this project, you
+ * should consider making the change in our @qawolf base config instead. There is
+ * also a `.eslintrc.json` file in this repo root folder for any rules that we want
+ * in this repo but not necessarily in other repos that use our @qawolf base config.
+ */
+{
+  "root": true,
+  "rules": {},
+  "extends": ["@qawolf", "../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*", "/**/*.js", "/**/*.d.ts", "dist", "node_modules"]
+}

package/README.md

@@ -0,0 +1,3 @@
+# ci-utils
+
+A set of utilities to be shared between CI packages.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./types";
+export * from "./log";
+export * from "./string";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./log"), exports);
+tslib_1.__exportStar(require("./string"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,gDAAsB;AACtB,mDAAyB"}

package/dist/log.d.ts

@@ -0,0 +1,7 @@
+export interface LogDriver {
+    error(message: string, error?: unknown): void;
+    info(message: string): void;
+    warn(message: string): void;
+}
+export declare const coreLogDriver: LogDriver;
+//# sourceMappingURL=log.d.ts.map

package/dist/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../src/log.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9C,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,eAAO,MAAM,aAAa,EAAE,SAM3B,CAAC"}

package/dist/log.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.coreLogDriver = void 0;
+const core_1 = require("@actions/core");
+const string_1 = require("./string");
+exports.coreLogDriver = {
+    error(message, error) {
+        (0, core_1.error)(message + (error ? `\n${(0, string_1.stringifyUnknown)(error)}` : ""));
+    },
+    info: core_1.info,
+    warn: core_1.warning,
+};
+//# sourceMappingURL=log.js.map

package/dist/log.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../src/log.ts"],"names":[],"mappings":";;;AAAA,wCAAkE;AAElE,qCAA4C;AAQ/B,QAAA,aAAa,GAAc;IACtC,KAAK,CAAC,OAAO,EAAE,KAAK;QAClB,IAAA,YAAS,EAAC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAA,yBAAgB,EAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,EAAJ,WAAI;IACJ,IAAI,EAAE,cAAO;CACd,CAAC"}

package/dist/string.d.ts

@@ -0,0 +1,2 @@
+export declare function stringifyUnknown(value: unknown): string;
+//# sourceMappingURL=string.d.ts.map

package/dist/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAkBvD"}

package/dist/string.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringifyUnknown = stringifyUnknown;
+function stringifyUnknown(value) {
+    if (value === null || value === undefined) {
+        return "";
+    }
+    if (typeof value === "string")
+        return value;
+    if (value instanceof Error) {
+        if ("message" in value && typeof value.message === "string") {
+            return value.message;
+        }
+        return value.toString();
+    }
+    try {
+        const stringified = JSON.stringify(value);
+        return !stringified ? "" : stringified;
+    }
+    catch {
+        return "";
+    }
+}
+//# sourceMappingURL=string.js.map

package/dist/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../src/string.ts"],"names":[],"mappings":";;AAAA,4CAkBC;AAlBD,SAAgB,gBAAgB,CAAC,KAAc;IAC7C,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC5D,OAAO,KAAK,CAAC,OAAO,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IACD,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAE1C,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,16 @@
+import zod from "zod";
+declare const environmentVariablesSchema: zod.ZodRecord<zod.ZodString, zod.ZodString>;
+export declare const jsonEnvironmentVariablesSchema: zod.ZodPipeline<zod.ZodEffects<zod.ZodString, unknown, string>, zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+export type EnvironmentVariables = zod.infer<typeof environmentVariablesSchema>;
+export declare const jsonEnvironmentsMappingSchema: zod.ZodPipeline<zod.ZodEffects<zod.ZodString, unknown, string>, zod.ZodArray<zod.ZodObject<{
+    environmentAlias: zod.ZodString;
+    vcsBranch: zod.ZodString;
+}, "strip", zod.ZodTypeAny, {
+    environmentAlias: string;
+    vcsBranch: string;
+}, {
+    environmentAlias: string;
+    vcsBranch: string;
+}>, "many">>;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,QAAA,MAAM,0BAA0B,6CAAyC,CAAC;AAE1E,eAAO,MAAM,8BAA8B,8GAaR,CAAC;AAEpC,MAAM,MAAM,oBAAoB,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAQhF,eAAO,MAAM,6BAA6B;;;;;;;;;YAaR,CAAC"}

package/dist/types.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonEnvironmentsMappingSchema = exports.jsonEnvironmentVariablesSchema = void 0;
+const tslib_1 = require("tslib");
+const zod_1 = tslib_1.__importDefault(require("zod"));
+const environmentVariablesSchema = zod_1.default.record(zod_1.default.string(), zod_1.default.string());
+exports.jsonEnvironmentVariablesSchema = zod_1.default
+    .string()
+    .transform((str, ctx) => {
+    try {
+        return JSON.parse(str);
+    }
+    catch (error) {
+        ctx.addIssue({
+            code: "custom",
+            message: "input is not a valid JSON-formatted string",
+        });
+        return;
+    }
+})
+    .pipe(environmentVariablesSchema);
+const environmentsMappingSchema = zod_1.default.array(zod_1.default.object({
+    environmentAlias: zod_1.default.string(),
+    vcsBranch: zod_1.default.string(),
+}));
+exports.jsonEnvironmentsMappingSchema = zod_1.default
+    .string()
+    .transform((str, ctx) => {
+    try {
+        return JSON.parse(str);
+    }
+    catch (error) {
+        ctx.addIssue({
+            code: "custom",
+            message: "input is not a valid JSON-formatted string",
+        });
+        return;
+    }
+})
+    .pipe(environmentsMappingSchema);
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,MAAM,0BAA0B,GAAG,aAAG,CAAC,MAAM,CAAC,aAAG,CAAC,MAAM,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,CAAC;AAE7D,QAAA,8BAA8B,GAAG,aAAG;KAC9C,MAAM,EAAE;KACR,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAW,EAAE;IAC/B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,4CAA4C;SACtD,CAAC,CAAC;QACH,OAAO;IACT,CAAC;AACH,CAAC,CAAC;KACD,IAAI,CAAC,0BAA0B,CAAC,CAAC;AAIpC,MAAM,yBAAyB,GAAG,aAAG,CAAC,KAAK,CACzC,aAAG,CAAC,MAAM,CAAC;IACT,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE;IAC9B,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE;CACxB,CAAC,CACH,CAAC;AACW,QAAA,6BAA6B,GAAG,aAAG;KAC7C,MAAM,EAAE;KACR,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAW,EAAE;IAC/B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,4CAA4C;SACtD,CAAC,CAAC;QACH,OAAO;IACT,CAAC;AACH,CAAC,CAAC;KACD,IAAI,CAAC,yBAAyB,CAAC,CAAC"}

package/jest.config.ts

@@ -0,0 +1,8 @@
+import { type Config } from "jest";
+
+const config: Config = {
+  displayName: "ci-utils",
+  preset: "../../jest.preset.js",
+};
+
+export default config;

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@qawolf/ci-utils",
+  "version": "1.0.0",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "engines": {
+    "node": "^16 || ^18 || ^20 || >=22"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "build:clean": "tsc --build --clean && rm -rf ./dist",
+    "lint": "eslint . --ext js,jsx,mjs,ts,tsx --max-warnings=0 && prettier --check .",
+    "lint:fix": "eslint . --ext js,jsx,mjs,ts,tsx --fix --max-warnings=0 && prettier --write .",
+    "test": "jest --passWithNoTests",
+    "test:watch": "npm run test -- --watch",
+    "tsc:check": "tsc",
+    "gen": "npm run build"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.1",
+    "tslib": "^2.5.3",
+    "zod": "^3.22.4"
+  },
+  "license": "MIT"
+}

package/project.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "name": "ci-utils",
+  "projectType": "library",
+  "sourceRoot": "packages/ci-utils/src"
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./types";
+export * from "./log";
+export * from "./string";

package/src/log.ts

@@ -0,0 +1,17 @@
+import { error as coreError, info, warning } from "@actions/core";
+
+import { stringifyUnknown } from "./string";
+
+export interface LogDriver {
+  error(message: string, error?: unknown): void;
+  info(message: string): void;
+  warn(message: string): void;
+}
+
+export const coreLogDriver: LogDriver = {
+  error(message, error) {
+    coreError(message + (error ? `\n${stringifyUnknown(error)}` : ""));
+  },
+  info,
+  warn: warning,
+};

package/src/string.ts

@@ -0,0 +1,19 @@
+export function stringifyUnknown(value: unknown): string {
+  if (value === null || value === undefined) {
+    return "";
+  }
+  if (typeof value === "string") return value;
+  if (value instanceof Error) {
+    if ("message" in value && typeof value.message === "string") {
+      return value.message;
+    }
+    return value.toString();
+  }
+  try {
+    const stringified = JSON.stringify(value);
+
+    return !stringified ? "" : stringified;
+  } catch {
+    return "";
+  }
+}

package/src/types.test.ts

@@ -0,0 +1,58 @@
+import {
+  jsonEnvironmentsMappingSchema,
+  jsonEnvironmentVariablesSchema,
+} from "./types";
+
+describe("types", () => {
+  describe("jsonEnvironmentVariablesSchema", () => {
+    it("should fail to parse malformed JSON", () => {
+      const result = jsonEnvironmentVariablesSchema.safeParse("{");
+      expect(result.success).toBe(false);
+    });
+    it("should succeed to parse well formatted JSON object string-string dictionary", () => {
+      const result = jsonEnvironmentVariablesSchema.safeParse(
+        JSON.stringify({
+          foo: "bar",
+        }),
+      );
+      expect(result.success).toBe(true);
+    });
+    it("should fail to parse well formatted JSON which is not an object", () => {
+      const result = jsonEnvironmentVariablesSchema.safeParse(
+        JSON.stringify("Hello world"),
+      );
+      expect(result.success).toBe(false);
+    });
+
+    it("should fail to parse well formatted JSON which is not a dictionary of string-string", () => {
+      const result = jsonEnvironmentVariablesSchema.safeParse(
+        JSON.stringify({ foo: 1 }),
+      );
+      expect(result.success).toBe(false);
+    });
+  });
+
+  describe("jsonEnvironmentsMappingSchema", () => {
+    it("fails with invalid JSON", () => {
+      const result = jsonEnvironmentsMappingSchema.safeParse("{");
+      expect(result.success).toBe(false);
+    });
+    it("succeeds with valid JSON w/ correct schema", () => {
+      const result = jsonEnvironmentsMappingSchema.safeParse(
+        JSON.stringify([
+          {
+            environmentAlias: "foo",
+            vcsBranch: "bar",
+          },
+        ]),
+      );
+      expect(result.success).toBe(true);
+    });
+    it("fails with valid JSON w/ incorrect schema", () => {
+      const result = jsonEnvironmentsMappingSchema.safeParse(
+        JSON.stringify([{ invalid: "schema" }]),
+      );
+      expect(result.success).toBe(false);
+    });
+  });
+});

package/src/types.ts

@@ -0,0 +1,41 @@
+import zod from "zod";
+
+const environmentVariablesSchema = zod.record(zod.string(), zod.string());
+
+export const jsonEnvironmentVariablesSchema = zod
+  .string()
+  .transform((str, ctx): unknown => {
+    try {
+      return JSON.parse(str);
+    } catch (error) {
+      ctx.addIssue({
+        code: "custom",
+        message: "input is not a valid JSON-formatted string",
+      });
+      return;
+    }
+  })
+  .pipe(environmentVariablesSchema);
+
+export type EnvironmentVariables = zod.infer<typeof environmentVariablesSchema>;
+
+const environmentsMappingSchema = zod.array(
+  zod.object({
+    environmentAlias: zod.string(),
+    vcsBranch: zod.string(),
+  }),
+);
+export const jsonEnvironmentsMappingSchema = zod
+  .string()
+  .transform((str, ctx): unknown => {
+    try {
+      return JSON.parse(str);
+    } catch (error) {
+      ctx.addIssue({
+        code: "custom",
+        message: "input is not a valid JSON-formatted string",
+      });
+      return;
+    }
+  })
+  .pipe(environmentsMappingSchema);

package/tsconfig.build.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "noEmit": false,
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx"],
+  "exclude": ["src/**/*.test.ts", "src/**/*.test.tsx"]
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "."
+  },
+  "include": ["./**/*.ts", "./**/*.tsx"],
+  "exclude": ["dist", "node_modules"]
+}