sshkit 1.19.0 → 1.21.2

data/Dangerfile

@@ -1 +1 @@
-danger.import_dangerfile(github: "capistrano/danger")
+danger.import_dangerfile(github: "capistrano/danger", branch: "no-changelog")

data/EXAMPLES.md

@@ -171,6 +171,7 @@ individual hosts:
 SSHKit::Backend::Netssh.configure do |ssh|
   ssh.connection_timeout = 30
   ssh.ssh_options = {
+    user: 'adifferentuser',
     keys: %w(/home/user/.ssh/id_rsa),
     forward_agent: false,
     auth_methods: %w(publickey password)

data/Gemfile

@@ -2,18 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'json'
-end
-
-# Chandler requires Ruby >= 2.1.0, but depending on the Travis environment,
-# we may not meet that requirement. Only include the chandler gem if the Ruby
-# requirement is met. (Chandler is used only for `rake release`; see Rakefile.)
-if Gem::Requirement.new('>= 2.1.0').satisfied_by?(Gem::Version.new(RUBY_VERSION))
-  gem 'chandler', '>= 0.1.1'
-end
-
 # public_suffix 3+ requires ruby 2.1+
 if Gem::Requirement.new('< 2.1').satisfied_by?(Gem::Version.new(RUBY_VERSION))
   gem 'public_suffix', '< 3'

data/README.md

@@ -6,29 +6,31 @@ more servers.
 [![Gem Version](https://badge.fury.io/rb/sshkit.svg)](https://rubygems.org/gems/sshkit)
 [![Build Status](https://travis-ci.org/capistrano/sshkit.svg?branch=master)](https://travis-ci.org/capistrano/sshkit)
 
-## How might it work?
+## Example
 
-The typical use-case looks something like this:
+ - Connect to 2 servers
+ - Execute commands as `deploy` user with `RAILS_ENV=production`
+ - Execute commands in serial (default is `:parallel`)
 
 ```ruby
 require 'sshkit'
 require 'sshkit/dsl'
 include SSHKit::DSL
 
-on %w{1.example.com 2.example.com}, in: :sequence, wait: 5 do |host|
+on ["1.example.com", "2.example.com"], in: :sequence do |host|
+  puts "Now executing on #{host}"
   within "/opt/sites/example.com" do
     as :deploy  do
-      with rails_env: :production do
-        rake   "assets:precompile"
-        runner "S3::Sync.notify"
-        execute :node, "socket_server.js"
+      with RAILS_ENV: 'production' do
+        execute :rake, "assets:precompile"
+        execute :rails, "runner", "S3::Sync.notify"
       end
     end
   end
 end
 ```
 
-You can find many other examples of how to use SSHKit over in [EXAMPLES.md](EXAMPLES.md).
+Many other examples are in [EXAMPLES.md](EXAMPLES.md).
 
 ## Basic usage
 
@@ -37,7 +39,7 @@ You can pass one or more hosts as parameters; this runs commands via SSH. Altern
 pass `:local` to run commands locally. By default SSKit will run the commands on all hosts in
 parallel.
 
-#### Running commands
+### Running commands
 
 All backends support the `execute(*args)`, `test(*args)` & `capture(*args)` methods
 for executing a command. You can call any of these methods in the context of an `on()`
@@ -63,7 +65,7 @@ end
 By default the `capture` methods strips whitespace. If you need to preserve whitespace
 you can pass the `strip: false` option: `capture(:ls, '-l', strip: false)`
 
-#### Transferring files
+### Transferring files
 
 All backends also support the `upload!` and `download!` methods for transferring files.
 For the remote backend, the file is transferred with scp.
@@ -75,7 +77,7 @@ on '1.example.com' do
 end
 ```
 
-#### Users, working directories, environment variables and umask
+### Users, working directories, environment variables and umask
 
 When running commands, you can tell SSHKit to set up the context for those
 commands using the following methods:
@@ -113,6 +115,11 @@ the raised error.
 Helpers such as `runner()` and `rake()` which expand to `execute(:rails, "runner", ...)` and
 `execute(:rake, ...)` are convenience helpers for Ruby, and Rails based apps.
 
+### Verbosity / Silence
+
+ - raise verbosity of a command: `execute "echo DEAD", verbosity: :ERROR`
+ - hide a command from output: `execute "echo HIDDEN", verbosity: :DEBUG`
+
 ## Parallel
 
 Notice on the `on()` call the `in: :sequence` option, the following will do
@@ -567,10 +574,20 @@ In order to do special gymnastics with SSH, tunneling, aliasing, complex options
 
 These system level files are the preferred way of setting up tunneling and proxies because the system implementations of these things are faster and better than the Ruby implementations you would get if you were to configure them through Net::SSH. In cases where it's not possible (Windows?), it should be possible to make use of the Net::SSH APIs to setup tunnels and proxy commands before deferring control to Capistrano/SSHKit..
 
-## SSHKit Related Blog Posts
+## Proxying
 
-[SSHKit Gem Basics](http://www.rubyplus.com/articles/591)
+To connect to the target host via a jump/bastion host, use a `Net::SSH::Proxy::Jump`
 
-[SSHKit Gem Part 2](http://www.rubyplus.com/articles/601)
+```ruby
+host = SSHKit::Host.new(
+  hostname: 'target.host.com',
+  ssh_options: { proxy: Net::SSH::Proxy::Jump.new("proxy.bar.com") }
+)
+on [host] do
+  execute :echo, '1'
+end
+```
+
+## SSHKit Related Blog Posts
 
 [Embedded Capistrano with SSHKit](http://ryandoyle.net/posts/embedded-capistrano-with-sshkit/)

data/RELEASING.md

@@ -5,7 +5,6 @@
 * You must have commit rights to the SSHKit repository.
 * You must have push rights for the sshkit gem on rubygems.org.
 * You must be using Ruby >= 2.1.0.
-* Your `~/.netrc` must be configured with your GitHub credentials, [as explained here](https://github.com/mattbrictson/chandler#2-configure-netrc).
 
 ## How to release
 
@@ -13,6 +12,6 @@
 2.  **Ensure the tests are passing by running `rake test`.** If functional tests fail, ensure you have [Vagrant](https://www.vagrantup.com) installed and have started it with `vagrant up`.
 3. Determine which would be the correct next version number according to [semver](http://semver.org/).
 4. Update the version in `./lib/sshkit/version.rb`.
-5. Update the `CHANGELOG`.
-6. Commit the changelog and version in a single commit, the message should be "Preparing vX.Y.Z"
-7. Run `rake release`; this will tag, push to GitHub, publish to rubygems.org, and upload the latest changelog entry to the [GitHub releases page](https://github.com/capistrano/sshkit/releases).
+5. Commit the `version.rb` change with a message like "Preparing vX.Y.Z"
+6. Run `rake release`; this will tag, push to GitHub, and publish to rubygems.org
+7. Update the draft release on the [GitHub releases page](https://github.com/capistrano/sshkit/releases) to point to the new tag and publish the release

data/Rakefile

@@ -30,10 +30,7 @@ RuboCop::RakeTask.new(:lint) do |task|
   task.options = ['--lint']
 end
 
-task "release:rubygem_push" do
-  # Delay loading Chandler until this point, since it requires Ruby >= 2.1,
-  # which may not be available in all environments (e.g. Travis).
-  # We assume that the person doing `rake release` has Ruby >= 2.1.
-  require "chandler/tasks"
-  Rake.application.invoke_task("chandler:push")
+Rake::Task["release"].enhance do
+  puts "Don't forget to publish the release on GitHub!"
+  system "open https://github.com/capistrano/sshkit/releases"
 end

data/Vagrantfile

@@ -2,6 +2,11 @@ VAGRANTFILE_API_VERSION = "2"
 
 Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   config.vm.box = 'hashicorp/precise64'
+  config.vm.provision "shell", inline: <<-SHELL
+  echo 'ClientAliveInterval 1' >> /etc/ssh/sshd_config
+  echo 'ClientAliveCountMax 1' >> /etc/ssh/sshd_config
+  service ssh restart
+  SHELL
 
   json_config_path = File.join("test", "boxes.json")
   list = File.open(json_config_path).read

data/examples/simple_connection.rb

@@ -0,0 +1,9 @@
+# tiny example so you can play with the sshkit or make a failing example for an issue
+require 'bundler/setup'
+require 'sshkit'
+require 'sshkit/dsl'
+include SSHKit::DSL
+
+on [ENV.fetch("HOST")] do
+  execute "echo hello"
+end

data/lib/sshkit/backends/abstract.rb

@@ -82,9 +82,10 @@ module SSHKit
 
       def within(directory, &_block)
         (@pwd ||= []).push directory.to_s
+        escaped = Command.shellescape_except_tilde(pwd_path)
         execute <<-EOTEST, verbosity: Logger::DEBUG
-          if test ! -d #{File.join(@pwd).shellescape}
-            then echo "Directory does not exist '#{File.join(@pwd).shellescape}'" 1>&2
+          if test ! -d #{escaped}
+            then echo "Directory does not exist '#{escaped}'" 1>&2
             false
           fi
         EOTEST

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

@@ -36,12 +36,12 @@ class SSHKit::Backend::ConnectionPool::Cache
   def evict
     # Peek at the first connection to see if it is still fresh. If so, we can
     # return right away without needing to use `synchronize`.
-    first_expires_at, _connection = connections.first
-    return if first_expires_at.nil? || fresh?(first_expires_at)
+    first_expires_at, first_conn = connections.first
+    return if (first_expires_at.nil? || fresh?(first_expires_at)) && !closed?(first_conn)
 
     connections.synchronize do
-      fresh, stale = connections.partition do |expires_at, _|
-        fresh?(expires_at)
+      fresh, stale = connections.partition do |expires_at, conn|
+        fresh?(expires_at) && !closed?(conn)
       end
       connections.replace(fresh)
       stale.each { |_, conn| closer.call(conn) }
@@ -71,6 +71,13 @@ class SSHKit::Backend::ConnectionPool::Cache
   end
 
   def closed?(conn)
-    conn.respond_to?(:closed?) && conn.closed?
+    return true if conn.respond_to?(:closed?) && conn.closed?
+    # test if connection is alive
+    conn.process(0) if conn.respond_to?(:process)
+    return false
+  rescue IOError => e
+    # connection is closed by server
+    return true if e.message == 'closed stream'
+    raise
   end
 end

data/lib/sshkit/backends/netssh.rb

@@ -109,7 +109,8 @@ module SSHKit
             message = "#{action} #{name} #{percentage.round(2)}%"
             percentage_r = (percentage / log_percent).truncate * log_percent
             if percentage_r > 0 && (last_name != name || last_percentage != percentage_r)
-              info message
+              verbosity = (options[:verbosity] || :INFO).downcase # TODO: ideally reuse command.rb logic
+              public_send verbosity, message
               last_name = name
               last_percentage = percentage_r
             else

data/lib/sshkit/command.rb

@@ -143,7 +143,7 @@ module SSHKit
 
     def within(&_block)
       return yield unless options[:in]
-      "cd #{options[:in].shellescape} && #{yield}"
+      "cd #{self.class.shellescape_except_tilde(options[:in])} && #{yield}"
     end
 
     def environment_hash
@@ -219,6 +219,11 @@ module SSHKit
       end
     end
 
+    # allow using home directory but escape everything else like spaces etc
+    def self.shellescape_except_tilde(file)
+      file.shellescape.gsub("\\~", "~")
+    end
+
     private
 
     def default_options
@@ -234,7 +239,7 @@ module SSHKit
 
     def call_interaction_handler(stream_name, data, channel)
       interaction_handler = options[:interaction_handler]
-      interaction_handler = MappingInteractionHandler.new(interaction_handler) if interaction_handler.kind_of?(Hash)
+      interaction_handler = MappingInteractionHandler.new(interaction_handler) if interaction_handler.kind_of?(Hash) or interaction_handler.kind_of?(Proc)
       interaction_handler.on_data(self, stream_name, data, channel) if interaction_handler.respond_to?(:on_data)
     end
 

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.19.0".freeze
+  VERSION = "1.21.2".freeze
 end

data/sshkit.gemspec

@@ -9,6 +9,9 @@ Gem::Specification.new do |gem|
   gem.description   = %q{A comprehensive toolkit for remotely running commands in a structured manner on groups of servers.}
   gem.homepage      = "http://github.com/capistrano/sshkit"
   gem.license       = "MIT"
+  gem.metadata      = {
+    "changelog_uri" => "https://github.com/capistrano/sshkit/releases"
+  }
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

data/test/functional/backends/test_local.rb

@@ -99,6 +99,24 @@ module SSHKit
         end.run
         assert_equal("Enter Data\nCaptured SOME DATA", captured_command_result)
       end
+
+      def test_interaction_handler_with_proc
+        captured_command_result = nil
+        Local.new do
+          command = 'echo Enter Data; read the_data; echo Captured $the_data;'
+          captured_command_result = capture(command, interaction_handler:
+            lambda { |data|
+              case data
+              when "Enter Data\n"
+                "SOME DATA\n"
+              when "Captured SOME DATA\n"
+                nil
+              end
+            }
+          )
+        end.run
+        assert_equal("Enter Data\nCaptured SOME DATA", captured_command_result)
+      end
     end
   end
 end

data/test/functional/backends/test_netssh.rb

@@ -180,7 +180,7 @@ module SSHKit
         size      = 25
         fills     = SecureRandom.random_bytes(1024*1024)
         file_name = "/tmp/file-#{size}.txt"
-        File.open(file_name, 'w') do |f|
+        File.open(file_name, 'wb') do |f|
           (size).times {f.write(fills) }
         end
         file_contents = ""
@@ -188,7 +188,7 @@ module SSHKit
           upload!(file_name, file_name)
           file_contents = download!(file_name)
         end.run
-        assert_equal File.open(file_name).read, file_contents
+        assert_equal File.open(file_name, 'rb').read, file_contents
       end
 
       def test_upload_via_pathname
@@ -212,6 +212,20 @@ module SSHKit
         end.run
         assert_equal("Enter Data\nCaptured SOME DATA", captured_command_result)
       end
+
+      def test_connection_pool_keepalive
+        # ensure we enable connection pool
+        SSHKit::Backend::Netssh.pool.idle_timeout = 10
+        Netssh.new(a_host) do |_host|
+          test :false
+        end.run
+        sleep 2.5
+        captured_command_result = nil
+        Netssh.new(a_host) do |_host|
+          captured_command_result = capture(:echo, 'some_value')
+        end.run
+        assert_equal "some_value", captured_command_result
+      end
     end
 
   end

data/test/helper.rb

@@ -3,7 +3,7 @@ require 'bundler/setup'
 require 'tempfile'
 require 'minitest/autorun'
 require 'minitest/reporters'
-require 'mocha/setup'
+require 'mocha/minitest'
 require 'stringio'
 require 'json'
 

data/test/unit/backends/test_abstract.rb

@@ -99,6 +99,18 @@ module SSHKit
         assert_equal '/usr/bin/env cat file', backend.executed_command.to_command
       end
 
+      def test_within_home
+        backend = ExampleBackend.new do
+          within '~/foo' do
+            execute :cat, 'file', :strip => false
+          end
+        end
+
+        backend.run
+
+        assert_equal 'cd ~/foo && /usr/bin/env cat file', backend.executed_command.to_command
+      end
+
       def test_background_logs_deprecation_warnings
         deprecation_out = ''
         SSHKit.config.deprecation_output = deprecation_out

data/test/unit/backends/test_netssh.rb

@@ -54,6 +54,13 @@ module SSHKit
         end
       end
 
+      def test_transfer_summarizer_uses_verbosity
+        netssh = Netssh.new(Host.new('fake'))
+        summarizer = netssh.send(:transfer_summarizer, 'Transferring', verbosity: :ERROR)
+        netssh.expects(:error).with { |msg| msg.include?('Transferring afile 15.0%') }
+        summarizer.call(nil,'afile',15,100)
+      end
+
       if Net::SSH::Version::CURRENT >= Net::SSH::Version[3, 1, 0]
         def test_known_hosts_for_when_all_hosts_are_recognized
           perform_known_hosts_test('github', 'github.com')

data/test/unit/formatters/test_pretty.rb

@@ -115,7 +115,7 @@ module SSHKit
 
     def test_can_write_to_output_which_just_supports_append
       # Note output doesn't have to be an IO, it only needs to support <<
-      output = stub(:<<)
+      output = stub(:<< => nil)
       pretty = SSHKit::Formatter::Pretty.new(output)
       simulate_command_lifecycle(pretty)
     end

data/test/unit/test_command.rb

@@ -84,6 +84,11 @@ module SSHKit
       assert_equal "cd /opt/sites && /usr/bin/env ls -l", c.to_command
     end
 
+    def test_working_in_home_directory
+      c = Command.new(:ls, '-l', in: "~/sites")
+      assert_equal "cd ~/sites && /usr/bin/env ls -l", c.to_command
+    end
+
     def test_working_in_a_given_weird_directory
       c = Command.new(:ls, '-l', in: "/opt/sites and stuff")
       assert_equal "cd /opt/sites\\ and\\ stuff && /usr/bin/env ls -l", c.to_command

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.21.2
 platform: ruby
 authors:
 - Lee Hambley
 - Tom Clements
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -180,6 +180,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/release-drafter.yml"
+- ".github/workflows/push.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -199,6 +201,7 @@ files:
 - Vagrantfile
 - examples/images/example_output.png
 - examples/images/logo.png
+- examples/simple_connection.rb
 - lib/core_ext/array.rb
 - lib/core_ext/hash.rb
 - lib/sshkit.rb
@@ -270,8 +273,9 @@ files:
 homepage: http://github.com/capistrano/sshkit
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/capistrano/sshkit/releases
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -286,8 +290,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.5
+signing_key:
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby
 test_files: