Merge pull request #47 from jaswilli/feature/sftp-progress-bar

add an optional progress bar for sftp uploads. Fixes #21.
israelroldan · Jan 16, 2014 · 02724ad · 02724ad
2 parents f46f8fe + c42ff27
commit 02724ad
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -43,7 +43,8 @@ sftp: {
       path: '/tmp/',
       host: '<%= secret.host %>',
       username: '<%= secret.username %>',
-      password: '<%= secret.password %>'
+      password: '<%= secret.password %>',
+      showProgress: true
     }
   }
 },
@@ -186,6 +187,10 @@ The permissions to apply to directories created with createDirectories.  The def
 directoryPermissions: parseInt(755, 8)
 ```
 
+###### showProgress ```boolean```
+
+Show a progress bar during the file transfer.  The default is ```false```.
+
 ##### Connection options
 
 There are three mutually exclusive sets of connection options. They are

diff --git a/package.json b/package.json
@@ -30,7 +30,8 @@
   },
   "dependencies": {
     "ssh2": ">=0.2.14",
-    "async": "*"
+    "async": "*",
+    "progress": "~1.1.3"
   },
   "devDependencies": {
     "grunt": "~0.4",

diff --git a/tasks/lib/util.js b/tasks/lib/util.js
@@ -98,5 +98,28 @@ exports.init = function (grunt) {
     return connectionOptions;
   };
 
+  // Converts a file size in bytes into a human-readable file size string.
+  exports.fileSizeReadable = function (bytes) {
+    var KB = 1024,
+        MB = KB * 1024,
+        GB = MB * 1024,
+        result;
+
+    if (bytes < KB) {
+      result = bytes + 'B';
+    }
+    else if (bytes < MB) {
+      result = Math.floor(bytes / KB) + 'KB';
+    }
+    else if (bytes < GB) {
+      result = Math.floor(bytes / MB) + 'MB';
+    }
+    else {
+      result = Math.floor(bytes / GB) + 'GB';
+    }
+
+    return result;
+  };
+
   return exports;
 };
diff --git a/tasks/sftp.js b/tasks/sftp.js
@@ -18,6 +18,7 @@ module.exports = function (grunt) {
     var Connection = require('ssh2');
     var path = require('path');
     var sftpHelper = require("./lib/sftpHelpers").init(grunt);
+    var ProgressBar = require('progress');
 
     var options = this.options({
       path: '',
@@ -29,7 +30,8 @@ module.exports = function (grunt) {
       minimatch: {},
       srcBasePath: "",
       createDirectories: false,
-      directoryPermissions: parseInt(755, 8)
+      directoryPermissions: parseInt(755, 8),
+      showProgress: false
     });
 
     var tally = {
@@ -56,6 +58,7 @@ module.exports = function (grunt) {
     setOption('username');
     setOption('password');
     setOption('passphrase');
+    setOption('showProgress');
 
     // add trailing slash to path if needed
     if (!options.path.match(/(\/|\\)$/)) {
@@ -149,8 +152,32 @@ module.exports = function (grunt) {
             }
 
             async.eachSeries(fileQueue, function (file, callback) {
+              var fpOptions;
+
+              if (options.showProgress) {
+                var fileSize = fs.statSync(file.src).size;
+                var barTemplate = file.src + ' [:bar] :percent of ' + utillib.fileSizeReadable(fileSize);
+
+                var bar = new ProgressBar(barTemplate, {
+                  complete: '=',
+                  incomplete: ' ',
+                  width: 20,
+                  total: fileSize
+                });
+
+                fpOptions = {
+                  step: function (totalSent, lastSent, total) {
+                    bar.tick(lastSent);
+                  }
+                };
+              } else {
+                fpOptions = {
+                  step: function () {}
+                };
+              }
+
               grunt.verbose.writeln('copying ' + file.src + ' to ' + file.dest);
-              sftp.fastPut(file.src, file.dest, function (err) {
+              sftp.fastPut(file.src, file.dest, fpOptions, function (err) {
                 if (err) {
                   return callback(err);
                 }

diff --git a/test/util_test.js b/test/util_test.js
@@ -176,6 +176,15 @@ module.exports = {
     test.equal(util.validateNumber("name", 32), 32, "should validate number");
     test.equal(util.validateNumber("name", 0), 0, "should validate zero");
     test.done();
-  }
+  },
+  fileSizeReadable: function (test) {
+    'use strict';
+    test.equal(util.fileSizeReadable(0), "0B", "0 should be 0B");
+    test.equal(util.fileSizeReadable(1023), "1023B", "less than one KB should be B");
+    test.equal(util.fileSizeReadable(1048575), "1023KB", "less than one MB should be KB");
+    test.equal(util.fileSizeReadable(1073741823), "1023MB", "less than one GB should be MB");
+    test.equal(util.fileSizeReadable(1073741825), "1GB", "greater than one GB should be GB");
 
+    test.done();
+  }
 };