Browser tests

.github/workflows/test.yml

@@ -0,0 +1,251 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - main
+      - staging
+      - frontend-websocket-test
+  pull_request:
+    branches:
+      - main
+      - staging
+  workflow_dispatch:
+
+jobs:
+  question-service-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Set up .env
+        env:
+          QUESTION_FIREBASE_CREDENTIAL_PATH: ${{ vars.QUESTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+          JWT_SECRET: ${{ secrets.JWT_SECRET }}
+          EXECUTION_SERVICE_URL: ${{ vars.EXECUTION_SERVICE_URL }}
+        run: |
+          cd ./apps/question-service
+          echo "FIREBASE_CREDENTIAL_PATH=$QUESTION_FIREBASE_CREDENTIAL_PATH" >> .env
+          echo "JWT_SECRET=$JWT_SECRET" >> .env
+          echo "EXECUTION_SERVICE_URL=$EXECUTION_SERVICE_URL" >> .env
+
+      - name: Set up credentials
+        env:
+          QUESTION_FIREBASE_JSON: ${{ secrets.QUESTION_SERVICE_FIREBASE_CREDENTIAL }}
+          QUESTION_FIREBASE_CREDENTIAL_PATH: ${{ vars.QUESTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+        run: |
+          cd ./apps/question-service
+          echo "$QUESTION_FIREBASE_JSON" > "./$QUESTION_FIREBASE_CREDENTIAL_PATH"
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.23.x"
+
+      - name: Install Go dependencies
+        run: |
+          cd ./apps/question-service
+          go mod tidy
+
+      - name: Install firebase tools
+        run: curl -sL firebase.tools | bash
+
+      - name: Run Go tests with Firebase emulator
+        run: firebase emulators:exec --only firestore 'cd ./apps/question-service; go test -v ./tests'
+
+  frontend-unit-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Setup .env
+        run: |
+          cd ./apps/frontend
+          cp .env.example  .env
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "22"
+
+      - name: Install pnpm
+        run: npm i -g pnpm
+
+      - name: Install dependencies
+        run: |
+          cd ./apps/frontend
+          pnpm i
+
+      - name: Run tests
+        run: |
+          cd ./apps/frontend
+          pnpm unit-test
+
+  test-docker-compose:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Compose
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y docker-compose
+
+      - name: Create Environment Files
+        env:
+          QUESTION_SERVICE_URL: ${{ vars.QUESTION_SERVICE_URL }}
+          USER_SERVICE_URL: ${{ vars.USER_SERVICE_URL }}
+          MATCHING_SERVICE_URL: ${{ vars.MATCHING_SERVICE_URL }}
+          HISTORY_SERVICE_URL: ${{ vars.HISTORY_SERVICE_URL }}
+          SIGNALLING_SERVICE_URL: ${{ vars.SIGNALLING_SERVICE_URL }}
+          EXECUTION_SERVICE_URL: ${{ vars.EXECUTION_SERVICE_URL }}
+          JWT_SECRET: ${{ secrets.JWT_SECRET }}
+          QUESTION_FIREBASE_CREDENTIAL_PATH: ${{ vars.QUESTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+          HISTORY_FIREBASE_CREDENTIAL_PATH: ${{ vars.HISTORY_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+          EXECUTION_FIREBASE_CREDENTIAL_PATH: ${{ vars.EXECUTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+          DB_CLOUD_URI: ${{ secrets.USER_SERVICE_DB_CLOUD_URI }}
+          USER_SERVICE_PORT: ${{ vars.USER_SERVICE_PORT }}
+          MATCHING_SERVICE_PORT: ${{ vars.MATCHING_SERVICE_PORT }}
+          HISTORY_SERVICE_PORT: ${{ vars.HISTORY_SERVICE_PORT }}
+          SIGNALLING_SERVICE_PORT: ${{ vars.SIGNALLING_SERVICE_PORT }}
+          EXECUTION_SERVICE_PORT: ${{ vars.EXECUTION_SERVICE_PORT }}
+          MATCHING_SERVICE_TIMEOUT: ${{ vars.MATCHING_SERVICE_TIMEOUT }}
+          REDIS_URL: ${{ vars.REDIS_URL }}
+          QUESTION_SERVICE_GRPC_URL: ${{ vars.QUESTION_SERVICE_GPRC_URL }}
+        run: |
+          cd ./apps/frontend
+          echo "NEXT_PUBLIC_QUESTION_SERVICE_URL=$QUESTION_SERVICE_URL" >> .env
+          echo "NEXT_PUBLIC_USER_SERVICE_URL=$USER_SERVICE_URL" >> .env
+          echo "NEXT_PUBLIC_MATCHING_SERVICE_URL=$MATCHING_SERVICE_URL" >> .env
+          echo "NEXT_PUBLIC_HISTORY_SERVICE_URL=$HISTORY_SERVICE_URL" >> .env
+          echo "NEXT_PUBLIC_SIGNALLING_SERVICE_URL=$SIGNALLING_SERVICE_URL" >> .env
+          echo "NEXT_PUBLIC_EXECUTION_SERVICE_URL=EXECUTION_SERVICE_URL" >> .env
+
+          cd ../question-service
+          echo "FIREBASE_CREDENTIAL_PATH=$QUESTION_FIREBASE_CREDENTIAL_PATH" >> .env
+          echo "JWT_SECRET=$JWT_SECRET" >> .env
+          echo "EXECUTION_SERVICE_URL=$EXECUTION_SERVICE_URL" >> .env
+
+          cd ../user-service
+          echo "DB_CLOUD_URI=$DB_CLOUD_URI" >> .env
+          echo "PORT=$USER_SERVICE_PORT" >> .env
+          echo "JWT_SECRET=$JWT_SECRET" >> .env
+
+          cd ../matching-service
+          echo "PORT=$MATCHING_SERVICE_PORT" >> .env
+          echo "MATCH_TIMEOUT=$MATCHING_SERVICE_TIMEOUT" >> .env
+          echo "JWT_SECRET=$JWT_SECRET" >> .env
+          echo "REDIS_URL=$REDIS_URL" >> .env
+          echo "QUESTION_SERVICE_GRPC_URL=$QUESTION_SERVICE_GRPC_URL" >> .env
+
+          cd ../history-service
+          echo "FIREBASE_CREDENTIAL_PATH=$HISTORY_FIREBASE_CREDENTIAL_PATH" >> .env
+          echo "PORT=$HISTORY_SERVICE_PORT" >> .env
+
+          cd ../execution-service
+          echo "FIREBASE_CREDENTIAL_PATH=$EXECUTION_FIREBASE_CREDENTIAL_PATH" >> .env
+          echo "PORT=$EXECUTION_SERVICE_PORT" >> .env
+          echo "HISTORY_SERVICE_URL=$HISTORY_SERVICE_URL" >> .env
+
+          cd ../signalling-service
+          echo "PORT=$SIGNALLING_SERVICE_PORT" >> .env
+
+      - name: Create Database Credential Files
+        env:
+          QUESTION_FIREBASE_JSON: ${{ secrets.QUESTION_SERVICE_FIREBASE_CREDENTIAL }}
+          QUESTION_FIREBASE_CREDENTIAL_PATH: ${{ vars.QUESTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+          HISTORY_FIREBASE_JSON: ${{ secrets.HISTORY_SERVICE_FIREBASE_CREDENTIAL }}
+          HISTORY_FIREBASE_CREDENTIAL_PATH: ${{ vars.HISTORY_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+          EXECUTION_FIREBASE_JSON: ${{ secrets.EXECUTION_SERVICE_FIREBASE_CREDENTIAL }}
+          EXECUTION_FIREBASE_CREDENTIAL_PATH: ${{ vars.EXECUTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+        run: |
+          cd ./apps/question-service
+          echo "$QUESTION_FIREBASE_JSON" > "./$QUESTION_FIREBASE_CREDENTIAL_PATH"
+
+          cd ../history-service
+          echo "$HISTORY_FIREBASE_JSON" > "./$HISTORY_FIREBASE_CREDENTIAL_PATH"
+
+          cd ../execution-service
+          echo "$EXECUTION_FIREBASE_JSON" > "./$EXECUTION_FIREBASE_CREDENTIAL_PATH"
+
+      - name: Build and Run Services
+        run: |
+          cd ./apps
+          docker-compose up --build -d
+
+      - name: Wait for services to be ready
+        run: sleep 30
+
+      - name: Install websocat
+        run: |
+          sudo wget -qO /usr/local/bin/websocat https://github.com/vi/websocat/releases/latest/download/websocat.x86_64-unknown-linux-musl
+          sudo chmod a+x /usr/local/bin/websocat
+          websocat --version
+
+      - name: Run Tests
+        env:
+          FRONTEND_URL: ${{ vars.FRONTEND_URL }}
+          USER_SERVICE_URL: ${{ vars.USER_SERVICE_URL }}
+          QUESTION_SERVICE_URL: ${{ vars.QUESTION_SERVICE_URL }}
+          MATCHING_SERVICE_URL: ${{ vars.MATCHING_SERVICE_URL }}
+          HISTORY_SERVICE_URL: ${{ vars.HISTORY_SERVICE_URL }}
+          SIGNALLING_SERVICE_URL: ${{ vars.SIGNALLING_SERVICE_URL }}
+          EXECUTION_SERVICE_URL: ${{ vars.EXECUTION_SERVICE_URL }}
+        run: |
+          echo "Testing Question Service..."
+          curl -sSL -o /dev/null $QUESTION_SERVICE_URL && echo "Question Service is up"
+          echo "Testing User Service..."
+          curl -fsSL -o /dev/null $USER_SERVICE_URL && echo "User Service is up"
+          echo "Testing Frontend..."
+          curl -fsSL -o /dev/null $FRONTEND_URL && echo "Frontend is up"
+          echo "Testing History Service..."
+          curl -fsSL -o /dev/null $HISTORY_SERVICE_URL && echo "History Service is up"
+          echo "Testing Execution Service..."
+          curl -fsSL -o /dev/null $EXECUTION_SERVICE_URL && echo "Execution Service is up"
+          echo "Testing Matching Service..."
+          if ! (echo "Hello" | websocat $MATCHING_SERVICE_URL); then
+            echo "WebSocket for Matching Service is not live"
+          else
+            echo "WebSocket for Matching Service is live"
+          fi
+          # Add in test for matching service in the future
+          echo "Testing Signalling Service..."
+          if ! (echo "Hello" | websocat $SIGNALLING_SERVICE_URL); then
+            echo "WebSocket for Signalling Service is not live"
+          else
+            echo "WebSocket for Signalling Service is live"
+          fi
+          # We can add more tests here
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.1.4
+
+      - name: Install dependencies
+        run: |
+          cd ./apps/frontend
+          pnpm i
+
+      - name: Install Chrome WebDriver
+        uses: nanasess/setup-chromedriver@v2
+        with:
+          chromedriver-version: '130.0.6723.116'
+      - name: Install Edge
+        uses: browser-actions/setup-edge@v1
+        with:
+          edge-version: stable
+
+      - name: Install Geckodriver
+        uses: browser-actions/setup-geckodriver@latest
+
+      - name: Run Browser Test
+        run: |
+          cd ./apps/frontend
+          pnpm browser-test

.gitignore

@@ -0,0 +1,5 @@
+apps/question-service/.next/
+apps/question-service/next-env.d.ts
+apps/question-service/node_modules/
+services/question-service/cs3219-g24-firebase-adminsdk-9cm7h-b1675603ab.json
+

README.md

@@ -1,7 +1,11 @@
+[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/bzPrOe11)
+
 # CS3219 Project (PeerPrep) - AY2425S1
-## Group: Gxx
 
-### Note: 
-- You can choose to develop individual microservices within separate folders within this repository **OR** use individual repositories (all public) for each microservice. 
-- In the latter scenario, you should enable sub-modules on this GitHub classroom repository to manage the development/deployment **AND** add your mentor to the individual repositories as a collaborator. 
-- The teaching team should be given access to the repositories as we may require viewing the history of the repository in case of any disputes or disagreements. 
+## Group: G24
+
+### Note:
+
+- You can choose to develop individual microservices within separate folders within this repository **OR** use individual repositories (all public) for each microservice.
+- In the latter scenario, you should enable sub-modules on this GitHub classroom repository to manage the development/deployment **AND** add your mentor to the individual repositories as a collaborator.
+- The teaching team should be given access to the repositories as we may require viewing the history of the repository in case of any disputes or disagreements.

apps/README.md

@@ -0,0 +1,110 @@
+# PeerPrep Docker Compose Guide
+
+This project uses Docker Compose to manage multiple services such as a frontend, backend, and a database. The configuration is defined in the `docker-compose.yml` file, and environment variables can be stored in environment files for different environments (e.g., development, production).
+
+## Prerequisites
+
+Before you begin, ensure you have the following installed on your machine:
+
+- [Docker](https://www.docker.com/get-started)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+
+## Project Structure
+
+In the `./apps` directory:
+
+```plaintext
+.
+├── docker-compose.yml       # Docker Compose configuration
+├── README.md                # Project documentation (for docker compose)
+├── .env                     # Global environment variables (optional)
+├── frontend
+│   ├── Dockerfile           # Dockerfile for frontend
+│   └── ... (other frontend files)
+├── matching-service
+│   ├── Dockerfile           # Dockerfile for matching-service
+│   └── ... (other matching-service files)
+├── question-service
+│   ├── Dockerfile           # Dockerfile for question-service
+│   └── ... (other question-service files)
+├── user-service
+│   ├── Dockerfile           # Dockerfile for user-service
+│   └── ... (other user-service files)
+
+```
+
+## Docker Compose Setup
+
+By using multiple Dockerfiles in Docker Compose, we can manage complex multi-container applications where each service has its own environment and build process.
+
+1. Build and Start the Application
+
+To build and run both the frontend and backend services, you can change your directory to the `./apps` directory and run:
+
+```bash
+docker-compose up --build
+```
+
+This will:
+
+- Build the Docker images for all services using the specified Dockerfiles
+- Start the containers and map the defined ports
+
+2. Access the Application
+
+Once running, you can access:
+
+- The **frontend** at http://localhost:3000
+- The **user service** at http://localhost:3001
+- The **question service** at http://localhost:8080 (REST) and http://localhost:50051 (gRPC)
+- The **matching service** at http://localhost:8081
+- The **redis service** at http://localhost:6379
+
+3. Stopping Services
+
+To stop the running services, run:
+
+```bash
+docker-compose down
+```
+
+This command will stop and remove the containers, networks, and volumes created by docker-compose up.
+
+## Troubleshooting
+
+### Common Issues
+
+- **Port Conflicts**: If you encounter port conflicts, ensure the host ports specified in docker-compose.yml (e.g., 3000:3000) are not in use by other applications.
+- **Environment Variables Not Loaded**: Ensure the `.env` files are in the correct directories as found in the `docker-compose.yml` file.
+
+### Known Issues
+
+- **Mongo DB Connection Failing**: The user service fails to connect to the Mongo DB server on NUS Wi-Fi. To resolve this we have to use another network.
+
+### Logs
+
+You can view the logs for each service using the following command:
+
+```bash
+docker-compose logs
+```
+
+### Useful Commands
+
+Rebuild a specific service:
+
+```bash
+docker-compose build <service_name>
+```
+
+Start services in detached mode (run in the background):
+
+```bash
+docker-compose up -d
+```
+
+Remove all containers, networks, and volumes created by Docker Compose:
+
+```bash
+docker-compose down --volumes
+```