sshkit 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cd81576d8df6878627ee2ca1b298c2079698085
-  data.tar.gz: 9676306af0f0de95b974134d580fed271486004f
+  metadata.gz: a17c8de5efa195cef64bac5bd868dce70e430939
+  data.tar.gz: 90f2200bf01fa80d3549ed747a4e8ef545806ffe
 SHA512:
-  metadata.gz: 4a0cfdd77807a8e280376f8f5a07b0f7bac96339091c67bb2c3e7e2424247e192436451ca189772352095f9132afc57e7c660381180812ca315c2ad0715e58f4
-  data.tar.gz: 0e4037910686419d816927cddae4a065021c8e7ebae2530c55d62ea299414310e1bb9fcb44fd88dabde85de069667e537aec5a4ff2dc5f9dff55cf9bc0bc592f
+  metadata.gz: ce8989e38ff9dab3be7673183786c838ea9fa71d174dfec0c5ae0d812a47619fcc1a2b768939cb531b9cf8dbabd4993b3f46c60bee81d01c7aff9976d5b5d77f
+  data.tar.gz: 906b9b7317960551ed9b137f9cf1611e11821d3a042cc0d990853cedfbc5e970c1b4a4d1a92a0b4896b662e162395fc3244b91db8f29ba92a52a596c9145cc06

data/CHANGELOG.md

@@ -8,6 +8,16 @@ appear at the top.
   * Add your entries here, remember to credit yourself however you want to be
     credited!
 
