sshkit 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a17c8de5efa195cef64bac5bd868dce70e430939
-  data.tar.gz: 90f2200bf01fa80d3549ed747a4e8ef545806ffe
+  metadata.gz: 2be29e1ebec8acbfa5605fddeb959a1803f06581
+  data.tar.gz: 51115f162047ee443d2383e05d49851ae1e9b056
 SHA512:
-  metadata.gz: ce8989e38ff9dab3be7673183786c838ea9fa71d174dfec0c5ae0d812a47619fcc1a2b768939cb531b9cf8dbabd4993b3f46c60bee81d01c7aff9976d5b5d77f
-  data.tar.gz: 906b9b7317960551ed9b137f9cf1611e11821d3a042cc0d990853cedfbc5e970c1b4a4d1a92a0b4896b662e162395fc3244b91db8f29ba92a52a596c9145cc06
+  metadata.gz: 8f0e074042930ca893c2953712bce4abb47bc04387d98b0339aed07df8e2dfccef783ecaf6696b00d4d1d9c88b8d51bc6982fd9bc60aaa6343950e9da02a3260
+  data.tar.gz: 5bf7f417df04ab339fe70dcb12377b248cf2eef18bf9a881ea9e23dd7eb2d62b717f6f2713dd68878173aef4f50af6a3920624fc6986b5972bce1b79e4672e7e

data/.travis.yml

@@ -3,5 +3,4 @@ rvm:
   - 2.0.0
   - 1.9.3
   - 1.9.2
-  - rbx
 script: "rake test:units"

data/CHANGELOG.md

@@ -8,11 +8,28 @@ appear at the top.
   * Add your entries here, remember to credit yourself however you want to be
     credited!
 
+## 1.5.0
+
+  * Deprecate background helper - too many badly behaved pseudo-daemons. Lee Hambley
+  * Don't colourize unless $stdout is a tty. Lee Hambley
+  * Remove out of date "Known Issues" section from README. Lee Hambley
+  * Dealy variable interpolation inside `as()` block. Nick Townsend
+  * Fixes for functional tests under modern Vagrant. Lewis Marshal
+  * Fixes for connection pooling. Chris Heald
+  * Add `localhost` hostname to local backend. Adam Mckaig
+  * Wrap execptions to include hostname. Brecht Hoflack
+  * Remove `shellwords` stdlib dependency Bruno Sutic
+  * Remove unused `cooldown` accessor. Bruno Sutic
+  * Replace Term::ANSIColor with a lighter solution. Tom Clements
+  * Documentation fixes. Matt Brictson
+
 ## 1.4.0
 
+https://github.com/capistrano/sshkit/compare/v1.3.0...v1.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.
+  * Connection pooling now uses a thread local to store connection pool, giving each thread its own connection pool. Thank you @mbrictson 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.
@@ -20,6 +37,8 @@ appear at the top.
 
 ## 1.3.0
 
+https://github.com/capistrano/sshkit/compare/v1.2.0...v1.3.0
+
   * Connection pooling. SSH connections are reused across multiple invocations
     of `on()`, which can result in significant performance gains. See:
     https://github.com/capistrano/sshkit/pull/70. Matt @mbrictson Brictson.
@@ -30,6 +49,8 @@ appear at the top.
 
 ## 1.2.0
 
+https://github.com/capistrano/sshkit/compare/v1.1.0...v1.2.0
+
   * Support picking up a project local SSH config file, if a SSH config file
     exists at ./.ssh/config it will be merged with the ~/.ssh/config. This is
     ideal for defining project-local proxies/gateways, etc. Thanks to Alex
@@ -55,6 +76,8 @@ appear at the top.
 
 ## 1.1.0
 
+https://github.com/capistrano/sshkit/compare/v1.0.0...v1.1.0
+
   * Please see the Git history. `git rebase` ate our changelog (we should have been
     more careful)
 

data/EXAMPLES.md

