sshkit 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d240b417c873ab9f0c9e56797700ae369c9e247
-  data.tar.gz: d254ac62cb140472b626d2aacb6f6de5d43b8c04
+  metadata.gz: 3898c2edc5a5a2dc313f80f0170c5511f67358ee
+  data.tar.gz: 2d9a40af7ea3e3f862d68c5bdc9b892f848cbbc6
 SHA512:
-  metadata.gz: 5c5732a48ae1ea014a15012a9e9b2f4ddecf89ab9926d5d98ec91b27984ec9313bcfe8e736b70afcafac6832c094267dcc1863e6cbbc6af546b28339d8ec022b
-  data.tar.gz: 6fff632e1d8853d80535c812cc31bf45710f5887d2135747f078fc2b642567d213717d410bb54d6e36cb37167975e24ee76899fa2a35693a99d240faeb558cc3
+  metadata.gz: 4d04c3dec016fdb417fb550b5f3a4d247a1d1165867e60457b5cf652d2a8b6660721a9e703442ba611c57397b1b85133ccb16b4c539f051cd9e3f251bed120e7
+  data.tar.gz: 7389b19eb7a6f724207d5f00b889ff3ea93f1b70b48f02a4dc9a705d1d4563c3d4f09e510bf0b6f4791a33ccf8b6dc8b2c9eab37627c389ff7ab723c6d5a4b0a

data/CHANGELOG.md

