build real unit and integration tests

.eslintrc

@@ -35,5 +35,13 @@
         "alwaysTryTypes": true
       }
     }
-  }
+  },
+  "overrides": [
+    {
+      "files": ["*.test.ts", "*.testdata.ts"],
+      "rules": {
+        "@typescript-eslint/no-explicit-any": "off"
+      }
+    }
+  ]
 }

Makefile

@@ -62,15 +62,15 @@ deploy_dev: check_account_dev build
 
 install_test_deps:
 	yarn -D
-	pip install -r $(integration_test_directory_root)/requirements.txt
 
 test_live_integration: install_test_deps
-	APPLICATION_KEY=$(application_key) pytest -rP $(integration_test_directory_root)
+	yarn test:live
 
 test_unit: install_test_deps
 	yarn typecheck
 	yarn lint
 	yarn prettier
+	yarn test:unit
 
 dev_health_check:
 	curl -f https://$(application_key).aws.qa.acmuiuc.org/api/v1/healthz

package.json

@@ -16,13 +16,21 @@
     "prettier": "prettier --check src/*.ts src/**/*.ts",
     "prettier:write": "prettier --write src/*.ts src/**/*.ts",
     "prepare": "node .husky/install.mjs || true",
-    "lint-staged": "lint-staged"
+    "lint-staged": "lint-staged",
+    "test:unit": "cross-env APPLICATION_KEY=infra-events-api vitest run tests/unit",
+    "test:unit-ui": "yarn test:unit --ui",
+    "test:unit-watch": "cross-env APPLICATION_KEY=infra-events-api vitest tests/unit",
+    "test:live": "cross-env APPLICATION_KEY=infra-events-api vitest run tests/live",
+    "test:live-ui": "yarn test:live --ui"
   },
   "devDependencies": {
     "@tsconfig/node20": "^20.1.4",
     "@types/node": "^22.1.0",
+    "@types/supertest": "^6.0.2",
     "@typescript-eslint/eslint-plugin": "^8.0.1",
     "@typescript-eslint/parser": "^8.0.1",
+    "aws-sdk-client-mock": "^4.0.1",
+    "cross-env": "^7.0.3",
     "esbuild": "^0.23.0",
     "eslint": "^8.57.0",
     "eslint-config-esnext": "^4.1.0",
@@ -34,9 +42,11 @@
     "lint-staged": "^15.2.8",
     "prettier": "^3.3.3",
     "request": "^2.88.2",
+    "supertest": "^7.0.0",
     "synp": "^1.9.13",
     "tsx": "^4.16.5",
-    "typescript": "^5.5.4"
+    "typescript": "^5.5.4",
+    "vitest": "^2.0.5"
   },
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.624.0",

src/errors/index.ts