@@ -158,25 +158,6 @@ leading slashes. It may be misleading as the `File.join()` is performed on the
 machine running the code, if that's a Windows box, the paths may be incorrectly
 joined according to the expectations of the machine receiving the commands.
 
-## Running a task in the background
-
-    on hosts do
-      within '/opt/sites/example.com' do
-        background :rails, :server
-      end
-    end
-
-This will run something like `nohup /usr/bin/env rails server > /dev/null &`,
-backgrounding the Rails process, and making sure we don't leave nohup log
-files littering the filesystem.
-
-**Note:** The `background()` method won't do what you expect if you pass a
-string `sleep 5`, according to the rules of processing commands, you must call
-`background(:sleep, "5")` (that is, command: sleep, args: 5).
-
-**Further Note:** The background() task wraps the given command in `nohup .... &` under some
-circumstances the program will hang anyway when the SSH session exits.
-
 ## Do not care about the host block
 
     on hosts do
@@ -217,7 +198,7 @@ circumstances the program will hang anyway when the SSH session exits.
       execute!(:echo, '"Example Message!" 1>&2; false')
     end
 
-This will raise `SSHKit::Command:Failed` with the `#message` "Example Message!"`
+This will raise `SSHKit::Command:Failed` with the `#message` "Example Message!"
 which will cause the command to abort.
 
 ## Make a test, or run a command which may fail without raising an error:

data/README.md

@@ -201,15 +201,15 @@ 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)
 
-By default, the output format is set to `:pretty`: 
+By default, the output format is set to `:pretty`:
 
 ```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. 
+However, if you prefer minimal output, `:dot` format will simply output red or green dots based on the success or failure of operations.
 
-To output directly to $stdout without any formatting, you can use: 
+To output directly to $stdout without any formatting, you can use:
 
 ```ruby
 SSHKit.config.output = $stdout
@@ -248,46 +248,3 @@ pooling behaviour entirely by setting the idle_timeout to zero:
 ```ruby
 SSHKit::Backend::Netssh.pool.idle_timeout = 0 # disabled
 ```
-
-## Known Issues
-
-* No handling of slow / timed out connections
-* No handling of slow / hung remote commands
-* ~~No built-in way to background() something (execute and background the
-  process).~~
-* No environment handling (sshkit might not need to care)
-* ~~No arbitrary `Host` properties (example storing `roles` on servers, or other
-  metadata that might be useful in the `on()` block)~~
-* ~~No log/warning facility (passing Log messages to the output would work)
-  A log object could be made available globally which would emit a LogMessage
-  type object which would be recognised by the formatters that need to care
-  about them.~~
-* ~~No verbosity control, commands should have a `Logger::LEVEL` on them,
-  user-generated should be at a high level, the commands auto-generated from
-  the guards and checks from as() and within() should have a lower level.~~
-* ~~Decide if `execute()` (and friends) should raise on non-zero exit statuses or
-  not, perhaps a family of similarly named bang methods should be the ones to
-  raise. (Perhaps `test()` should be a way to `execute()` without raising, and
-  `execute()` and friends should always raise)~~
-* ~~It would be nice to be able to say `SSHKit.config.formatter = :pretty` and
-  have that method setter do the legwork of updating `SSHKit.config.output` to
-  be an instance of the correct formatter class wrapping the existing output
-  stream.~~
-* No "trace" level debugging for internal stuff, the debug level should be
-  reserved for client-level debugging, with trace being (int -1) used
-  internally for logging about connection opening, closing, timing out, etc.
-* 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 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)
-* Wrap all commands in a known shell, that is that `execute('uptime')` should
-  be converted into `sh -c 'uptime'` to ensure that we have a consistent shell
-  experience.
-* ~~There's no suitable host parser that accepts `Host.new('user@ip:port')`, it
-  will decode a `user@hostname:port`, but IP addresses don't work.~~
-* If Net::SSH raises `IOError` (as it does when authentication fails) this
-  needs to be caught, and re-raised as some kind of ConnectionFailed error.

data/lib/sshkit.rb

