sshkit 0.0.23 → 0.0.24

data/CHANGELOG.md

@@ -3,6 +3,28 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## 0.0.24
+
+  * Pretty output now streams stdout and stderr. Previous versions would
+    append (`+=`) chunks of data written by the remote host to the `Command`
+    instance, and the `Pretty` formatter would only print stdout/stderr if the
+    command was `#complete?`. Historically this lead to issues where the
+    remote process was blocking for input, had written the prompt to stdout,
+    but it was not visible on the client side.
+
+    Now each time the command is passed to the output stream, the
+    stdout/stderr are replaced with the lines returned from the remote server
+    in this chunk. (i.e were yielded to the callback block). Commands now have
+    attribute accessors for `#full_stdout` and `#full_stderr` which are appended
+    in the way that `#stdout` and `#stderr` were previously.
+
+    This should be considered a private API, and one should beware of relying
+    on `#full_stdout` or `#full_stderr`, they will likely be replaced with a
+    cleaner soltion eventually.
+
+  * `upload!` and `download!` now print progress reports at the `Logger::INFO`
+     verbosity level.
+
 ## 0.0.23
 
   * Explicitly rely on `net-scp` gem.

data/EXAMPLES.md

@@ -42,14 +42,14 @@
       end
     end
 
-The `debug()``, `info()`, `warn()`, `error()` and `fatal()` honor the current
+The `debug()`, `info()`, `warn()`, `error()` and `fatal()` honor the current
 log level of `SSHKit.config.output_verbosity`
 
 ## Run a command in a different directory as a different user
 
     on hosts do |host|
       as 'www-data' do
-        in '/var/log' do
+        within '/var/log' do
           puts capture(:whoami)
           puts capture(:pwd)
         end
@@ -70,7 +70,7 @@ have a shell defined, one cannot switch to that user.
       upload! '/config/database.yml', '/opt/my_project/shared/databse.yml'
     end
 
-**Note:** The `upload!()` method doesn't honor the values of `in()`, `as()`
+**Note:** The `upload!()` method doesn't honor the values of `within()`, `as()`
 etc, this will be improved as the library matures, but we're not there yet.
 
 ## Upload a file from a stream
@@ -93,14 +93,23 @@ for example
 This spares one from having to figure out the correct escaping sequences for
 something like "echo(:cat, '...?...', '> /etc/sudoers.d/yolo')".
 
-**Note:** The `upload!()` method doesn't honor the values of `in()`, `as()`
+**Note:** The `upload!()` method doesn't honor the values of `within()`, `as()`
 etc, this will be improved as the library matures, but we're not there yet.
 
+## Upload a directory of files
+
+    on hosts do |host|
+      upload! '.', '/tmp/mypwd', recursive: true
+    end
+
+In this case the `recursive: true` option mirrors the same options which are
+available to `Net::{SCP,SFTP}`.
+
 ## Run a command with a different effective group ID
 
     on hosts do |host|
       as user: 'www-data', group: 'project-group' do
-        in '/var/log' do
+        within '/var/log' do
           execute :touch, 'somefile'
           execute :ls, '-l'
         end
@@ -116,9 +125,9 @@ scripts for deployment between team members without sharing logins.
 ## Stack directory nestings
 
     on hosts do
-      in "/var" do
+      within "/var" do
         puts capture(:pwd)
-        in :log do
+        within :log do
           puts capture(:pwd)
         end
       end
@@ -138,7 +147,7 @@ joined according to the expectations of the machine receiving the commands.
 ## Running a task in the background
 
     on hosts do
-      in '/opt/sites/example.com' do
+      within '/opt/sites/example.com' do
         background :rails, :server
       end
     end

data/lib/sshkit/backends/netssh.rb

@@ -1,4 +1,5 @@
 require 'net/ssh'
+require 'net/scp'
 
 module SSHKit
   module Backend
@@ -34,18 +35,18 @@ module SSHKit
 
       def capture(*args)
         options = args.extract_options!.merge(verbosity: Logger::DEBUG)
-        _execute(*[*args, options]).stdout.strip
+        _execute(*[*args, options]).full_stdout.strip
       end
 
       def upload!(local, remote, options = {})
-        ssh.scp.upload!(local, remote, options) do
-          warn "Progress"
+        ssh.scp.upload!(local, remote, options) do |ch, name, sent, total|
+          info "Uploading #{name} #{(sent.to_f * 100 / total.to_f).to_i}%"
         end
       end
 
       def download!(remote, local=nil, options = {})
-        ssh.scp.download!(remote, local, options) do
-          warn "Progress"
+        ssh.scp.download!(remote, local, options) do |ch, name, received, total|
+          info "Downloading #{name} #{(received.to_f * 100 / total.to_f).to_i}%"
         end
       end
 
@@ -69,11 +70,13 @@ module SSHKit
             chan.request_pty if Netssh.config.pty
             chan.exec cmd.to_command do |ch, success|
               chan.on_data do |ch, data|
-                cmd.stdout += data
+                cmd.stdout = data
+                cmd.full_stdout += data
                 output << cmd
               end
               chan.on_extended_data do |ch, type, data|
-                cmd.stderr += data
+                cmd.stderr = data
+                cmd.full_stderr += data
                 output << cmd
               end
               chan.on_request("exit-status") do |ch, data|

data/lib/sshkit/command.rb

@@ -36,6 +36,7 @@ module SSHKit
     attr_reader :command, :args, :options, :started_at, :started, :exit_status
 
     attr_accessor :stdout, :stderr
+    attr_accessor :full_stdout, :full_stderr
 
     # Initialize a new Command object
     #
@@ -52,6 +53,7 @@ module SSHKit
       @options.symbolize_keys!
       sanitize_command!
       @stdout, @stderr = String.new, String.new
+      @full_stdout, @full_stderr = String.new, String.new
     end
 
     def complete?

data/lib/sshkit/formatters/pretty.rb

@@ -28,13 +28,13 @@ module SSHKit
         end
 
         if SSHKit.config.output_verbosity == Logger::DEBUG
-          if command.complete? && !command.stdout.empty?
+          unless command.stdout.empty?
             command.stdout.lines.each do |line|
               original_output << level(Logger::DEBUG) + uuid(command) + c.green("\t" + line)
             end
           end
 
-          if command.complete? && !command.stderr.empty?
+          unless command.stderr.empty?
             command.stderr.lines.each do |line|
               original_output << level(Logger::DEBUG) + uuid(command) + c.red("\t" + line)
             end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "0.0.23"
+  VERSION = "0.0.24"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.24
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh