sshkit 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3898c2edc5a5a2dc313f80f0170c5511f67358ee
-  data.tar.gz: 2d9a40af7ea3e3f862d68c5bdc9b892f848cbbc6
+  metadata.gz: 6cd81576d8df6878627ee2ca1b298c2079698085
+  data.tar.gz: 9676306af0f0de95b974134d580fed271486004f
 SHA512:
-  metadata.gz: 4d04c3dec016fdb417fb550b5f3a4d247a1d1165867e60457b5cf652d2a8b6660721a9e703442ba611c57397b1b85133ccb16b4c539f051cd9e3f251bed120e7
-  data.tar.gz: 7389b19eb7a6f724207d5f00b889ff3ea93f1b70b48f02a4dc9a705d1d4563c3d4f09e510bf0b6f4791a33ccf8b6dc8b2c9eab37627c389ff7ab723c6d5a4b0a
+  metadata.gz: 4a0cfdd77807a8e280376f8f5a07b0f7bac96339091c67bb2c3e7e2424247e192436451ca189772352095f9132afc57e7c660381180812ca315c2ad0715e58f4
+  data.tar.gz: 0e4037910686419d816927cddae4a065021c8e7ebae2530c55d62ea299414310e1bb9fcb44fd88dabde85de069667e537aec5a4ff2dc5f9dff55cf9bc0bc592f

data/.gitignore

@@ -1,5 +1,5 @@
 *.gem
 .yardoc
-.vagrant
+.vagrant*
 test/tmp
 Gemfile.lock

data/.travis.yml

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

data/CHANGELOG.md

@@ -3,29 +3,44 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## (Unreleased)
+
+  * Add your entries here, remember to credit yourself however you want to be
+    credited!
+
+## 1.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.
+  * Fixes to the Formatter::Dot and to the formatter class name resolver. @hab287:w
+  * Added the license to the Gemspec. @anatol.
+  * Fix :limit handling for the `in: :groups` run mode. Phil @phs Smith
+  * Doc fixes @seanhandley, @sergey-alekseev.
+
 ## 1.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 
+    ideal for defining project-local proxies/gateways, etc. Thanks to Alex
     @0rca Vzorov.
