Add show-progress and show-stats flags to enable logging during rsync

packages/shipit-cli/package.json

@@ -27,6 +27,7 @@
   "dependencies": {
     "chalk": "^2.4.1",
     "commander": "^2.15.0",
+    "lodash": "^4.17.10",
     "interpret": "^1.1.0",
     "liftoff": "^2.5.0",
     "orchestrator": "^0.3.7",

packages/shipit-cli/src/Shipit.js

@@ -4,6 +4,7 @@ import LineWrapper from 'stream-line-wrapper'
 import Orchestrator from 'orchestrator'
 import chalk from 'chalk'
 import prettyTime from 'pretty-hrtime'
+import _ from 'lodash'
 
 /**
  * An ExecResult returned when a command is executed with success.
@@ -170,6 +171,26 @@ class Shipit extends Orchestrator {
     return this
   }
 
+  /**
+   * Add --progress flag to rsync config.
+   *
+   * @returns {Shipit} for chaining
+   */
+  setShowProgress(){
+    this.config.rsync = this.config.rsync ? [...this.config.rsync, "--progress"] : ["--progress"]
+    return this
+  }
+
+  /**
+   * Add --stats flag to rsync config.
+   *
+   * @returns {Shipit} for chaining
+   */
+  setShowStats(){
+    this.config.rsync = this.config.rsync ? [...this.config.rsync, "--stats"] : ["--stats"]
+    return this
+  }
+
   /**
    * Initialize shipit configuration.
    *
@@ -228,7 +249,13 @@ class Shipit extends Orchestrator {
       ignores: this.config && this.config.ignores ? this.config.ignores : [],
       rsync: this.config && this.config.rsync ? this.config.rsync : [],
     }
-    const copyOptions = { ...defaultOptions, ...options }
+    let copyOptions = { ...defaultOptions, ...options }
+
+    // Stop rsync config to be overwrited from the deploy rsync options.
+    if(typeof copyOptions.rsync === 'string') {
+      copyOptions.rsync = [copyOptions.rsync]
+    }
+    copyOptions = {...copyOptions, rsync: _.uniq([...defaultOptions.rsync, ...copyOptions.rsync])}
 
     return this.pool.copy(src, dest, copyOptions)
   }
@@ -252,7 +279,14 @@ class Shipit extends Orchestrator {
       ignores: this.config && this.config.ignores ? this.config.ignores : [],
       rsync: this.config && this.config.rsync ? this.config.rsync : [],
     }
-    const copyOptions = { ...defaultOptions, ...options }
+    let copyOptions = { ...defaultOptions, ...options }
+
+    // Stop rsync config to be overwrited from the deploy rsync options.
+    if(typeof copyOptions.rsync === 'string') {
+      copyOptions.rsync = [copyOptions.rsync]
+    }
+    copyOptions = {...copyOptions, rsync: _.uniq([...defaultOptions.rsync, ...copyOptions.rsync])}
+
     return this.pool.copyToRemote(src, dest, copyOptions)
   }
 
@@ -274,7 +308,14 @@ class Shipit extends Orchestrator {
       ignores: this.config && this.config.ignores ? this.config.ignores : [],
       rsync: this.config && this.config.rsync ? this.config.rsync : [],
     }
-    const copyOptions = { ...defaultOptions, ...options }
+    let copyOptions = { ...defaultOptions, ...options }
+
+    // Stop rsync config to be overwrited from the deploy rsync options.
+    if(typeof copyOptions.rsync === 'string') {
+      copyOptions.rsync = [copyOptions.rsync]
+    }
+    copyOptions = {...copyOptions, rsync: _.uniq([...defaultOptions.rsync, ...copyOptions.rsync])}
+
     return this.pool.copyFromRemote(src, dest, copyOptions)
   }
 

packages/shipit-cli/src/cli.js

@@ -26,6 +26,8 @@ program
   .option('--require <files...>', 'Script required before launching Shipit')
   .option('--tasks', 'List available tasks')
   .option('--environments', 'List available environments')
+  .option('-p, --show-progress', 'Show rsync Progress')
+  .option('-s, --show-stats', 'Show rsync Stats')
 
 program.parse(process.argv)
 
@@ -49,6 +51,14 @@ function logEnvironments(shipit) {
   )
 }
 
+function logProgress(shipit) {
+  shipit.setShowProgress()
+}
+
+function logStats(shipit) {
+  shipit.setShowStats()
+}
+
 async function asyncInvoke(env) {
   if (!env.configPath) {
     console.error(chalk.red('shipitfile not found'))
@@ -71,6 +81,13 @@ async function asyncInvoke(env) {
     throw error
   }
 
+  if(program.showProgress) {
+    logProgress(shipit)
+  }
+  if(program.showStats){
+    logStats(shipit)
+  }
+
   if (program.tasks === true) {
     logTasks(shipit)
   } else if (program.environments === true) {

packages/ssh-pool/src/Connection.js

@@ -335,7 +335,7 @@ class Connection {
       src,
       dest,
       remoteShell: sshCommand,
-      additionalArgs: typeof rsync === 'string' ? [rsync] : rsync,
+      additionalArgs: (typeof rsync === 'string' ? [rsync] : rsync),
       excludes: ignores,
     })