sshkit 1.21.5 → 1.23.0

data/test/functional/backends/netssh_transfer_tests.rb

@@ -0,0 +1,83 @@
+require 'securerandom'
+
+module SSHKit
+  module Backend
+    module NetsshTransferTests
+      def setup
+        super
+        @output = String.new
+        SSHKit.config.output_verbosity = :debug
+        SSHKit.config.output = SSHKit::Formatter::SimpleText.new(@output)
+      end
+
+      def a_host
+        DockerWrapper.host
+      end
+
+      def test_upload_and_then_capture_file_contents
+        actual_file_contents = ""
+        file_name = File.join("/tmp", SecureRandom.uuid)
+        File.open file_name, 'w+' do |f|
+          f.write "Some Content\nWith a newline and trailing spaces    \n "
+        end
+        Netssh.new(a_host) do
+          upload!(file_name, file_name)
+          actual_file_contents = capture(:cat, file_name, strip: false)
+        end.run
+        assert_equal "Some Content\nWith a newline and trailing spaces    \n ", actual_file_contents
+      end
+
+      def test_upload_within
+        file_name = SecureRandom.uuid
+        file_contents = "Some Content"
+        dir_name = SecureRandom.uuid
+        actual_file_contents = ""
+        Netssh.new(a_host) do |_host|
+          within("/tmp") do
+            execute :mkdir, "-p", dir_name
+            within(dir_name) do
+              upload!(StringIO.new(file_contents), file_name)
+            end
+          end
+          actual_file_contents = capture(:cat, "/tmp/#{dir_name}/#{file_name}", strip: false)
+        end.run
+        assert_equal file_contents, actual_file_contents
+      end
+
+      def test_upload_string_io
+        file_contents = ""
+        Netssh.new(a_host) do |_host|
+          file_name = File.join("/tmp", SecureRandom.uuid)
+          upload!(StringIO.new('example_io'), file_name)
+          file_contents = download!(file_name)
+        end.run
+        assert_equal "example_io", file_contents
+      end
+
+      def test_upload_large_file
+        size      = 25
+        fills     = SecureRandom.random_bytes(1024*1024)
+        file_name = "/tmp/file-#{size}.txt"
+        File.open(file_name, 'wb') do |f|
+          (size).times {f.write(fills) }
+        end
+        file_contents = ""
+        Netssh.new(a_host) do
+          upload!(file_name, file_name)
+          file_contents = download!(file_name)
+        end.run
+        assert_equal File.open(file_name, 'rb').read, file_contents
+      end
+
+      def test_upload_via_pathname
+        file_contents = ""
+        Netssh.new(a_host) do |_host|
+          file_name = Pathname.new(File.join("/tmp", SecureRandom.uuid))
+          upload!(StringIO.new('example_io'), file_name)
+          file_contents = download!(file_name)
+        end.run
+        assert_equal "example_io", file_contents
+      end
+    end
+  end
+end

data/test/functional/backends/test_netssh.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'securerandom'
 require 'benchmark'
 
 module SSHKit
@@ -16,7 +15,7 @@ module SSHKit
       end
 
       def a_host
-        VagrantWrapper.hosts['one']
+        DockerWrapper.host
       end
 
       def test_simple_netssh
@@ -136,71 +135,6 @@ module SSHKit
         end.run
       end
 
-      def test_upload_and_then_capture_file_contents
-        actual_file_contents = ""
-        file_name = File.join("/tmp", SecureRandom.uuid)
-        File.open file_name, 'w+' do |f|
-          f.write "Some Content\nWith a newline and trailing spaces    \n "
-        end
-        Netssh.new(a_host) do
-          upload!(file_name, file_name)
-          actual_file_contents = capture(:cat, file_name, strip: false)
-        end.run
-        assert_equal "Some Content\nWith a newline and trailing spaces    \n ", actual_file_contents
-      end
-
-      def test_upload_within
-        file_name = SecureRandom.uuid
-        file_contents = "Some Content"
-        dir_name = SecureRandom.uuid
-        actual_file_contents = ""
-        Netssh.new(a_host) do |_host|
-          within("/tmp") do
-            execute :mkdir, "-p", dir_name
-            within(dir_name) do
-              upload!(StringIO.new(file_contents), file_name)
-            end
-          end
-          actual_file_contents = capture(:cat, "/tmp/#{dir_name}/#{file_name}", strip: false)
-        end.run
-        assert_equal file_contents, actual_file_contents
-      end
-
-      def test_upload_string_io
-        file_contents = ""
-        Netssh.new(a_host) do |_host|
-          file_name = File.join("/tmp", SecureRandom.uuid)
-          upload!(StringIO.new('example_io'), file_name)
-          file_contents = download!(file_name)
-        end.run
-        assert_equal "example_io", file_contents
-      end
-
-      def test_upload_large_file
-        size      = 25
-        fills     = SecureRandom.random_bytes(1024*1024)
-        file_name = "/tmp/file-#{size}.txt"
-        File.open(file_name, 'wb') do |f|
-          (size).times {f.write(fills) }
-        end
-        file_contents = ""
-        Netssh.new(a_host) do
-          upload!(file_name, file_name)
-          file_contents = download!(file_name)
-        end.run
-        assert_equal File.open(file_name, 'rb').read, file_contents
-      end
-
-      def test_upload_via_pathname
-        file_contents = ""
-        Netssh.new(a_host) do |_host|
-          file_name = Pathname.new(File.join("/tmp", SecureRandom.uuid))
-          upload!(StringIO.new('example_io'), file_name)
-          file_contents = download!(file_name)
-        end.run
-        assert_equal "example_io", file_contents
-      end
-
       def test_interaction_handler
         captured_command_result = nil
         Netssh.new(a_host) do

data/test/functional/backends/test_netssh_scp.rb

@@ -0,0 +1,23 @@
+require 'helper'
+require_relative 'netssh_transfer_tests'
+
+module SSHKit
+  module Backend
+    class TestNetsshScp < FunctionalTest
+      include NetsshTransferTests
+
+      def setup
+        super
+        SSHKit::Backend::Netssh.configure do |ssh|
+          ssh.transfer_method = :scp
+        end
+      end
+
+      def test_scp_implementation_is_used
+        Netssh.new(a_host).send(:with_transfer, nil) do |transfer|
+          assert_instance_of Netssh::ScpTransfer, transfer
+        end
+      end
+    end
+  end
+end

data/test/functional/backends/test_netssh_sftp.rb

@@ -0,0 +1,23 @@
+require 'helper'
+require_relative 'netssh_transfer_tests'
+
+module SSHKit
+  module Backend
+    class TestNetsshSftp < FunctionalTest
+      include NetsshTransferTests
+
+      def setup
+        super
+        SSHKit::Backend::Netssh.configure do |ssh|
+          ssh.transfer_method = :sftp
+        end
+      end
+
+      def test_sftp_implementation_is_used
+        Netssh.new(a_host).send(:with_transfer, nil) do |transfer|
+          assert_instance_of Netssh::SftpTransfer, transfer
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -28,51 +28,13 @@ class UnitTest < Minitest::Test
 end
 
 class FunctionalTest < Minitest::Test
-
   def setup
-    unless VagrantWrapper.running?
-      warn "Vagrant VMs are not running. Please, start it manually with `vagrant up`"
-    end
-  end
-
-  private
-
-  def create_user_with_key(username, password = :secret)
-    username, password = username.to_s, password.to_s
-
-    keys = VagrantWrapper.hosts.collect do |_name, host|
-      Net::SSH.start(host.hostname, host.user, port: host.port, password: host.password) do |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")
+    require_relative "support/docker_wrapper"
+    return if DockerWrapper.running?
 
-        # 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")
-
-        # 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")
-
-        key = ssh.exec!("cat /home/vagrant/#{username}")
-
-        # Clean Up Files
-        ssh.exec!("sudo rm #{username} #{username}.pub")
-
-        key
-      end
-    end
-
-    Hash[VagrantWrapper.hosts.collect { |n, _h| n.to_sym }.zip(keys)]
+    DockerWrapper.start
+    DockerWrapper.wait_for_ssh_server
   end