-  * Tests and general improvements to the Printer backends (mostly used 
+  * Tests and general improvements to the Printer backends (mostly used
     internally). Thanks to Michael @miry Nikitochkin.
-  * Update the net-scp dependency version. Thanks again to Michael @miry 
+  * Update the net-scp dependency version. Thanks again to Michael @miry
     Nikitochkin.
   * Improved command map. This feature allows mapped variables to be pushed
     and unshifted onto the mapping so that the Capistrano extensions for
     rbenv and bundler, etc can work together. For discussion about the reasoning
-    see https://github.com/capistrano/capistrano/issues/639 and 
+    see https://github.com/capistrano/capistrano/issues/639 and
     https://github.com/capistrano/sshkit/pull/45. A big thanks to Kir @kirs
     Shatrov.
   * `test()` and `capture()` now behave as expected inside a `run_locally` block
     meaning that they now run on your local machine, rather than erring out. Thanks
     to Kentaro @kentaroi Imai.
-  * The `:wait` option is now successfully passed to the runner now. Previously the 
+  * The `:wait` option is now successfully passed to the runner now. Previously the
     `:wait` option was ignored. Thanks to Jordan @jhollinger Hollinger for catching
     the mistake in our test coverage.
-  * Fixes and general improvements to the `download()` method which until now was 
+  * Fixes and general improvements to the `download()` method which until now was
     quite naïve. Thanks to @chqr.
 
 ## 1.1.0

data/FAQ.md

@@ -5,7 +5,7 @@ a toolkit for performing structured commands on groups of servers in a
 repeatable way.
 
 It provides concurrency handling, sane error checking and control flow that
-would otherwise be difficult to achive with pure *Net::SSH*.
+would otherwise be difficult to achieve with pure *Net::SSH*.
 
 Since *Capistrano v3.0*, *SSHKit* is used by *Capistrano* to communicate with
 backend servers. Whilst Capistrano provides the structure for repeatable
@@ -24,7 +24,7 @@ descriptors which no longer exist.
 
 The following resources are worth a read to better understand what a process
 must do in order to daemonize reliably, not all processes perform all of the
-steps necassary:
+steps necessary:
 
 * [http://stackoverflow.com/questions/881388/what-is-the-reason-for-performing-a-double-fork-when-creating-a-daemon]
 

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
 gemspec
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubysl-json'
+end

data/README.md

@@ -55,13 +55,13 @@ 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, limit: 2) { ...}
+    on(in: :parallel) { ... }
     on(in: :sequence, wait: 5) { ... }
     on(in: :groups, limit: 2, wait: 5) { ... }
 
-The default is to run `in: :parallel` with no limit, if you have 400 servers,
-this might be a problem, and you might better look at changing that to run in
-groups, or sequence.
+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
+`groups`, or `sequence`.
 
 Groups were designed in this case to relieve problems (mass Git checkouts)
 where you rely on a contested resource that you don't want to DDOS by hitting
@@ -194,6 +194,29 @@ and defaults to `Logger::INFO`.
 
 At present the `Logger::WARN`, `ERROR` and `FATAL` are not used.
 
+## Connection Pooling
+
+SSHKit uses a simple connection pool (enabled by default) to reduce the
+cost of negotiating a new SSH connection for every `on()` block. Depending on
+usage and network conditions, this can add up to a significant time savings.
+In one test, a basic `cap deploy` ran 15-20 seconds faster thanks to the
+connection pooling added in recent versions of SSHKit.
+
+To prevent connections from "going stale", an existing pooled connection will
+be replaced with a new connection if it hasn't been used for more than 30
+seconds. This timeout can be changed as follows:
+
+```ruby
+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:
+
+```ruby
+SSHKit::Backend::Netssh.pool.idle_timeout = 0 # disabled
+```
+
 ## Known Issues
 
 * No handling of slow / timed out connections
@@ -225,14 +248,14 @@ At present the `Logger::WARN`, `ERROR` and `FATAL` are not used.
   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
+* ~~No conncetion 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.
+  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.
+* ~~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/Rakefile

@@ -1,6 +1,5 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-require 'debugger'
 require 'rake/testtask'
 
 namespace :test do
@@ -15,15 +14,9 @@ namespace :test do
     t.test_files = FileList['test/functional/**/test*.rb']
   end
 
-  Rake::TestTask.new(:integration) do |t|
-    t.libs << "test"
-    t.test_files = FileList['test/integration/**/test*.rb']
-  end
-
   task :test do
     Rake::Task['test:units'].execute
-    Rake::Task['test:integration'].execute
-    Rake::Task['test:functional'].execute unless ENV['TRAVIS']
+    Rake::Task['test:functional'].execute
   end
 
   task default: :test

data/Vagrantfile

@@ -1,19 +1,17 @@
-#
-# vi: set ft=ruby
-#
+VAGRANTFILE_API_VERSION = "2"
 
-Vagrant::Config.run do |config|
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = 'precise64'
+  config.vm.box_url = "http://cloud-images.ubuntu.com/vagrant/precise/current/precise-server-cloudimg-amd64-vagrant-disk1.box"
 
-  config.vm.define :one do |one|
-    one.vm.box = "precise64"
-  end
-
-  config.vm.define :two do |one|
-    one.vm.box = "precise64"
-  end
+  json_config_path = File.join("test", "boxes.json")
+  list = File.open(json_config_path).read
+  list = JSON.parse(list)
 
-  config.vm.define :three do |one|
-    one.vm.box = "precise64"
+  list.each do |vm|
+    config.vm.define vm["name"] do |web|
+      web.vm.box = "precise64"
+      web.vm.network "forwarded_port", guest: 22, host: vm["port"]
+    end
   end
-
 end

data/lib/sshkit/all.rb

@@ -23,6 +23,7 @@ require_relative 'runners/group'
 require_relative 'runners/null'
 
 require_relative 'backends/abstract'
+require_relative 'backends/connection_pool'
 require_relative 'backends/printer'
 require_relative 'backends/netssh'
 require_relative 'backends/local'

data/lib/sshkit/backends/abstract.rb

@@ -129,10 +129,6 @@ module SSHKit
         SSHKit::Command.new(*[*args, options.merge({in: @pwd.nil? ? nil : File.join(@pwd), env: @env, host: @host, user: @user, group: @group})])
       end
 
-      def connection
-        raise "No Connection Pool Implementation"
-      end
-
     end
 
   end

data/lib/sshkit/backends/connection_pool.rb

@@ -0,0 +1,71 @@
+require "monitor"
+
+module SSHKit
+
+  module Backend
+
+    class ConnectionPool
+
+      attr_accessor :idle_timeout
+
+      def initialize
+        self.idle_timeout = 30
+        @connections = {}
+        @monitor = Monitor.new
+      end
+
+      def create_or_reuse_connection(*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? }
+
+        if entry.nil?
+          entry = store_entry(key, yield(*new_connection_args))
+        end
+
+        entry.expires_at = Time.now + idle_timeout if idle_timeout
+        entry.connection
+      end
+
+      private
+
+      def find_and_reject_invalid(key, &block)
+        synchronize do
+          entry = @connections[key]
+          invalid = entry && yield(entry)
+
+          @connections.delete(entry) if invalid
+
+          invalid ? nil : entry
+        end
+      end
+
+      def store_entry(key, connection)
+        synchronize do
+          @connections[key] = Entry.new(connection)
+        end
+      end
+
+      def synchronize(&block)
+        @monitor.synchronize(&block)
+      end
+
+
+      Entry = Struct.new(:connection) do
+        attr_accessor :expires_at
+
+        def expired?
+          expires_at && Time.now > expires_at
+        end
+
+        def closed?
+          connection.respond_to?(:closed?) && connection.closed?
+        end
+      end
+
+    end
+
+  end
+end

data/lib/sshkit/backends/netssh.rb

@@ -86,7 +86,11 @@ module SSHKit
         ssh.scp.download!(remote, local, options, &summarizer)
       end
 
+      @pool = SSHKit::Backend::ConnectionPool.new
+
       class << self
+        attr_accessor :pool
+
         def configure
           yield config
         end
@@ -166,10 +170,11 @@ module SSHKit
       def ssh
         @ssh ||= begin
           host.ssh_options ||= Netssh.config.ssh_options
-          Net::SSH.start(
+          self.class.pool.create_or_reuse_connection(
             String(host.hostname),
             host.username,
-            host.netssh_options
+            host.netssh_options,
+            &Net::SSH.method(:start)
           )
         end
       end

data/lib/sshkit/configuration.rb

@@ -44,7 +44,9 @@ module SSHKit
     end
 
     def formatter(format)
-      SSHKit::Formatter.const_get(format.capitalize).new($stdout)
+      SSHKit::Formatter.constants.each do |const|
+        return SSHKit::Formatter.const_get(const).new($stdout) if const.downcase.eql?(format.downcase)
+      end
     end
 
   end

data/lib/sshkit/formatters/dot.rb

@@ -7,7 +7,7 @@ module SSHKit
     class Dot < Abstract
 
       def write(obj)
-        return unless obj === SSHKit::Command
+        return unless obj.is_a? SSHKit::Command
         if obj.finished?
           original_output << (obj.failure? ? c.red('.') : c.green('.'))
         end

data/lib/sshkit/runners/group.rb

@@ -12,7 +12,7 @@ module SSHKit
       end
       private
       def group_size
-        @group_size ||= 2
+        @group_size || options[:limit] || 2
       end
     end
 

data/lib/sshkit/version.rb

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

data/sshkit.gemspec

@@ -7,7 +7,8 @@ Gem::Specification.new do |gem|
   gem.email         = ["lee.hambley@gmail.com", "seenmyfate@gmail.com"]
   gem.summary       = %q{SSHKit makes it easy to write structured, testable SSH commands in Ruby}
   gem.description   = %q{A comprehensive toolkit for remotely running commands in a structured manner on groups of servers.}
-  gem.homepage      = "http://wacku.github.com/sshkit"
+  gem.homepage      = "http://github.com/capistrano/sshkit"
+  gem.license       = "GPL3"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
@@ -25,10 +26,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('turn')
   gem.add_development_dependency('unindent')
   gem.add_development_dependency('mocha')
-  gem.add_development_dependency('debugger')
-  gem.add_development_dependency('vagrant')
-
-  gem.add_development_dependency('yard')
-  gem.add_development_dependency('redcarpet')
 
 end

data/test/boxes.json

@@ -0,0 +1,14 @@
+[
+  {
+    "name": "one",
+    "port": 3001
+  },
+  {
+    "name": "two",
+    "port": 3002
+  },
+  {
+    "name": "three",
+    "port": 3003
+  }
+]

data/test/functional/backends/test_netssh.rb

@@ -28,7 +28,7 @@ module SSHKit
       end
 
       def a_host
-        vm_hosts.first
+        VagrantWrapper.hosts["one"]
       end
 
       def printer
@@ -56,9 +56,9 @@ module SSHKit
           SSHKit.capture_output(dnull) do
             captured_command_result = ""
             Netssh.new(a_host) do |host|
-              captured_command_result = capture(:hostname)
+              captured_command_result = capture(:uname)
             end.run
-            assert_equal "lucid32", captured_command_result
+            assert_equal "Linux", captured_command_result
           end
         end
       end

data/test/helper.rb

@@ -1,49 +1,50 @@
 require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
+require 'bundler/setup'
 require 'tempfile'
 require 'minitest/unit'
 require 'mocha/setup'
 require 'turn'
 require 'unindent'
-require 'debugger'
-require 'vagrant'
 require 'stringio'
+require 'json'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'sshkit'
 
-module Vagrant
-  module Communication
-    class SSH
-      def download(from)
-        scp_connect do |scp|
-          return StringIO.new.tap do |sio|
-            scp.download!(from, sio)
+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
-      rescue RuntimeError => e
-        raise if e.message !~ /Permission denied/
-        raise Vagrant::Errors::SCPPermissionDenied, :path => from.to_s
+
+        result
       end
-      private
-      def scp_connect
-        connect do |connection|
-          scp = Net::SCP.new(connection)
-          return yield scp
-        end
-      rescue Net::SCP::Error => e
-        raise Vagrant::Errors::SCPUnavailable if e.message =~ /\(127\)/
-        raise
+    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
 
@@ -57,69 +58,52 @@ end
 
 class FunctionalTest < MiniTest::Unit::TestCase
 
-  attr_accessor :venv
-
   def setup
-    @venv = Vagrant::Environment.new
-    venv.vms.each do |name, vm|
-      warn "#{name} (of #{venv.vms.size}) needs to be booted, please wait" unless vm.state == :running
+    unless VagrantWrapper.running?
+      raise "Vagrant VMs are not running. Please, start it manually with `vagrant up`"
     end
-    venv.cli "up"
   end
 
   private
 
-  def vm_hosts
-    venv.vms.collect do |name, vm|
-      port = vm.env.config.for_vm(name).vm.forwarded_ports.first[:hostport]
-      SSHKit::Host.new("vagrant@localhost:#{port}").tap do |h|
-        h.password = 'vagrant'
-      end
-    end
-  end
-
   def create_user_with_key(username, password = :secret)
     username, password = username.to_s, password.to_s
-    keys = venv.vms.collect do |hostname, vm|
 
-      # Remove the user, make it again, force-generate a key for him
-      # short keys save us a few microseconds
-      vm.channel.sudo("userdel -rf #{username}; true") # The `rescue nil` of the shell world
-      vm.channel.sudo("useradd -m #{username}")
-      vm.channel.sudo("echo y | ssh-keygen -b 1024 -f #{username} -N ''")
-      vm.channel.sudo("chown vagrant:vagrant #{username}*")
-      vm.channel.sudo("echo #{username}:#{password} | chpasswd")
+    keys = VagrantWrapper.hosts.collect do |name, host|
+      Net::SSH.start(host.hostname, host.user, port: host.port, password: host.password) do |ssh|
 
-      # Make the .ssh directory, change the ownership and the
-      vm.channel.sudo("mkdir -p /home/#{username}/.ssh")
-      vm.channel.sudo("chown #{username}:#{username} /home/#{username}/.ssh")
-      vm.channel.sudo("chmod 700 /home/#{username}/.ssh")
+        # Remove the user, make it again, force-generate a key for him
+        # short keys save us a few microseconds
+        ssh.exec!("sudo userdel -rf #{username}; true") # The `rescue nil` of the shell world
+        ssh.exec!("sudo useradd -m #{username}")
+        ssh.exec!("sudo echo y | ssh-keygen -b 1024 -f #{username} -N ''")
+        ssh.exec!("sudo chown vagrant:vagrant #{username}*")
+        ssh.exec!("sudo echo #{username}:#{password} | chpasswd")
 
-      # Move the key to authorized keys and chown and chmod it
-      vm.channel.sudo("cat #{username}.pub > /home/#{username}/.ssh/authorized_keys")
-      vm.channel.sudo("chown #{username}:#{username} /home/#{username}/.ssh/authorized_keys")
-      vm.channel.sudo("chmod 600 /home/#{username}/.ssh/authorized_keys")
+        # Make the .ssh directory, change the ownership and the
+        ssh.exec!("sudo mkdir -p /home/#{username}/.ssh")
+        ssh.exec!("sudo chown #{username}:#{username} /home/#{username}/.ssh")
+        ssh.exec!("sudo chmod 700 /home/#{username}/.ssh")
 
-      sio = vm.channel.download("/home/vagrant/#{username}")
+        # Move the key to authorized keys and chown and chmod it
+        ssh.exec!("sudo cat #{username}.pub > /home/#{username}/.ssh/authorized_keys")
+        ssh.exec!("sudo chown #{username}:#{username} /home/#{username}/.ssh/authorized_keys")
+        ssh.exec!("sudo chmod 600 /home/#{username}/.ssh/authorized_keys")
 
-      # Clean Up Files
-      vm.channel.sudo("rm #{username} #{username}.pub")
+        key = ssh.exec!("cat /home/vagrant/#{username}")
 
-      # Rewind the stringio, and read it as a string
-      sio.tap { |s| s.rewind }.read
+        # Clean Up Files
+        ssh.exec!("sudo rm #{username} #{username}.pub")
 
+        key
+      end
     end
 
-    Hash[venv.vms.collect { |n,vm| n }.zip(keys)]
-
+    Hash[VagrantWrapper.hosts.collect { |n, h| n.to_sym }.zip(keys)]
   end
 
 end
 
-class IntegrationTest < MiniTest::Unit::TestCase
-
-end
-
 #
 # Force colours in Autotest
 #

data/test/unit/backends/test_connection_pool.rb

@@ -0,0 +1,77 @@
+require 'helper'
+require 'ostruct'
+
+module SSHKit
+  module Backend
+    class TestConnectionPool < UnitTest
+
+      def pool
+        @pool ||= SSHKit::Backend::ConnectionPool.new
+      end
+
+      def connect
+        ->(*args) { Object.new }
+      end
+
+      def connect_and_close
+        ->(*args) { OpenStruct.new(:closed? => true) }
+      end
+
+      def echo_args
+        ->(*args) { args }
+      end
+
+      def test_default_idle_timeout
+        assert_equal 30, pool.idle_timeout
+      end
+
+      def test_connection_factory_receives_args
+        args = %w(a b c)
+        conn = pool.create_or_reuse_connection(*args, &echo_args)
+
+        assert_equal args, conn
+      end
+
+      def test_connections_are_reused
+        conn1 = pool.create_or_reuse_connection("conn", &connect)
+        conn2 = pool.create_or_reuse_connection("conn", &connect)
+
+        assert_equal conn1, conn2
+      end
+
+      def test_zero_idle_timeout_disables_resuse
+        pool.idle_timeout = 0
+
+        conn1 = pool.create_or_reuse_connection("conn", &connect)
+        conn2 = pool.create_or_reuse_connection("conn", &connect)
+
+        refute_equal conn1, conn2
+      end
+
+      def test_expired_connection_is_not_reused
+        pool.idle_timeout = 0.1
+
+        conn1 = pool.create_or_reuse_connection("conn", &connect)
+        sleep(pool.idle_timeout)
+        conn2 = pool.create_or_reuse_connection("conn", &connect)
+
+        refute_equal conn1, conn2
+      end
+
+      def test_closed_connection_is_not_reused
+        conn1 = pool.create_or_reuse_connection("conn", &connect_and_close)
+        conn2 = pool.create_or_reuse_connection("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)
+
+        refute_equal conn1, conn2
+      end
+
+    end
+  end
+end

data/test/unit/formatters/test_dot.rb

@@ -0,0 +1,65 @@
+require 'helper'
+require 'sshkit'
+
+module SSHKit
+  class TestDot < UnitTest
+
+    def setup
+      SSHKit.config.output_verbosity = Logger::DEBUG
+    end
+
+    def output
+      @_output ||= String.new
+    end
+
+    def dot
+      @_dot ||= SSHKit::Formatter::Dot.new(output)
+    end
+
+    def teardown
+      remove_instance_variable :@_dot
+      remove_instance_variable :@_output
+      SSHKit.reset_configuration!
+    end
+
+    def test_logging_fatal
+      dot << SSHKit::LogMessage.new(Logger::FATAL, "Test")
+      assert_equal "", output.strip
+    end
+
+    def test_logging_error
+      dot << SSHKit::LogMessage.new(Logger::ERROR, "Test")
+      assert_equal "", output.strip
+    end
+
+    def test_logging_warn
+      dot << SSHKit::LogMessage.new(Logger::WARN, "Test")
+      assert_equal "", output.strip
+    end
+
+    def test_logging_info
+      dot << SSHKit::LogMessage.new(Logger::INFO, "Test")
+      assert_equal "", output.strip
+    end
+
+    def test_logging_debug
+      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
+    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
+    end
+
+  end
+end

data/test/unit/test_configuration.rb

@@ -51,10 +51,15 @@ module SSHKit
       assert_equal "/opt/sites/example/current/bin ruby", SSHKit.config.command_map[:ruby]
     end
 
-    def test_setting_formatter
+    def test_setting_formatter_to_dot
       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
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -129,62 +129,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: vagrant
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A comprehensive toolkit for remotely running commands in a structured
   manner on groups of servers.
 email:
@@ -214,6 +158,7 @@ files:
 - lib/sshkit.rb
 - lib/sshkit/all.rb
 - lib/sshkit/backends/abstract.rb
+- lib/sshkit/backends/connection_pool.rb
 - lib/sshkit/backends/local.rb
 - lib/sshkit/backends/netssh.rb
 - lib/sshkit/backends/printer.rb
@@ -237,14 +182,17 @@ files:
 - lib/sshkit/runners/sequential.rb
 - lib/sshkit/version.rb
 - sshkit.gemspec
+- test/boxes.json
 - test/functional/backends/test_local.rb
 - test/functional/backends/test_netssh.rb
 - test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
 - test/helper.rb
+- test/unit/backends/test_connection_pool.rb
 - test/unit/backends/test_netssh.rb
 - test/unit/backends/test_printer.rb
 - test/unit/core_ext/test_string.rb
+- test/unit/formatters/test_dot.rb
 - test/unit/formatters/test_pretty.rb
 - test/unit/test_command.rb
 - test/unit/test_command_map.rb
@@ -252,8 +200,9 @@ files:
 - test/unit/test_coordinator.rb
 - test/unit/test_host.rb
 - test/unit/test_logger.rb
-homepage: http://wacku.github.com/sshkit
-licenses: []
+homepage: http://github.com/capistrano/sshkit
+licenses:
+- GPL3
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -276,14 +225,17 @@ signing_key:
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby
 test_files:
+- test/boxes.json
 - test/functional/backends/test_local.rb
 - test/functional/backends/test_netssh.rb
 - test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
 - test/helper.rb
+- test/unit/backends/test_connection_pool.rb
 - test/unit/backends/test_netssh.rb
 - test/unit/backends/test_printer.rb
 - test/unit/core_ext/test_string.rb
+- test/unit/formatters/test_dot.rb
 - test/unit/formatters/test_pretty.rb
 - test/unit/test_command.rb
 - test/unit/test_command_map.rb