sshkit 1.7.1 → 1.8.0

data/test/unit/test_deprecation_logger.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+module SSHKit
+
+  class TestDeprecationLogger < UnitTest
+
+    def output
+      @output ||= String.new
+    end
+
+    def logger
+      @logger ||= DeprecationLogger.new(output)
+    end
+
+    def test_hides_duplicate_deprecation_warnings
+      line_number = generate_warning
+      generate_warning
+
+      actual_lines = output.lines.to_a
+
+      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]
+    end
+
+    def test_handles_nil_output
+      DeprecationLogger.new(nil).log('Some message')
+    end
+
+    private
+
+    def generate_warning
+      logger.log('Some message')
+      __LINE__-1
+    end
+  end
+
+end

data/test/unit/test_host.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'etc'
 
 module SSHKit
 
@@ -46,8 +45,9 @@ module SSHKit
       h = Host.new :local
       assert       h.local?
       assert_nil   h.port
-      assert_equal Etc.getpwuid.name, h.username
-      assert_equal 'localhost',       h.hostname
+      username_candidates = ENV['USER'] || ENV['LOGNAME'] || ENV['USERNAME']
+      assert_equal username_candidates, h.username
+      assert_equal 'localhost',         h.hostname
     end
 
     def test_does_not_confuse_ipv6_hosts_with_port_specification
@@ -65,7 +65,6 @@ module SSHKit
     end
 
     def test_assert_hosts_compare_equal
-      assert Host.new('example.com') == Host.new('example.com')
       assert Host.new('example.com').eql? Host.new('example.com')
       assert Host.new('example.com').equal? Host.new('example.com')
     end

data/test/unit/test_logger.rb

@@ -5,7 +5,6 @@ module SSHKit
   class TestLogger < UnitTest
 
     def test_logger_severity_constants
-      assert_equal Logger::TRACE, -1
       assert_equal Logger::DEBUG,  0
       assert_equal Logger::INFO,   1
       assert_equal Logger::WARN,   2

data/test/unit/test_mapping_interaction_handler.rb

