Merge pull request #82 from CS3219-AY2425S1/staging

feat: D5 to D7

.github/workflows/test.yml

@@ -10,9 +10,82 @@ on:
     branches:
       - main
       - staging
+  workflow_dispatch:
 
 jobs:
-  test:
+  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:
@@ -29,22 +102,36 @@ jobs:
           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 }}
-          FIREBASE_CREDENTIAL_PATH: ${{ vars.QUESTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+          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 }}
+          RABBITMQ_URL: ${{ vars.RABBITMQ_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=$FIREBASE_CREDENTIAL_PATH" >> .env
+          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
@@ -56,14 +143,39 @@ jobs:
           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
+          echo "RABBMITMQ_URL=$RABBITMQ_URL" >> .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
+          echo "RABBMITMQ_URL=$RABBITMQ_URL" >> .env
+
+          cd ../signalling-service
+          echo "PORT=$SIGNALLING_SERVICE_PORT" >> .env
 
       - name: Create Database Credential Files
         env:
-          FIREBASE_JSON: ${{ secrets.QUESTION_SERVICE_FIREBASE_CREDENTIAL }}
-          FIREBASE_CREDENTIAL_PATH: ${{ vars.QUESTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+          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 "$FIREBASE_JSON" > "./$FIREBASE_CREDENTIAL_PATH"
+          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: |
@@ -85,19 +197,59 @@ jobs:
           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: |
+          docker ps -a
           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

README.md

@@ -9,3 +9,38 @@
 - 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.
+
+---
+
+## Architecture Diagram
+
+![Overall Architecture Diagram](./docs/architecture_diagram.png)
+
+The overall architecture of PeerPrep follows a microservices architecture. The client acts as an orchestrator for the interaction between the different services.
+
+## Screenshots
+
+![Home Page](./docs/home_page.png)
+
+![Collaboration Page](./docs/collab_page_1.png)
+
+![Collaboration Page](./docs/collab_page_2.png)
+
+![Question Page](./docs/question_page.png)
+
+![Question Page](./docs/indiv_question_page.png)
+
+![History Page](./docs/submission_history_page.png)
+
+## More details
+
+- [Frontend](./apps/frontend/README.md)
+- [User Service](./apps/user-service/README.md)
+- [Question Service](./apps/question-service/README.md)
+- [Matching Service](./apps/matching-service/README.md)
+- [Signalling Service](./apps/signalling-service/README.md)
+- [History Service](./apps/history-service/README.md)
+- [Execution Service](./apps/execution-service/README.md)
+- [CI/CD Guide](./docs/cicid.md)
+- [Docker Compose Guide](./apps/README.md)
+- [Set Up Guide](./docs/setup.md)

apps/README.md

@@ -2,6 +2,8 @@
 
 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).
 
+More details on how to set up Docker Compose can be found [here](../docs/setup.md)
+
 ## Prerequisites
 
 Before you begin, ensure you have the following installed on your machine:
@@ -30,11 +32,25 @@ In the `./apps` directory:
 ├── user-service
 │   ├── Dockerfile           # Dockerfile for user-service
 │   └── ... (other user-service files)
-
+├── execution-service
+│   ├── Dockerfile           # Dockerfile for execution-service
+│   └── ... (other execution-service files)
+├── signalling-service
+│   ├── Dockerfile           # Dockerfile for signalling-service
+│   └── ... (other signalling-service files)
+├── history-service
+│   ├── Dockerfile           # Dockerfile for history-service
+│   └── ... (other history-service files)
 ```
 
 ## Docker Compose Setup
 
+Ensure that you are currently using **Docker Compose v2** in your local Docker Desktop.
+- Launch your local Docker Desktop application
+- Click on settings button at the top right hand corner (beside the name)
+- Under the General tab, scroll down until you see a checkbox that says Use Docker Compose V2, ensure that the box is checked then apply and restart (refer to the image below)
+![Docker Compose V2](https://github.com/user-attachments/assets/3b8d47c2-c488-4fc1-804d-418ffebbdd9c)
+
 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
@@ -54,11 +70,15 @@ This will:
 
 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
-- The **matching service** at http://localhost:8081
-- The **redis service** at http://localhost:6379
+- The [**frontend**](./frontend/README.md) at http://localhost:3000
+- The [**user-service**](./user-service/README.md) at http://localhost:3001
+- The [**question-service**](./question-service/README.md) at http://localhost:8080 (REST) and http://localhost:50051 (gRPC)
+- The [**matching-service**](./matching-service/README.md) at http://localhost:8081
+- The [**history-service**](./history-service/README.md) at http://localhost:8082
+- The [**execution-service**](./execution-service/README.md) at http://localhost:8083
+- The [**signalling-service**](./signalling-service/README.md) at http://localhost:4444
+- The **redis** at http://localhost:6379
+- The **rabbitmq** at http://localhost:5672
 
 3. Stopping Services
 
@@ -76,6 +96,11 @@ This command will stop and remove the containers, networks, and volumes created
 
 - **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.
+- **Command execution failed**: When you try running test cases or submitting the code in the collaborative environment, if you encounter the following error message:
+    ```bash
+  Command execution failed: Unable to find image 'apps-python-sandbox:latest' locally docker: Error response from daemon: pull access denied for apps-python-sandbox, repository does not exist or may require 'docker login': denied: requested access to the resource is denied. See 'docker run --help'. : exit status 125
+    ```
+  Ensure that you have **Docker Compose V2** enabled for your Docker Desktop application. Please refer to the Docker Compose setup guide above to enable it locally.
 
 ### Known Issues