sshkit 1.21.5 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45797b636d02d174676019185c1199342f1ca21f8b72c09acd1cbebf44bb9263
-  data.tar.gz: fc271769aefc5c107ff1c406a54d3d085d062d8a24dbd0946b9763170f338d19
+  metadata.gz: f40ad7a1382ef707a259094c945692f08c44392e0bba7c37fe4099e748301a5e
+  data.tar.gz: 72f3fea395eaaa0036dd701c04692e75c379867465cffaa4ac6cdf1c4f647813
 SHA512:
-  metadata.gz: 30396905e750c8f3a82466eb90486eb0287bd716db6762fa9cdb67953369f42decbb44c19915983253286d57cc8a7ba061c05c5cc06f623fcdc884473af7fc1d
-  data.tar.gz: 6d15cb5f1d640fec3767d7a1130fe2ce5c723364b9e1678b94baeb55994bb2978de03e1790aca017f894efbd4b8f29d5b02556967cbbebcea43e31ea360d599f
+  metadata.gz: ab28074eba7cb9bdbfcbca9857f5e74fc89ed06acdf872148fcb7329b45754a714c658dacd879fead076de3bbd2541d84bcfd8ef66369007a1444b3edc2b3ac3
+  data.tar.gz: a6d0deb01db101ba2a41dcfcd861a10c7604b17ebe5e25981eebe6d74a0b5c9a9ea345d2dcbb45a4ba30952b571b6736f3bdcd7721d7d8fe684db772cc723700

data/.docker/Dockerfile

@@ -0,0 +1,6 @@
+FROM ubuntu:22.04
+WORKDIR /provision
+COPY ./ubuntu_setup.sh ./
+RUN ./ubuntu_setup.sh
+EXPOSE 22
+CMD ["/usr/sbin/sshd", "-D"]

data/.docker/ubuntu_setup.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+export DEBIAN_FRONTEND=noninteractive
+apt -y update
+
+# Create `deployer` user that can sudo without a password
+apt-get -y install sudo
+adduser --disabled-password deployer < /dev/null
+echo "deployer:topsecret" | chpasswd
+echo "deployer ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
+
+# Install and configure sshd
+apt-get -y install openssh-server
+{
+  echo "Port 22"
+  echo "PasswordAuthentication yes"
+  echo "ChallengeResponseAuthentication no"
+} >> /etc/ssh/sshd_config
+mkdir /var/run/sshd
+chmod 0755 /var/run/sshd

data/.github/release-drafter.yml

@@ -1,5 +1,5 @@
-name-template: "$NEXT_PATCH_VERSION"
-tag-template: "v$NEXT_PATCH_VERSION"
+name-template: "$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
 categories:
   - title: "⚠️ Breaking Changes"
     label: "⚠️ Breaking"
@@ -11,7 +11,15 @@ categories:
     label: "📚 Docs"
   - title: "🏠 Housekeeping"
     label: "🏠 Housekeeping"
+version-resolver:
+  minor:
+    labels:
+      - "⚠️ Breaking"
+      - "✨ Feature"
+  default: patch
 change-template: "- $TITLE (#$NUMBER) @$AUTHOR"
 no-changes-template: "- No changes"
 template: |
   $CHANGES
+
+  **Full Changelog:** https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION

data/.github/workflows/ci.yml

