feat(ci/cd): enhance CI/CD testing and deployment pipelines

Author: hoangsonww

.github/workflows/ci.yml

@@ -1,114 +1,132 @@
 name: CI/CD Pipeline for Budget Management API
+
 on:
   push:
-    branches: [master]
+    branches:
+      - master
   pull_request:
-    branches: [master]
+    branches:
+      - master
 
 jobs:
   formatting:
-    name: "🔧 Formatting & Lint"
+    name: 🔧 Install, Lint & Format
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-        continue-on-error: true
 
-      - name: Setup Node.js
+      - name: Use Node.js 18
         uses: actions/setup-node@v3
         with:
           node-version: 18
-        continue-on-error: true
 
       - name: Install dependencies
         run: npm ci
-        continue-on-error: true
 
-      - name: Prettier format
+      - name: Run Prettier
         run: npm run format
-        continue-on-error: true
-
-      - name: ESLint lint
-        run: npm run lint
-        continue-on-error: true
 
-  backend:
-    name: "✅ Backend Build & Test"
+  test:
+    name: ✅ Run Tests
     runs-on: ubuntu-latest
-    needs: [formatting]
-    if: ${{ always() }}
+    needs: formatting
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-        continue-on-error: true
 
-      - name: Setup Node.js
+      - name: Use Node.js 18
         uses: actions/setup-node@v3
         with:
           node-version: 18
-        continue-on-error: true
-
-      - name: Install backend deps
-        run: npm --workspace backend ci
-        continue-on-error: true
-
-      - name: Backend format
-        run: npm --workspace backend run format
-        continue-on-error: true
-
-      - name: Backend lint
-        run: npm --workspace backend run lint
-        continue-on-error: true
 
-      - name: Build backend
-        run: npm --workspace backend run build
-        continue-on-error: true
+      - name: Install dependencies
+        run: npm ci
 
-      - name: Backend tests
-        run: npm --workspace backend run test
-        continue-on-error: true
+      - name: Run Jest tests
+        run: npm test
 
-  frontend:
-    name: "🌐 Frontend Build & Test"
+  coverage:
+    name: 📊 Generate Coverage
     runs-on: ubuntu-latest
-    needs: [backend]
-    if: ${{ always() }}
+    needs: test
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-        continue-on-error: true
 
-      - name: Setup Node.js
+      - name: Use Node.js 18
         uses: actions/setup-node@v3
         with:
           node-version: 18
-        continue-on-error: true
 
-      - name: Install frontend deps
-        run: npm --workspace frontend ci
-        continue-on-error: true
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run coverage
+        run: npm run coverage
 
-      - name: Frontend format
-        run: npm --workspace frontend run format
-        continue-on-error: true
+      - name: Archive coverage report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage
 
-      - name: Frontend lint
-        run: npm --workspace frontend run lint
-        continue-on-error: true
+  docker:
+    name: 🐳 Build & Push Docker Images
+    runs-on: ubuntu-latest
+    needs:
+      - coverage
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-      - name: Build frontend
-        run: npm --workspace frontend run build
-        continue-on-error: true
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Frontend tests
-        run: npm --workspace frontend run test:unit
-        continue-on-error: true
+      - name: Build & push backend image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository_owner }}/budget-management-backend:${{ github.sha }}
+            ghcr.io/${{ github.repository_owner }}/budget-management-backend:latest
+
+      - name: Build & push frontend image
+        uses: docker/build-push-action@v3
+        with:
+          context: ./frontend
+          file: ./frontend/Dockerfile
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository_owner }}/budget-management-frontend:${{ github.sha }}
+            ghcr.io/${{ github.repository_owner }}/budget-management-frontend:latest
+
+  deploy:
+    name: 🚀 Deploying
+    runs-on: ubuntu-latest
+    needs: docker
+    steps:
+      - name: Simulate deployment to Render
+        run: |
+          echo "✅ Backend deployed to Render"
+      - name: Simulate deployment to Vercel
+        run: |
+          echo "✅ Frontend deployed to Vercel"
 
   complete:
-    name: "🎉 Pipeline Complete"
+    name: 🎉 All Done
     runs-on: ubuntu-latest
-    needs: [formatting, backend, frontend]
-    if: ${{ always() }}
+    needs: deploy
     steps:
       - name: Final status
         run: echo "✅ CI/CD pipeline finished successfully."