@@ -0,0 +1,101 @@
+require 'helper'
+
+module SSHKit
+
+  class TestMappingInteractionHandler < UnitTest
+    def channel
+      @channel ||= mock
+    end
+
+    def setup
+      super
+      @output = stub()
+      SSHKit.config.output = @output
+    end
+
+    def test_calls_send_data_with_mapped_input_when_stdout_matches
+      handler = MappingInteractionHandler.new('Server output' => "some input\n")
+      channel.expects(:send_data).with("some input\n")
+      handler.on_data(nil, :stdout, 'Server output', channel)
+    end
+
+    def test_calls_send_data_with_mapped_input_when_stderr_matches
+      handler = MappingInteractionHandler.new('Server output' => "some input\n")
+      channel.expects(:send_data).with("some input\n")
+      handler.on_data(nil, :stderr, 'Server output', channel)
+    end
+
+    def test_logs_unmatched_interaction_if_constructed_with_a_log_level
+      @output.expects(:debug).with('Looking up response for stdout message "Server output\n"')
+      @output.expects(:debug).with('Unable to find interaction handler mapping for stdout: "Server output\n" so no response was sent')
+
+      MappingInteractionHandler.new({}, :debug).on_data(nil, :stdout, "Server output\n", channel)
+    end
+
+    def test_logs_matched_interaction_if_constructed_with_a_log_level
+      handler = MappingInteractionHandler.new({"Server output\n" => "Some input\n"}, :debug)
+
+      channel.stubs(:send_data)
+      @output.expects(:debug).with('Looking up response for stdout message "Server output\n"')
+      @output.expects(:debug).with('Sending "Some input\n"')
+
+      handler.on_data(nil, :stdout, "Server output\n", channel)
+    end
+
+    def test_supports_regex_keys
+      handler = MappingInteractionHandler.new({/Some \w+ output\n/ => "Input\n"})
+      channel.expects(:send_data).with("Input\n")
+      handler.on_data(nil, :stdout, "Some lovely output\n", channel)
+    end
+
+    def test_supports_lambda_mapping
+      channel.expects(:send_data).with("GREAT Input\n")
+
+      mapping = lambda do |server_output|
+        case server_output
+        when /Some (\w+) output\n/
+          "#{$1.upcase} Input\n"
+        end
+      end
+
+      MappingInteractionHandler.new(mapping).on_data(nil, :stdout, "Some great output\n", channel)
+    end
+
+
+    def test_matches_keys_in_ofer
+      interaction_handler = MappingInteractionHandler.new({
+        "Specific output\n" => "Specific Input\n",
+        /.*/ => "Default Input\n"
+      })
+
+      channel.expects(:send_data).with("Specific Input\n")
+      interaction_handler.on_data(nil, :stdout, "Specific output\n", channel)
+    end
+
+    def test_supports_default_mapping
+      interaction_handler = MappingInteractionHandler.new({
+        "Specific output\n" => "Specific Input\n",
+        /.*/ => "Default Input\n"
+      })
+
+      channel.expects(:send_data).with("Specific Input\n")
+      interaction_handler.on_data(nil, :stdout, "Specific output\n", channel)
+    end
+
+    def test_raises_for_unsupported_mapping_type
+      raised_error = assert_raises RuntimeError do
+        MappingInteractionHandler.new(Object.new)
+      end
+      assert_equal('Unsupported mapping type: Object - only Hash and Proc mappings are supported', raised_error.message)
+    end
+
+    def test_raises_for_unsupported_channel_type
+      handler = MappingInteractionHandler.new({"Some output\n" => "Whatever"})
+      raised_error = assert_raises RuntimeError do
+        handler.on_data(nil, :stdout, "Some output\n", Object.new)
+      end
+      assert_match(/Unable to write response data to channel #<Object:.*> - does not support 'send_data' or 'write'/, raised_error.message)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,124 +9,110 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.2
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.11.3
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.11.3
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: unindent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A comprehensive toolkit for remotely running commands in a structured
@@ -138,9 +124,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
+- .gitignore
+- .travis.yml
+- .yardopts
+- BREAKING_API_WISHLIST.md
 - CHANGELOG.md
 - CONTRIBUTING.md
 - EXAMPLES.md
@@ -168,6 +155,7 @@ files:
 - lib/sshkit/command_map.rb
 - lib/sshkit/configuration.rb
 - lib/sshkit/coordinator.rb
+- lib/sshkit/deprecation_logger.rb
 - lib/sshkit/dsl.rb
 - lib/sshkit/exception.rb
 - lib/sshkit/formatters/abstract.rb
@@ -178,35 +166,39 @@ files:
 - lib/sshkit/host.rb
 - lib/sshkit/log_message.rb
 - lib/sshkit/logger.rb
+- lib/sshkit/mapping_interaction_handler.rb
 - lib/sshkit/runners/abstract.rb
 - lib/sshkit/runners/group.rb
 - lib/sshkit/runners/null.rb
 - lib/sshkit/runners/parallel.rb
 - lib/sshkit/runners/sequential.rb
-- lib/sshkit/utils/capture_output_methods.rb
 - lib/sshkit/version.rb
 - sshkit.gemspec
 - test/boxes.json
 - test/functional/backends/test_local.rb
 - test/functional/backends/test_netssh.rb
-- test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
 - test/helper.rb
 - test/support/vagrant_wrapper.rb
+- test/unit/backends/test_abstract.rb
 - test/unit/backends/test_connection_pool.rb
 - test/unit/backends/test_local.rb
 - test/unit/backends/test_netssh.rb
 - test/unit/backends/test_printer.rb
 - test/unit/core_ext/test_string.rb
+- test/unit/formatters/test_custom.rb
 - test/unit/formatters/test_dot.rb
 - test/unit/formatters/test_pretty.rb
+- test/unit/formatters/test_simple_text.rb
 - test/unit/test_color.rb
 - test/unit/test_command.rb
 - test/unit/test_command_map.rb
 - test/unit/test_configuration.rb
 - test/unit/test_coordinator.rb
+- test/unit/test_deprecation_logger.rb
 - test/unit/test_host.rb
 - test/unit/test_logger.rb
+- test/unit/test_mapping_interaction_handler.rb
 homepage: http://github.com/capistrano/sshkit
 licenses:
 - GPL3
@@ -217,17 +209,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby
@@ -235,21 +227,25 @@ test_files:
 - test/boxes.json
 - test/functional/backends/test_local.rb
 - test/functional/backends/test_netssh.rb
-- test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
 - test/helper.rb
 - test/support/vagrant_wrapper.rb
+- test/unit/backends/test_abstract.rb
 - test/unit/backends/test_connection_pool.rb
 - test/unit/backends/test_local.rb
 - test/unit/backends/test_netssh.rb
 - test/unit/backends/test_printer.rb
 - test/unit/core_ext/test_string.rb
+- test/unit/formatters/test_custom.rb
 - test/unit/formatters/test_dot.rb
 - test/unit/formatters/test_pretty.rb
+- test/unit/formatters/test_simple_text.rb
 - test/unit/test_color.rb
 - test/unit/test_command.rb
 - test/unit/test_command_map.rb
 - test/unit/test_configuration.rb
 - test/unit/test_coordinator.rb
+- test/unit/test_deprecation_logger.rb
 - test/unit/test_host.rb
 - test/unit/test_logger.rb
+- test/unit/test_mapping_interaction_handler.rb

data/lib/sshkit/utils/capture_output_methods.rb

@@ -1,13 +0,0 @@
-module SSHKit
-  module Utils
-    module CaptureOutputMethods
-      def <<(object)
-        if object.is_a?(SSHKit::Command) || object.is_a?(SSHKit::LogMessage)
-          super("#{object}\n")
-        else
-          super
-        end
-      end
-    end
-  end
-end