Merge pull request #6 from hoangsonww/feat/add-ci-cd-tests

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

Author: hoangsonww

.github/workflows/ci.yml

@@ -1,114 +1,181 @@
 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 Jest 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: Install dependencies
+        run: npm ci
 
-      - name: Backend format
-        run: npm --workspace backend run format
-        continue-on-error: true
+      - name: Run Jest tests
+        run: npm test
 
-      - name: Backend lint
-        run: npm --workspace backend run lint
-        continue-on-error: true
+  mocha:
+    name: 🧪 Run Mocha & Chai Tests
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-      - name: Build backend
-        run: npm --workspace backend run build
-        continue-on-error: true
+      - name: Use Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
 
-      - name: Backend tests
-        run: npm --workspace backend run test
-        continue-on-error: true
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Mocha & Chai tests
+        run: npm run test:mocha
 
   frontend:
-    name: "🌐 Frontend Build & Test"
+    name: 🌐 Frontend Test, Build & Artifact
     runs-on: ubuntu-latest
-    needs: [backend]
-    if: ${{ always() }}
+    needs: mocha
     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 frontend dependencies
+        working-directory: frontend
+        run: npm ci
 
-      - name: Frontend format
-        run: npm --workspace frontend run format
-        continue-on-error: true
+      - name: Build Frontend
+        working-directory: frontend
+        run: npm run build
 
-      - name: Frontend lint
-        run: npm --workspace frontend run lint
-        continue-on-error: true
+      - name: Upload Frontend Build Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: frontend-build
+          path: frontend/build
 
-      - name: Build frontend
-        run: npm --workspace frontend run build
-        continue-on-error: true
+  coverage:
+    name: 📊 Generate Coverage
+    runs-on: ubuntu-latest
+    needs:
+      - test
+      - mocha
+      - frontend
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-      - name: Frontend tests
-        run: npm --workspace frontend run test:unit
-        continue-on-error: true
+      - name: Use Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run coverage
+        run: npm run coverage
+
+      - name: Archive coverage report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage
+
+  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: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - 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.mocha.test.cjs

@@ -0,0 +1,129 @@
+// __tests__/app.mocha.test.cjs
+const chai       = require('chai');
+const chaiHttp   = require('chai-http');
+const proxyquire = require('proxyquire').noCallThru();
+const express    = require('express');
+const path       = require('path');
+const fs         = require('fs');
+
+chai.use(chaiHttp);
+const { expect } = chai;
+
+describe('Express app (Mocha & Chai)', function() {
+  let app;
+
+  before(function() {
+    // 1) Prepare static files
+    fs.mkdirSync(path.join(__dirname, '../views'), { recursive: true });
+    fs.writeFileSync(path.join(__dirname, '../views/home.html'), '<h1>Home Page</h1>');
+    fs.mkdirSync(path.join(__dirname, '../public'), { recursive: true });
+    fs.writeFileSync(path.join(__dirname, '../public/test.txt'), 'Hello, Static!');
+
+    // 2) Stub all external modules exactly as index.js requires them
+    const stubs = {
+      mongoose: { connect: () => Promise.resolve() },
+      './services/redisService': {},
+      './apache-kafka/kafkaService': { connectToKafka: () => Promise.resolve() },
+      './services/rabbitMQService': { connectToRabbitMQ: () => Promise.resolve() },
+      './services/dataSeeder': () => Promise.resolve(),
+      './grpcServer': () => {},
+      morgan: () => (req, res, next) => next(),
+      'serve-favicon': () => (req, res, next) => next(),
+      'swagger-ui-express': {
+        serve: (_req, _res, next) => next(),
+        setup: () => (_req, res) => res.send('<html>SWAGGER UI</html>')
+      },
+      './routes': (() => {
+        const router = express.Router();
+        router.get('/ping', (_req, res) => res.json({ pong: true }));
+        return router;
+      })(),
+    };
+
+    // 3) Load index.js via proxyquire and grab the exported app
+    app = proxyquire('../index', stubs);
+  });
+
+  after(function() {
+    // clean up test files
+    const v = path.join(__dirname, '../views/home.html');
+    if (fs.existsSync(v)) fs.unlinkSync(v);
+    const p = path.join(__dirname, '../public/test.txt');
+    if (fs.existsSync(p)) fs.unlinkSync(p);
+  });
+
+  it('serves the homepage at GET /', (done) => {
+    chai.request(app)
+      .get('/')
+      .end((err, res) => {
+        expect(err).to.be.null;
+        expect(res).to.have.status(200);
+        expect(res.text).to.include('<h1>Home Page</h1>');
+        done();
+      });
+  });
+
+  it('serves Swagger UI at GET /docs', (done) => {
+    chai.request(app)
+      .get('/docs')
+      .end((err, res) => {
+        expect(err).to.be.null;
+        expect(res).to.have.status(200);
+        expect(res.text).to.include('SWAGGER UI');
+        done();
+      });
+  });
+
+  it('responds on ping route under /api', (done) => {
+    chai.request(app)
+      .get('/api/ping')
+      .end((err, res) => {
+        expect(err).to.be.null;
+        expect(res).to.have.status(200);
+        expect(res.body).to.deep.equal({ pong: true });
+        done();
+      });
+  });
+
+  it('includes CORS headers on API responses', (done) => {
+    chai.request(app)
+      .get('/api/ping')
+      .end((err, res) => {
+        expect(err).to.be.null;
+        expect(res).to.have.header('access-control-allow-origin', '*');
+        done();
+      });
+  });
+
+  it('serves static files from public/', (done) => {
+    chai.request(app)
+      .get('/test.txt')
+      .end((err, res) => {
+        expect(err).to.be.null;
+        expect(res).to.have.status(200);
+        expect(res.text).to.equal('Hello, Static!');
+        // allow for optional charset parameter
+        expect(res).to.have.header('content-type');
+        expect(res.header['content-type']).to.match(/^text\/plain(?:;.*)?$/);
+        done();
+      });
+  });
+
+  it('404s on unknown non-API route', (done) => {
+    chai.request(app)
+      .get('/does-not-exist')
+      .end((err, res) => {
+        expect(res).to.have.status(404);
+        done();
+      });
+  });
+
+  it('404s on nonexistent /api path', (done) => {
+    chai.request(app)
+      .get('/api/does-not-exist')
+      .end((err, res) => {
+        expect(res).to.have.status(404);
+        done();
+      });
+  });
+});