-
 end
 
 #

data/test/support/docker_wrapper.rb

@@ -0,0 +1,71 @@
+require "socket"
+
+Minitest.after_run do
+  DockerWrapper.stop if DockerWrapper.running?
+end
+
+module DockerWrapper
+  SSH_SERVER_PORT = 2122
+
+  class << self
+    def host
+      SSHKit::Host.new(
+        user: "deployer",
+        hostname: "localhost",
+        port: SSH_SERVER_PORT,
+        password: "topsecret",
+        ssh_options: host_verify_options
+      )
+    end
+
+    def running?
+      out, status = run_compose_command("ps --status running", false)
+      status.success? && out.include?("ssh_server")
+    end
+
+    def start
+      run_compose_command("up -d")
+    end
+
+    def stop
+      run_compose_command("down")
+    end
+
+    def wait_for_ssh_server(retries=3)
+      Socket.tcp("localhost", SSH_SERVER_PORT, connect_timeout: 1).close
+      sleep(1)
+    rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT
+      retries -= 1
+      sleep(2) && retry if retries.positive?
+      raise
+    end
+
+    private
+
+    def run_compose_command(command, echo=true)
+      $stderr.puts "[docker compose] #{command}" if echo
+      Open3.popen2e("docker compose #{command}") do |stdin, outerr, wait_thread|
+        stdin.close
+        output = Thread.new { capture_stream(outerr, echo) }
+        [output.value, wait_thread.value]
+      end
+    end
+
+    def capture_stream(stream, echo=true)
+      buffer = String.new
+      while (line = stream.gets)
+        buffer << line
+        $stderr.puts("[docker compose] #{line}") if echo
+      end
+      buffer
+    end
+
+    def host_verify_options
+      if Net::SSH::Version::MAJOR >= 5
+        { verify_host_key: :never }
+      else
+        { paranoid: false }
+      end
+    end
+  end
+end

data/test/unit/backends/test_abstract.rb

@@ -124,7 +124,7 @@ module SSHKit
         assert_equal 2, lines.length
 
         assert_equal("[Deprecated] The background method is deprecated. Blame badly behaved pseudo-daemons!\n", lines[0])