README.md

@@ -172,7 +172,7 @@ Budget-Management-Backend-API/
 ├── .prettierrc                    # Prettier configuration for code formatting
 ├── LICENSE                        # License information
 ├── README.md                      # Documentation for the project
-├── app.test.js                    # Main test file for application
+├── __tests__/app.test.js          # Main test file for application
 ├── cli.js                         # CLI tool for interacting with the backend
 ├── docker-compose.yml             # Docker Compose configuration
 ├── Dockerfile                     # Dockerfile for containerizing the application

__tests__/app.test.js

@@ -0,0 +1,104 @@
+jest.mock('mongoose', () => ({
+  connect: jest.fn().mockResolvedValue(),
+}));
+
+jest.mock('../services/redisService', () => ({}));
+
+jest.mock('../apache-kafka/kafkaService', () => ({
+  connectToKafka: jest.fn().mockResolvedValue(),
+}));
+
+jest.mock('../services/rabbitMQService', () => ({
+  connectToRabbitMQ: jest.fn().mockResolvedValue(),
+}));
+
+jest.mock('../services/dataSeeder', () => jest.fn().mockResolvedValue());
+
+jest.mock('../grpcServer', () => jest.fn());
+
+jest.mock('morgan', () => () => (req, res, next) => next());
+
+jest.mock('serve-favicon', () => () => (req, res, next) => next());
+
+jest.mock('../routes', () => {
+  const express = require('express');
+  const router = express.Router();
+  router.get('/ping', (_req, res) => res.json({ pong: true }));
+  return router;
+});
+
+jest.mock('swagger-ui-express', () => ({
+  serve: jest.fn((req, res, next) => next()),
+  setup: jest.fn(() => {
+    return (_req, res) => res.send('<html>SWAGGER UI</html>');
+  }),
+}));
+
+const request = require('supertest');
+const path = require('path');
+const fs = require('fs');
+const app = require('../index');
+
+describe('Express app', () => {
+  beforeAll(() => {
+    // create views/home.html
+    const viewsDir = path.join(__dirname, '../views');
+    fs.mkdirSync(viewsDir, { recursive: true });
+    fs.writeFileSync(path.join(viewsDir, 'home.html'), '<h1>Home Page</h1>');
+
+    // create public/test.txt for static serving
+    const publicDir = path.join(__dirname, '../public');
+    fs.mkdirSync(publicDir, { recursive: true });
+    fs.writeFileSync(path.join(publicDir, 'test.txt'), 'Hello, Static!');
+  });
+
+  afterAll(() => {
+    // clean up views/home.html
+    const htmlPath = path.join(__dirname, '../views/home.html');
+    if (fs.existsSync(htmlPath)) fs.unlinkSync(htmlPath);
+
+    // clean up public/test.txt
+    const txtPath = path.join(__dirname, '../public/test.txt');
+    if (fs.existsSync(txtPath)) fs.unlinkSync(txtPath);
+  });
+
+  it('serves the homepage at GET /', async () => {
+    const res = await request(app).get('/');
+    expect(res.status).toBe(200);
+    expect(res.text).toContain('<h1>Home Page</h1>');
+  });
+
+  it('serves Swagger UI at GET /docs', async () => {
+    const res = await request(app).get('/docs');
+    expect(res.status).toBe(200);
+    expect(res.text).toContain('SWAGGER UI');
+  });
+
+  it('responds on ping route under /api', async () => {
+    const res = await request(app).get('/api/ping');
+    expect(res.status).toBe(200);
+    expect(res.body).toEqual({ pong: true });
+  });
+
+  it('includes CORS headers on API responses', async () => {
+    const res = await request(app).get('/api/ping');
+    expect(res.headers['access-control-allow-origin']).toBe('*');
+  });
+
+  it('serves static files from public/', async () => {
+    const res = await request(app).get('/test.txt');
+    expect(res.status).toBe(200);
+    expect(res.text).toBe('Hello, Static!');
+    expect(res.headers['content-type']).toMatch(/text\/plain/);
+  });
+
+  it('404s on unknown non-API route', async () => {
+    const res = await request(app).get('/does-not-exist');
+    expect(res.status).toBe(404);
+  });
+
+  it('404s on nonexistent /api path', async () => {
+    const res = await request(app).get('/api/does-not-exist');
+    expect(res.status).toBe(404);
+  });
+});