Merge pull request #24 from aymenn/controllers-tests-session

Controllers tests: session controller

Author: kuschanton

index.ts

@@ -1,36 +1,11 @@
-import cors from "cors";
-import express from "express";
-import createError from "http-errors";
-import logger from "morgan";
-import router from "./src/routes";
-import bodyParser from 'body-parser';
+import {app} from './src/app/app'
 
-const PORT = process.env.PORT || 3000;
-
-const app = express();
-
-/****************************************************
- Apply Middleware
-****************************************************/
-if (app.get("env") === "development") {
-  app.use(cors({ origin: "*" }));
-  app.use(logger("dev"));
-}
-
-app.use(bodyParser.json())
-app.use(express.json());
-app.use(express.urlencoded({ extended: true }));
-
-app.use(router);
-
-/****************************************************
- Apply Routes
-****************************************************/
-app.use((req, res, next) => next(createError(404))); // throw 404 if route not found
+const PORT = process.env.PORT || 3000
 
 /****************************************************
  Start Server
-****************************************************/
+ ****************************************************/
+
 app.listen(PORT, () => {
-  console.log(`Server running on port:${PORT}`);
-});
+  console.log(`Server running on port:${PORT}`)
+})

jest.config.js

@@ -1,5 +1,6 @@
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   preset: 'ts-jest',
-  testEnvironment: 'node'
+  testEnvironment: 'node',
+  setupFiles: ['<rootDir>/tests/.jest/setEnvVars.js']
 };

package.json

@@ -7,6 +7,7 @@
     "express": "^4.18.1",
     "express-basic-auth": "^1.2.1",
     "http-errors": "^2.0.0",
+    "moq.ts": "^9.0.2",
     "morgan": "^1.10.0",
     "twilio": "^3.78.0"
   },
@@ -18,9 +19,11 @@
     "@types/jest": "^28.1.5",
     "@types/morgan": "^1.9.3",
     "@types/node": "^18.0.1",
+    "@types/supertest": "^2.0.12",
     "jest": "^28.1.3",
     "node-fetch": "2",
     "nodemon": "^2.0.19",
+    "supertest": "^6.2.4",
     "ts-jest": "^28.0.6",
     "ts-node": "^10.8.2",
     "typescript": "^4.7.4"

src/app/app.ts

@@ -0,0 +1,28 @@
+import cors from 'cors'
+import express from 'express'
+import createError from 'http-errors'
+import logger from 'morgan'
+import bodyParser from 'body-parser'
+import router from '../routes'
+
+
+export const app = express()
+
+/****************************************************
+ Apply Middleware
+ ****************************************************/
+if (app.get('env') === 'development') {
+  app.use(cors({origin: '*'}))
+  app.use(logger('dev'))
+}
+
+app.use(bodyParser.json())
+app.use(express.json())
+app.use(express.urlencoded({extended: true}))
+
+app.use(router)
+
+/****************************************************
+ Apply Routes
+ ****************************************************/
+app.use((req, res, next) => next(createError(404))) // throw 404 if route not found

src/controllers/session.ts

