#142 testing framework

packages/api/package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "dev": "nodemon ./src/index.ts",
     "start": "tsc && node dist/index.js",
-    "test": "jest --runInBand --watchAll"
+    "test": "jest --runInBand --watchAll --testTimeout=10000"
   },
   "dependencies": {
     "@seitz/shared": "workspace:*",
@@ -31,6 +31,7 @@
     "@types/passport-local": "^1.0.36",
     "@types/supertest": "^2.0.15",
     "jest": "^29.7.0",
+    "mongodb-memory-server": "^8.16.1",
     "nodemon": "^3.0.1",
     "supertest": "^6.3.3",
     "ts-jest": "^29.1.1",

packages/api/src/services/admin.service.ts

@@ -11,7 +11,7 @@ import type {
   ICustomizedBattery,
   IUser,
 } from "@seitz/shared";
-import { parseVisibility } from "@/util/validation.utils";
+import { parseVisibility } from "../util/validation.utils";
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 

packages/api/src/util/validation.utils.ts

@@ -1,4 +1,4 @@
-import { VisibilityError } from "@/types/errors";
+import { VisibilityError } from "../types/errors";
 
 export enum Visibility {
   ON = "on",

packages/api/test/config/database.ts

@@ -0,0 +1,22 @@
+import mongoose from "mongoose";
+import { MongoMemoryServer } from "mongodb-memory-server";
+
+let mongoServer: MongoMemoryServer;
+
+export const connectDB = async () => {
+  mongoServer = await MongoMemoryServer.create();
+  const mongoUri = mongoServer.getUri();
+  await mongoose.connect(mongoUri);
+};
+
+export const closeDB = async () => {
+  await mongoose.disconnect();
+  await mongoServer.stop();
+};
+
+export const clearDB = async () => {
+  const collections = mongoose.connection.collections;
+  for (const key in collections) {
+    await collections[key].deleteMany({});
+  }
+};

packages/api/test/seed/index.ts

@@ -0,0 +1,43 @@
+import mongoose from "mongoose";
+import { Battery, CustomizedBattery, User } from "../../src/models";
+import type { CreateBattery, CreateUser } from "@seitz/shared";
+
+export const seedUsers = [
+  {
+    _id: new mongoose.Types.ObjectId(),
+    email: "[email protected]",
+    password: "password123",
+    isAdmin: true,
+  },
+  {
+    _id: new mongoose.Types.ObjectId(),
+    email: "[email protected]",
+    password: "password123",
+    isAdmin: false,
+  },
+] as CreateUser[];
+
+export const seedBatteries = [
+  {
+    _id: new mongoose.Types.ObjectId(),
+    name: "Test Battery",
+    description: "A test battery",
+    imageUrl: "https://test.com/image.jpg",
+    stages: [],
+    deleted: false,
+  },
+] as CreateBattery[];
+
+export const seedCustomizedBatteries = [
+  {
+    _id: new mongoose.Types.ObjectId(),
+    battery: seedBatteries[0]._id,
+    isVisibleToNonAdmins: false,
+  },
+];
+
+export const seedDatabase = async () => {
+  await User.create(seedUsers);
+  await Battery.create(seedBatteries);
+  await CustomizedBattery.create(seedCustomizedBatteries);
+};

packages/api/test/unit/admin.service.test.ts

@@ -0,0 +1,85 @@
+import { connectDB, closeDB, clearDB } from "../config/database";
+import { seedDatabase, seedCustomizedBatteries } from "../seed";
+import * as adminService from "../../src/services/admin.service";
+import HttpError from "../../src/types/errors";
+
+describe("Admin Service", () => {
+  beforeAll(async () => {
+    await connectDB();
+  });
+
+  beforeEach(async () => {
+    await clearDB();
+    await seedDatabase();
+  });
+
+  afterAll(async () => {
+    await closeDB();
+  });
+
+  describe("updateAdminVisibility", () => {
+    const batteryId = seedCustomizedBatteries[0]._id.toString();
+
+    it('should update visibility to true when setting to "on"', async () => {
+      const [status, battery] = await adminService.updateAdminVisibility(
+        batteryId,
+        "on"
+      );
+
+      expect(status).toBe(200);
+      expect(battery?.isVisibleToNonAdmins).toBe(true);
+    });
+
+    it('should update visibility to false when setting to "off"', async () => {
+      const [status, battery] = await adminService.updateAdminVisibility(
+        batteryId,
+        "off"
+      );
+
+      expect(status).toBe(200);
+      expect(battery?.isVisibleToNonAdmins).toBe(false);
+    });
+
+    it("should default to false for invalid visibility value", async () => {
+      const [status, battery] = await adminService.updateAdminVisibility(
+        batteryId,
+        "invalid"
+      );
+
+      expect(status).toBe(200);
+      expect(battery?.isVisibleToNonAdmins).toBe(false);
+    });
+
+    describe("edge cases should default to false", () => {
+      const testCases = [
+        { desc: "undefined", value: undefined },
+        { desc: "null", value: null },
+        { desc: "empty string", value: "" },
+        { desc: "number", value: 123 },
+        { desc: "object", value: {} },
+      ];
+
+      testCases.forEach(({ desc, value }) => {
+        it(`should handle ${desc} input`, async () => {
+          const [status, battery] = await adminService.updateAdminVisibility(
+            batteryId,
+            value as unknown as string // have to do this to avoid type error :/
+          );
+
+          expect(status).toBe(200);
+          expect(battery?.isVisibleToNonAdmins).toBe(false);
+        });
+      });
+    });
+
+    it("should throw 404 error for non-existent battery", async () => {
+      const nonExistentId = "507f1f77bcf86cd799439011";
+
+      await expect(
+        adminService.updateAdminVisibility(nonExistentId, "on")
+      ).rejects.toThrow(
+        new HttpError(404, `Battery not found with ID: ${nonExistentId}`)
+      );
+    });
+  });
+});