Replace mocha and chai with jest

Author: DavideViolante

README.md

@@ -64,7 +64,7 @@ A window will automatically open at [localhost:4200](http://localhost:4200). Ang
 ## Running tests
 Run `ng test` to execute the frontend unit tests via [Karma](https://karma-runner.github.io).
 
-Run `npm run testbe` to execute the backend tests via [Mocha](https://mochajs.org/) (it requires `mongod` already running).
+Run `npm run testbe` to execute the backend tests via [Jest](https://jestjs.io/) (it requires mongod already running).
 
 ## Running linters
 Run `npm run lint` to execute [Angular ESLint](https://github.com/angular-eslint/angular-eslint), [HTML linting](https://github.com/htmlhint/HTMLHint) and [SASS linting](https://github.com/sasstools/sass-lint).

jest.config.js

@@ -0,0 +1,6 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testRegex: '(/server/test/.*spec.ts)$'
+};

package-lock.json

@@ -17,7 +17,8 @@
     "dev": "concurrently \"mongod\" \"ng serve --open\" \"tsc -w -p server\" \"nodemon dist/server/app.js\"",
     "prod": "concurrently \"mongod\" \"ng build && tsc -p server && node dist/server/app.js\"",
     "test": "ng test",
-    "testbe": "tsc -p server && mocha dist/server/test --exit",
+    "testbe": "tsc -p server && jest",
+    "testbecov": "tsc -p server && jest --coverage",
     "lint": "ng lint && htmlhint \"client/**/*.html\" && sass-lint \"client/**/*.scss\" -v",
     "lintfix": "ng lint -- --fix"
   },
@@ -38,7 +39,7 @@
     "express": "^4.18.2",
     "font-awesome": "^4.7.0",
     "jsonwebtoken": "^9.0.0",
-    "mongoose": "^6.8.4",
+    "mongoose": "^6.10.3",
     "morgan": "^1.10.0",
     "rxjs": "~7.8.0",
     "tslib": "^2.3.0",
@@ -55,32 +56,32 @@
     "@angular/compiler-cli": "^15.2.2",
     "@angular/language-service": "^15.2.2",
     "@types/bcryptjs": "^2.4.2",
-    "@types/chai-http": "^4.2.0",
     "@types/express": "^4.17.16",
     "@types/jasmine": "~4.3.0",
+    "@types/jest": "^29.5.0",
     "@types/jsonwebtoken": "^9.0.1",
-    "@types/mocha": "^10.0.1",
     "@types/morgan": "^1.9.4",
     "@types/node": "^18.11.18",
+    "@types/supertest": "^2.0.12",
     "@typescript-eslint/eslint-plugin": "^5.43.0",
     "@typescript-eslint/parser": "^5.43.0",
-    "chai": "^4.3.7",
-    "chai-http": "^4.3.0",
     "concurrently": "^7.6.0",
     "eslint": "^8.35.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsdoc": "^40.0.1",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "htmlhint": "^1.1.4",
     "jasmine-core": "~4.5.0",
+    "jest": "^29.5.0",
     "karma": "~6.4.0",
     "karma-chrome-launcher": "~3.1.0",
     "karma-coverage": "~2.2.0",
     "karma-jasmine": "~5.1.0",
     "karma-jasmine-html-reporter": "^2.0.0",
-    "mocha": "^10.2.0",
     "nodemon": "^2.0.20",
     "sass-lint": "^1.13.1",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.0.5",
     "ts-node": "~8.3.0",
     "typescript": "~4.9.4"
   }

package.json

@@ -4,7 +4,7 @@ import * as express from 'express';
 import * as morgan from 'morgan';
 import * as path from 'path';
 
-import setMongo from './mongo';
+import { connectToMongo } from './mongo';
 import setRoutes from './routes';
 
 const app = express();
@@ -16,10 +16,11 @@ if (process.env.NODE_ENV !== 'test') {
   app.use(morgan('dev'));
 }
 
+setRoutes(app);
+
 const main = async (): Promise<any> => {
   try {
-    await setMongo();
-    setRoutes(app);
+    await connectToMongo();
     app.get('/*', (req, res) => {
       res.sendFile(path.join(__dirname, '../public/index.html'));
     });
@@ -29,6 +30,8 @@ const main = async (): Promise<any> => {
   }
 };
 
-main();
+if (process.env.NODE_ENV !== 'test') {
+  main();
+}
 
 export { app };

server/app.ts

@@ -63,6 +63,16 @@ abstract class BaseCtrl {
       return res.status(400).json({ error: err.message });
     }
   };
+
+  // Drop collection (for tests)
+  deleteAll = async (_req: Request, res: Response) => {
+    try {
+      await this.model.deleteMany();
+      return res.sendStatus(200);
+    } catch (err: any) {
+      return res.status(400).json({ error: err.message });
+    }
+  };
 }
 
 export default BaseCtrl;

server/controllers/base.ts

@@ -1,14 +1,18 @@
 import * as mongoose from 'mongoose';
 
-const setMongo = async (): Promise<any> => {
+const connectToMongo = async (): Promise<void> => {
   let mongodbURI: string;
   if (process.env.NODE_ENV === 'test') {
     mongodbURI = process.env.MONGODB_TEST_URI as string;
   } else {
     mongodbURI = process.env.MONGODB_URI as string;
   }
   await mongoose.connect(mongodbURI);
-  console.log('Connected to MongoDB');
+  console.log(`Connected to MongoDB (db: ${mongodbURI.split('/').pop()})`);
 };
 
-export default setMongo;
+const disconnectMongo = async (): Promise<void> => {
+  await mongoose.connection.close();
+};
+
+export { connectToMongo, disconnectMongo };

server/mongo.ts

@@ -25,6 +25,12 @@ const setRoutes = (app: Application): void => {
   router.route('/user/:id').put(userCtrl.update);
   router.route('/user/:id').delete(userCtrl.delete);
 
+  // Test routes
+  if (process.env.NODE_ENV === 'test') {
+    router.route('/cats/delete').delete(catCtrl.deleteAll);
+    router.route('/users/delete').delete(userCtrl.deleteAll);
+  }
+
   // Apply the routes to our application with the prefix /api
   app.use('/api', router);
 

server/routes.ts

@@ -1,103 +1,50 @@
-import * as chai from 'chai';
-import chaiHttp = require('chai-http');
-import { describe, it } from 'mocha';
 
+import * as request from 'supertest';
+import { describe, expect, test } from '@jest/globals';
 process.env.NODE_ENV = 'test';
 import { app } from '../app';
-import Cat from '../models/cat';
+import { connectToMongo, disconnectMongo } from '../mongo';
 
-chai.use(chaiHttp).should();
+const newCat = { name: 'Fluffy', weight: 4, age: 2 };
+let catId = '';
 
-describe('Cats', () => {
-
-  beforeEach(done => {
-    Cat.deleteMany({}, err => {
-      done();
-    });
-  });
-
-  describe('Backend tests for cats', () => {
-
-    it('should get all the cats', done => {
-      chai.request(app)
-        .get('/api/cats')
-        .end((err, res) => {
-          res.should.have.status(200);
-          res.body.should.be.a('array');
-          res.body.length.should.be.eql(0);
-          done();
-        });
-    });
-
-    it('should get cats count', done => {
-      chai.request(app)
-        .get('/api/cats/count')
-        .end((err, res) => {
-          res.should.have.status(200);
-          res.body.should.be.a('number');
-          res.body.should.be.eql(0);
-          done();
-        });
-    });
-
-    it('should create new cat', done => {
-      const cat = new Cat({ name: 'Fluffy', weight: 4, age: 2 });
-      chai.request(app)
-        .post('/api/cat')
-        .send(cat)
-        .end((err, res) => {
-          res.should.have.status(201);
-          res.body.should.be.a('object');
-          res.body.should.have.a.property('name');
-          res.body.should.have.a.property('weight');
-          res.body.should.have.a.property('age');
-          done();
-        });
-    });
-
-    it('should get a cat by its id', done => {
-      const cat = new Cat({ name: 'Cat', weight: 2, age: 4 });
-      cat.save((error, newCat) => {
-        chai.request(app)
-          .get(`/api/cat/${newCat.id}`)
-          .end((err, res) => {
-            res.should.have.status(200);
-            res.body.should.be.a('object');
-            res.body.should.have.property('name');
-            res.body.should.have.property('weight');
-            res.body.should.have.property('age');
-            res.body.should.have.property('_id').eql(newCat.id);
-            done();
-          });
-      });
-    });
+beforeAll(async () => {
+  await connectToMongo();
+});
 
-    it('should update a cat by its id', done => {
-      const cat = new Cat({ name: 'Cat', weight: 2, age: 4 });
-      cat.save((error, newCat) => {
-        chai.request(app)
-          .put(`/api/cat/${newCat.id}`)
-          .send({ weight: 5 })
-          .end((err, res) => {
-            res.should.have.status(200);
-            done();
-          });
-      });
-    });
+afterAll(async () => {
+  await request(app).delete('/api/cats/delete');
+  await disconnectMongo();
+});
 
-    it('should delete a cat by its id', done => {
-      const cat = new Cat({ name: 'Cat', weight: 2, age: 4 });
-      cat.save((error, newCat) => {
-        chai.request(app)
-          .del(`/api/cat/${newCat.id}`)
-          .end((err, res) => {
-            res.should.have.status(200);
-            done();
-          });
-      });
-    });
+describe('Cat tests', () => {
+  test('should get all cats', async () => {
+    const res = await request(app).get('/api/cats');
+    expect(res.statusCode).toBe(200);
+    expect(res.body).toStrictEqual([]);
+  });
+  test('should count all cats', async () => {
+    const res = await request(app).get('/api/cats/count');
+    expect(res.statusCode).toBe(200);
+    expect(res.body).toStrictEqual(0);
+  });
+  test('should create a new cat', async () => {
+    const res = await request(app).post('/api/cat').send(newCat);
+    expect(res.statusCode).toBe(201);
+    expect(res.body).toMatchObject(newCat);
+    catId = res.body._id;
+  });
+  test('should get a cat by id', async () => {
+    const res = await request(app).get(`/api/cat/${catId}`);
+    expect(res.statusCode).toBe(200);
+    expect(res.body).toMatchObject(newCat);
+  });
+  test('should update a cat by id', async () => {
+    const res = await request(app).put(`/api/cat/${catId}`).send({ weight: 5 });
+    expect(res.statusCode).toBe(200);
+  });
+  test('should delete a cat by id', async () => {
+    const res = await request(app).delete(`/api/cat/${catId}`);
+    expect(res.statusCode).toBe(200);
   });
-
 });
-
-