@@ -22,7 +22,7 @@ export const post = async (
     try {
       await addParticipantsToConversation(conversation.sid, proxyAddresses)
       res.setHeader('content-type', 'application/json');
-      return res.status(200).send(`${JSON.stringify(conversation)}`);
+      return res.status(200).send({'conversationSid': conversation.sid});
     } catch(err) {
       await deleteConversation(conversation.sid);
       return res.status(500).send(`${conversation.sid} failed to create session: ${err}`)

tests/.jest/setEnvVars.js

@@ -0,0 +1,6 @@
+process.env.NUMBER_POOL = '["+3334445555", "+4445556666", "+5556667777", "+6667778888"]'
+process.env.TWILIO_ACCOUNT_SID = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+process.env.TWILIO_AUTH_TOKEN = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+process.env.AUTH_USERNAME = 'testUser'
+process.env.AUTH_PASSWORD = 'testPassword'
+process.env.AUTH_HEADER = 'Basic dGVzdFVzZXI6dGVzdFBhc3N3b3Jk'

tests/controllers/session.test.ts

@@ -0,0 +1,95 @@
+import request from 'supertest'
+import * as SessionService from '../../src/services/session.service'
+import {addParticipantsToConversation, matchAvailableProxyAddresses} from '../../src/services/session.service'
+import * as CreateConversation from '../../src/utils/createConversation.util'
+import * as DeleteConversation from '../../src/utils/deleteConversation.util'
+import {ConversationInstance} from 'twilio/lib/rest/conversations/v1/conversation'
+import {Mock} from 'moq.ts'
+import {app} from '../../src/app/app'
+
+describe('sessions controller', () => {
+
+  jest.setTimeout(3600000)
+
+
+  // Test parameters
+  const requestedPhoneNumbers = ['+1001', '+1002']
+  const activeProxyAddresses = {
+    '+1001': ['+2001', '+2002'],
+    '+1002': [],
+  }
+  const availableProxyAddresses = {
+    '+1001': ['+2003', '+2004'],
+    '+1002': ['+2001', '+2002', '+2003', '+2004'],
+  }
+  const conversationsSid = 'CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+
+  // Mocks
+  const getActiveProxyAddressesSpy = jest
+    .spyOn(SessionService, 'getActiveProxyAddresses')
+    .mockResolvedValue(activeProxyAddresses)
+
+  const matchAvailableProxyAddressesSpy = jest
+    .spyOn(SessionService, 'matchAvailableProxyAddresses')
+    .mockResolvedValue(availableProxyAddresses)
+
+  // Apparently with jest following is not possible, at least I couldn't find anything like this
+  const mockedConversationInstance = new Mock<ConversationInstance>()
+    .setup(instance => instance.sid)
+    .returns(conversationsSid)
+    .object()
+
+  const createConversationSpy = jest
+    .spyOn(CreateConversation, 'createConversation')
+    .mockResolvedValue(mockedConversationInstance)
+
+  createConversationSpy.mockResolvedValue(mockedConversationInstance)
+
+  // Tests
+  it('should create a session', async () => {
+
+    const addParticipantsToConversationSpy = jest
+      .spyOn(SessionService, 'addParticipantsToConversation')
+      .mockResolvedValue([])
+
+    const res = await request(app)
+      .post('/sessions')
+      .set('Content-Type', 'application/json')
+      .set('Authorization', process.env.AUTH_HEADER)
+      .send({
+        addresses: requestedPhoneNumbers,
+      })
+
+    expect(res.status).toEqual(200)
+    expect(getActiveProxyAddressesSpy).toBeCalledWith(requestedPhoneNumbers)
+    expect(matchAvailableProxyAddressesSpy).toBeCalledWith(activeProxyAddresses)
+    expect(createConversationSpy).toBeCalledWith({addresses: requestedPhoneNumbers})
+    expect(addParticipantsToConversationSpy).toBeCalledWith(conversationsSid, availableProxyAddresses)
+  })
+
+  it('should delete conversation on failure and return 500', async () => {
+
+    const addParticipantsToConversationSpy = jest
+      .spyOn(SessionService, 'addParticipantsToConversation')
+      .mockRejectedValue([])
+
+    const deleteConversationSpy = jest
+      .spyOn(DeleteConversation, 'deleteConversation')
+      .mockResolvedValue(true)
+
+    const res = await request(app)
+      .post('/sessions')
+      .set('content-type', 'application/json')
+      .set('Authorization', process.env.AUTH_HEADER)
+      .send({
+        addresses: requestedPhoneNumbers,
+      })
+
+    expect(res.status).toEqual(500)
+    expect(getActiveProxyAddressesSpy).toBeCalledWith(requestedPhoneNumbers)
+    expect(matchAvailableProxyAddressesSpy).toBeCalledWith(activeProxyAddresses)
+    expect(createConversationSpy).toBeCalledWith({addresses: requestedPhoneNumbers})
+    expect(addParticipantsToConversationSpy).toBeCalledWith(conversationsSid, availableProxyAddresses)
+    expect(deleteConversationSpy).toBeCalledWith(conversationsSid)
+  })
+})