sshkit 1.18.0 → 1.23.0

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
@@ -112,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
@@ -54,6 +102,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

@@ -51,13 +51,13 @@ module SSHKit
     def test_double_quotes_are_escaped_in_env
       SSHKit.config = nil
       c = Command.new(:rails, 'server', env: {foo: 'asdf"hjkl'})
-      assert_equal %{( export FOO="asdf\\\"hjkl" ; /usr/bin/env rails server )}, c.to_command
+      assert_equal %{( export FOO="asdf\\"hjkl" ; /usr/bin/env rails server )}, c.to_command
     end
 
     def test_percentage_symbol_handled_in_env
       SSHKit.config = nil
       c = Command.new(:rails, 'server', env: {foo: 'asdf%hjkl'}, user: "anotheruser")
-      assert_equal %{( export FOO="asdf%hjkl" ; sudo -u anotheruser FOO=\"asdf%hjkl\" -- sh -c '/usr/bin/env rails server' )}, c.to_command
+      assert_equal %{( export FOO="asdf%hjkl" ; sudo -u anotheruser FOO=\"asdf%hjkl\" -- sh -c /usr/bin/env\\ rails\\ server )}, c.to_command
     end
 
     def test_including_the_env_doesnt_addressively_escape
@@ -84,6 +84,16 @@ 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
+    end
+
     def test_working_in_a_given_directory_with_env
       c = Command.new(:ls, '-l', in: "/opt/sites", env: {a: :b})
       assert_equal %{cd /opt/sites && ( export A="b" ; /usr/bin/env ls -l )}, c.to_command
@@ -97,17 +107,27 @@ module SSHKit
 
     def test_working_as_a_given_user
       c = Command.new(:whoami, user: :anotheruser)
-      assert_equal "sudo -u anotheruser -- sh -c '/usr/bin/env whoami'", c.to_command
+      assert_equal "sudo -u anotheruser -- sh -c /usr/bin/env\\ whoami", c.to_command
+    end
+
+    def test_working_as_a_given_weird_user
+      c = Command.new(:whoami, user: "mr space |")
+      assert_equal "sudo -u mr\\ space\\ \\| -- sh -c /usr/bin/env\\ whoami", c.to_command
     end
 
     def test_working_as_a_given_group
       c = Command.new(:whoami, group: :devvers)
-      assert_equal 'sg devvers -c "/usr/bin/env whoami"', c.to_command
+      assert_equal 'sg devvers -c /usr/bin/env\\ whoami', c.to_command
+    end
+
+    def test_working_as_a_given_weird_group
+      c = Command.new(:whoami, group: "space | group")
+      assert_equal "sg space\\ \\|\\ group -c /usr/bin/env\\ whoami", c.to_command
     end
 
     def test_working_as_a_given_user_and_group
       c = Command.new(:whoami, user: :anotheruser, group: :devvers)
-      assert_equal %Q(sudo -u anotheruser -- sh -c 'sg devvers -c "/usr/bin/env whoami"'), c.to_command
+      assert_equal %Q(sudo -u anotheruser -- sh -c sg\\ devvers\\ -c\\ /usr/bin/env\\\\\\ whoami), c.to_command
     end
 
     def test_umask
@@ -125,13 +145,13 @@ module SSHKit
     def test_umask_with_working_directory_and_user
       SSHKit.config.umask = '007'
       c = Command.new(:touch, 'somefile', in: '/var', user: 'alice')
-      assert_equal "cd /var && umask 007 && sudo -u alice -- sh -c '/usr/bin/env touch somefile'", c.to_command
+      assert_equal "cd /var && umask 007 && sudo -u alice -- sh -c /usr/bin/env\\ touch\\ somefile", c.to_command
     end
 
     def test_umask_with_env_and_working_directory_and_user
       SSHKit.config.umask = '007'
       c = Command.new(:touch, 'somefile', user: 'bob', env: {a: 'b'}, in: '/var')
-      assert_equal %{cd /var && umask 007 && ( export A="b" ; sudo -u bob A="b" -- sh -c '/usr/bin/env touch somefile' )}, c.to_command
+      assert_equal %{cd /var && umask 007 && ( export A="b" ; sudo -u bob A="b" -- sh -c /usr/bin/env\\ touch\\ somefile )}, c.to_command
     end
 
     def test_verbosity_defaults_to_logger_info
@@ -245,5 +265,10 @@ module SSHKit
       assert_equal "whoami exit status: 1\nwhoami stdout: Nothing written\nwhoami stderr: Nothing written\n", error.message
     end
 
+    def test_shares_same_uuid_before_and_after_redaction
+      command = Command.new(:whoami)
+      command_with_redaction = command.with_redaction
+      assert_equal command.uuid, command_with_redaction.uuid, "UUID should be stable before and after redaction"
+    end
   end
 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,12 +56,23 @@ 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
       assert_equal '1fff:0:a88:85a3::ac1f', h.hostname
     end
 
+    def test_does_not_confuse_ipv6_hosts_without_port_specification
+      h = Host.new '[2001:db8:85a3:8d3:1319:8a2e:370:7348]'
+      assert_equal '2001:db8:85a3:8d3:1319:8a2e:370:7348', h.hostname
+    end
+
     def testing_host_casting_to_a_string
       assert_equal "example.com", Host.new('user@example.com:1234').to_s
     end
@@ -137,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,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Lee Hambley
 - Tom Clements
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-21 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
@@ -87,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -180,8 +208,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".docker/Dockerfile"
+- ".docker/ubuntu_setup.sh"
+- ".github/dependabot.yml"
+- ".github/release-drafter.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/push.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".yardopts"
 - BREAKING_API_WISHLIST.md
 - CHANGELOG.md
@@ -194,9 +229,10 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
-- Vagrantfile
+- docker-compose.yml
 - 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
@@ -208,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
@@ -234,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
@@ -268,8 +307,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
@@ -284,21 +324,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+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

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-rvm:
-  - 2.5
-  - 2.4
-  - 2.3
-  - 2.2
-  - 2.1
-  - 2.0
-matrix:
-  include:
-    # Run Danger only once, on 2.5
-    - rvm: 2.5
-      script: bundle exec danger
-script: bundle exec rake test:units lint

data/Vagrantfile

@@ -1,15 +0,0 @@
-VAGRANTFILE_API_VERSION = "2"
-
-Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  config.vm.box = 'hashicorp/precise64'
-
-  json_config_path = File.join("test", "boxes.json")
-  list = File.open(json_config_path).read
-  list = JSON.parse(list)
-
-  list.each do |vm|
-    config.vm.define vm["name"] do |web|
-      web.vm.network "forwarded_port", guest: 22, host: vm["port"]
-    end
-  end
-end

data/test/boxes.json

@@ -1,17 +0,0 @@
-[
-  {
-    "name": "one",
-    "port": 3001,
-    "user": "vagrant",
-    "password": "vagrant",
-    "hostname": "localhost"
-  },
-  {
-    "name": "two",
-    "port": 3002
-  },
-  {
-    "name": "three",
-    "port": 3003
-  }
-]

data/test/functional/test_ssh_server_comes_up_for_functional_tests.rb

@@ -1,24 +0,0 @@
-require 'helper'
-
-module SSHKit
-
-  class TestHost < FunctionalTest
-
-    def host
-      @_host ||= Host.new('')
-    end
-
-    def test_that_it_works
-      assert true
-    end
-
-    def test_creating_a_user_gives_us_back_his_private_key_as_a_string
-      skip 'It is not safe to create an user for non vagrant envs' unless VagrantWrapper.running?
-      keys = create_user_with_key(:peter)
-      assert_equal [:one, :two, :three], keys.keys
-      assert keys.values.all?
-    end
-
-  end
-
-end

data/test/support/vagrant_wrapper.rb

@@ -1,55 +0,0 @@
-class VagrantWrapper
-  class << self
-    def hosts
-      @vm_hosts ||= begin
-        result = {}
-
-        boxes = boxes_list
-
-        unless running?
-          boxes.map! do |box|
-            box['user'] = ENV['USER']
-            box['port'] = '22'
-            box
-          end
-        end
-
-        boxes.each do |vm|
-          result[vm['name']] = vm_host(vm)
-        end
-
-        result
-      end
-    end
-
-    def running?
-      @running ||= begin
-        status = `#{vagrant_binary} status`
-        status.include?('running')
-      end
-    end
-
-    def boxes_list
-      json_config_path = File.join('test', 'boxes.json')
-      boxes = File.open(json_config_path).read
-      JSON.parse(boxes)
-    end
-
-    def vagrant_binary
-      'vagrant'
-    end
-
-    private
-
-    def vm_host(vm)
-      host_options = {
-          user: vm['user'] || 'vagrant',
-          hostname: vm['hostname'] || 'localhost',
-          port: vm['port'] || '22',
-          password: vm['password'] || 'vagrant'
-      }
-
-      SSHKit::Host.new(host_options)
-    end
-  end
-end