-        assert_match(/    \(Called from.*test_abstract.rb:\d+:in `block in test_background_logs_deprecation_warnings'\)\n/, lines[1])
+        assert_match(/    \(Called from.*test_abstract.rb:\d+:in .block in .*test_background_logs_deprecation_warnings.\)\n/, lines[1])
       end
 
       def test_calling_abstract_with_undefined_execute_command_raises_exception

data/test/unit/backends/test_netssh.rb

@@ -5,6 +5,12 @@ module SSHKit
   module Backend
     class TestNetssh < UnitTest
 
+      def teardown
+        super
+        # Reset config to defaults after each test
+        backend.instance_variable_set :@config, nil
+      end
+
       def backend
         @backend ||= Netssh
       end
@@ -13,6 +19,7 @@ module SSHKit
         backend.configure do |ssh|
           ssh.pty = true
           ssh.connection_timeout = 30
+          ssh.transfer_method = :sftp
           ssh.ssh_options = {
             keys: %w(/home/user/.ssh/id_rsa),
             forward_agent: false,
@@ -21,6 +28,7 @@ module SSHKit
         end
 
         assert_equal 30, backend.config.connection_timeout
+        assert_equal :sftp, backend.config.transfer_method
         assert_equal true, backend.config.pty
 
         assert_equal %w(/home/user/.ssh/id_rsa),  backend.config.ssh_options[:keys]
@@ -29,6 +37,46 @@ module SSHKit
         assert_instance_of backend::KnownHosts,   backend.config.ssh_options[:known_hosts]
       end
 
+      def test_transfer_method_prohibits_invalid_values
+        error = assert_raises ArgumentError do
+          backend.configure do |ssh|
+            ssh.transfer_method = :nope
+          end
+        end
+
+        assert_match ":nope is not a valid transfer method", error.message
+      end
+
+      def test_transfer_method_does_not_allow_nil
+        error = assert_raises ArgumentError do
+          backend.configure do |ssh|
+            ssh.transfer_method = nil
+          end
+        end
+
+        assert_match "nil is not a valid transfer method", error.message
+      end
+
+      def test_transfer_method_defaults_to_scp
+        assert_equal :scp, backend.config.transfer_method
+      end
+
+      def test_host_can_override_transfer_method
+        backend.configure do |ssh|
+          ssh.transfer_method = :scp
+        end
+
+        host = Host.new("fake")
+        host.transfer_method = :sftp
+
+        netssh = backend.new(host)
+        netssh.stubs(:with_ssh).yields(nil)
+
+        netssh.send(:with_transfer, nil) do |transfer|
+          assert_instance_of Netssh::SftpTransfer, transfer
+        end
+      end
+
       def test_netssh_ext
         assert_includes  Net::SSH::Config.default_files, "#{Dir.pwd}/.ssh/config"
       end

data/test/unit/test_command_map.rb

@@ -27,26 +27,26 @@ module SSHKit
 
     def test_prefix
       map = CommandMap.new
-      map.prefix[:rake].push("/home/vagrant/.rbenv/bin/rbenv exec")
+      map.prefix[:rake].push("/home/deployer/.rbenv/bin/rbenv exec")
       map.prefix[:rake].push("bundle exec")
 
-      assert_equal map[:rake], "/home/vagrant/.rbenv/bin/rbenv exec bundle exec rake"
+      assert_equal map[:rake], "/home/deployer/.rbenv/bin/rbenv exec bundle exec rake"
     end
 
     def test_prefix_procs
       map = CommandMap.new
-      map.prefix[:rake].push("/home/vagrant/.rbenv/bin/rbenv exec")
+      map.prefix[:rake].push("/home/deployer/.rbenv/bin/rbenv exec")
       map.prefix[:rake].push(proc{ "bundle exec" })
 
-      assert_equal map[:rake], "/home/vagrant/.rbenv/bin/rbenv exec bundle exec rake"
+      assert_equal map[:rake], "/home/deployer/.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")
+      map.prefix[:rake].unshift("/home/deployer/.rbenv/bin/rbenv exec")
 
-      assert_equal map[:rake], "/home/vagrant/.rbenv/bin/rbenv exec bundle exec rake"
+      assert_equal map[:rake], "/home/deployer/.rbenv/bin/rbenv exec bundle exec rake"
     end
 
     def test_indifferent_setter
@@ -59,10 +59,10 @@ module SSHKit
 
     def test_indifferent_prefix
       map = CommandMap.new
-      map.prefix[:rake].push("/home/vagrant/.rbenv/bin/rbenv exec")
+      map.prefix[:rake].push("/home/deployer/.rbenv/bin/rbenv exec")
       map.prefix["rake"].push("bundle exec")
 
-      assert_equal map[:rake], "/home/vagrant/.rbenv/bin/rbenv exec bundle exec rake"
+      assert_equal map[:rake], "/home/deployer/.rbenv/bin/rbenv exec bundle exec rake"
     end
 
     def test_prefix_initialization_is_thread_safe

data/test/unit/test_deprecation_logger.rb

@@ -20,7 +20,7 @@ module SSHKit
 
       assert_equal(2, actual_lines.size)
       assert_equal "[Deprecated] Some message\n", actual_lines[0]
-      assert_match %r{    \(Called from .*sshkit/test/unit/test_deprecation_logger.rb:#{line_number}:in `generate_warning'\)\n}, actual_lines[1]
+      assert_match %r{    \(Called from .*sshkit/test/unit/test_deprecation_logger.rb:#{line_number}:in .*generate_warning.\)\n}, actual_lines[1]
     end
 
     def test_handles_nil_output

data/test/unit/test_host.rb

@@ -28,6 +28,12 @@ module SSHKit
       assert_equal 'example.com', h.hostname
     end
 
+    def test_custom_host_with_port
+      h = Host.new 'db:22'
+      assert_equal 22,   h.port
+      assert_equal 'db', h.hostname
+    end
+
     def test_host_with_username
       h = Host.new 'root@example.com'
       assert_equal 'root',        h.username
@@ -50,6 +56,12 @@ module SSHKit
       assert_equal 'localhost',         h.hostname
     end
 
+    def test_ipv6_without_brackets
+      h = Host.new '1fff:0:a88:85a3::ac1f'
+      assert_nil h.port
+      assert_equal '1fff:0:a88:85a3::ac1f', h.hostname
+    end
+
     def test_does_not_confuse_ipv6_hosts_with_port_specification
       h = Host.new '[1fff:0:a88:85a3::ac1f]:8001'
       assert_equal 8001,                    h.port
@@ -142,6 +154,33 @@ module SSHKit
       end
     end
 
+    def test_transfer_method_defaults_to_nil
+      host = Host.new 'example.com'
+      assert_nil host.transfer_method
+    end
+
+    def test_transfer_method_can_be_configured
+      host = Host.new 'example.com'
+
+      host.transfer_method = :scp
+      assert_equal :scp, host.transfer_method
+
+      host.transfer_method = :sftp
+      assert_equal :sftp, host.transfer_method
+
+      host.transfer_method = nil
+      assert_nil host.transfer_method
+    end
+
+    def test_transfer_method_prohibits_invalid_values
+      host = Host.new 'example.com'
+
+      error = assert_raises ArgumentError do
+        host.transfer_method = :nope
+      end
+
+      assert_match ":nope is not a valid transfer method", error.message
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.21.5
+  version: 1.23.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2024-06-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -39,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: danger
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +208,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".docker/Dockerfile"
+- ".docker/ubuntu_setup.sh"
 - ".github/dependabot.yml"
 - ".github/release-drafter.yml"
 - ".github/workflows/ci.yml"
@@ -199,7 +229,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
-- Vagrantfile
+- docker-compose.yml
 - examples/images/example_output.png
 - examples/images/logo.png
 - examples/simple_connection.rb
@@ -214,6 +244,8 @@ files:
 - lib/sshkit/backends/local.rb
 - lib/sshkit/backends/netssh.rb
 - lib/sshkit/backends/netssh/known_hosts.rb
+- lib/sshkit/backends/netssh/scp_transfer.rb
+- lib/sshkit/backends/netssh/sftp_transfer.rb
 - lib/sshkit/backends/printer.rb
 - lib/sshkit/backends/skipper.rb
 - lib/sshkit/color.rb
@@ -240,15 +272,16 @@ files:
 - lib/sshkit/runners/sequential.rb
 - lib/sshkit/version.rb
 - sshkit.gemspec
-- test/boxes.json
+- test/functional/backends/netssh_transfer_tests.rb
 - test/functional/backends/test_local.rb
 - test/functional/backends/test_netssh.rb
-- test/functional/test_ssh_server_comes_up_for_functional_tests.rb
+- test/functional/backends/test_netssh_scp.rb
+- test/functional/backends/test_netssh_sftp.rb
 - test/helper.rb
 - test/known_hosts/github
 - test/known_hosts/github_hash
 - test/known_hosts/github_ip
-- test/support/vagrant_wrapper.rb
+- test/support/docker_wrapper.rb
 - test/unit/backends/test_abstract.rb
 - test/unit/backends/test_connection_pool.rb
 - test/unit/backends/test_local.rb
@@ -291,20 +324,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.13
 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/netssh_transfer_tests.rb
 - test/functional/backends/test_local.rb
 - test/functional/backends/test_netssh.rb
-- test/functional/test_ssh_server_comes_up_for_functional_tests.rb
+- test/functional/backends/test_netssh_scp.rb
+- test/functional/backends/test_netssh_sftp.rb
 - test/helper.rb
 - test/known_hosts/github
 - test/known_hosts/github_hash
 - test/known_hosts/github_ip
-- test/support/vagrant_wrapper.rb
+- test/support/docker_wrapper.rb
 - test/unit/backends/test_abstract.rb
 - test/unit/backends/test_connection_pool.rb
 - test/unit/backends/test_local.rb