+## 1.4.0
+
+  * Removed `invoke` alias for [`SSHKit::Backend::Printer.execute`](https://github.com/capistrano/sshkit/blob/master/lib/sshkit/backends/printer.rb#L20). This is to prevent collisions with
+  methods in capistrano with similar names, and to provide a cleaner API. See [capistrano issue 912](https://github.com/capistrano/capistrano/issues/912) and [issue 107](https://github.com/capistrano/sshkit/issues/107) for more details.
+  * Connection pooling now uses a thread local to store connection pool, giving each thread its own connection pool. Thank you @mcbriston see [#101](https://github.com/capistrano/sshkit/pull/101) for more.
+  * Command map indifferent towards strings and symbols thanks to @thomasfedb see [#91](https://github.com/capistrano/sshkit/pull/91)
+  * Moved vagrant wrapper to `support` directory, added ability to run tests with vagrant using ssh. @miry see [#64](https://github.com/capistrano/sshkit/pull/64)
+  * Removed unnecessary require `require_relative '../sshkit'` in `lib/sshkit/dsl.rb` prevents warnings thanks @brabic.
+  * Doc fixes thanks @seanhandley @vojto
+
 ## 1.3.0
 
   * Connection pooling. SSH connections are reused across multiple invocations

data/EXAMPLES.md

@@ -64,21 +64,21 @@ This will output:
 **Note:** This example is a bit misleading, as the `www-data` user doesn't
 have a shell defined, one cannot switch to that user.
 
-## Upload a file from disk
+## Upload a file from disk
 
     on hosts do |host|
-      upload! '/config/database.yml', '/opt/my_project/shared/databse.yml'
+      upload! '/config/database.yml', '/opt/my_project/shared/database.yml'
     end
 
 **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
+## Upload a file from a stream
 
     on hosts do |host|
       file = File.open('/config/database.yml')
       io   = StringIO.new(....)
-      upload! file, '/opt/my_project/shared/databse.yml'
+      upload! file, '/opt/my_project/shared/database.yml'
       upload! io,   '/opt/my_project/shared/io.io.io'
     end
 
@@ -110,7 +110,7 @@ available to `Net::{SCP,SFTP}`.
 Setting global SSH options, these will be overwritten by options set on the
 individual hosts:
 
-    Netssh.configure do |ssh|
+    SSHKit::Backend::Netssh.configure do |ssh|
       ssh.connection_timeout = 30
       ssh.ssh_options = {
         keys: %w(/home/user/.ssh/id_rsa),
@@ -119,7 +119,7 @@ individual hosts:
       }
     end
 
-## Run a command with a different effective group ID
+## Run a command with a different effective group ID
 
     on hosts do |host|
       as user: 'www-data', group: 'project-group' do
@@ -233,7 +233,7 @@ which will cause the command to abort.
     end
 
 The `test()` command behaves exactly the same as execute however will return
-false if the command exits with a non-zero exit (as `man 1 test` does). As ti
+false if the command exits with a non-zero exit (as `man 1 test` does). As it
 returns boolean it can be used to direct the control flow within the block.
 
 ## Do something different on one host, or another depending on a host property
@@ -294,7 +294,7 @@ An extension of the behaviour above, if you write a command like this:
 known test cases, it works. The key thing is that `if` is not mapped to
 `/usr/bin/env if`, which would break with a syntax error.
 
-## Using with Rake
+## Using with Rake
 
 Into the `Rakefile` simply put something like:
 

data/FAQ.md

@@ -11,11 +11,6 @@ Since *Capistrano v3.0*, *SSHKit* is used by *Capistrano* to communicate with
 backend servers. Whilst Capistrano provides the structure for repeatable
 deployments.
 
-## Production Ready?
-
-It's in private Beta use, and the documentation could use more work, but this
-is open source, that's more or less how it works.
-
 ## Why does <something> stop responding after I started it with `background()`?
 
 The answer is complicated, but it can be summed up by saying that under

data/Gemfile

@@ -4,5 +4,5 @@ gemspec
 
 platforms :rbx do
   gem 'rubysl', '~> 2.0'
-  gem 'rubysl-json'
+  gem 'json'
 end

data/README.md

@@ -3,25 +3,28 @@
 **SSHKit** is a toolkit for running commands in a structured way on one or
 more servers.
 
-[![Build Status](https://travis-ci.org/leehambley/sshkit.png?branch=master)](https://travis-ci.org/leehambley/sshkit)
+[![Build Status](https://travis-ci.org/capistrano/sshkit.png?branch=master)](https://travis-ci.org/capistrano/sshkit)
 [![Dependency Status](https://gemnasium.com/leehambley/sshkit.png)](https://gemnasium.com/leehambley/sshkit)
 
 ## How might it work?
 
 The typical use-case looks something like this:
 
-    require 'sshkit/dsl'
-
-    on %w{1.example.com 2.example.com}, in: :sequence, wait: 5 do
-      within "/opt/sites/example.com" do
-        as :deploy  do
-          with rails_env: :production do
-            rake   "assets:precompile"
-            runner "S3::Sync.notify"
-          end
-        end
+```ruby
+require 'sshkit/dsl'
+
+on %w{1.example.com 2.example.com}, in: :sequence, wait: 5 do
+  within "/opt/sites/example.com" do
+    as :deploy  do
+      with rails_env: :production do
+        rake   "assets:precompile"
+        runner "S3::Sync.notify"
+        execute "node", "socket_server.js"
       end
     end
+  end
+end
+```
 
 One will notice that it's quite low level, but exposes a convenient API, the
 `as()`/`within()`/`with()` are nestable in any order, repeatable, and stackable.
@@ -55,9 +58,11 @@ Helpers such as `runner()` and `rake()` which expand to `execute(:rails, "runner
 Notice on the `on()` call the `in: :sequence` option, the following will do
 what you might expect:
 
-    on(in: :parallel) { ... }
-    on(in: :sequence, wait: 5) { ... }
-    on(in: :groups, limit: 2, wait: 5) { ... }
+```ruby
+on(in: :parallel) { ... }
+on(in: :sequence, wait: 5) { ... }
+on(in: :groups, limit: 2, wait: 5) { ... }
+```
 
 The default is to run `in: :parallel` which has no limit. If you have 400 servers,
 this might be a problem and you might better look at changing that to run in
@@ -77,49 +82,68 @@ for all servers to complete before it returns.
 
 For example:
 
-    all_servers = %w{one.example.com two.example.com three.example.com}
-    site_dir    = '/opt/sites/example.com'
-
-    # Let's simulate a backup task, assuming that some servers take longer
-    # then others to complete
-    on servers do |host|
-      in site_dir do
-        execute :tar, '-czf', "backup-#{host.hostname}.tar.gz", 'current'
-        # Will run: "/usr/bin/env tar -czf backup-one.example.com.tar.gz current"
-      end
-    end
-
-    # Now we can do something with those backups, safe in the knowledge that
-    # they will all exist (all tar commands exited with a success status, or
-    # that we will have raised an exception if one of them failed.
-    on servers do |host|
-      in site_dir do
-        backup_filename = "backup-#{host.hostname}.tar.gz"
-        target_filename = "backups/#{Time.now.utc.iso8601}/#{host.hostname}.tar.gz"
-        puts capture(:s3cmd, 'put', backup_filename, target_filename)
-      end
-    end
+```ruby
+all_servers = %w{one.example.com two.example.com three.example.com}
+site_dir    = '/opt/sites/example.com'
+
+# Let's simulate a backup task, assuming that some servers take longer
+# then others to complete
+on all_servers do |host|
+  in site_dir do
+    execute :tar, '-czf', "backup-#{host.hostname}.tar.gz", 'current'
+    # Will run: "/usr/bin/env tar -czf backup-one.example.com.tar.gz current"
+  end
+end
+
+# Now we can do something with those backups, safe in the knowledge that
+# they will all exist (all tar commands exited with a success status, or
+# that we will have raised an exception if one of them failed.
+on all_servers do |host|
+  in site_dir do
+    backup_filename = "backup-#{host.hostname}.tar.gz"
+    target_filename = "backups/#{Time.now.utc.iso8601}/#{host.hostname}.tar.gz"
+    puts capture(:s3cmd, 'put', backup_filename, target_filename)
+  end
+end
+```
 
 ## The Command Map
 
-It's often a problem that programatic SSH sessions don't share the same environmental
-variables as sessions that are started interactively.
+It's often a problem that programmatic SSH sessions don't have the same environment
+variables as interactive sessions.
 
-This problem often comes when calling out to executables, expected to be on
-the `$PATH` which, under conditions without dotfiles or other environmental
-configuration are not where they are expected to be.
+A problem often arises when calling out to executables expected to be on
+the `$PATH`.  Under conditions without dotfiles or other environmental
+configuration, `$PATH` may not be set as expected, and thus executables are not found where expected.
 
 To try and solve this there is the `with()` helper which takes a hash of variables and makes them
 available to the environment.
 
-    with path: '/usr/local/bin/rbenv/shims:$PATH' do
-      execute :ruby, '--version'
-    end
+```ruby
+with path: '/usr/local/bin/rbenv/shims:$PATH' do
+  execute :ruby, '--version'
+end
+```
 
 Will execute:
 
     ( PATH=/usr/local/bin/rbenv/shims:$PATH /usr/bin/env ruby --version )
 
+By contrast, the following won't modify the command at all:
+
+
+```ruby
+with path: '/usr/local/bin/rbenv/shims:$PATH' do
+  execute 'ruby --version'
+end
+```
+
+Will execute, without mapping the environmental variables, or querying the command map:
+
+    ruby --version
+
+(This behaviour is sometimes considered confusing, but it has mostly to do with shell escaping: in the case of whitespace in your command, or newlines, we have no way of reliably composing a correct shell command from the input given.)
+
 **Often more preferable is to use the *command map*.**
 
 The *command map* is used by default when instantiating a *Command* object
@@ -128,36 +152,43 @@ The *command map* exists on the configuration object, and in principle is
 quite simple, it's a *Hash* structure with a default key factory block
 specified, for example:
 
-    puts SSHKit.config.command_map[:ruby]
-    # => /usr/bin/env ruby
+```ruby
+puts SSHKit.config.command_map[:ruby]
+# => /usr/bin/env ruby
+```
 
-The `/usr/bin/env` prefix is applied to all commands, to make clear that the
-environment is being deferred to to make the decision, this is what happens
-anyway when one would simply attempt to execute `ruby`, however by making it
-explicit, it was hoped that it might lead people to explore the documentation.
+To make clear the environment is being deferred to, the `/usr/bin/env` prefix is applied to all commands.
+Although this is what happens anyway when one would simply attempt to execute `ruby`, making it
+explicit hopefully leads people to explore the documentation.
 
 One can override the hash map for individual commands:
 
-    SSHKit.config.command_map[:rake] = "/usr/local/rbenv/shims/rake"
-    puts SSHKit.config.command_map[:rake]
-    # => /usr/local/rbenv/shims/rake
+```ruby
+SSHKit.config.command_map[:rake] = "/usr/local/rbenv/shims/rake"
+puts SSHKit.config.command_map[:rake]
+# => /usr/local/rbenv/shims/rake
+```
 
-Another oportunity is to add command prefixes:
+Another opportunity is to add command prefixes:
 
-    SSHKit.config.command_map.prefix[:rake].push("bundle exec")
-    puts SSHKit.config.command_map[:rake]
-    # => bundle exec rake
+```ruby
+SSHKit.config.command_map.prefix[:rake].push("bundle exec")
+puts SSHKit.config.command_map[:rake]
+# => bundle exec rake
 
-    SSHKit.config.command_map.prefix[:rake].unshift("/usr/local/rbenv/bin exec")
-    puts SSHKit.config.command_map[:rake]
-    # => /usr/local/rbenv/bin exec bundle exec rake
+SSHKit.config.command_map.prefix[:rake].unshift("/usr/local/rbenv/bin exec")
+puts SSHKit.config.command_map[:rake]
+# => /usr/local/rbenv/bin exec bundle exec rake
+```
 
 One can also override the command map completely, this may not be wise, but it
 would be possible, for example:
 
-    SSHKit.config.command_map = Hash.new do |hash, command|
-      hash[command] = "/usr/local/rbenv/shims/#{command}"
-    end
+```ruby
+SSHKit.config.command_map = Hash.new do |hash, command|
+  hash[command] = "/usr/local/rbenv/shims/#{command}"
+end
+```
 
 This would effectively make it impossible to call any commands which didn't
 provide an executable in that directory, but in some cases that might be
@@ -170,26 +201,27 @@ first argument before attempting to find it in the *command map*.
 
 ![Example Output](https://raw.github.com/leehambley/sshkit/master/assets/images/example_output.png)
 
-The output handling comprises two objects, first is the output itself, by
-default this is *$stdout*, but can be any object responding to a
-*StringIO*-like interface. The second part is the *formatter*.
+By default, the output format is set to `:pretty`: 
 
-The *formatter* and *output* have a strange relationship:
+```ruby
+SSHKit.config.format = :pretty
+```
+
+However, if you prefer minimal output, `:dot` format will simply output red or green dots based on the success or failure of operations. 
 
-    SSHKit.config.output = SSHKit.config.formatter.new($stdout)
+To output directly to $stdout without any formatting, you can use: 
 
-The *formatter* will typically delegate all calls to the *output*, depending
-on it's implementation it will almost certainly override the implementation of
-`write()` (alias `<<()`) and query the objects it receives to determine what
-should be printed.
+```ruby
+SSHKit.config.output = $stdout
+```
 
-## Verbosity
+## Output Verbosity
 
 By default calls to `capture()` and `test()` are not logged, they are used
 *so* frequently by backend tasks to check environmental settings that it
 produces a large amount of noise. They are tagged with a verbosity option on
 the `Command` instances of `Logger::DEBUG`. The default configuration for
-output verbosity is avaialble to override with `SSHKit.config.output_verbosity=`,
+output verbosity is available to override with `SSHKit.config.output_verbosity=`,
 and defaults to `Logger::INFO`.
 
 At present the `Logger::WARN`, `ERROR` and `FATAL` are not used.
@@ -211,7 +243,7 @@ SSHKit::Backend::Netssh.pool.idle_timeout = 60 # seconds
 ```
 
 If you suspect the connection pooling is causing problems, you can disable the
-pooling behavior entirely by setting the idle_timeout to zero:
+pooling behaviour entirely by setting the idle_timeout to zero:
 
 ```ruby
 SSHKit::Backend::Netssh.pool.idle_timeout = 0 # disabled
@@ -247,8 +279,8 @@ SSHKit::Backend::Netssh.pool.idle_timeout = 0 # disabled
 * No method for uploading or downloading files, or the same for saving/loading
   a string to/from a remote file.
 * No closing of connections, the abstract backend class should include a
-  cleanup method which is empty but can be overriden by other implementations.
-* ~~No conncetion pooling, the `connection` method of the NetSSH backend could
+  cleanup method which is empty but can be overridden by other implementations.
+* ~~No connection pooling, the `connection` method of the NetSSH backend could
   easily be modified to look into some connection factory for it's objects,
   saving half a second when running lots of `on()` blocks.~~
 * Documentation! (YARD style)

data/Rakefile

@@ -1,5 +1,6 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 namespace :test do

data/lib/sshkit.rb

@@ -3,28 +3,31 @@ module SSHKit
   StandardError = Class.new(::StandardError)
 
   class << self
+    
     attr_accessor :config
-  end
-
-  def self.capture_output(io, &block)
-    original_io = config.output
-    config.output = io
-    yield
-  ensure
-    config.output = original_io
-  end
-
-  def self.configure
-    @@config ||= Configuration.new
-    yield config
-  end
-
-  def self.config
-    @@config ||= Configuration.new
-  end
 
-  def self.reset_configuration!
-    @@config = nil
+    def capture_output(io, &block)
+      original_io = config.output
+      config.output = io
+      config.output.extend(SSHKit::Utils::CaptureOutputMethods)
+      yield
+    ensure
+      config.output = original_io
+    end
+
+    def configure
+      @@config ||= Configuration.new
+      yield config
+    end
+
+    def config
+      @@config ||= Configuration.new
+    end
+
+    def reset_configuration!
+      @@config = nil
+    end
+    
   end
 
 end

data/lib/sshkit/all.rb

@@ -13,6 +13,7 @@ require_relative 'log_message'
 
 require_relative 'formatters/abstract'
 require_relative 'formatters/black_hole'
+require_relative 'formatters/simple_text'
 require_relative 'formatters/pretty'
 require_relative 'formatters/dot'
 
@@ -28,3 +29,5 @@ require_relative 'backends/printer'
 require_relative 'backends/netssh'
 require_relative 'backends/local'
 require_relative 'backends/skipper'
+
+require_relative 'utils/capture_output_methods'

data/lib/sshkit/backends/connection_pool.rb

@@ -10,7 +10,6 @@ module SSHKit
 
       def initialize
         self.idle_timeout = 30
-        @connections = {}
         @monitor = Monitor.new
       end
 
@@ -31,25 +30,21 @@ module SSHKit
 
       private
 
+      def connections
+        Thread.current[:sshkit_pool] ||= {}
+      end
+
       def find_and_reject_invalid(key, &block)
-        synchronize do
-          entry = @connections[key]
-          invalid = entry && yield(entry)
+        entry = connections[key]
+        invalid = entry && yield(entry)
 
-          @connections.delete(entry) if invalid
+        connections.delete(entry) if invalid
 
-          invalid ? nil : entry
-        end
+        invalid ? nil : entry
       end
 
       def store_entry(key, connection)
-        synchronize do
-          @connections[key] = Entry.new(connection)
-        end
-      end
-
-      def synchronize(&block)
-        @monitor.synchronize(&block)
+        connections[key] = Entry.new(connection)
       end
 
 

data/lib/sshkit/backends/local.rb

@@ -26,7 +26,7 @@ module SSHKit
       end
 
       def capture(*args)
-        options = args.extract_options!.merge(verbosity: Logger::DEBUG)
+        options = { verbosity: Logger::DEBUG }.merge(args.extract_options!)
         _execute(*[*args, options]).full_stdout.strip
       end
 
@@ -38,7 +38,13 @@ module SSHKit
 
           cmd.started = Time.now
 
-          stdout, stderr, exit_status = Open3.capture3(cmd.to_command)
+          stdout, stderr, exit_status =
+            if RUBY_ENGINE == 'jruby'
+              _, o, e, t = Open3.popen3('/usr/bin/env', 'sh', '-c', cmd.to_command)
+              [o.read, e.read, t.value]
+            else
+              Open3.capture3(cmd.to_command)
+            end
 
           cmd.stdout = stdout
           cmd.full_stdout += stdout

data/lib/sshkit/backends/netssh.rb

@@ -72,7 +72,7 @@ module SSHKit
       end
 
       def capture(*args)
-        options = args.extract_options!.merge(verbosity: Logger::DEBUG)
+        options = { verbosity: Logger::DEBUG }.merge(args.extract_options!)
         _execute(*[*args, options]).full_stdout.strip
       end
 

data/lib/sshkit/backends/printer.rb

@@ -11,13 +11,12 @@ module SSHKit
 
       def execute(*args)
         command(*args).tap do |cmd|
-          output << sprintf("%s\n", cmd)
+          output << cmd
         end
       end
       alias :upload! :execute
       alias :download! :execute
       alias :test :execute
-      alias :invoke :execute
 
       def capture(*args)
         String.new.tap { execute(*args) }

data/lib/sshkit/command.rb

@@ -87,10 +87,14 @@ module SSHKit
     def exit_status=(new_exit_status)
       @finished_at = Time.now
       @exit_status = new_exit_status
+
       if options[:raise_on_non_zero_exit] && exit_status > 0
         message = ""
+        message += "#{command} exit status: " + exit_status.to_s + "\n"
         message += "#{command} stdout: " + (stdout.strip.empty? ? "Nothing written" : stdout.strip) + "\n"
-        message += "#{command} stderr: " + (stderr.strip.empty? ? "Nothing written" : stderr.strip) + "\n"
+
+        stderr_message = [stderr.strip, full_stderr.strip].delete_if(&:empty?).first
+        message += "#{command} stderr: " + (stderr_message || 'Nothing written') + "\n"
         raise Failed, message
       end
     end
@@ -147,7 +151,7 @@ module SSHKit
       (SSHKit.config.default_env || {}).merge(options[:env] || {})
     end
 
-    def envivonment_string
+    def environment_string
       environment_hash.collect do |key,value|
         "#{key.to_s.upcase}=#{value}"
       end.join(' ')
@@ -155,7 +159,7 @@ module SSHKit
 
     def with(&block)
       return yield unless environment_hash.any?
-      "( #{envivonment_string} %s )" % yield
+      "( #{environment_string} %s )" % yield
     end
 
     def user(&block)
@@ -165,7 +169,7 @@ module SSHKit
 
     def in_background(&block)
       return yield unless options[:run_in_background]
-      "nohup %s > /dev/null &" % yield
+      "( nohup %s > /dev/null & )" % yield
     end
 
     def umask(&block)

data/lib/sshkit/command_map.rb

@@ -1,8 +1,29 @@
 module SSHKit
   class CommandMap
+    class CommandHash
+      def initialize(defaults = {})
+        @storage = {}
+        @defaults = defaults
+      end
+
+      def [](key)
+        @storage[normalize_key(key)] ||= @defaults[key]
+      end
+
+      def []=(key, value)
+        @storage[normalize_key(key)] = value
+      end
+
+      private
+
+      def normalize_key(key)
+        key.to_sym
+      end
+    end
+
     class PrefixProvider
       def initialize
-        @storage = {}
+        @storage = CommandHash.new
       end
 
       def [](command)
@@ -13,7 +34,7 @@ module SSHKit
     end
 
     def initialize(value = nil)
-      @map = value || defaults
+      @map = CommandHash.new(value || defaults)
     end
 
     def [](command)
@@ -35,7 +56,7 @@ module SSHKit
     end
 
     def clear
-      @map = defaults
+      @map = CommandHash.new(defaults)
     end
 
     def defaults

data/lib/sshkit/coordinator.rb

@@ -6,7 +6,7 @@ module SSHKit
 
     def initialize(raw_hosts)
       @raw_hosts = Array(raw_hosts)
-      resolve_hosts! if Array(raw_hosts).any?
+      @hosts = @raw_hosts.any? ? resolve_hosts : []
     end
 
     def each(options={}, &block)
@@ -32,8 +32,8 @@ module SSHKit
         { in: :parallel }
       end
 
-      def resolve_hosts!
-        @hosts = @raw_hosts.collect { |rh| rh.is_a?(Host) ? rh : Host.new(rh) }.uniq
+      def resolve_hosts
+        @raw_hosts.collect { |rh| rh.is_a?(Host) ? rh : Host.new(rh) }.uniq
       end
 
   end

data/lib/sshkit/dsl.rb

@@ -1,5 +1,3 @@
-require_relative '../sshkit'
-
 module SSHKit
 
   module DSL

data/lib/sshkit/formatters/simple_text.rb

@@ -0,0 +1,58 @@
+
+module SSHKit
+
+  module Formatter
+
+    class SimpleText < Abstract
+
+      def write(obj)
+        return if obj.verbosity < SSHKit.config.output_verbosity
+        case obj
+        when SSHKit::Command    then write_command(obj)
+        when SSHKit::LogMessage then write_log_message(obj)
+        else
+          original_output << "Output formatter doesn't know how to handle #{obj.class}\n"
+        end
+      end
+      alias :<< :write
+
+      private
+
+      def write_command(command)
+        unless command.started?
+          original_output << "Running #{String(command)} on #{command.host.to_s}\n"
+          if SSHKit.config.output_verbosity == Logger::DEBUG
+            original_output << "Command: #{command.to_command}" + "\n"
+          end
+        end
+
+        if SSHKit.config.output_verbosity == Logger::DEBUG
+          unless command.stdout.empty?
+            command.stdout.lines.each do |line|
+              original_output << "\t" + line
+              original_output << "\n" unless line[-1] == "\n"
+            end
+          end
+
+          unless command.stderr.empty?
+            command.stderr.lines.each do |line|
+              original_output << "\t" + line
+              original_output << "\n" unless line[-1] == "\n"
+            end
+          end
+        end
+
+        if command.finished?
+          original_output << "Finished in #{sprintf('%5.3f seconds', command.runtime)} with exit status #{command.exit_status} (#{ command.failure? ? 'failed' : 'successful' }).\n"
+        end
+      end
+
+      def write_log_message(log_message)
+        original_output << log_message.to_s + "\n"
+      end
+
+    end
+
+  end
+
+end

data/lib/sshkit/runners/parallel.rb

@@ -9,7 +9,7 @@ module SSHKit
         threads = []
         hosts.each do |host|
           threads << Thread.new(host) do |h|
-            backend(host, &block).run
+            backend(h, &block).run
           end
         end
         threads.map(&:join)

data/lib/sshkit/utils/capture_output_methods.rb

@@ -0,0 +1,13 @@
+module SSHKit
+  module Utils
+    module CaptureOutputMethods
+      def <<(object)
+        if object.is_a?(SSHKit::Command) || object.is_a?(SSHKit::LogMessage)
+          super("#{object}\n")
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/sshkit.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = SSHKit::VERSION
 
-  gem.add_runtime_dependency('net-ssh')
+  gem.add_runtime_dependency('net-ssh', '>= 2.8.0')
   gem.add_runtime_dependency('net-scp', '>= 1.1.2')
   gem.add_runtime_dependency('term-ansicolor')
 

data/test/boxes.json

@@ -1,7 +1,10 @@
 [
   {
     "name": "one",
-    "port": 3001
+    "port": 3001,
+    "user": "vagrant",
+    "password": "vagrant",
+    "hostname": "localhost"
   },
   {
     "name": "two",

data/test/functional/backends/test_local.rb

@@ -23,7 +23,7 @@ module SSHKit
             execute :echo, "'Test capturing stderr' 1>&2; false"
           end.run
         end
-        assert_equal "echo stdout: Nothing written\necho stderr: Test capturing stderr\n", err.message
+        assert_equal "echo exit status: 256\necho stdout: Nothing written\necho stderr: Test capturing stderr\n", err.message
       end
 
       def test_test

data/test/functional/backends/test_netssh.rb

@@ -28,7 +28,7 @@ module SSHKit
       end
 
       def a_host
-        VagrantWrapper.hosts["one"]
+        VagrantWrapper.hosts['one']
       end
 
       def printer
@@ -54,11 +54,13 @@ module SSHKit
       def test_capture
         File.open('/dev/null', 'w') do |dnull|
           SSHKit.capture_output(dnull) do
-            captured_command_result = ""
+            captured_command_result = nil
             Netssh.new(a_host) do |host|
               captured_command_result = capture(:uname)
             end.run
-            assert_equal "Linux", captured_command_result
+
+            assert captured_command_result
+            assert_match captured_command_result, /Linux|Darwin/
           end
         end
       end
@@ -69,7 +71,7 @@ module SSHKit
             execute :echo, "'Test capturing stderr' 1>&2; false"
           end.run
         end
-        assert_equal "echo stdout: Nothing written\necho stderr: Test capturing stderr\n", err.message
+        assert_equal "echo exit status: 1\necho stdout: Nothing written\necho stderr: Test capturing stderr\n", err.message
       end
 
       def test_test_does_not_raise_on_non_zero_exit_status
@@ -130,7 +132,6 @@ module SSHKit
         end.run
         assert_equal File.open(file_name).read, file_contents
       end
-
     end
 
   end

data/test/functional/test_ssh_server_comes_up_for_functional_tests.rb

@@ -13,6 +13,7 @@ module SSHKit
     end
 
     def test_creating_a_user_gives_us_back_his_private_key_as_a_string
+      skip 'It is not safe to create an user for non vagrant envs' unless VagrantWrapper.running?
       keys = create_user_with_key(:peter)
       assert_equal [:one, :two, :three], keys.keys
       assert keys.values.all?

data/test/helper.rb

@@ -12,41 +12,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'sshkit'
 
-class VagrantWrapper
-  class << self
-    def hosts
-      @vm_hosts ||= begin
-        result = {}
-        boxes_list.each do |vm|
-          host = SSHKit::Host.new("vagrant@localhost:#{vm["port"]}").tap do |h|
-            h.password = 'vagrant'
-          end
-
-          result[vm["name"]] = host
-        end
-
-        result
-      end
-    end
-
-    def running?
-      @running ||= begin
-        status = `#{vagrant_binary} status`
-        status.include?('running')
-      end
-    end
-
-    def boxes_list
-      json_config_path = File.join("test", "boxes.json")
-      boxes = File.open(json_config_path).read
-      JSON.parse(boxes)
-    end
-
-    def vagrant_binary
-      'vagrant'
-    end
-  end
-end
+Dir[File.expand_path('test/support/*.rb')].each { |file| require file }
 
 class UnitTest < MiniTest::Unit::TestCase
 
@@ -54,13 +20,18 @@ class UnitTest < MiniTest::Unit::TestCase
     SSHKit.reset_configuration!
   end
 
+  SSHKit::Backend::ConnectionPool.class_eval do
+    def flush_connections
+      Thread.current[:sshkit_pool] = {}
+    end
+  end
 end
 
 class FunctionalTest < MiniTest::Unit::TestCase
 
   def setup
     unless VagrantWrapper.running?
-      raise "Vagrant VMs are not running. Please, start it manually with `vagrant up`"
+      warn "Vagrant VMs are not running. Please, start it manually with `vagrant up`"
     end
   end
 

data/test/support/vagrant_wrapper.rb

@@ -0,0 +1,56 @@
+class VagrantWrapper
+  class << self
+    def hosts
+      @vm_hosts ||= begin
+        result = {}
+
+        boxes = boxes_list
+
+        unless running?
+          boxes.map! do |box|
+            box['user'] = ENV['USER']
+            box['port'] = '22'
+            box
+          end
+        end
+
+        boxes.each do |vm|
+          result[vm['name']] = vm_host(vm)
+        end
+
+        result
+      end
+    end
+
+    def running?
+      @running ||= begin
+        status = `#{vagrant_binary} status`
+        status.include?('running')
+      end
+    end
+
+    def boxes_list
+      json_config_path = File.join('test', 'boxes.json')
+      boxes = File.open(json_config_path).read
+      JSON.parse(boxes)
+    end
+
+    def vagrant_binary
+      'vagrant'
+    end
+
+    private
+
+    def vm_host(vm)
+      host_options = {
+          user: vm['user'] || 'vagrant',
+          hostname: vm['hostname'] || 'localhost',
+          port: vm['port'] || '22'
+      }
+
+
+
+      SSHKit::Host.new(host_options)
+    end
+  end
+end

data/test/unit/backends/test_connection_pool.rb

@@ -39,7 +39,7 @@ module SSHKit
         assert_equal conn1, conn2
       end
 
-      def test_zero_idle_timeout_disables_resuse
+      def test_zero_idle_timeout_disables_reuse
         pool.idle_timeout = 0
 
         conn1 = pool.create_or_reuse_connection("conn", &connect)
@@ -59,6 +59,8 @@ module SSHKit
       end
 
       def test_closed_connection_is_not_reused
+        # Ensure there aren't any other open connections
+        pool.flush_connections()
         conn1 = pool.create_or_reuse_connection("conn", &connect_and_close)
         conn2 = pool.create_or_reuse_connection("conn", &connect)
 

data/test/unit/backends/test_local.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+module SSHKit
+  module Backend
+    class TestLocal < UnitTest
+
+      def local
+        @local ||= Local.new
+      end
+
+      def test_execute
+        assert_equal true, local.execute('uname -a')
+        assert_equal true, local.execute
+        assert_equal true, local.execute('cd && pwd')
+      end
+    end
+  end
+end

data/test/unit/backends/test_printer.rb

@@ -59,6 +59,12 @@ module SSHKit
         assert_equal false,                       backend.config.ssh_options[:forward_agent]
         assert_equal %w(publickey password),      backend.config.ssh_options[:auth_methods]
       end
+      
+      def test_invoke_raises_no_method_error
+        assert_raises NoMethodError do
+          printer.invoke :echo
+        end
+      end
 
     end
 

data/test/unit/test_command.rb

@@ -93,17 +93,22 @@ module SSHKit
 
     def test_backgrounding_a_task
       c = Command.new(:sleep, 15, run_in_background: true)
-      assert_equal "nohup /usr/bin/env sleep 15 > /dev/null &", c.to_command
+      assert_equal "( nohup /usr/bin/env sleep 15 > /dev/null & )", c.to_command
     end
 
     def test_backgrounding_a_task_as_a_given_user
       c = Command.new(:sleep, 15, run_in_background: true, user: :anotheruser)
-      assert_equal "sudo su anotheruser -c \"nohup /usr/bin/env sleep 15 > /dev/null &\"", c.to_command
+      assert_equal "sudo su anotheruser -c \"( nohup /usr/bin/env sleep 15 > /dev/null & )\"", c.to_command
     end
 
     def test_backgrounding_a_task_as_a_given_user_with_env
       c = Command.new(:sleep, 15, run_in_background: true, user: :anotheruser, env: {a: :b})
-      assert_equal "( A=b sudo su anotheruser -c \"nohup /usr/bin/env sleep 15 > /dev/null &\" )", c.to_command
+      assert_equal "( A=b sudo su anotheruser -c \"( nohup /usr/bin/env sleep 15 > /dev/null & )\" )", c.to_command
+    end
+
+    def test_backgrounding_a_task_with_working_directory
+      c = Command.new(:sleep, 15, run_in_background: true, in: '/opt')
+      assert_equal "cd /opt && ( nohup /usr/bin/env sleep 15 > /dev/null & )", c.to_command
     end
 
     def test_umask
@@ -205,7 +210,7 @@ module SSHKit
       error = assert_raises SSHKit::Command::Failed do
         Command.new(:whoami).exit_status = 1
       end
-      assert_equal "whoami stdout: Nothing written\nwhoami stderr: Nothing written\n", error.message
+      assert_equal "whoami exit status: 1\nwhoami stdout: Nothing written\nwhoami stderr: Nothing written\n", error.message
     end
 
   end

data/test/unit/test_command_map.rb

@@ -36,5 +36,21 @@ module SSHKit
       assert_equal map[:rake], "/home/vagrant/.rbenv/bin/rbenv exec bundle exec rake"
     end
 
+    def test_indifferent_setter
+      map = CommandMap.new
+      map[:rake] = "/usr/local/rbenv/shims/rake"
+      map["rake"] = "/usr/local/rbenv/shims/rake2"
+
+      assert_equal "/usr/local/rbenv/shims/rake2", map[:rake]
+    end
+
+    def test_indifferent_prefix
+      map = CommandMap.new
+      map.prefix[:rake].push("/home/vagrant/.rbenv/bin/rbenv exec")
+      map.prefix["rake"].push("bundle exec")
+
+      assert_equal map[:rake], "/home/vagrant/.rbenv/bin/rbenv exec bundle exec rake"
+    end
+    
   end
 end

data/test/unit/test_coordinator.rb

@@ -21,6 +21,12 @@ module SSHKit
       end
     end
 
+    def test_the_connection_manager_handles_empty_argument
+      Coordinator.new([]).each do
+        raise "This should not be executed"
+      end
+    end
+
     def test_connection_manager_handles_a_single_argument
       h = Host.new('1.example.com')
       Host.expects(:new).with('1.example.com').once().returns(h)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,7 @@ files:
 - lib/sshkit/formatters/black_hole.rb
 - lib/sshkit/formatters/dot.rb
 - lib/sshkit/formatters/pretty.rb
+- lib/sshkit/formatters/simple_text.rb
 - lib/sshkit/host.rb
 - lib/sshkit/log_message.rb
 - lib/sshkit/logger.rb
@@ -180,6 +181,7 @@ files:
 - lib/sshkit/runners/null.rb
 - lib/sshkit/runners/parallel.rb
 - lib/sshkit/runners/sequential.rb
+- lib/sshkit/utils/capture_output_methods.rb
 - lib/sshkit/version.rb
 - sshkit.gemspec
 - test/boxes.json
@@ -188,7 +190,9 @@ files:
 - test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
 - test/helper.rb
+- test/support/vagrant_wrapper.rb
 - test/unit/backends/test_connection_pool.rb
+- test/unit/backends/test_local.rb
 - test/unit/backends/test_netssh.rb
 - test/unit/backends/test_printer.rb
 - test/unit/core_ext/test_string.rb
@@ -231,7 +235,9 @@ test_files:
 - test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
 - test/helper.rb
+- test/support/vagrant_wrapper.rb
 - test/unit/backends/test_connection_pool.rb
+- test/unit/backends/test_local.rb
 - test/unit/backends/test_netssh.rb
 - test/unit/backends/test_printer.rb
 - test/unit/core_ext/test_string.rb