@@ -3,14 +3,35 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
-## 1.1.0
+## 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 
+    @0rca Vzorov.
+  * 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 
+    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 
+    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 
+    `: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 
+    quite naïve. Thanks to @chqr.
 
-  * The output now reads "Command exited with status _", rather than "command
-    failed", or "command succeded", the semantics are the same, but people
-    were confused by "failure", when things were running correctly.
+## 1.1.0
 
-  * Small fix to the printer backend for tests, casting command to a string
-    explicitly.
+  * Please see the Git history. `git rebase` ate our changelog (we should have been
+    more careful)
 
 ## 1.0.0
 

data/EXAMPLES.md

@@ -222,8 +222,8 @@ which will cause the command to abort.
 
 ## Make a test, or run a command which may fail without raising an error:
 
-    on hosts do |host
-      if test "[ -d /opt/sites ]" do
+    on hosts do |host|
+      if test "[ -d /opt/sites ]"
         within "/opt/sites" do
           execute :git, :pull
         end

data/README.md

@@ -142,6 +142,16 @@ One can override the hash map for individual commands:
     puts SSHKit.config.command_map[:rake]
     # => /usr/local/rbenv/shims/rake
 
+Another oportunity is to add command prefixes:
+
+    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
+
 One can also override the command map completely, this may not be wise, but it
 would be possible, for example:
 

data/lib/sshkit/all.rb

@@ -4,6 +4,7 @@ require_relative '../core_ext/hash'
 require_relative 'host'
 
 require_relative 'command'
+require_relative 'command_map'
 require_relative 'configuration'
 require_relative 'coordinator'
 

data/lib/sshkit/backends/local.rb

@@ -13,7 +13,26 @@ module SSHKit
         instance_exec(&@block)
       end
 
+      def test(*args)
+        options = args.extract_options!.merge(
+          raise_on_non_zero_exit: false,
+          verbosity: Logger::DEBUG
+        )
+        _execute(*[*args, options]).success?
+      end
+
       def execute(*args)
+        _execute(*args).success?
+      end
+
+      def capture(*args)
+        options = args.extract_options!.merge(verbosity: Logger::DEBUG)
+        _execute(*[*args, options]).full_stdout.strip
+      end
+
+      private
+
+      def _execute(*args)
         command(*args).tap do |cmd|
           output << cmd
 

data/lib/sshkit/backends/netssh.rb

@@ -1,6 +1,18 @@
 require 'net/ssh'
 require 'net/scp'
 
+module Net
+  module SSH
+    class Config
+      class << self
+        def default_files
+          @@default_files + [File.join(Dir.pwd, '.ssh/config')]
+        end
+      end
+    end
+  end
+end
+
 module SSHKit
 
   class Logger
@@ -65,29 +77,13 @@ module SSHKit
       end
 
       def upload!(local, remote, options = {})
-        ssh.scp.upload!(local, remote, options) do |ch, name, sent, total|
-          percentage = (sent.to_f * 100 / total.to_f)
-          unless percentage.nan?
-            if percentage > 0 && percentage % 10 == 0
-              info "Uploading #{name} #{percentage.round(2)}%"
-            else
-              debug "Uploading #{name} #{percentage.round(2)}%"
-            end
-          else
-            warn "Error calculating percentage #{percentage} is NaN"
-          end
-        end
+        summarizer = transfer_summarizer('Uploading')
+        ssh.scp.upload!(local, remote, options, &summarizer)
       end
 
       def download!(remote, local=nil, options = {})
-        ssh.scp.download!(remote, local, options) do |ch, name, received, total|
-          percentage = (received.to_f * 100 / total.to_f).to_i
-          if percentage > 0 && percentage % 10 == 0
-            info "Downloading #{name} #{percentage}%"
-          else
-            debug "Downloading #{name} #{percentage}%"
-          end
-        end
+        summarizer = transfer_summarizer('Downloading')
+        ssh.scp.download!(remote, local, options, &summarizer)
       end
 
       class << self
@@ -102,6 +98,23 @@ module SSHKit
 
       private
 
+      def transfer_summarizer(action)
+        proc do |ch, name, transferred, total|
+          percentage = (transferred.to_f * 100 / total.to_f)
+          unless percentage.nan?
+            message = "#{action} #{name} #{percentage.round(2)}%"
+            if percentage > 0 && percentage.round % 10 == 0
+              info message
+            else
+              debug message
+            end
+          else
+            warn "Error calculating percentage #{transferred}/#{total}, " <<
+              "is #{name} empty?"
+          end
+        end
+      end
+
       def _execute(*args)
         command(*args).tap do |cmd|
           output << cmd

data/lib/sshkit/backends/printer.rb

@@ -11,7 +11,7 @@ module SSHKit
 
       def execute(*args)
         command(*args).tap do |cmd|
-          output << cmd.to_s
+          output << sprintf("%s\n", cmd)
         end
       end
       alias :upload! :execute

data/lib/sshkit/command_map.rb

@@ -0,0 +1,51 @@
+module SSHKit
+  class CommandMap
+    class PrefixProvider
+      def initialize
+        @storage = {}
+      end
+
+      def [](command)
+        @storage[command] ||= []
+
+        @storage[command]
+      end
+    end
+
+    def initialize(value = nil)
+      @map = value || defaults
+    end
+
+    def [](command)
+      if prefix[command].any?
+        prefixes = prefix[command].join(" ")
+
+        "#{prefixes} #{command}"
+      else
+        @map[command]
+      end
+    end
+
+    def prefix
+      @prefix ||= PrefixProvider.new
+    end
+
+    def []=(command, new_command)
+      @map[command] = new_command
+    end
+
+    def clear
+      @map = defaults
+    end
+
+    def defaults
+      Hash.new do |hash, command|
+        if %w{if test time}.include? command.to_s
+          hash[command] = command.to_s
+        else
+          hash[command] = "/usr/bin/env #{command}"
+        end
+      end
+    end
+  end
+end

data/lib/sshkit/configuration.rb

@@ -3,7 +3,7 @@ module SSHKit
   class Configuration
 
     attr_accessor :umask, :output_verbosity
-    attr_writer :output, :backend, :default_env, :command_map
+    attr_writer :output, :backend, :default_env
 
     def output
       @output ||= formatter(:pretty)
@@ -30,15 +30,11 @@ module SSHKit
     end
 
     def command_map
-      @command_map ||= begin
-        Hash.new do |hash, command|
-          if %w{if test time}.include? command.to_s
-            hash[command] = command.to_s
-          else
-            hash[command] = "/usr/bin/env #{command}"
-          end
-        end
-      end
+      @command_map ||= SSHKit::CommandMap.new
+    end
+
+    def command_map=(value)
+      @command_map = SSHKit::CommandMap.new(value)
     end
 
     private

data/lib/sshkit/coordinator.rb

@@ -18,9 +18,9 @@ module SSHKit
         when :groups   then Runner::Group
         else
           raise RuntimeError, "Don't know how to handle run style #{options[:in].inspect}"
-        end.new(hosts, &block).execute
+        end.new(hosts, options, &block).execute
       else
-        Runner::Null.new(hosts, &block).execute
+        Runner::Null.new(hosts, options, &block).execute
       end
     end
 

data/lib/sshkit/host.rb

@@ -29,7 +29,6 @@ module SSHKit
           HostWithUsernameAndPortParser,
           IPv6HostWithPortParser,
           HostWithUsernameParser,
-          HostWithUsernameAndPortParser
         ].select do |p|
           p.suitable?(host_string_or_options_hash)
         end
@@ -117,16 +116,10 @@ module SSHKit
 
   end
 
-  # @private
-  # :nodoc:
-  class HostWithUsernameAndPortParser < SimpleHostParser
+  class HostWithPortParser < SimpleHostParser
 
     def self.suitable?(host_string)
-      !host_string.match /.*@.*\:.*/
-    end
-
-    def username
-      @host_string.split('@').last.to_i
+      !host_string.match /[@|\[|\]]/
     end
 
     def port
@@ -134,25 +127,26 @@ module SSHKit
     end
 
     def hostname
-      @host_string.split(/@|\:/)[1]
+      @host_string.split(':').first
     end
 
   end
 
-  class HostWithPortParser < SimpleHostParser
-
+  # @private
+  # :nodoc:
+  class HostWithUsernameAndPortParser < SimpleHostParser
     def self.suitable?(host_string)
-      !host_string.match /[@|\[|\]]/
+      host_string.match /@.*:\d+/
     end
-
-    def port
-      @host_string.split(':').last.to_i
+    def username
+      @host_string.split(/:|@/)[0]
     end
-
     def hostname
-      @host_string.split(':').first
+      @host_string.split(/:|@/)[1]
+    end
+    def port
+      @host_string.split(/:|@/)[2].to_i
     end
-
   end
 
   # @private
@@ -188,21 +182,4 @@ module SSHKit
     end
   end
 
-  # @private
-  # :nodoc:
-  class HostWithUsernameAndPortParser < SimpleHostParser
-    def self.suitable?(host_string)
-      host_string.match /@.*:\d+/
-    end
-    def username
-      @host_string.split(/:|@/)[0]
-    end
-    def hostname
-      @host_string.split(/:|@/)[1]
-    end
-    def port
-      @host_string.split(/:|@/)[2].to_i
-    end
-  end
-
 end

data/lib/sshkit/runners/abstract.rb

@@ -4,10 +4,11 @@ module SSHKit
 
     class Abstract
 
-      attr_reader :hosts, :block
+      attr_reader :hosts, :options, :block
 
-      def initialize(hosts, &block)
+      def initialize(hosts, options = nil, &block)
         @hosts       = Array(hosts)
+        @options     = options || {}
         @block       = block
       end
 

data/lib/sshkit/runners/sequential.rb

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

data/lib/sshkit/version.rb

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

data/sshkit.gemspec

@@ -16,9 +16,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = SSHKit::VERSION
 
-  gem.add_dependency('net-ssh')
-  gem.add_dependency('net-scp')
-  gem.add_dependency('term-ansicolor')
+  gem.add_runtime_dependency('net-ssh')
+  gem.add_runtime_dependency('net-scp', '>= 1.1.2')
+  gem.add_runtime_dependency('term-ansicolor')
 
   gem.add_development_dependency('minitest', ['>= 2.11.3', '< 2.12.0'])
   gem.add_development_dependency('rake')

data/test/functional/backends/test_local.rb

@@ -9,6 +9,14 @@ module SSHKit
         SSHKit.config.output = SSHKit::Formatter::BlackHole.new($stdout)
       end
 
+      def test_capture
+        captured_command_result = ''
+        Local.new do
+          captured_command_result = capture(:echo, 'foo')
+        end.run
+        assert_equal 'foo', captured_command_result
+      end
+
       def test_execute_raises_on_non_zero_exit_status_and_captures_stdout_and_stderr
         err = assert_raises SSHKit::Command::Failed do
           Local.new do
@@ -17,6 +25,16 @@ module SSHKit
         end
         assert_equal "echo stdout: Nothing written\necho stderr: Test capturing stderr\n", err.message
       end
+
+      def test_test
+        succeeded_test_result = failed_test_result = nil
+        Local.new do
+          succeeded_test_result = test('[ -d ~ ]')
+          failed_test_result    = test('[ -f ~ ]')
+        end.run
+        assert_equal true,  succeeded_test_result
+        assert_equal false, failed_test_result
+      end
     end
   end
 end

data/test/helper.rb

@@ -49,6 +49,10 @@ end
 
 class UnitTest < MiniTest::Unit::TestCase
 
+  def setup
+    SSHKit.reset_configuration!
+  end
+
 end
 
 class FunctionalTest < MiniTest::Unit::TestCase

data/test/unit/backends/test_netssh.rb

@@ -12,7 +12,6 @@ module SSHKit
         backend.configure do |ssh|
           ssh.pty = true
           ssh.connection_timeout = 30
-          ssh.connection_timeout = 30
           ssh.ssh_options = {
             keys: %w(/home/user/.ssh/id_rsa),
             forward_agent: false,
@@ -26,7 +25,31 @@ module SSHKit
         assert_equal %w(/home/user/.ssh/id_rsa),  backend.config.ssh_options[:keys]
         assert_equal false,                       backend.config.ssh_options[:forward_agent]
         assert_equal %w(publickey password),      backend.config.ssh_options[:auth_methods]
+
+      end
+
+      def test_netssh_ext
+        assert_includes  Net::SSH::Config.default_files, "#{Dir.pwd}/.ssh/config"
+      end
+
+      def test_transfer_summarizer
+        netssh = Netssh.new(Host.new('fake'))
+
+        summarizer = netssh.send(:transfer_summarizer,'Transferring')
+
+        [
+         [1,    100, :debug, 'Transferring afile 1.0%'],
+         [1,    3,   :debug, 'Transferring afile 33.33%'],
+         [0,    1,   :debug, 'Transferring afile 0.0%'],
+         [1,    2,   :info,  'Transferring afile 50.0%'],
+         [0,    0,   :warn,  'percentage 0/0'],
+         [1023, 343, :debug, 'Transferring'],
+        ].each do |transferred,total,method,substring|
+          netssh.expects(method).with { |msg| msg.include?(substring) }
+          summarizer.call(nil,'afile',transferred,total)
+        end
       end
+
     end
   end
 end

data/test/unit/backends/test_printer.rb

@@ -12,6 +12,14 @@ module SSHKit
         end
       end
 
+      def backend
+        @backend ||= Printer
+      end
+
+      def teardown
+        @backend = nil
+      end
+
       def printer
         Printer.new(Host.new(:'example.com'), &block_to_run)
       end
@@ -26,7 +34,30 @@ module SSHKit
           printer.run
         end
         result.rewind
-        assert_equal '/usr/bin/env ls -l /some/directory', result.read
+        assert_equal "/usr/bin/env ls -l /some/directory\n", result.read
+      end
+
+      def test_printer_respond_to_configure
+        assert backend.respond_to?(:configure)
+      end
+
+      def test_printer_any_params_config
+        backend.configure do |ssh|
+          ssh.pty = true
+          ssh.connection_timeout = 30
+          ssh.ssh_options = {
+              keys: %w(/home/user/.ssh/id_rsa),
+              forward_agent: false,
+              auth_methods: %w(publickey password)
+          }
+        end
+
+        assert_equal 30, backend.config.connection_timeout
+        assert_equal true, backend.config.pty
+
+        assert_equal %w(/home/user/.ssh/id_rsa),  backend.config.ssh_options[:keys]
+        assert_equal false,                       backend.config.ssh_options[:forward_agent]
+        assert_equal %w(publickey password),      backend.config.ssh_options[:auth_methods]
       end
 
     end

data/test/unit/test_command_map.rb

@@ -0,0 +1,40 @@
+require 'helper'
+require 'sshkit'
+
+module SSHKit
+  class TestCommandMap < UnitTest
+
+    def setup
+      SSHKit.reset_configuration!
+    end
+
+    def test_defaults
+      map = CommandMap.new
+      assert_equal map[:rake], "/usr/bin/env rake"
+      assert_equal map[:test], "test"
+    end
+
+    def test_setter
+      map = CommandMap.new
+      map[:rake] = "/usr/local/rbenv/shims/rake"
+      assert_equal map[:rake], "/usr/local/rbenv/shims/rake"
+    end
+
+    def test_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
+
+    def test_prefix_unshift
+      map = CommandMap.new
+      map.prefix[:rake].push("bundle exec")
+      map.prefix[:rake].unshift("/home/vagrant/.rbenv/bin/rbenv exec")
+
+      assert_equal map[:rake], "/home/vagrant/.rbenv/bin/rbenv exec bundle exec rake"
+    end
+
+  end
+end

data/test/unit/test_configuration.rb

@@ -42,11 +42,12 @@ module SSHKit
     end
 
     def test_command_map
+      assert_equal SSHKit.config.command_map.is_a?(SSHKit::CommandMap), true
+
       cm = Hash.new { |h,k| h[k] = "/opt/sites/example/current/bin #{k}"}
-      assert_equal Hash.new, SSHKit.config.command_map
-      assert_equal "/usr/bin/env ruby", SSHKit.config.command_map[:ruby]
+
       assert SSHKit.config.command_map = cm
-      assert_equal cm, SSHKit.config.command_map
+      assert_equal SSHKit.config.command_map.is_a?(SSHKit::CommandMap), true
       assert_equal "/opt/sites/example/current/bin ruby", SSHKit.config.command_map[:ruby]
     end
 

data/test/unit/test_coordinator.rb

@@ -6,6 +6,7 @@ module SSHKit
   class TestCoordinator < UnitTest
 
     def setup
+      super
       @s = String.new
       SSHKit.config.backend = SSHKit::Backend::Printer
     end
@@ -40,7 +41,7 @@ module SSHKit
         SSHKit.capture_output str do
           Coordinator.new(%w{1.example.com}).each &spy
         end
-        assert_equal "echo 1.example.com", str.strip
+        assert_equal "/usr/bin/env echo 1.example.com", str.strip
       end
     end
 
@@ -60,10 +61,27 @@ module SSHKit
       assert_operator results.first.to_i, :<, results.last.to_i
     end
 
+    def test_the_connection_manager_can_run_things_in_sequence_with_wait
+      start = Time.now
+      SSHKit.capture_output @s do
+        Coordinator.new(%w{1.example.com 2.example.com}).each in: :sequence, wait: 10, &block_to_run
+      end
+      stop = Time.now
+      assert_operator (stop.to_i - start.to_i), :>=, 10
+    end
+
     def test_the_connection_manager_can_run_things_in_groups
       SSHKit.capture_output @s do
-        Coordinator.new(%w{1.example.com 2.example.com 3.example.com
-                                 4.example.com 5.example.com 6.example.com}).each in: :groups, &block_to_run
+        Coordinator.new(
+          %w{
+            1.example.com
+            2.example.com
+            3.example.com
+            4.example.com 
+            5.example.com 
+            6.example.com
+          }
+        ).each in: :groups, &block_to_run
       end
       assert_equal 6, results.length
       assert_equal *results[0..1].map(&:to_i)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +219,7 @@ files:
 - lib/sshkit/backends/printer.rb
 - lib/sshkit/backends/skipper.rb
 - lib/sshkit/command.rb
+- lib/sshkit/command_map.rb
 - lib/sshkit/configuration.rb
 - lib/sshkit/coordinator.rb
 - lib/sshkit/dsl.rb
@@ -246,6 +247,7 @@ files:
 - test/unit/core_ext/test_string.rb
 - test/unit/formatters/test_pretty.rb
 - test/unit/test_command.rb
+- test/unit/test_command_map.rb
 - test/unit/test_configuration.rb
 - test/unit/test_coordinator.rb
 - test/unit/test_host.rb
@@ -284,6 +286,7 @@ test_files:
 - test/unit/core_ext/test_string.rb
 - test/unit/formatters/test_pretty.rb
 - test/unit/test_command.rb
+- test/unit/test_command_map.rb
 - test/unit/test_configuration.rb
 - test/unit/test_coordinator.rb
 - test/unit/test_host.rb