Added integration tests

Author: muhammedkamel

.env.testing

@@ -0,0 +1,14 @@
+APP_ENV=testing
+APP_DEBUG=true
+PORT=8000
+
+# REDIS
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_USERNAME=default
+REDIS_PASSWORD=password
+
+# RATE LIMITER
+RATE_LIMITER_ENABLED=true
+RATE_LIMITER_MAX_REQUESTS=5
+RATE_LIMITER_TIME_WINDOW=60000

jest.config.js

@@ -0,0 +1,16 @@
+require('dotenv').config({ path: '.env.testing' });
+
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    testMatch: ['**/*.test.ts'],
+    moduleNameMapper: {
+        '^@/(.*)$': '<rootDir>/src/$1',
+    },
+    globals: {
+        __DEV__: true,
+    },
+    transform: {
+        '^.+\\.tsx?$': 'ts-jest',
+    },
+};

package-lock.json

@@ -2,18 +2,23 @@
   "dependencies": {
     "dotenv": "^16.0.3",
     "express": "^4.18.2",
-    "redis": "^4.6.5"
+    "redis": "^4.6.5",
+    "supertest": "^6.3.3"
   },
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/fs-extra": "^9.0.13",
+    "@types/jest": "^29.5.1",
     "@types/node": "^16.18.23",
     "@types/shelljs": "^0.8.11",
+    "@types/supertest": "^2.0.12",
     "fs-extra": "^10.1.0",
+    "jest": "^29.5.0",
     "nodemon": "^2.0.22",
     "npm-run-all": "^4.1.5",
     "rimraf": "^3.0.2",
     "shelljs": "^0.8.5",
+    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "tslint": "^6.1.3",
     "typescript": "^4.9.5"
@@ -27,6 +32,6 @@
     "dev:start": "npm-run-all build start",
     "dev": "nodemon --watch src -e ts --exec npm run dev:start",
     "start": "node .",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest --detectOpenHandles"
   }
 }

package.json

@@ -12,9 +12,6 @@ export const rateLimiter = async (req: Request, res: Response, next: NextFunctio
 
     const current = await getCurrentWindow(key, Number(process.env.RATE_LIMITER_TIME_WINDOW));
 
-    // tslint:disable-next-line:no-console
-    console.log(current);
-
     if (current + 1 > Number(process.env.RATE_LIMITER_MAX_REQUESTS)) {
         return res.status(429).json({
             message: 'too many requests'

src/middlewares/rate-limiter.ts

@@ -0,0 +1,12 @@
+import express from 'express';
+import { rateLimiter } from './middlewares/rate-limiter';
+
+const app = express();
+
+if (process.env.RATE_LIMITER_ENABLED === 'true') {
+    app.use(rateLimiter.bind(this));
+}
+
+app.get('/', (req, res) => res.json({ message: 'Hello World!' }));
+
+export { app };

src/router.ts

@@ -1,16 +1,6 @@
 import * as dotenv from "dotenv";
 dotenv.config();
-import express from "express";
-import { client } from "./utils/redis";
-import { rateLimiter } from "./middlewares/rate-limiter";
-
-const app = express();
-
-if (process.env.RATE_LIMITER_ENABLED === 'true') {
-    app.use(rateLimiter.bind(this));
-}
-
-app.get('/', (req, res) => res.send(client.get('test')));
+import { app } from "./router";
 
 // tslint:disable-next-line:no-console
-app.listen(process.env.PORT, () => console.log(`Application started listening http://localhost:${process.env.PORT}`));
+app.listen(process.env.PORT, () => console.log(`Application started listening http://localhost:${process.env.PORT}`));

src/server.ts

@@ -0,0 +1,39 @@
+import request from "supertest";
+import { client } from "../../src/utils/redis";
+import { app } from "../../src/router";
+
+let req: request.SuperTest<request.Test>;
+
+describe('rate-limiter middleware', () => {
+    beforeEach(async () => {
+        await client.flushAll();
+
+        req = request(app);
+    });
+
+    it('should return 429 if the rate limit is reached', async () => {
+        let now = Date.now();
+        await client.zAdd('rate-limiter:172.20.0.1', [
+            { score: now, value: now.toString() },
+            { score: ++now, value: now.toString() },
+            { score: ++now, value: now.toString() },
+            { score: ++now, value: now.toString() },
+            { score: ++now, value: now.toString() },
+        ]);
+
+        const res = await req.get('/').set('x-forwarded-for', '172.20.0.1');
+        
+        expect(res.status).toEqual(429);
+    });
+
+    it('should return 200 if the rate limit is not reached', async () => {
+        const res = await req.get('/');
+
+        expect(res.status).toEqual(200);
+    });
+    
+    afterAll(async () => {
+        await client.flushAll();
+        await client.disconnect();
+    });
+});

test/middlewares/rate-limiter.test.ts

@@ -12,7 +12,7 @@
             "*": [
                 "node_modules/*"
             ]
-        }
+        },
     },
     "include": [
         "src/**/*"