chore(test): Add Test for privateKey param on shh tunnel

Author: wzrdtales

test/driver/index_test.js

@@ -1,4 +1,4 @@
-var proxyquire = require('proxyquire');
+var proxyquire = require('proxyquire').noPreserveCache();
 var sinon = require('sinon');
 var Code = require('code');
 var Lab = require('lab');
@@ -41,6 +41,7 @@ lab.experiment('index', function() {
     // Set up stubs/spies to verify correct flow
     var driverSpy = sinon.stub(driver, 'connect').yields(null, {});
     var tunnelStub = sinon.stub().callsArg(1);
+
     var index = proxyquire('../../lib/driver/index', {
       'tunnel-ssh': tunnelStub,
       './mysql': driver
@@ -137,4 +138,80 @@ lab.experiment('index', function() {
       done();
     }
   });
+
+  lab.test('privateKey gets set as expected',
+    function(done, cleanup) {
+
+    // Ensure that require gets a new copy of the module for each test
+    delete require.cache[require.resolve('db-migrate-mysql')];
+    var driver = require('db-migrate-mysql');
+    var fs = { readFileSync: sinon.stub().returns('sshkey') };
+
+    // Set up stubs/spies to verify correct flow
+    var driverSpy = sinon.stub(driver, 'connect').yields(null, {});
+    var tunnelStub = sinon.stub().callsArg(1);
+
+    var index = proxyquire('../../lib/driver/index', {
+      'tunnel-ssh': tunnelStub,
+      'fs': fs,
+      './mysql': driver,
+    });
+
+    //register clean up
+    cleanup(function(next) {
+
+      driverSpy.restore();
+
+      delete require.cache[require.resolve('tunnel-ssh')];
+      delete require.cache[require.resolve('db-migrate-mysql')];
+      next();
+    });
+
+    validDbConfigWithTunnel.tunnel.privateKeyPath = '/test/key';
+
+    index.connect(
+      validDbConfigWithTunnel,
+      {},
+      indexConnectCallback(tunnelStub, driverSpy, validate)
+    );
+
+    function validate(err, db, tunnelStub, driverSpy) {
+      var expectedTunnelConfig = {
+        localPort: 'localPort',
+        host: 'sshHost',
+        port: 'sshPort',
+        privateKeyPath: '/test/key',
+        dstHost: '127.0.0.1',
+        dstPort: 'localPort',
+        privateKey: 'sshkey'
+      };
+      var expectedDbConfig = {
+        driver: 'mysql',
+        host: '127.0.0.1',
+        port: 'localPort',
+        tunnel: {
+          localPort: 'localPort',
+          host: 'sshHost',
+          port: 'sshPort',
+          privateKeyPath: '/test/key'
+        }
+      };
+
+
+      Code.expect(err).to.be.null();
+      Code.expect(db).to.not.be.null();
+      Code.expect(
+        fs.readFileSync.withArgs(validDbConfigWithTunnel.tunnel.privateKeyPath)
+          .calledOnce
+      ).to.be.true();
+      Code.expect(
+        tunnelStub.withArgs(expectedTunnelConfig).calledOnce
+      ).to.be.true();
+      Code.expect(
+        driverSpy.withArgs(expectedDbConfig).calledOnce
+      ).to.be.true();
+
+      done();
+    }
+  });
 });