sshkit 1.18.1 → 1.21.0

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/support/vagrant_wrapper.rb

@@ -46,10 +46,19 @@ class VagrantWrapper
           user: vm['user'] || 'vagrant',
           hostname: vm['hostname'] || 'localhost',
           port: vm['port'] || '22',
-          password: vm['password'] || 'vagrant'
+          password: vm['password'] || 'vagrant',
+          ssh_options: host_verify_options
       }
 
       SSHKit::Host.new(host_options)
     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

@@ -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

@@ -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_host.rb

@@ -56,6 +56,11 @@ module SSHKit
       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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  version: 1.21.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-26 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -180,7 +180,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/release-drafter.yml"
+- ".github/workflows/push.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
 - BREAKING_API_WISHLIST.md
@@ -197,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
@@ -268,7 +273,8 @@ files:
 homepage: http://github.com/capistrano/sshkit
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/capistrano/sshkit/releases
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -284,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby