@jaypie/testkit 0.1.1 → 0.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaypie/testkit",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "author": "Finlayson Studio",
   "type": "module",
   "main": "src/index.js",
@@ -13,10 +13,16 @@
     "new": "hygen jaypie vite",
     "test": "vitest",
     "test:spec:index": "vitest run ./src/__tests__/index.spec.js",
+    "test:spec:jsonApiSchema.module": "vitest run ./src/__tests__/jsonApiSchema.module.spec.js",
     "test:spec:matchers.module": "vitest run ./src/__tests__/matchers.module.spec.js",
-    "test:spec:mockLog.module": "vitest run ./src/__tests__/mockLog.module.spec.js"
+    "test:spec:mockLog.module": "vitest run ./src/__tests__/mockLog.module.spec.js",
+    "test:spec:toBeJaypieError.matcher": "vitest run ./src/matchers/__tests__/toBeJaypieError.matcher.spec.js"
+  },
+  "dependencies": {
+    "jest-json-schema": "^6.1.0"
   },
   "devDependencies": {
+    "@jaypie/core": "^0.3.7",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
@@ -27,8 +33,5 @@
     "prettier": "^3.2.5",
     "sort-package-json": "^2.8.0",
     "vitest": "^1.4.0"
-  },
-  "dependencies": {
-    "jest-json-schema": "^6.1.0"
   }
 }

package/src/__tests__/index.spec.js

@@ -1,7 +1,14 @@
 import { describe, expect, it } from "vitest";
 
 // Subject
-import { matchers, mockLogFactory, restoreLog, spyLog } from "../index.js";
+import {
+  jsonApiErrorSchema,
+  jsonApiSchema,
+  matchers,
+  mockLogFactory,
+  restoreLog,
+  spyLog,
+} from "../index.js";
 
 //
 //
@@ -15,6 +22,8 @@ describe("Index", () => {
     expect(spyLog).toBeFunction();
   });
   it("Exports matchers", () => {
+    expect(jsonApiErrorSchema).toBeObject();
+    expect(jsonApiSchema).toBeObject();
     expect(matchers).toBeObject();
   });
 });

package/src/__tests__/jsonApiSchema.module.spec.js

@@ -0,0 +1,17 @@
+// eslint-disable-next-line no-unused-vars
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+// Subject
+import { jsonApiErrorSchema, jsonApiSchema } from "../jsonApiSchema.module.js";
+
+//
+//
+// Run tests
+//
+
+describe("Json Api Schema Module", () => {
+  it("Exports objects", () => {
+    expect(jsonApiSchema).toBeObject();
+    expect(jsonApiErrorSchema).toBeObject();
+  });
+});

package/src/index.js

@@ -3,5 +3,6 @@
 // Export
 //
 
+export { jsonApiErrorSchema, jsonApiSchema } from "./jsonApiSchema.module.js";
 export { default as matchers } from "./matchers.module.js";
 export { mockLogFactory, restoreLog, spyLog } from "./mockLog.module.js";

package/src/jsonApiSchema.module.js

@@ -0,0 +1,39 @@
+export const jsonApiErrorSchema = {
+  type: "object",
+  properties: {
+    errors: {
+      type: "array",
+      items: {
+        type: "object",
+        properties: {
+          status: { type: "number" },
+          title: { type: "string" },
+          detail: { type: "string" },
+        },
+        required: ["status", "title"],
+      },
+      minItems: 1,
+    },
+  },
+  required: ["errors"],
+};
+
+export const jsonApiSchema = {
+  type: "object",
+  properties: {
+    data: {
+      type: "object",
+      properties: {
+        id: { type: "string" },
+        type: { type: "string" },
+        attributes: { type: "object" },
+        links: { type: "object" },
+        meta: { type: "object" },
+        relationships: { type: "object" },
+      },
+      required: ["id", "type"],
+    },
+    meta: { type: "object" },
+  },
+  required: ["data"],
+};

package/src/matchers/__tests__/toBeJaypieError.matcher.spec.js

