sshkit 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2075a49a2e5d52e26409761fffbb3da8dd6bc46d
-  data.tar.gz: d9579584daf0ac0f3d2170fa4dc0c2bc57d3ac55
+  metadata.gz: 63716bfbb3150fe84235f1161bc7ecc9d303155c
+  data.tar.gz: 91103b89d73d2c9f56ade1ebd21ae80f85f6fb24
 SHA512:
-  metadata.gz: 4a84ef1bf0b996cf4a3ecb0d855f8d7b872c1d0bc31f46804908b3f51f31cb1f2af0ff7d39e7bc498f8a7aecf05576116bff008b8955b853b6e39c3fcb6f71bf
-  data.tar.gz: b2e42bf3216b4fdfbdd531329a09e9534775b71eb15dd2853319dca4ac358623b494474f179f136034beee435fd424f03b13d64fe6eb64dd283da39fcd6ae3f8
+  metadata.gz: 0cd4182399d780bc1a760be58589ee74bcbd1a8428d6ba1007c1f5a47ff587d3ce5f4a93258cac4be3d38f3e9a5f0bbc6e546ce5b4b72469b31195bdf2060dee
+  data.tar.gz: b022fccb0e7c55965b5a58420878fd6340eea1fd3a0ac5a47a50573e1149719fc784970c1f1956cfd3ea7ccb5b11ae413082c306806030059b5e0d2e0b0ada64

data/CHANGELOG.md

@@ -7,6 +7,21 @@ appear at the top.
 
   * Your contribution here!
 
