test(notification-service): added unit testcases (#26)

Author: ashutosh-bansal-2136

package-lock.json

@@ -22,12 +22,13 @@
     "eslint": "lb-eslint --report-unused-disable-directives .",
     "eslint:fix": "npm run eslint -- --fix",
     "pretest": "npm run clean && npm run build",
-    "test": "echo \"No test specified\"",
+    "test": "lb-mocha --allow-console-logs \"dist/__tests__\"",
     "posttest": "npm run lint",
     "test:dev": "lb-mocha --allow-console-logs dist/__tests__/**/*.js && npm run posttest",
     "clean": "lb-clean dist *.tsbuildinfo .eslintcache",
     "prepublishOnly": "npm run test && npm run lint",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "coverage": "nyc npm run test"
   },
   "repository": {
     "type": "git",
@@ -49,7 +50,9 @@
     "@types/nodemailer": "^6.4.0",
     "firebase-admin": "^9.7.0",
     "nodemailer": "^6.6.0",
-    "socket.io-client": "^2.4.0",
+    "nyc": "^15.1.0",
+    "proxyquire": "^2.1.3",
+    "socket.io-client": "^4.0.2",
     "tslib": "^2.0.0"
   },
   "devDependencies": {
@@ -61,6 +64,7 @@
     "@semantic-release/changelog": "^5.0.1",
     "@semantic-release/git": "^9.0.0",
     "@types/node": "^10.17.59",
+    "@types/proxyquire": "^1.3.28",
     "@types/pubnub": "^4.27.3",
     "@types/socket.io-client": "^1.4.33",
     "aws-sdk": "^2.683.0",

package.json

@@ -0,0 +1,40 @@
+import AWS from 'aws-sdk';
+import Pubnub from 'pubnub';
+import Mail = require('nodemailer/lib/mailer');
+import SMTPTransport = require('nodemailer/lib/smtp-transport');
+
+export class MockSES {
+  constructor(config: AWS.SES.Types.ClientConfiguration) {}
+
+  async sendEmail(emailReq: AWS.SES.SendEmailRequest) {}
+}
+
+export class MockSNS {
+  constructor(config: AWS.SNS.ClientConfiguration) {}
+
+  async publish(message: AWS.SNS.PublishInput) {}
+}
+
+export class MockSocketIo {
+  constructor(
+    url: string,
+    options?: {
+      [key: string]: string;
+    },
+  ) {}
+
+  async emit(path: string, message: string) {}
+}
+
+export class MockMail {
+  constructor(config: SMTPTransport.Options) {}
+
+  async sendMail(message: Mail.Options) {}
+}
+
+export class MockPubnub {
+  constructor(config: Pubnub.PubnubConfig) {}
+
+  grant(grantConfig: Pubnub.GrantParameters) {}
+  async publish(publishConfig: Pubnub.PublishParameters) {}
+}

src/__tests__/mock-sdk.ts

@@ -0,0 +1,213 @@
+/* eslint-disable @typescript-eslint/no-shadow */
+import {expect} from '@loopback/testlab';
+import * as admin from 'firebase-admin';
+import {FcmMessage, FcmProvider} from '../../providers';
+
+describe('FCM Service', () => {
+  const app = admin.initializeApp();
+  const fcmProvider = new FcmProvider(app);
+
+  describe('fcm configration addition', () => {
+    it('returns error message when no firebase config', async () => {
+      try {
+        /* eslint-disable @typescript-eslint/no-unused-vars */
+        const fcmProvider = new FcmProvider();
+      } catch (err) {
+        const result = err.message;
+        expect(result).which.eql('Firebase Config missing !');
+      }
+    });
+
+    it('returns error message on passing reciever length as zero', async () => {
+      const message: FcmMessage = {
+        receiver: {
+          to: [],
+        },
+        body: 'test',
+        sentDate: new Date(),
+        type: 0,
+        options: {},
+      };
+      try {
+        const result = fcmProvider.initialValidations(message);
+      } catch (err) {
+        expect(err.message).which.eql(
+          'Message receiver, topic or condition not found in request !',
+        );
+      }
+    });
+
+    it('returns error message on passing reciever length as zero in value function', async () => {
+      const message: FcmMessage = {
+        receiver: {
+          to: [],
+        },
+        body: 'test',
+        sentDate: new Date(),
+        type: 0,
+        options: {},
+      };
+      try {
+        const result = fcmProvider.value().publish(message);
+      } catch (err) {
+        expect(err.message).which.eql(
+          'Message receiver, topic or condition not found in request !',
+        );
+      }
+    });
+
+    it('returns error message on having no message subject', async () => {
+      const message: FcmMessage = {
+        receiver: {
+          to: [
+            {
+              id: 'dummy',
+              type: 0,
+            },
+          ],
+        },
+        body: 'test',
+        sentDate: new Date(),
+        type: 0,
+        options: {},
+      };
+      try {
+        const result = fcmProvider.initialValidations(message);
+      } catch (err) {
+        expect(err.message).which.eql('Message title not found !');
+      }
+    });
+
+    it('returns error message on having no message subject using value function', async () => {
+      const message: FcmMessage = {
+        receiver: {
+          to: [
+            {
+              id: 'dummy',
+              type: 0,
+            },
+          ],
+        },
+        body: 'test',
+        sentDate: new Date(),
+        type: 0,
+        options: {},
+      };
+      try {
+        const result = fcmProvider.value().publish(message);
+      } catch (err) {
+        expect(err.message).which.eql('Message title not found !');
+      }
+    });
+
+    it('returns array for sending push to conditions', async () => {
+      const message: FcmMessage = {
+        receiver: {
+          to: [
+            {
+              id: 'dummy',
+              type: 0,
+            },
+          ],
+        },
+        body: 'test',
+        sentDate: new Date(),
+        type: 0,
+        options: {},
+        subject: 'test',
+      };
+
+      const generalMessageObj = {
+        notification: {
+          title: 'test',
+          body: 'test',
+        },
+      };
+      const result = fcmProvider.sendingPushToConditions(
+        message,
+        generalMessageObj,
+      );
+      expect(result).which.eql([]);
+    }).timeout(5000);
+
+    it('returns array for sending push to receive tokens', async () => {
+      const message: FcmMessage = {
+        receiver: {
+          to: [
+            {
+              id: 'dummy',
+              type: 0,
+            },
+          ],
+        },
+        body: 'test',
+        sentDate: new Date(),
+        type: 0,
+        options: {},
+        subject: 'test',
+      };
+
+      const generalMessageObj = {
+        notification: {
+          title: 'test',
+          body: 'test',
+        },
+      };
+      const result = fcmProvider.sendingPushToReceiverTokens(
+        message,
+        generalMessageObj,
+      );
+      expect(result).to.have.Array();
+    }).timeout(5000);
+
+    it('returns array for sending push to topics', async () => {
+      const message: FcmMessage = {
+        receiver: {
+          to: [
+            {
+              id: 'dummy',
+              type: 0,
+            },
+          ],
+        },
+        body: 'test',
+        sentDate: new Date(),
+        type: 0,
+        options: {},
+        subject: 'test',
+      };
+
+      const generalMessageObj = {
+        notification: {
+          title: 'test',
+          body: 'test',
+        },
+      };
+      const result = fcmProvider.sendingPushToTopics(
+        message,
+        generalMessageObj,
+      );
+      expect(result).which.eql([]);
+    }).timeout(5000);
+
+    it('returns array for sending in value function', async () => {
+      const message: FcmMessage = {
+        receiver: {
+          to: [
+            {
+              id: 'dummy',
+              type: 0,
+            },
+          ],
+        },
+        body: 'test',
+        sentDate: new Date(),
+        type: 0,
+        options: {},
+        subject: 'test',
+      };
+      const result = fcmProvider.value().publish(message);
+      expect(result).to.have.Promise();
+    }).timeout(5000);
+  });
+});