@@ -0,0 +1,100 @@
+// eslint-disable-next-line no-unused-vars
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+import { ConfigurationError } from "@jaypie/core";
+
+// Subject
+import toBeJaypieError from "../toBeJaypieError.matcher.js";
+
+//
+//
+// Mock constants
+//
+
+//
+//
+// Mock modules
+//
+
+//
+//
+// Mock environment
+//
+
+const DEFAULT_ENV = process.env;
+beforeEach(() => {
+  process.env = { ...process.env };
+});
+afterEach(() => {
+  process.env = DEFAULT_ENV;
+});
+
+//
+//
+// Run tests
+//
+
+describe("To Be Jaypie Error Matcher", () => {
+  it("Is a function", () => {
+    expect(toBeJaypieError).toBeFunction();
+  });
+  describe("Error Conditions", () => {
+    it("Rejects instances of plain error objects", () => {
+      const error = new Error(
+        "If this is your first night at Fight Club, you have to fight",
+      );
+      const result = toBeJaypieError(error);
+      expect(result.message).toBeFunction();
+      expect(result.message()).toBeString();
+      expect(result.pass).toBeFalse();
+    });
+    it("Rejects if nothing passed", () => {
+      const result = toBeJaypieError();
+      expect(result.message).toBeFunction();
+      expect(result.message()).toBeString();
+      expect(result.pass).toBeFalse();
+    });
+    it("Rejects if non-object passed", () => {
+      const result = toBeJaypieError(12);
+      expect(result.message).toBeFunction();
+      expect(result.message()).toBeString();
+      expect(result.pass).toBeFalse();
+    });
+    it("Rejects if no errors array", () => {
+      const result = toBeJaypieError({});
+      expect(result.message).toBeFunction();
+      expect(result.message()).toBeString();
+      expect(result.pass).toBeFalse();
+    });
+    it("Rejects if errors array is empty", () => {
+      const result = toBeJaypieError({ errors: [] });
+      expect(result.message).toBeFunction();
+      expect(result.message()).toBeString();
+      expect(result.pass).toBeFalse();
+    });
+    it("Must match the entire json:api error schema", () => {
+      const result = toBeJaypieError({ errors: ["taco"] });
+      expect(result.message).toBeFunction();
+      expect(result.message()).toBeString();
+      expect(result.pass).toBeFalse();
+    });
+  });
+  describe("Happy Path", () => {
+    it("Matches instances of Jaypie error objects", () => {
+      const error = new ConfigurationError();
+      const result = toBeJaypieError(error);
+      expect(result.message).toBeFunction();
+      expect(result.message()).toBeString();
+      expect(result.pass).toBeTrue();
+    });
+    it("Matches plain old json errors", () => {
+      const error = new ConfigurationError(
+        "If this is your first night at Fight Club, you have to fight",
+      ).json();
+      const result = toBeJaypieError(error);
+      expect(result.message).toBeFunction();
+      expect(result.message()).toBeString();
+      expect(result.pass).toBeTrue();
+    });
+  });
+});

package/src/matchers/toBeJaypieError.matcher.js

@@ -0,0 +1,57 @@
+import { matchers as jsonSchemaMatchers } from "jest-json-schema";
+import { jsonApiErrorSchema } from "../jsonApiSchema.module.js";
+
+//
+//
+// Constants
+//
+
+//
+//
+// Helper Functions
+//
+
+function isErrorObjectJaypieError(error) {
+  if (error.isProjectError) {
+    return {
+      message: () => `expected "${error}" not to be a Jaypie error`,
+      pass: true,
+    };
+  }
+  return {
+    message: () => `expected "${error}" to be a Jaypie error`,
+    pass: false,
+  };
+}
+
+//
+//
+// Main
+//
+
+const toBeJaypieError = (received) => {
+  // See if it is an instance of error:
+  if (received instanceof Error) {
+    return isErrorObjectJaypieError(received);
+  }
+
+  const result = jsonSchemaMatchers.toMatchSchema(received, jsonApiErrorSchema);
+  if (result.pass) {
+    return {
+      message: () => `expected ${received} not to be a Jaypie error`,
+      pass: true,
+    };
+  } else {
+    return {
+      message: () => `expected ${received} to be a Jaypie error`,
+      pass: false,
+    };
+  }
+};
+
+//
+//
+// Export
+//
+
+export default toBeJaypieError;

package/src/matchers.module.js

@@ -1,11 +1,14 @@
 import { matchers as jsonSchemaMatchers } from "jest-json-schema";
 
+import toBeJaypieError from "./matchers/toBeJaypieError.matcher.js";
+
 //
 //
 // Export
 //
 
 export default {
+  toBeJaypieError,
   toBeValidSchema: jsonSchemaMatchers.toBeValidSchema,
   toMatchSchema: jsonSchemaMatchers.toMatchSchema,
 };