@@ -3,7 +3,7 @@ module SSHKit
   StandardError = Class.new(::StandardError)
 
   class << self
-    
+
     attr_accessor :config
 
     def capture_output(io, &block)
@@ -27,7 +27,7 @@ module SSHKit
     def reset_configuration!
       @@config = nil
     end
-    
+
   end
 
 end

data/lib/sshkit/all.rb

@@ -3,11 +3,14 @@ require_relative '../core_ext/hash'
 
 require_relative 'host'
 
+require_relative 'color'
 require_relative 'command'
 require_relative 'command_map'
 require_relative 'configuration'
 require_relative 'coordinator'
 
+require_relative 'exception'
+
 require_relative 'logger'
 require_relative 'log_message'
 

data/lib/sshkit/backends/abstract.rb

@@ -54,10 +54,6 @@ module SSHKit
         raise MethodUnavailableError
       end
 
-      def background(command, args=[])
-        raise MethodUnavailableError
-      end
-
       def test(command, args=[])
         raise MethodUnavailableError
       end

data/lib/sshkit/backends/connection_pool.rb

@@ -1,4 +1,4 @@
-require "monitor"
+require "thread"
 
 module SSHKit
 
@@ -10,47 +10,53 @@ module SSHKit
 
       def initialize
         self.idle_timeout = 30
-        @monitor = Monitor.new
+        @mutex = Mutex.new
+        @pool = {}
       end
 
-      def create_or_reuse_connection(*new_connection_args, &block)
+      def checkout(*new_connection_args, &block)
         # Optimization: completely bypass the pool if idle_timeout is zero.
-        return yield(*new_connection_args) if idle_timeout == 0
-
         key = new_connection_args.to_s
-        entry = find_and_reject_invalid(key) { |e| e.expired? || e.closed? }
+        return create_new_entry(new_connection_args, key, &block) if idle_timeout == 0
 
-        if entry.nil?
-          entry = store_entry(key, yield(*new_connection_args))
-        end
+        find_live_entry(key) || create_new_entry(new_connection_args, key, &block)
+      end
 
+      def checkin(entry)
         entry.expires_at = Time.now + idle_timeout if idle_timeout
-        entry.connection
+        @mutex.synchronize do
+          @pool[entry.key] ||= []
+          @pool[entry.key] << entry
+        end
       end
 
-      private
-
-      def connections
-        Thread.current[:sshkit_pool] ||= {}
+      def flush_connections
+        @mutex.synchronize { @pool.clear }
       end
 
-      def find_and_reject_invalid(key, &block)
-        entry = connections[key]
-        invalid = entry && yield(entry)
-
-        connections.delete(entry) if invalid
+      private
 
-        invalid ? nil : entry
+      def find_live_entry(key)
+        @mutex.synchronize do
+          return nil unless @pool.key?(key)
+          while entry = @pool[key].shift
+            return entry if entry.live?
+          end
+        end
+        nil
       end
 
-      def store_entry(key, connection)
-        connections[key] = Entry.new(connection)
+      def create_new_entry(args, key, &block)
+        Entry.new block.call(*args), key
       end
 
-
-      Entry = Struct.new(:connection) do
+      Entry = Struct.new(:connection, :key) do
         attr_accessor :expires_at
 
+        def live?
+          !expired? && !closed?
+        end
+
         def expired?
           expires_at && Time.now > expires_at
         end
@@ -61,6 +67,5 @@ module SSHKit
       end
 
     end
-
   end
 end

data/lib/sshkit/backends/local.rb

@@ -6,6 +6,7 @@ module SSHKit
     class Local < Printer
 
       def initialize(&block)
+        @host = Host.new(hostname: 'localhost') # just for logging
         @block = block
       end
 

data/lib/sshkit/backends/netssh.rb

@@ -67,6 +67,7 @@ module SSHKit
       end
 
       def background(*args)
+        warn "[Deprecated] The background method is deprecated. Blame badly behaved pseudo-daemons!"
         options = args.extract_options!.merge(run_in_background: true)
         _execute(*[*args, options]).success?
       end