+## [1.13.0][] (2017-03-24)
+
+### Breaking changes
+
+  * None
+
+### New features
+
+  * [#372](https://github.com/capistrano/sshkit/pull/372): Use cp_r in local backend with recursive option - [@okuramasafumi](https://github.com/okuramasafumi)
+
+### Bug fixes
+
+  * [#390](https://github.com/capistrano/sshkit/pull/390): Properly wrap Ruby StandardError w/ add'l context - [@mattbrictson](https://github.com/mattbrictson)
+  * [#392](https://github.com/capistrano/sshkit/pull/392): Fix open two connections with changed cache key - [@shirosaki](https://github.com/shirosaki)
+
 ## [1.12.0][] (2017-02-10)
 
 ### Breaking changes

data/Dangerfile

@@ -1,54 +1 @@
-# Adapted from https://github.com/ruby-grape/danger/blob/master/Dangerfile
-# Q: What is a Dangerfile, anyway? A: See http://danger.systems/
-
-# ------------------------------------------------------------------------------
-# Additional pull request data
-# ------------------------------------------------------------------------------
-project_name = github.pr_json["base"]["repo"]["name"]
-pr_number = github.pr_json["number"]
-pr_url = github.pr_json["_links"]["html"]["href"]
-
-# ------------------------------------------------------------------------------
-# What changed?
-# ------------------------------------------------------------------------------
-has_lib_changes = !git.modified_files.grep(/^lib/).empty?
-has_test_changes = !git.modified_files.grep(/^test/).empty?
-has_changelog_changes = git.modified_files.include?("CHANGELOG.md")
-
-# ------------------------------------------------------------------------------
-# You've made changes to lib, but didn't write any tests?
-# ------------------------------------------------------------------------------
-if has_lib_changes && !has_test_changes
-  warn("There are code changes, but no corresponding tests. "\
-       "Please include tests if this PR introduces any modifications in "\
-       "#{project_name}'s behavior.",
-       :sticky => false)
-end
-
-# ------------------------------------------------------------------------------
-# Have you updated CHANGELOG.md?
-# ------------------------------------------------------------------------------
-if !has_changelog_changes && has_lib_changes
-  markdown <<-MARKDOWN
-Here's an example of a CHANGELOG.md entry (place it immediately under the `* Your contribution here!` line):
-
-```markdown
-* [##{pr_number}](#{pr_url}): #{github.pr_title} - [@#{github.pr_author}](https://github.com/#{github.pr_author}).
-```
-MARKDOWN
-  warn("Please update CHANGELOG.md with a description of your changes. "\
-       "If this PR is not a user-facing change (e.g. just refactoring), "\
-       "you can disregard this.", :sticky => false)
-end
-
-# ------------------------------------------------------------------------------
-# Did you remove the CHANGELOG's "Your contribution here!" line?
-# ------------------------------------------------------------------------------
-if has_changelog_changes
-  unless IO.read("CHANGELOG.md") =~ /^\s*\* Your contribution here/i
-    fail(
-      "Please put the `* Your contribution here!` line back into CHANGELOG.md.",
-      :sticky => false
-    )
-  end
-end
+danger.import_dangerfile(github: "capistrano/danger")

data/lib/sshkit/backends/connection_pool/cache.rb

@@ -1,7 +1,10 @@
 # A Cache holds connections for a given key. Each connection is stored along
 # with an expiration time so that its idle duration can be measured.
 class SSHKit::Backend::ConnectionPool::Cache
-  def initialize(idle_timeout, closer)
+  attr_accessor :key
+
+  def initialize(key, idle_timeout, closer)
+    @key = key
     @connections = []
     @connections.extend(MonitorMixin)
     @idle_timeout = idle_timeout
@@ -53,6 +56,10 @@ class SSHKit::Backend::ConnectionPool::Cache
     end
   end
 
+  def same_key?(other_key)
+    key == other_key
+  end
+
   protected
 
   attr_reader :connections, :idle_timeout, :closer

data/lib/sshkit/backends/connection_pool/nil_cache.rb

@@ -8,4 +8,8 @@ SSHKit::Backend::ConnectionPool::NilCache = Struct.new(:closer) do
   def push(conn)
     closer.call(conn)
   end
+
+  def same_key?(_key)
+    true
+  end
 end

data/lib/sshkit/backends/connection_pool.rb

@@ -61,6 +61,9 @@ class SSHKit::Backend::ConnectionPool
     yield(conn)
   ensure
     cache.push(conn) unless conn.nil?
+    # Sometimes the args mutate as a result of opening a connection. In this
+    # case we need to update the cache key to match the new args.
+    update_key_if_args_changed(cache, args)
   end
 
   # Immediately remove all cached connections, without closing them. This only
@@ -84,6 +87,10 @@ class SSHKit::Backend::ConnectionPool
 
   private
 
+  def cache_key_for_connection_args(args)
+    args.to_s
+  end
+
   def cache_enabled?
     idle_timeout && idle_timeout > 0
   end
@@ -91,7 +98,7 @@ class SSHKit::Backend::ConnectionPool
   # Look up a Cache that matches the given connection arguments.
   def find_cache(args)
     if cache_enabled?
-      key = args.to_s
+      key = cache_key_for_connection_args(args)
       caches[key] || thread_safe_find_or_create_cache(key)
     else
       NilCache.new(method(:silently_close_connection))
@@ -103,11 +110,22 @@ class SSHKit::Backend::ConnectionPool
   def thread_safe_find_or_create_cache(key)
     caches.synchronize do
       caches[key] ||= begin
-        Cache.new(idle_timeout, method(:silently_close_connection_later))
+        Cache.new(key, idle_timeout, method(:silently_close_connection_later))
       end
     end
   end
 
+  # Update cache key with changed args to prevent cache miss
+  def update_key_if_args_changed(cache, args)
+    new_key = cache_key_for_connection_args(args)
+    return if cache.same_key?(new_key)
+
+    caches.synchronize do
+      caches[new_key] = caches.delete(cache.key)
+      cache.key = new_key
+    end
+  end
+
   # Loops indefinitely to close connections and to find abandoned connections
   # that need to be closed.
   def run_eviction_loop

data/lib/sshkit/backends/local.rb

@@ -10,9 +10,13 @@ module SSHKit
         super(Host.new(:local), &block)
       end
 
-      def upload!(local, remote, _options = {})
+      def upload!(local, remote, options = {})
         if local.is_a?(String)
-          FileUtils.cp(local, remote)
+          if options[:recursive]
+            FileUtils.cp_r(local, remote)
+          else
+            FileUtils.cp(local, remote)
+          end
         else
           File.open(remote, "wb") do |f|
             IO.copy_stream(local, f)

data/lib/sshkit/backends/netssh.rb

@@ -36,12 +36,20 @@ module SSHKit
         if Net::SSH::VALID_OPTIONS.include?(:known_hosts)
           def default_options
             @default_options ||= {known_hosts: SSHKit::Backend::Netssh::KnownHosts.new}
+            assign_defaults
           end
         else
           def default_options
             @default_options ||= {}
+            assign_defaults
           end
         end
+
+        # Set default options early for ConnectionPool cache key
+        def assign_defaults
+          Net::SSH.assign_defaults(@default_options)
+          @default_options
+        end
       end
 
       def upload!(local, remote, options = {})

data/lib/sshkit/runners/parallel.rb

@@ -10,7 +10,7 @@ module SSHKit
           Thread.new(host) do |h|
             begin
               backend(h, &block).run
-            rescue StandardError => e
+            rescue ::StandardError => e
               e2 = ExecuteError.new e
               raise e2, "Exception while executing #{host.user ? "as #{host.user}@" : "on host "}#{host}: #{e.message}"
             end

data/lib/sshkit/runners/sequential.rb

@@ -26,7 +26,7 @@ module SSHKit
       private
       def run_backend(host, &block)
         backend(host, &block).run
-      rescue StandardError => e
+      rescue ::StandardError => e
         e2 = ExecuteError.new e
         raise e2, "Exception while executing #{host.user ? "as #{host.user}@" : "on host "}#{host}: #{e.message}"
       end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.12.0".freeze
+  VERSION = "1.13.0".freeze
 end

data/test/functional/backends/test_local.rb

@@ -10,6 +10,30 @@ module SSHKit
         SSHKit.config.output = SSHKit::Formatter::BlackHole.new($stdout)
       end
 
+      def test_upload
+        Dir.mktmpdir do |dir|
+          File.new("#{dir}/local", 'w')
+          Local.new do
+            upload!("#{dir}/local", "#{dir}/remote")
+          end.run
+          assert File.exist?("#{dir}/remote")
+        end
+      end
+
+      def test_upload_recursive
+        Dir.mktmpdir do |dir|
+          Dir.mkdir("#{dir}/local")
+          File.new("#{dir}/local/file1", 'w')
+          File.new("#{dir}/local/file2", 'w')
+          Local.new do
+            upload!("#{dir}/local", "#{dir}/remote", recursive: true)
+          end.run
+          assert File.directory?("#{dir}/remote")
+          assert File.exist?("#{dir}/remote/file1")
+          assert File.exist?("#{dir}/remote/file2")
+        end
+      end
+
       def test_capture
         captured_command_result = ''
         Local.new do

data/test/functional/backends/test_netssh.rb

@@ -59,7 +59,7 @@ module SSHKit
           capture(:uname)
           host_ssh_options = host.ssh_options
         end.run
-        assert_equal [:forward_agent, :paranoid, :known_hosts].sort, host_ssh_options.keys.sort
+        assert_equal [:forward_agent, :paranoid, :known_hosts, :logger, :password_prompt].sort, host_ssh_options.keys.sort
         assert_equal false, host_ssh_options[:forward_agent]
         assert_equal true, host_ssh_options[:paranoid]
         assert_instance_of SSHKit::Backend::Netssh::KnownHosts, host_ssh_options[:known_hosts]

data/test/unit/backends/test_connection_pool.rb

@@ -134,6 +134,15 @@ module SSHKit
           pool.close_connections
         end
       end
+
+      def test_connections_with_changed_args_is_reused
+        options = { known_hosts: "foo" }
+        connect_change_options = ->(*args) { args.last[:known_hosts] = "bar"; Object.new }
+        conn1 = pool.with(connect_change_options, "arg", options) { |c| c }
+        conn2 = pool.with(connect_change_options, "arg", options) { |c| c }
+
+        assert_equal conn1, conn2
+      end
     end
   end
 end

data/test/unit/runners/test_group.rb

@@ -0,0 +1,17 @@
+require "helper"
+require "sshkit"
+
+module SSHKit
+  module Runner
+    class TestGroup < UnitTest
+      def test_wraps_ruby_standard_error_in_execute_error
+        localhost = Host.new(:local)
+        runner = Group.new([localhost]) { raise "oh no!" }
+        error = assert_raises(SSHKit::Runner::ExecuteError) do
+          runner.execute
+        end
+        assert_match(/while executing.*localhost/, error.message)
+      end
+    end
+  end
+end

data/test/unit/runners/test_parallel.rb

@@ -0,0 +1,18 @@
+require "helper"
+require "sshkit"
+
+module SSHKit
+  module Runner
+    class TestParallel < UnitTest
+      def test_wraps_ruby_standard_error_in_execute_error
+        host = Host.new("deployer@example")
+        runner = Parallel.new([host]) { raise "oh no!" }
+        error = assert_raises(SSHKit::Runner::ExecuteError) do
+          runner.execute
+        end
+        assert_match(/deployer@example/, error.message)
+        assert_match(/oh no!/, error.message)
+      end
+    end
+  end
+end

data/test/unit/runners/test_sequential.rb

@@ -0,0 +1,18 @@
+require "helper"
+require "sshkit"
+
+module SSHKit
+  module Runner
+    class TestSequential < UnitTest
+      def test_wraps_ruby_standard_error_in_execute_error
+        host = Host.new("deployer@example")
+        runner = Sequential.new([host]) { raise "oh no!" }
+        error = assert_raises(SSHKit::Runner::ExecuteError) do
+          runner.execute
+        end
+        assert_match(/deployer@example/, error.message)
+        assert_match(/oh no!/, error.message)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -218,6 +218,9 @@ files:
 - test/unit/formatters/test_dot.rb
 - test/unit/formatters/test_pretty.rb
 - test/unit/formatters/test_simple_text.rb
+- test/unit/runners/test_group.rb
+- test/unit/runners/test_parallel.rb
+- test/unit/runners/test_sequential.rb
 - test/unit/test_color.rb
 - test/unit/test_command.rb
 - test/unit/test_command_map.rb
@@ -248,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby
@@ -271,6 +274,9 @@ test_files:
 - test/unit/formatters/test_dot.rb
 - test/unit/formatters/test_pretty.rb
 - test/unit/formatters/test_simple_text.rb
+- test/unit/runners/test_group.rb
+- test/unit/runners/test_parallel.rb
+- test/unit/runners/test_sequential.rb
 - test/unit/test_color.rb
 - test/unit/test_command.rb
 - test/unit/test_command_map.rb