Update tests with twilio client mocks

Author: joliveros

.env.example

@@ -1,3 +1,3 @@
-TWILIO_ACCOUNT_SID=
-TWILIO_AUTH_TOKEN=
-TWILIO_NUMBER=
+TWILIO_ACCOUNT_SID=your_account_sid
+TWILIO_AUTH_TOKEN=your_account_secret
+TWILIO_NUMBER=the_twilio_number_you_purchased

config.js

@@ -4,7 +4,7 @@ var cfg = {};
 if (process.env.NODE_ENV !== 'production' && process.env.NODE_ENV !== 'test') {
   dotenv.config({path: '.env'});
 } else {
-  dotenv.config({path: '.env.test', silent: true});
+  dotenv.config({path: '.env.example', silent: true});
 }
 
 // HTTP Port to run our web application

package.json

@@ -4,7 +4,7 @@
   "description": "Send SMS notifications on exceptions thrown by your Node.js application",
   "main": "index.js",
   "scripts": {
-    "test": "export NODE_ENV=test && mocha test"
+    "test": "NODE_ENV=test node_modules/.bin/mocha test"
   },
   "repository": {
     "type": "git",
@@ -24,7 +24,9 @@
     "url": "https://github.com/TwilioDevEd/server-notifications-node/issues"
   },
   "homepage": "https://github.com/TwilioDevEd/server-notifications-node",
-  "engines" : { "node" : ">=4.1.0 <5.5.0" },
+  "engines": {
+    "node": ">=4.1.0"
+  },
   "dependencies": {
     "body-parser": "^1.12.0",
     "connect-flash": "^0.1.1",
@@ -40,6 +42,8 @@
   "devDependencies": {
     "chai": "^3.5.0",
     "mocha": "^3.1.2",
+    "mockery": "^2.0.0",
+    "sinon": "^2.1.0",
     "supertest": "^2.0.1"
   }
 }

test/testTwilioNotifications.js

@@ -1,20 +1,51 @@
 var expect = require('chai').expect;
 var supertest = require('supertest');
+var mockery = require('mockery');
+var stub = require('sinon').stub;
 
 var app = require('../webapp');
 var config = require('../config');
 
 describe('Twilio notifications on error', function() {
   var agent = supertest(app);
+  var msgCreateStub;
+
+  before(() => {
+    // mockery.deregisterAll();
+    mockery.enable({
+      useCleanCache: true,
+      warnOnReplace: false,
+      warnOnUnregistered: false
+    });
+
+    msgCreateStub = stub().returns(Promise.resolve({}));
+
+    function TwilioMock() {
+      return {
+        api: {
+          messages: {
+            create: msgCreateStub,
+          },
+        },
+      }
+    }
+
+    mockery.registerMock('twilio', TwilioMock);
+  });
+
+  after(function () {
+    mockery.deregisterAll();
+    mockery.disable();
+  });
 
   describe('GET /error', function() {
-    it('should return an error', function(done) {
-      agent
+    it('should return an error', function() {
+      return agent
         .get('/error')
         .expect(function(res) {
           expect(res.status).to.equal(500);
-        })
-        .end(done);
-    });
+          expect(msgCreateStub.calledTwice).to.be.true;
+        });
+      });
   });
 });

test/twilioClient.js

@@ -0,0 +1,49 @@
+var mockery = require('mockery');
+var stub = require('sinon').stub;
+var expect = require('chai').expect;
+
+describe('twilioClient', function(){
+  var msgCreateStub;
+
+  before(function(){
+    mockery.enable({
+      useCleanCache: true,
+      warnOnReplace: false,
+      warnOnUnregistered: false
+    });
+
+    msgCreateStub = stub().returns(Promise.resolve({}));
+
+    function TwilioMock() {
+      return {
+        api: {
+          messages: {
+            create: msgCreateStub,
+          },
+        },
+      }
+    }
+
+    mockery.registerMock('twilio', TwilioMock);
+  });
+
+  after(function () {
+    mockery.deregisterAll();
+    mockery.disable();
+  });
+
+  it('should send sms message and return promise with result', function() {
+   // Arrange
+   var twilioClient = require('../twilioClient');
+   var toNumber = '+15555555555';
+   var message = 'test message';
+
+   // Act
+   return twilioClient
+    .sendSms(toNumber, message)
+    .then(() => {
+      // Assert
+      expect(msgCreateStub.called).to.be.true;
+    });
+  });
+});

twilioClient.js

@@ -1,16 +1,17 @@
 var config = require('./config');
-var client = require('twilio')(config.accountSid, config.authToken);
 
 module.exports.sendSms = function(to, message) {
-  client.messages.create({
-    body: message,
-    to: to,
-    from: config.sendingNumber,
-    mediaUrl: imageUrl
-  }).then(function(data) {
-    console.log('Administrator notified');
-  }).catch(function(err) {
-    console.error('Could not notify administrator');
-    console.error(err);
-  });
+  var client = require('twilio')(config.accountSid, config.authToken);
+  // console.log(client.api.messages.create())
+  return client.api.messages
+    .create({
+      body: message,
+      to: to,
+      from: config.sendingNumber,
+    }).then(function(data) {
+      console.log('Administrator notified');
+    }).catch(function(err) {
+      console.error('Could not notify administrator');
+      console.error(err);
+    });
 };