@@ -78,12 +79,16 @@ module SSHKit
 
       def upload!(local, remote, options = {})
         summarizer = transfer_summarizer('Uploading')
-        ssh.scp.upload!(local, remote, options, &summarizer)
+        with_ssh do |ssh|
+          ssh.scp.upload!(local, remote, options, &summarizer)
+        end
       end
 
       def download!(remote, local=nil, options = {})
         summarizer = transfer_summarizer('Downloading')
-        ssh.scp.download!(remote, local, options, &summarizer)
+        with_ssh do |ssh|
+          ssh.scp.download!(remote, local, options, &summarizer)
+        end
       end
 
       @pool = SSHKit::Backend::ConnectionPool.new
@@ -123,59 +128,64 @@ module SSHKit
         command(*args).tap do |cmd|
           output << cmd
           cmd.started = true
-          ssh.open_channel do |chan|
-            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.full_stdout += data
-                output << cmd
-              end
-              chan.on_extended_data do |ch, type, data|
-                cmd.stderr = data
-                cmd.full_stderr += data
-                output << cmd
-              end
-              chan.on_request("exit-status") do |ch, data|
-                cmd.stdout = ''
-                cmd.stderr = ''
-                cmd.exit_status = data.read_long
-                output << cmd
-              end
-              #chan.on_request("exit-signal") do |ch, data|
-              #  # TODO: This gets called if the program is killed by a signal
-              #  # might also be a worthwhile thing to report
-              #  exit_signal = data.read_string.to_i
-              #  warn ">>> " + exit_signal.inspect
-              #  output << cmd
-              #end
-              chan.on_open_failed do |ch|
-                # TODO: What do do here?
-                # I think we should raise something
-              end
-              chan.on_process do |ch|
-                # TODO: I don't know if this is useful
-              end
-              chan.on_eof do |ch|
-                # TODO: chan sends EOF before the exit status has been
-                # writtend
+          with_ssh do |ssh|
+            ssh.open_channel do |chan|
+              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.full_stdout += data
+                  output << cmd
+                end
+                chan.on_extended_data do |ch, type, data|
+                  cmd.stderr = data
+                  cmd.full_stderr += data
+                  output << cmd
+                end
+                chan.on_request("exit-status") do |ch, data|
+                  cmd.stdout = ''
+                  cmd.stderr = ''
+                  cmd.exit_status = data.read_long
+                  output << cmd
+                end
+                #chan.on_request("exit-signal") do |ch, data|
+                #  # TODO: This gets called if the program is killed by a signal
+                #  # might also be a worthwhile thing to report
+                #  exit_signal = data.read_string.to_i
+                #  warn ">>> " + exit_signal.inspect
+                #  output << cmd
+                #end
+                chan.on_open_failed do |ch|
+                  # TODO: What do do here?
+                  # I think we should raise something
+                end
+                chan.on_process do |ch|
+                  # TODO: I don't know if this is useful
+                end
+                chan.on_eof do |ch|
+                  # TODO: chan sends EOF before the exit status has been
+                  # writtend
+                end
               end
+              chan.wait
             end
-            chan.wait
+            ssh.loop
           end
-          ssh.loop
         end
       end
 
-      def ssh
-        @ssh ||= begin
-          host.ssh_options ||= Netssh.config.ssh_options
-          self.class.pool.create_or_reuse_connection(
-            String(host.hostname),
-            host.username,
-            host.netssh_options,
-            &Net::SSH.method(:start)
-          )
+      def with_ssh
+        host.ssh_options ||= Netssh.config.ssh_options
+        conn = self.class.pool.checkout(
+          String(host.hostname),
+          host.username,
+          host.netssh_options,
+          &Net::SSH.method(:start)
+        )
+        begin
+          yield conn.connection
+        ensure
+          self.class.pool.checkin conn
         end
       end
 

data/lib/sshkit/color.rb

