Merge pull request #35 from CS3219-AY2425S1/titus/add-cicd-docker-compose

chore: add cicd docker compose

Author: bensohh

.github/workflows/test.yml

@@ -0,0 +1,74 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - main
+      - staging
+  pull_request:
+    branches:
+      - main
+      - staging
+
+jobs:
+  test:
+    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 }}
+          JWT_SECRET: ${{ secrets.JWT_SECRET }}
+          FIREBASE_CREDENTIAL_PATH: ${{ vars.QUESTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+          DB_CLOUD_URI: ${{ secrets.USER_SERVICE_DB_CLOUD_URI }}
+          USER_SERVICE_PORT: ${{ vars.USER_SERVICE_PORT }}
+        run: |
+          cd ./apps/frontend
+          echo "NEXT_PUBLIC_QUESTION_SERVICE_URL=$QUESTION_SERVICE_URL" >> .env
+          echo "NEXT_PUBLIC_USER_SERVICE_URL=$USER_SERVICE_URL" >> .env
+
+          cd ../question-service
+          echo "FIREBASE_CREDENTIAL_PATH=$FIREBASE_CREDENTIAL_PATH" >> .env
+          echo "JWT_SECRET=$JWT_SECRET" >> .env
+
+          cd ../user-service
+          echo "DB_CLOUD_URI=$DB_CLOUD_URI" >> .env
+          echo "PORT=$USER_SERVICE_PORT" >> .env
+          echo "JWT_SECRET=$JWT_SECRET" >> .env
+
+      - name: Create Database Credential Files
+        env:
+          FIREBASE_JSON: ${{ secrets.QUESTION_SERVICE_FIREBASE_CREDENTIAL }}
+          FIREBASE_CREDENTIAL_PATH: ${{ vars.QUESTION_SERVICE_FIREBASE_CREDENTIAL_PATH }}
+        run: |
+          cd ./apps/question-service
+          echo "$FIREBASE_JSON" > "./$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: Run Tests
+        env:
+          FRONTEND_URL: ${{ vars.FRONTEND_URL }}
+          USER_SERVICE_URL: ${{ vars.USER_SERVICE_URL }}
+          QUESTION_SERVICE_URL: ${{ vars.QUESTION_SERVICE_URL }}
+        run: |
+          curl -sSL -o /dev/null $QUESTION_SERVICE_URL
+          curl -fsSL -o /dev/null $USER_SERVICE_URL
+          curl -fsSL -o /dev/null $FRONTEND_URL
+
+          # We can add more tests here

apps/frontend/.env.example

@@ -1,3 +1,3 @@
-# Replace with the corresponding url, credentials and endpoint
+# URL endpoints of the services
 NEXT_PUBLIC_QUESTION_SERVICE_URL="http://localhost:8080/"
 NEXT_PUBLIC_USER_SERVICE_URL="http://localhost:3001/"

apps/question-service/.env.example

@@ -1,3 +1,4 @@
+# Path to the firebase credential json
 FIREBASE_CREDENTIAL_PATH=cs3219-g24-firebase-adminsdk-9cm7h-b1675603ab.json
 
 # Secret for creating JWT signature

apps/user-service/.env.sample

@@ -1,9 +1,8 @@
+# Mongo DB connection URL
 DB_CLOUD_URI=<CONNECTION_STRING>
-DB_LOCAL_URI=mongodb://127.0.0.1:27017/peerprepUserServiceDB
-PORT=3001
 
-# Will use cloud MongoDB Atlas database
-ENV=PROD
+# Port for the user-service
+PORT=3001
 
 # Secret for creating JWT signature
 JWT_SECRET=you-can-replace-this-with-your-own-secret

apps/user-service/model/repository.js

@@ -3,12 +3,9 @@ import "dotenv/config";
 import { connect } from "mongoose";
 
 export async function connectToDB() {
-  let mongoDBUri =
-    process.env.ENV === "PROD"
-      ? process.env.DB_CLOUD_URI
-      : process.env.DB_LOCAL_URI;
+  let mongoDBUri = process.env.DB_CLOUD_URI;
 
-  await connect(mongoDBUri);
+  await connect(mongoDBUri)
 }
 
 export async function createUser(username, email, password) {

apps/user-service/package-lock.json

@@ -21,6 +21,6 @@
     "dotenv": "^16.4.5",
     "express": "^4.21.0",
     "jsonwebtoken": "^9.0.2",
-    "mongoose": "^8.5.4"
+    "mongoose": "^8.7.0"
   }
 }