@@ -8,9 +8,21 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ["2.3", "2.4", "2.5", "2.6", "2.7", "3.0", "3.1", "3.2", "head"]
+        ruby:
+          [
+            "2.3",
+            "2.4",
+            "2.5",
+            "2.6",
+            "2.7",
+            "3.0",
+            "3.1",
+            "3.2",
+            "3.3",
+            "head",
+          ]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -25,7 +37,7 @@ jobs:
       matrix:
         ruby: ["2.0", "2.1", "2.2"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -49,7 +61,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -59,44 +71,17 @@ jobs:
         run: bundle exec rake lint
 
   functional:
-    runs-on: macos-12
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby:
-          [
-            "2.0",
-            "2.1",
-            "2.2",
-            "2.3",
-            "2.4",
-            "2.5",
-            "2.6",
-            "2.7",
-            "3.0",
-            "3.1",
-            "3.2",
-            "head",
-          ]
+        ruby: ["2.0", "ruby"]
     steps:
-      - uses: actions/checkout@v3
-
-      - name: Cache Vagrant boxes
-        uses: actions/cache@v3
-        with:
-          path: ~/.vagrant.d/boxes
-          key: ${{ runner.os }}-vagrant-v2-${{ hashFiles('Vagrantfile') }}
-          restore-keys: |
-            ${{ runner.os }}-vagrant-v2-
-
-      - name: Run vagrant up
-        run: vagrant up
-
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-
       - name: Run functional tests
         run: bundle exec rake test:functional
 

data/.github/workflows/push.yml

@@ -7,6 +7,6 @@ jobs:
     steps:
       - uses: actions/checkout@master
       - name: Draft Release
-        uses: toolmantim/release-drafter@v5.24.0
+        uses: toolmantim/release-drafter@v6.0.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -3,6 +3,5 @@
 bin/rake
 .bundle
 .yardoc
-.vagrant*
 test/tmp
 Gemfile.lock

data/.rubocop_todo.yml

@@ -102,7 +102,6 @@ Layout/IndentHash:
   Exclude:
     - 'test/functional/backends/test_local.rb'
     - 'test/functional/backends/test_netssh.rb'
-    - 'test/support/vagrant_wrapper.rb'
     - 'test/unit/formatters/test_custom.rb'
     - 'test/unit/formatters/test_pretty.rb'
     - 'test/unit/test_mapping_interaction_handler.rb'
@@ -445,12 +444,6 @@ Style/MethodName:
   Exclude:
     - 'test/unit/test_color.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MutableConstant:
-  Exclude:
-    - 'Vagrantfile'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: Strict.

data/CONTRIBUTING.md

@@ -24,8 +24,8 @@ using unsupported features.
 
 ## Tests
 
-SSHKit has a unit test suite and a functional test suite. Some functional tests run against
-[Vagrant](https://www.vagrantup.com/) VMs. If possible, you should make sure that the
+SSHKit has a unit test suite and a functional test suite. Some functional tests run using
+[Docker](https://docs.docker.com/get-docker/). If possible, you should make sure that the
 tests pass for each commit by running `rake` in the sshkit directory. This is in case we
 need to cherry pick commits or rebase. You should ensure the tests pass, (preferably on
 the minimum and maximum ruby version), before creating a PR.

data/EXAMPLES.md

@@ -121,9 +121,6 @@ on hosts do |host|
 end
 ```
 
-**Note:** The `upload!()` method doesn't honor the values of `as()` etc, this
-will be improved as the library matures, but we're not there yet.
-
 ## Upload a file from a stream
 
 ```ruby
@@ -148,9 +145,6 @@ end
 This spares one from having to figure out the correct escaping sequences for
 something like "echo(:cat, '...?...', '> /etc/sudoers.d/yolo')".
 
-**Note:** The `upload!()` method doesn't honor the values of `within()`, `as()`
-etc, this will be improved as the library matures, but we're not there yet.
-
 ## Upload a directory of files
 
 ```ruby
@@ -160,7 +154,25 @@ end
 ```
 
 In this case the `recursive: true` option mirrors the same options which are
-available to [`Net::{SCP,SFTP}`](http://net-ssh.github.io/net-scp/).
+available to [`Net::SCP`](https://github.com/net-ssh/net-scp) and
+[`Net::SFTP`](https://github.com/net-ssh/net-sftp).
+
+## Set the upload/download method (SCP or SFTP).
+
+SSHKit can use SCP or SFTP for file transfers. The default is SCP, but this can be changed to SFTP per host:
+
+```ruby
+host = SSHKit::Host.new('user@example.com')
+host.transfer_method = :sftp
+```
+
+or globally:
+
+```ruby
+SSHKit::Backend::Netssh.configure do |ssh|
+  ssh.transfer_method = :sftp
+end
+```
 
 ## Setting global SSH options
 
@@ -235,16 +247,16 @@ end
 
 ```ruby
 # The default format is pretty, which outputs colored text
-SSHKit.config.format = :pretty
+SSHKit.config.use_format :pretty
 
 # Text with no coloring
-SSHKit.config.format = :simpletext
+SSHKit.config.use_format :simpletext
 
 # Red / Green dots for each completed step
-SSHKit.config.format = :dot
+SSHKit.config.use_format :dot
 
 # No output
-SSHKit.config.format = :blackhole
+SSHKit.config.use_format :blackhole
 ```
 
 ## Implement a dirt-simple formatter class
@@ -254,7 +266,7 @@ module SSHKit
   module Formatter
     class MyFormatter < SSHKit::Formatter::Abstract
       def write(obj)
-        case obj.is_a? SSHKit::Command
+        if obj.is_a? SSHKit::Command
           # Do something here, see the SSHKit::Command documentation
         end
       end
@@ -263,7 +275,7 @@ module SSHKit
 end
 
 # If your formatter is defined in the SSHKit::Formatter module configure with the format option:
-SSHKit.config.format = :myformatter
+SSHKit.config.use_format :myformatter
 
 # Or configure the output directly
 SSHKit.config.output = MyFormatter.new($stdout)

data/README.md

@@ -68,7 +68,8 @@ you can pass the `strip: false` option: `capture(:ls, '-l', strip: false)`
 ### Transferring files
 
 All backends also support the `upload!` and `download!` methods for transferring files.
-For the remote backend, the file is transferred with scp.
+For the remote backend, the file is transferred with scp by default, but sftp is also
+supported. See [EXAMPLES.md](EXAMPLES.md) for details.
 
 ```ruby
 on '1.example.com' do

data/RELEASING.md

@@ -9,7 +9,7 @@
 ## How to release
 
 1. Run `bundle install` to make sure that you have all the gems necessary for testing and releasing.
-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`.
+2.  **Ensure the tests are passing by running `rake test`.** If functional tests fail, ensure you have [Docker installed](https://docs.docker.com/get-docker/) and running.
 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. Commit the `version.rb` change with a message like "Preparing vX.Y.Z"

data/Rakefile

@@ -21,10 +21,6 @@ namespace :test do
 
 end
 
-Rake::Task["test:functional"].enhance do
-  warn "Remember there are still some VMs running, kill them with `vagrant halt` if you are finished using them."
-end
-
 desc 'Run RuboCop lint checks'
 RuboCop::RakeTask.new(:lint) do |task|
   task.options = ['--lint']

data/docker-compose.yml

@@ -0,0 +1,8 @@
+name: sshkit
+
+services:
+  ssh_server:
+    build:
+      context: .docker
+    ports:
+      - "2122:22"

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

@@ -36,8 +36,8 @@ 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, first_conn = connections.first
-    return if (first_expires_at.nil? || fresh?(first_expires_at)) && !closed?(first_conn)
+    first_expires_at, _first_conn = connections.first
+    return if (first_expires_at.nil? || fresh?(first_expires_at))
 
     connections.synchronize do
       fresh, stale = connections.partition do |expires_at, conn|

data/lib/sshkit/backends/netssh/known_hosts.rb

@@ -1,3 +1,5 @@
+require "base64"
+
 module SSHKit
 
   module Backend
@@ -5,12 +7,11 @@ module SSHKit
     class Netssh < Abstract
 
       class KnownHostsKeys
-        include Mutex_m
-
         def initialize(path)
           super()
           @path = File.expand_path(path)
           @hosts_keys = nil
+          @mutex = Mutex.new
         end
 
         def keys_for(hostlist)
@@ -44,7 +45,7 @@ module SSHKit
         end
 
         def parse_file
-          synchronize do
+          @mutex.synchronize do
             return if hosts_keys && hosts_hashes
 
             unless File.readable?(path)
@@ -110,11 +111,10 @@ module SSHKit
       end
 
       class KnownHosts
-        include Mutex_m
-
         def initialize
           super()
           @files = {}
+          @mutex = Mutex.new
         end
 
         def search_for(host, options = {})
@@ -126,13 +126,13 @@ module SSHKit
 
         def add(*args)
           ::Net::SSH::KnownHosts.add(*args)
-          synchronize { @files = {} }
+          @mutex.synchronize { @files = {} }
         end
 
         private
 
         def known_hosts_file(path)
-          @files[path] || synchronize { @files[path] ||= KnownHostsKeys.new(path) }
+          @files[path] || @mutex.synchronize { @files[path] ||= KnownHostsKeys.new(path) }
         end
       end
 
@@ -140,4 +140,4 @@ module SSHKit
 
   end
 
-end
+end

data/lib/sshkit/backends/netssh/scp_transfer.rb

@@ -0,0 +1,26 @@
+require "net/scp"
+
+module SSHKit
+  module Backend
+    class Netssh < Abstract
+      class ScpTransfer
+        def initialize(ssh, summarizer)
+          @ssh = ssh
+          @summarizer = summarizer
+        end
+
+        def upload!(local, remote, options)
+          ssh.scp.upload!(local, remote, options, &summarizer)
+        end
+
+        def download!(remote, local, options)
+          ssh.scp.download!(remote, local, options, &summarizer)
+        end
+
+        private
+
+        attr_reader :ssh, :summarizer
+      end
+    end
+  end
+end

data/lib/sshkit/backends/netssh/sftp_transfer.rb

@@ -0,0 +1,46 @@
+require "net/sftp"
+
+module SSHKit
+  module Backend
+    class Netssh < Abstract
+      class SftpTransfer
+        def initialize(ssh, summarizer)
+          @ssh = ssh
+          @summarizer = summarizer
+        end
+
+        def upload!(local, remote, options)
+          options = { progress: self }.merge(options || {})
+          ssh.sftp.connect!
+          ssh.sftp.upload!(local, remote, options)
+        ensure
+          ssh.sftp.close_channel
+        end
+
+        def download!(remote, local, options)
+          options = { progress: self }.merge(options || {})
+          destination = local ? local : StringIO.new.tap { |io| io.set_encoding('BINARY') }
+
+          ssh.sftp.connect!
+          ssh.sftp.download!(remote, destination, options)
+          local ? true : destination.string
+        ensure
+          ssh.sftp.close_channel
+        end
+
+        def on_get(download, entry, offset, data)
+          entry.size ||= download.sftp.file.open(entry.remote) { |file| file.stat.size }
+          summarizer.call(nil, entry.remote, offset + data.bytesize, entry.size)
+        end
+
+        def on_put(_upload, file, offset, data)
+          summarizer.call(nil, file.local, offset + data.bytesize, file.size)
+        end
+
+        private
+
+        attr_reader :ssh, :summarizer
+      end
+    end
+  end
+end

data/lib/sshkit/backends/netssh.rb

@@ -1,8 +1,6 @@
 require 'English'
 require 'strscan'
-require 'mutex_m'
 require 'net/ssh'
-require 'net/scp'
 
 module Net
   module SSH
@@ -23,10 +21,27 @@ module SSHKit
   module Backend
 
     class Netssh < Abstract
+      def self.assert_valid_transfer_method!(method)
+        return if [:scp, :sftp].include?(method)
+
+        raise ArgumentError, "#{method.inspect} is not a valid transfer method. Supported methods are :scp, :sftp."
+      end
+
       class Configuration
         attr_accessor :connection_timeout, :pty
+        attr_reader :transfer_method
         attr_writer :ssh_options
 
+        def initialize
+          self.transfer_method = :scp
+        end
+
+        def transfer_method=(method)
+          Netssh.assert_valid_transfer_method!(method)
+
+          @transfer_method = method
+        end
+
         def ssh_options
           default_options.merge(@ssh_options ||= {})
         end
@@ -64,16 +79,16 @@ module SSHKit
       def upload!(local, remote, options = {})
         summarizer = transfer_summarizer('Uploading', options)
         remote = File.join(pwd_path, remote) unless remote.to_s.start_with?("/") || pwd_path.nil?
-        with_ssh do |ssh|
-          ssh.scp.upload!(local, remote, options, &summarizer)
+        with_transfer(summarizer) do |transfer|
+          transfer.upload!(local, remote, options)
         end
       end
 
       def download!(remote, local=nil, options = {})
         summarizer = transfer_summarizer('Downloading', options)
         remote = File.join(pwd_path, remote) unless remote.to_s.start_with?("/") || pwd_path.nil?
-        with_ssh do |ssh|
-          ssh.scp.download!(remote, local, options, &summarizer)
+        with_transfer(summarizer) do |transfer|
+          transfer.download!(remote, local, options)
         end
       end
 
@@ -105,7 +120,7 @@ module SSHKit
         last_percentage = nil
         proc do |_ch, name, transferred, total|
           percentage = (transferred.to_f * 100 / total.to_f)
-          unless percentage.nan?
+          unless percentage.nan? || percentage.infinite?
             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)
@@ -183,6 +198,20 @@ module SSHKit
         )
       end
 
+      def with_transfer(summarizer)
+        transfer_method = host.transfer_method || self.class.config.transfer_method
+        transfer_class = if transfer_method == :sftp
+                           require_relative "netssh/sftp_transfer"
+                           SftpTransfer
+                         else
+                           require_relative "netssh/scp_transfer"
+                           ScpTransfer
+                         end
+
+        with_ssh do |ssh|
+          yield(transfer_class.new(ssh, summarizer))
+        end
+      end
     end
   end
 

data/lib/sshkit/host.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'resolv'
 
 module SSHKit
 
@@ -7,6 +8,7 @@ module SSHKit
   class Host
 
     attr_accessor :password, :hostname, :port, :user, :ssh_options
+    attr_reader :transfer_method
 
     def key=(new_key)
       @keys = [new_key]
@@ -41,6 +43,12 @@ module SSHKit
       end
     end
 
+    def transfer_method=(method)
+      Backend::Netssh.assert_valid_transfer_method!(method) unless method.nil?
+
+      @transfer_method = method
+    end
+
     def local?
       @local
     end
@@ -115,6 +123,22 @@ module SSHKit
 
   end
 
+  # @private
+  # :nodoc:
+  class IPv6HostParser < SimpleHostParser
+    def self.suitable?(host_string)
+      host_string.match(Resolv::IPv6::Regex)
+    end
+
+    def port
+
+    end
+
+    def hostname
+      @host_string.match(Resolv::IPv6::Regex)[0]
+    end
+  end
+
   class HostWithPortParser < SimpleHostParser
 
     def self.suitable?(host_string)
@@ -185,6 +209,7 @@ module SSHKit
 
   PARSERS = [
     SimpleHostParser,
+    IPv6HostParser,
     HostWithPortParser,
     HostWithUsernameAndPortParser,
     IPv6HostWithPortParser,

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.21.5".freeze
+  VERSION = "1.23.0".freeze
 end

data/sshkit.gemspec

@@ -20,8 +20,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = SSHKit::VERSION
 
+  gem.add_runtime_dependency('base64') if RUBY_VERSION >= "2.4"
   gem.add_runtime_dependency('net-ssh',  '>= 2.8.0')
   gem.add_runtime_dependency('net-scp',  '>= 1.1.2')
+  gem.add_runtime_dependency('net-sftp', '>= 2.1.2')
 
   gem.add_development_dependency('danger')
   gem.add_development_dependency('minitest', '>= 5.0.0')