@@ -0,0 +1,13 @@
+require 'colorize'
+module Color
+  STYLES = [String::COLORS, String::MODES].flat_map(&:keys)
+
+  STYLES.each do |style|
+    instance_eval %{
+    def #{style}(string='')
+      string = yield if block_given?
+      $stdout.tty? ? string.colorize(:#{style}) : string
+    end
+    }
+  end
+end

data/lib/sshkit/command.rb

@@ -1,4 +1,3 @@
-require 'shellwords'
 require 'digest/sha1'
 require 'securerandom'
 
@@ -164,7 +163,7 @@ module SSHKit
 
     def user(&block)
       return yield unless options[:user]
-      "sudo su #{options[:user]} -c \"%s\"" % %Q{#{yield}}
+      "sudo su #{options[:user]} -c '%s'" % %Q{#{yield}}
     end
 
     def in_background(&block)

data/lib/sshkit/coordinator.rb

@@ -26,8 +26,6 @@ module SSHKit
 
     private
 
-      attr_accessor :cooldown
-
       def default_options
         { in: :parallel }
       end

data/lib/sshkit/exception.rb

@@ -0,0 +1,21 @@
+module SSHKit
+
+    module Runner
+
+        class ExecuteError < StandardError
+          attr_reader :cause
+
+          def initialize cause
+            @cause = cause
+          end
+
+          def backtrace
+            @cause.backtrace
+          end
+ 
+          def backtrace_locations
+            @cause.backtrace_locations
+          end
+        end
+    end
+end

data/lib/sshkit/formatters/dot.rb

@@ -1,5 +1,3 @@
-require 'term/ansicolor'
-
 module SSHKit
 
   module Formatter
@@ -17,7 +15,7 @@ module SSHKit
       private
 
       def c
-        @c ||= Term::ANSIColor
+        @c ||= Color
       end
 
     end

data/lib/sshkit/formatters/pretty.rb

@@ -1,5 +1,3 @@
-require 'term/ansicolor'
-
 module SSHKit
 
   module Formatter
@@ -53,7 +51,7 @@ module SSHKit
       end
 
       def c
-        @c ||= Term::ANSIColor
+        @c ||= Color
       end
 
       def uuid(obj)
@@ -61,9 +59,7 @@ module SSHKit
       end
 
       def level(verbosity)
-        # Insane number here accounts for the control codes added
-        # by term-ansicolor
-        sprintf "%14s ", c.send(level_formatting(verbosity), level_names(verbosity))
+        c.send(level_formatting(verbosity), level_names(verbosity))
       end
 
       def level_formatting(level_num)

data/lib/sshkit/runners/parallel.rb

@@ -9,7 +9,12 @@ module SSHKit
         threads = []
         hosts.each do |host|
           threads << Thread.new(host) do |h|
-            backend(h, &block).run
+            begin
+              backend(h, &block).run
+            rescue Exception => e
+              e2 = ExecuteError.new e
+              raise e2, "Exception while executing on host #{host}: #{e.message}" 
+            end
           end
         end
         threads.map(&:join)

data/lib/sshkit/runners/sequential.rb

@@ -6,7 +6,12 @@ module SSHKit
       attr_writer :wait_interval
       def execute
         hosts.each do |host|
-          backend(host, &block).run
+          begin
+            backend(host, &block).run
+          rescue Exception => e
+            e2 = ExecuteError.new e
+            raise e2, "Exception while executing on host #{host}: #{e.message}" 
+          end
           sleep wait_interval
         end
       end

data/lib/sshkit/version.rb

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

data/sshkit.gemspec

@@ -19,12 +19,11 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency('net-ssh', '>= 2.8.0')
   gem.add_runtime_dependency('net-scp', '>= 1.1.2')
-  gem.add_runtime_dependency('term-ansicolor')
+  gem.add_runtime_dependency('colorize')
 
   gem.add_development_dependency('minitest', ['>= 2.11.3', '< 2.12.0'])
   gem.add_development_dependency('rake')
   gem.add_development_dependency('turn')
   gem.add_development_dependency('unindent')
   gem.add_development_dependency('mocha')
-
 end

data/test/functional/backends/test_netssh.rb

@@ -80,21 +80,6 @@ module SSHKit
         end.run
       end
 
-      def test_backgrounding_a_process
-        #SSHKit.config.output = SSHKit::Formatter::Pretty.new($stdout)
-        process_list = ""
-        time = Benchmark.measure do
-          Netssh.new(a_host) do
-            background :sleep, 5
-          end.run
-          Netssh.new(a_host) do
-            process_list = capture :ps, "aux | grep sleep | grep -v grep; true"
-          end.run
-        end
-        assert_operator time.real, :<, 1
-        assert_match "sleep 5", process_list
-      end
-
       def test_upload_file
         file_contents = ""
         file_name = File.join("/tmp", SecureRandom.uuid)

data/test/support/vagrant_wrapper.rb

@@ -45,11 +45,10 @@ class VagrantWrapper
       host_options = {
           user: vm['user'] || 'vagrant',
           hostname: vm['hostname'] || 'localhost',
-          port: vm['port'] || '22'
+          port: vm['port'] || '22',
+          password: vm['password'] || 'vagrant'
       }
 
-
-
       SSHKit::Host.new(host_options)
     end
   end

data/test/unit/backends/test_connection_pool.rb

@@ -5,6 +5,10 @@ module SSHKit
   module Backend
     class TestConnectionPool < UnitTest
 
+      def setup
+        pool.flush_connections
+      end
+
       def pool
         @pool ||= SSHKit::Backend::ConnectionPool.new
       end
@@ -27,23 +31,54 @@ module SSHKit
 
       def test_connection_factory_receives_args
         args = %w(a b c)
-        conn = pool.create_or_reuse_connection(*args, &echo_args)
+        conn = pool.checkout(*args, &echo_args)
 
-        assert_equal args, conn
+        assert_equal args, conn.connection
       end
 
-      def test_connections_are_reused
-        conn1 = pool.create_or_reuse_connection("conn", &connect)
-        conn2 = pool.create_or_reuse_connection("conn", &connect)
+      def test_connections_are_not_reused_if_not_checked_in
+        conn1 = pool.checkout("conn", &connect)
+        conn2 = pool.checkout("conn", &connect)
+
+        refute_equal conn1, conn2
+      end
+
+      def test_connections_are_reused_if_checked_in
+        conn1 = pool.checkout("conn", &connect)
+        pool.checkin conn1
+        conn2 = pool.checkout("conn", &connect)
 
         assert_equal conn1, conn2
       end
 
+      def test_connections_are_reused_across_threads_multiple_times
+        t1 = Thread.new {
+          Thread.current[:conn] = pool.checkout("conn", &connect)
+          pool.checkin Thread.current[:conn]
+        }.join
+
+        t2 = Thread.new {
+          Thread.current[:conn] = pool.checkout("conn", &connect)
+          pool.checkin Thread.current[:conn]
+        }.join
+
+        t3 = Thread.new {
+          Thread.current[:conn] = pool.checkout("conn", &connect)
+          pool.checkin Thread.current[:conn]
+        }.join
+
+        refute_equal t1[:conn], nil
+        assert_equal t1[:conn], t2[:conn]
+        assert_equal t2[:conn], t3[:conn]
+      end
+
       def test_zero_idle_timeout_disables_reuse
         pool.idle_timeout = 0
 
-        conn1 = pool.create_or_reuse_connection("conn", &connect)
-        conn2 = pool.create_or_reuse_connection("conn", &connect)
+        conn1 = pool.checkout("conn", &connect)
+        pool.checkin conn1
+
+        conn2 = pool.checkout("conn", &connect)
 
         refute_equal conn1, conn2
       end
@@ -51,25 +86,26 @@ module SSHKit
       def test_expired_connection_is_not_reused
         pool.idle_timeout = 0.1
 
-        conn1 = pool.create_or_reuse_connection("conn", &connect)
+        conn1 = pool.checkout("conn", &connect)
+        pool.checkin conn1
         sleep(pool.idle_timeout)
-        conn2 = pool.create_or_reuse_connection("conn", &connect)
+        conn2 = pool.checkout("conn", &connect)
 
         refute_equal conn1, conn2
       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)
+        conn1 = pool.checkout("conn", &connect_and_close)
+        pool.checkin conn1
+        conn2 = pool.checkout("conn", &connect)
 
         refute_equal conn1, conn2
       end
 
       def test_connections_with_different_args_are_not_reused
-        conn1 = pool.create_or_reuse_connection("conn1", &connect)
-        conn2 = pool.create_or_reuse_connection("conn2", &connect)
+        conn1 = pool.checkout("conn1", &connect)
+        pool.checkin conn1
+        conn2 = pool.checkout("conn2", &connect)
 
         refute_equal conn1, conn2
       end

data/test/unit/backends/test_local.rb

@@ -8,6 +8,10 @@ module SSHKit
         @local ||= Local.new
       end
 
+      def test_host
+        assert_equal 'localhost', local.host.to_s
+      end
+
       def test_execute
         assert_equal true, local.execute('uname -a')
         assert_equal true, local.execute

data/test/unit/backends/test_printer.rb

@@ -59,7 +59,7 @@ 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

data/test/unit/core_ext/test_string.rb

@@ -1,9 +1,9 @@
 class String
 
   def unindent
-    indent = self.split("\n").select do |line| 
+    indent = self.split("\n").select do |line|
       !line.strip.empty?
-    end.map do |line| 
+    end.map do |line|
       line.index(/[^\s]/)
     end.compact.min || 0
     self.gsub(/^[[:blank:]]{#{indent}}/, '')

data/test/unit/formatters/test_dot.rb

@@ -46,19 +46,19 @@ module SSHKit
       dot << SSHKit::LogMessage.new(Logger::DEBUG, "Test")
       assert_equal "", output.strip
     end
-    
+
     def test_command_success
       command = SSHKit::Command.new(:ls)
       command.exit_status = 0
       dot << command
-      assert_equal "\e[32m.\e[0m", output.strip
+      assert_equal "\e[0;32;49m.\e[0m", output.strip
     end
-    
+
     def test_command_failure
       command = SSHKit::Command.new(:ls, {raise_on_non_zero_exit: false})
       command.exit_status = 1
       dot << command
-      assert_equal "\e[31m.\e[0m", output.strip
+      assert_equal "\e[0;31;49m.\e[0m", output.strip
     end
 
   end

data/test/unit/formatters/test_pretty.rb

@@ -24,27 +24,27 @@ module SSHKit
 
     def test_logging_fatal
       pretty << SSHKit::LogMessage.new(Logger::FATAL, "Test")
-      assert_equal output.strip, " \e[31mFATAL\e[0m Test \n".strip
+      assert_equal output.strip, "\e[0;31;49mFATAL\e[0mTest"
     end
 
     def test_logging_error
       pretty << SSHKit::LogMessage.new(Logger::ERROR, "Test")
-      assert_equal output.strip, " \e[31mERROR\e[0m Test \n".strip
+      assert_equal output.strip, "\e[0;31;49mERROR\e[0mTest"
     end
 
     def test_logging_warn
       pretty << SSHKit::LogMessage.new(Logger::WARN, "Test")
-      assert_equal output.strip, " \e[33mWARN\e[0m Test \n".strip
+      assert_equal output.strip, "\e[0;33;49mWARN\e[0mTest".strip
     end
 
     def test_logging_info
       pretty << SSHKit::LogMessage.new(Logger::INFO, "Test")
-      assert_equal output.strip, " \e[34mINFO\e[0m Test \n".strip
+      assert_equal output.strip, "\e[0;34;49mINFO\e[0mTest".strip
     end
 
     def test_logging_debug
       pretty << SSHKit::LogMessage.new(Logger::DEBUG, "Test")
-      assert_equal output.strip, " \e[30mDEBUG\e[0m Test \n".strip
+      assert_equal output.strip, "\e[0;30;49mDEBUG\e[0mTest".strip
     end
 
   end

data/test/unit/test_command.rb

@@ -78,7 +78,7 @@ module SSHKit
 
     def test_working_as_a_given_user
       c = Command.new(:whoami, user: :anotheruser)
-      assert_equal "sudo su anotheruser -c \"/usr/bin/env whoami\"", c.to_command
+      assert_equal "sudo su anotheruser -c '/usr/bin/env whoami'", c.to_command
     end
 
     def test_working_as_a_given_group
@@ -88,27 +88,7 @@ module SSHKit
 
     def test_working_as_a_given_user_and_group
       c = Command.new(:whoami, user: :anotheruser, group: :devvers)
-      assert_equal "sudo su anotheruser -c \"sg devvers -c \\\"/usr/bin/env whoami\\\"\"", c.to_command
-    end
-
-    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
-    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
-    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
-    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
+      assert_equal "sudo su anotheruser -c 'sg devvers -c \\\"/usr/bin/env whoami\\\"'", c.to_command
     end
 
     def test_umask
@@ -126,13 +106,13 @@ module SSHKit
     def test_umask_with_working_directory_and_user
       SSHKit.config.umask = '007'
       c = Command.new(:touch, 'somefile', in: '/var', user: 'alice')
-      assert_equal "cd /var && umask 007 && sudo su alice -c \"/usr/bin/env touch somefile\"", c.to_command
+      assert_equal "cd /var && umask 007 && sudo su alice -c '/usr/bin/env touch somefile'", c.to_command
     end
 
     def test_umask_with_env_and_working_directory_and_user
       SSHKit.config.umask = '007'
       c = Command.new(:touch, 'somefile', user: 'bob', env: {a: 'b'}, in: '/var')
-      assert_equal "cd /var && umask 007 && ( A=b sudo su bob -c \"/usr/bin/env touch somefile\" )", c.to_command
+      assert_equal "cd /var && umask 007 && ( A=b sudo su bob -c '/usr/bin/env touch somefile' )", c.to_command
     end
 
     def test_verbosity_defaults_to_logger_info

data/test/unit/test_command_map.rb

@@ -51,6 +51,6 @@ module SSHKit
 
       assert_equal map[:rake], "/home/vagrant/.rbenv/bin/rbenv exec bundle exec rake"
     end
-    
+
   end
 end

data/test/unit/test_configuration.rb

@@ -55,7 +55,7 @@ module SSHKit
       assert SSHKit.config.format = :dot
       assert SSHKit.config.output.is_a? SSHKit::Formatter::Dot
     end
-    
+
     def test_setting_formatter_to_blackhole
       assert SSHKit.config.format = :BlackHole
       assert SSHKit.config.output.is_a? SSHKit::Formatter::BlackHole

data/test/unit/test_coordinator.rb

@@ -83,8 +83,8 @@ module SSHKit
             1.example.com
             2.example.com
             3.example.com
-            4.example.com 
-            5.example.com 
+            4.example.com
+            5.example.com
             6.example.com
           }
         ).each in: :groups, &block_to_run

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.2
 - !ruby/object:Gem::Dependency
-  name: term-ansicolor
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -163,11 +163,13 @@ files:
 - lib/sshkit/backends/netssh.rb
 - lib/sshkit/backends/printer.rb
 - lib/sshkit/backends/skipper.rb
+- lib/sshkit/color.rb
 - lib/sshkit/command.rb
 - lib/sshkit/command_map.rb
 - lib/sshkit/configuration.rb
 - lib/sshkit/coordinator.rb
 - lib/sshkit/dsl.rb
+- lib/sshkit/exception.rb
 - lib/sshkit/formatters/abstract.rb
 - lib/sshkit/formatters/black_hole.rb
 - lib/sshkit/formatters/dot.rb