add support for passing in SSH key

README.md

@@ -93,6 +93,12 @@ Type: `String` or `Array<String>`
 
 Servers on which the project will be deployed. Pattern must be `[email protected]` if user is not specified (`myserver.com`) the default user will be "deploy".
 
+#### key
+
+Type: `String`
+
+Path to SSH key
+
 ### Usage example
 
 ```js
@@ -102,7 +108,8 @@ shipit: {
     deployTo: '/tmp/deploy_to',
     repositoryUrl: 'https://github.com/user/repo.git',
     ignores: ['.git', 'node_modules'],
-    keepReleases: 2
+    keepReleases: 2,
+    key: '/path/to/key'
   },
   staging: {
     servers: '[email protected]'

lib/shipit.js

@@ -8,6 +8,7 @@ var isArray = require('lodash').isArray;
 var defaults = require('lodash').defaults;
 var extend = require('lodash').extend;
 var defaults = require('lodash').defaults;
+var pick = require('lodash').pick;
 var childProcess = require('child_process');
 var ConnectionPool = require('./ssh/connection-pool');
 var LineWrapper = require('stream-line-wrapper');
@@ -63,7 +64,7 @@ Shipit.prototype.initialize = function () {
 
 Shipit.prototype.initSshPool = function () {
   var servers = isArray(this.config.servers) ? this.config.servers : [this.config.servers];
-  this.sshPool = new ConnectionPool(servers, this.options);
+  this.sshPool = new ConnectionPool(servers, extend({}, this.options, pick(this.config, 'key')));
   return this;
 };
 

lib/ssh/connection.js

@@ -50,7 +50,7 @@ Connection.prototype.run = function (command, options, cb) {
 
   // In sudo mode, we use a TTY channel.
   var args = /^sudo/.exec(command) ? ['-tt'] : [];
-  args.push('-p ' + (this.options.port || 22));
+  args.push.apply(args, buildSSHArgs(this.options));
   args.push(remote.format(this.remote));
 
   // Escape double quotes in command.
@@ -82,6 +82,7 @@ Connection.prototype.run = function (command, options, cb) {
  */
 
 Connection.prototype.copy = function (src, dest, options, cb) {
+
   // function (src, dest, cb)
   if (isFunction(options)) {
     cb = options;
@@ -102,7 +103,7 @@ Connection.prototype.copy = function (src, dest, options, cb) {
   var args = ['rsync'].concat(excludes).concat([
     '-az',
     '-e',
-    '"ssh -p ' + (this.options.port || 22) + '"',
+    '"ssh ' + (buildSSHArgs(this.options)).join(' ') + '"',
     src,
     dest
   ]);
@@ -133,3 +134,12 @@ function formatExcludes(excludes) {
     return prev.concat(['--exclude', current]);
   }, []);
 }
+
+function buildSSHArgs(options) {
+    var args = [];
+    args.push('-p ' + (options.port || 22));
+    if (options.key) {
+      args.push('-i ' + options.key);
+    }
+    return args;
+}

test/unit/ssh/connection.js

@@ -101,6 +101,18 @@ describe('SSH Connection', function () {
         'ssh -p 22 user@host "my-command2 -x"'
       );
     });
+
+    it('should use key if present', function () {
+      connection = new Connection({
+        remote: 'user@host',
+        logger: logger,
+        key: '/path/to/key'
+      });
+      connection.run('my-command -x', function () {});  
+      expect(childProcess.exec).to.be.calledWith(
+        'ssh -p 22 -i /path/to/key user@host "my-command -x"'
+      );
+    });
   });
 
   describe('#copy', function () {
@@ -125,5 +137,16 @@ describe('SSH Connection', function () {
       expect(childProcess.exec).to.be.calledWith('rsync --exclude a --exclude b -az -e ' +
         '"ssh -p 22" /src/dir user@host:/dest/dir');
     });
+
+    it('should use key if present', function (done) {
+      connection = new Connection({
+        remote: 'user@host',
+        logger: logger,
+        key: '/path/to/key'
+      });
+      connection.copy('/src/dir', '/dest/dir', done);
+      expect(childProcess.exec).to.be.calledWith('rsync -az -e "ssh -p 22 -i /path/to/key" /src/dir user@host:/dest/dir');
+    });
+
   });
 });