@@ -28,6 +28,14 @@ export abstract class BaseError<T extends string> extends Error {
   toString() {
     return `Error ${this.id} (${this.name}): ${this.message}\n\n${this.stack}`;
   }
+  toJson() {
+    return {
+      error: true,
+      name: this.name,
+      id: this.id,
+      message: this.message,
+    };
+  }
 }
 
 export class UnauthorizedError extends BaseError<"UnauthorizedError"> {

src/routes/events.ts

@@ -50,6 +50,7 @@ const responseJsonSchema = zodToJsonSchema(
 // GET
 const getResponseBodySchema = z.array(requestBodySchema);
 const getResponseJsonSchema = zodToJsonSchema(getResponseBodySchema);
+export type EventGetResponse = z.infer<typeof getResponseBodySchema>;
 type EventsGetQueryParams = { upcomingOnly?: boolean };
 
 const dynamoClient = new DynamoDBClient({

tests/live/events.test.ts

@@ -0,0 +1,17 @@
+import { expect, test } from "vitest";
+import { InternalServerError } from "../../src/errors/index.js";
+import { EventGetResponse } from "../../src/routes/events.js";
+
+const appKey = process.env.APPLICATION_KEY;
+if (!appKey) {
+  throw new InternalServerError({ message: "No application key found" });
+}
+
+const baseEndpoint = `https://${appKey}.aws.qa.acmuiuc.org`;
+
+test("getting events", async () => {
+  const response = await fetch(`${baseEndpoint}/api/v1/events`);
+  expect(response.status).toBe(200);
+  const responseJson = (await response.json()) as EventGetResponse;
+  expect(responseJson.length).greaterThan(0);
+});

tests/live/healthz.test.ts

@@ -0,0 +1,16 @@
+import { expect, test } from "vitest";
+import { InternalServerError } from "../../src/errors/index.js";
+
+const appKey = process.env.APPLICATION_KEY;
+if (!appKey) {
+  throw new InternalServerError({ message: "No application key found" });
+}
+
+const baseEndpoint = `https://${appKey}.aws.qa.acmuiuc.org`;
+
+test("healthz", async () => {
+  const response = await fetch(`${baseEndpoint}/api/v1/healthz`);
+  expect(response.status).toBe(200);
+  const responseJson = await response.json();
+  expect(responseJson).toEqual({ message: "UP" });
+});

tests/unit/events.test.ts

@@ -0,0 +1,66 @@
+import { afterAll, expect, test, beforeEach, vi } from "vitest";
+import { ScanCommand, DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { mockClient } from "aws-sdk-client-mock";
+import init from "../../src/index.js";
+import { EventGetResponse } from "../../src/routes/events.js";
+import {
+  dynamoTableData,
+  dynamoTableDataUnmarshalled,
+  dynamoTableDataUnmarshalledUpcomingOnly,
+} from "./mockEventData.testdata.js";
+
+const ddbMock = mockClient(DynamoDBClient);
+
+const app = await init();
+test("Test getting events", async () => {
+  ddbMock.on(ScanCommand).resolves({
+    Items: dynamoTableData as any,
+  });
+  const response = await app.inject({
+    method: "GET",
+    url: "/api/v1/events",
+  });
+  expect(response.statusCode).toBe(200);
+  const responseDataJson = (await response.json()) as EventGetResponse;
+  expect(responseDataJson).toEqual(dynamoTableDataUnmarshalled);
+});
+
+test("Test dynamodb error handling", async () => {
+  ddbMock.on(ScanCommand).rejects("Could not get data.");
+  const response = await app.inject({
+    method: "GET",
+    url: "/api/v1/events",
+  });
+  expect(response.statusCode).toBe(500);
+  const responseDataJson = await response.json();
+  expect(responseDataJson).toEqual({
+    error: true,
+    name: "DatabaseFetchError",
+    id: 106,
+    message: "Failed to get events from Dynamo table.",
+  });
+});
+
+test("Test upcoming only", async () => {
+  const date = new Date(2024, 7, 10, 13, 0, 0); // 2024-08-10T17:00:00.000Z, don't ask me why its off a month
+  vi.setSystemTime(date);
+  ddbMock.on(ScanCommand).resolves({
+    Items: dynamoTableData as any,
+  });
+  const response = await app.inject({
+    method: "GET",
+    url: "/api/v1/events?upcomingOnly=true",
+  });
+  expect(response.statusCode).toBe(200);
+  const responseDataJson = (await response.json()) as EventGetResponse;
+  expect(responseDataJson).toEqual(dynamoTableDataUnmarshalledUpcomingOnly);
+});
+
+afterAll(async () => {
+  await app.close();
+  vi.useRealTimers();
+});
+beforeEach(() => {
+  ddbMock.reset();
+  vi.useFakeTimers();
+});

tests/unit/health.test.ts

@@ -0,0 +1,17 @@
+import { afterAll, expect, test } from "vitest";
+import init from "../../src/index.js";
+import { EventGetResponse } from "../../src/routes/events.js";
+
+const app = await init();
+test("Test getting events", async () => {
+  const response = await app.inject({
+    method: "GET",
+    url: "/api/v1/healthz",
+  });
+  expect(response.statusCode).toBe(200);
+  const responseDataJson = (await response.json()) as EventGetResponse;
+  expect(responseDataJson).toEqual({ message: "UP" });
+});
+afterAll(async () => {
+  await app.close();
+});