write tests

Author: HarshCasper

.github/workflows/main.yml

@@ -55,6 +55,9 @@ jobs:
       - name: Deploy the frontend
         run: make frontend
 
+      - name: Run the tests
+        run: make test
+
       - name: Send a Slack notification
         if: failure() || github.event_name != 'pull_request'
         uses: ravsamhq/notify-slack-action@v2

Makefile

@@ -43,6 +43,10 @@ deploy:
 		yarn cdklocal bootstrap;
 		yarn cdklocal deploy;
 
+## Run the tests
+test:
+		yarn test
+
 ## Start LocalStack in detached mode
 start:
 		localstack start -d

package.json

@@ -13,12 +13,20 @@
     "prepare:frontend-local": "node packages/scripts/populate-frontend-config.js --local",
     "build:frontend": "cd packages/frontend && yarn build",
     "start:frontend": "cd packages/frontend && yarn start",
-    "serve:frontend": "cd packages/frontend && yarn build && yarn serve"
+    "serve:frontend": "cd packages/frontend && yarn build && yarn serve",
+    "test": "jest -c tests/jest.config.js",
+    "test:watch": "jest -c tests/jest.config.js --watch"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.11",
+    "@types/node": "^18.11.18",
+    "axios": "^1.6.5",
     "husky": "^4.2.3",
+    "jest": "^29.7.0",
     "lint-staged": "^10.1.2",
-    "prettier": "2.4.1"
+    "prettier": "2.4.1",
+    "ts-jest": "^29.1.1",
+    "typescript": "~4.9.4"
   },
   "husky": {
     "hooks": {

tests/jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  roots: ["<rootDir>"],
+  transform: {
+    "^.+\\.tsx?$": "ts-jest",
+  },
+  testRegex: ".*\\.test\\.tsx?$",
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+  testTimeout: 30000, // 30 seconds timeout for API calls
+};

tests/notes.test.ts

@@ -0,0 +1,94 @@
+import axios from "axios";
+import { readFileSync } from "fs";
+import { join } from "path";
+
+const configFile = join(__dirname, "../packages/frontend/.env");
+const envContent = readFileSync(configFile, "utf-8");
+const envVars = Object.fromEntries(
+  envContent
+    .split("\n")
+    .filter(Boolean)
+    .map((line) => line.trim())
+    .filter((line) => line.includes("="))
+    .map((line) => line.split("="))
+);
+
+const API_URL = `http://localhost:4566/_aws/execute-api/${envVars.VITE_GATEWAY_ID}/prod`;
+console.log("API URL:", API_URL);
+
+describe("Notes API Integration Tests", () => {
+  let noteId: string;
+
+  const testNote = {
+    content: "Test note content",
+  };
+
+  const updatedNote = {
+    content: "Updated note content",
+  };
+
+  const api = axios.create({
+    baseURL: API_URL,
+    headers: {
+      "Content-Type": "application/json",
+      Accept: "application/json",
+    },
+  });
+
+  test("should create a new note", async () => {
+    const response = await api.post("/notes", testNote);
+    expect(response.status).toBe(200);
+    const data = response.data;
+    expect(data).toBeDefined();
+    expect(data.content.S).toBe(testNote.content);
+    noteId = data.noteId.S;
+  });
+
+  test("should list all notes", async () => {
+    const response = await api.get("/notes");
+    expect(response.status).toBe(200);
+    const data = response.data;
+    expect(Array.isArray(data)).toBeTruthy();
+    expect(data.length).toBeGreaterThan(0);
+    const createdNote = data.find((note: any) => note.noteId === noteId);
+    expect(createdNote).toBeDefined();
+    expect(createdNote.content).toBe(testNote.content);
+  });
+
+  test("should get a specific note", async () => {
+    const response = await api.get(`/notes/${noteId}`);
+    expect(response.status).toBe(200);
+    const data = response.data;
+    expect(data).toBeDefined();
+    expect(data.noteId).toBe(noteId);
+    expect(data.content).toBe(testNote.content);
+  });
+
+  test("should update a note", async () => {
+    const response = await api.put(`/notes/${noteId}`, updatedNote);
+    expect(response.status).toBe(200);
+    const data = response.data;
+    expect(data).toBeDefined();
+    expect(data.status).toBe(true);
+
+    // Verify the update
+    const getResponse = await api.get(`/notes/${noteId}`);
+    expect(getResponse.status).toBe(200);
+    expect(getResponse.data.content).toBe(updatedNote.content);
+  });
+
+  test("should delete a note", async () => {
+    const response = await api.delete(`/notes/${noteId}`);
+    expect(response.status).toBe(200);
+    expect(response.data.status).toBe(true);
+
+    // Verify the note is deleted
+    const getResponse = await api.get(`/notes`);
+
+    // Check if the note is not in the list
+    const data = getResponse.data;
+    expect(Array.isArray(data)).toBeTruthy();
+    const deletedNote = data.find((note: any) => note.noteId === noteId);
+    expect(deletedNote).toBeUndefined();
+  });
+});

tests/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "commonjs",
+    "lib": ["es2018"],
+    "strict": true,
+    "noImplicitAny": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "types": ["jest", "node"]
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["node_modules"]
+}