em-ssh 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1155815fe2d0f34c5f6a9042c6affe16bb4a3d2
-  data.tar.gz: 3f473143a7b7e43f00f6ca7a47e9122644869248
+  metadata.gz: 08f5d7822b2ff48dc4708c0dbab6f0de0842e567
+  data.tar.gz: 0a4ef8adb8b79ff280e4df14ba9159f730f67be1
 SHA512:
-  metadata.gz: 2c64f15aeccde7c71cfd9c1b1e1ffca1b66a0ef44968239266a96db22ddc2748ee64b67799d35ef6b47dad42aede1f79bff91721387780c24b6586cfbc078171
-  data.tar.gz: a47b97dece38734b165a41ad0f2d6f5e7c86672737bb74f178db6a3c03eae3d9bb130b2abe2e31d2c6f4a15cfc17d6d1ab307af1ca8c06eb1e28a65550772ad5
+  metadata.gz: 8d381dca0e9711543e13975aed8eb6e6a5f066a0baa1ad123bcd0fbddb075fc7013406b0220ed721353a56ed0f8b61b280542d46418ea74198f43e6044eb2baf
+  data.tar.gz: 58af8534fd673f0ce11d851d9e433ba5810f550ff0cdb121484a00ab0a1b823072a4045daca7a35f9cbdc65f8fb4325bab31ffedd084aca49b6c32c357991a13

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+0.8.0
+-	[b1f5774](https://github.com/simulacre/em-ssh/commit/b1f5774f10b2496063db5d52bab66b1871b2cd26) - net-ssh 3.2.0; em 1.2.0; docker for testing. Contributions from Kirill Timofeev
+
 0.7.0
 - [88323761c67c433bd46fedfd042ae9a97b726cb6](https://github.com/simulacre/em-ssh/commit/88323761c67c433bd46fedfd042ae9a97b726cb6) - Deal with ssh servers that send algo data and server version at the same time (Dropbear). Discovered by [@mandre](https://github.com/mandre)
 
@@ -26,10 +29,10 @@
  - [#20](https://github.com/simulacre/em-ssh/pull/20) - Fix Interactive timeout wasn't set if parameter not fed [@freakhill](https://github.com/freakhill)
 
 0.5.0
- - Shell an Connection instances can have their own Loggers 
+ - Shell an Connection instances can have their own Loggers
  - [#18](https://github.com/simulacre/em-ssh/pull/18) - Target devices and options for specs can be configured through environment variables [@freakhill](https://github.com/freakhill)
  - [#19](https://github.com/simulacre/em-ssh/pull/19) - Decouple interactive behavior from Shell allowing for other channels to be extended with #expect, etc., [@freakhill](https://github.com/freakhill)
-  
+
 0.4.2
  - Connection accepts :nego_timeout (seconds to wait for protocol and algorithm negotiation to finish)
  - If protocol, or algorithm negotiation fail #errback will be called

data/README.md

@@ -3,7 +3,7 @@ Em-ssh is a net-ssh adapter for EventMachine. For the most part you can take any
 
 Em-ssh is not associated with the Jamis Buck's [net-ssh](http://net-ssh.github.com/) library. Please report any bugs with em-ssh to [https://github.com/simulacre/em-ssh/issues](https://github.com/simulacre/em-ssh/issues)
 ##Installation
-  gem install em-ssh 
+  gem install em-ssh
 
 ##Synopsis
 
@@ -18,38 +18,38 @@ EM.run do
     connection.callback do |ssh|
       # capture all stderr and stdout output from a remote process
       ssh.exec!('uname -a').tap {|r| puts "\nuname: #{r}"}
-    
+
       # capture only stdout matching a particular pattern
       stdout = ""
       ssh.exec!("ls -l /home") do |channel, stream, data|
         stdout << data if stream == :stdout
       end
       puts "\n#{stdout}"
-    
+
       # run multiple processes in parallel to completion
       ssh.exec('ping -c 1 www.google.com')
       ssh.exec('ping -c 1 www.yahoo.com')
       ssh.exec('ping -c 1 www.rakuten.co.jp')
-    
+
       #open a new channel and configure a minimal set of callbacks, then wait for the channel to finishes (closees).
       channel = ssh.open_channel do |ch|
         ch.exec "/usr/local/bin/ruby /path/to/file.rb" do |ch, success|
           raise "could not execute command" unless success
-    
+
           # "on_data" is called when the process writes something to stdout
           ch.on_data do |c, data|
             $stdout.print data
           end
-        
+
           # "on_extended_data" is called when the process writes something to stderr
           ch.on_extended_data do |c, type, data|
             $stderr.print data
           end
-        
+
           ch.on_close { puts "done!" }
         end
       end
-    
+
       channel.wait
 
       ssh.close
@@ -62,7 +62,7 @@ end
 See [http://net-ssh.github.com/ssh/v2/api/index.html](http://net-ssh.github.com/ssh/v2/api/index.html)
 
 ##Shell
- 
+
 Em-ssh provides an expect-like shell abstraction layer on top of net-ssh in EM::Ssh::Shell
 
 ### Example
@@ -149,7 +149,7 @@ EM.run do
       commands.clone.each do |command|
         Fiber.new {
           # When given a block Shell#split will close the Shell after
-          # the block returns. If a block is given it must be called 
+          # the block returns. If a block is given it must be called
           # within a Fiber.
           sresult = shell.split do |mys|
             mys.on(:closed) do
@@ -184,6 +184,60 @@ See bin/em-ssh-shell for a more complex example usage of Shell.
 
 Em-ssh relies on Fibers. MRI 1.9.2-p290 on OSX Lion has been known to segfault when using Fibers.
 
+## Testing
+
+The specs for em-ssh require two accessible ssh servers. The quickest
+and most consistent way to get the servers up is to use Docker.
+
+Containers run from ``krlmlr/debian-ssh:wheezy`` will be accessible with
+users 'docker' and 'root'.
+
+If you have ``docker-compose`` installed:
+```shell
+SSH_KEY="$(cat ~/.ssh/id_rsa.pub)" docker-compose up
+```
+
+If you do not have ``docker-compose`` installed:
+```
+docker run -d -p 2222:22 -e SSH_KEY="$(cat ~/.ssh/id_rsa.pub)" krlmlr/debian-ssh:wheezy
+docker run -d -p 2223:22 -e SSH_KEY="$(cat ~/.ssh/id_rsa.pub)" krlmlr/debian-ssh:wheezy
+```
+
+Once the two containers are running just run the specs.
+
+```shell
+rspec spec
+```
+
+If you want to use different ssh servers for testing you'll need to
+update the variables in ``spec/constants.rb``
+
+If you need to debug failing tests you can change the verbosity of
+EM::Ssh:
+
+```shell
+VERBOSITY=DEBUG rspec spec
+```
+
+### Manual Testing
+
+You can also run manual tests using the executable in ``bin``.
+
+```shell
+bin/em-ssh-shell docker@localhost:2223 '$ ' 'ls -al' 'hostname' 'uname -a'
+```
+
+```shell
+be bin/em-ssh docker@localhost:2223
+```
+
+
+## Known Issues
+
+ - If the server's signature changes from the one recorded in your
+   ``known_hosts`` file ``EM::Ssh.start`` will hang
+ - ``bin/em-ssh`` and ``bin/em-ssh-shell`` will ask for passwords even
+   when one isn't required
 
 ##Copyright
 Copyright (c) 2011 Caleb Crane

data/lib/em-ssh.rb

@@ -14,7 +14,7 @@ module EventMachine
   #    end
   #  end
   class Ssh
-    DEFAULT_PORT = 22
+    DEFAULT_PORT = Net::SSH::Transport::Session::DEFAULT_PORT
 
     # Generic error tag
     module Error; end
@@ -93,6 +93,7 @@ module EventMachine
 
     class << self
       attr_writer :logger
+
       # Creates a logger when necessary
       # @return [Logger]
       def logger(level = Logger::WARN)
@@ -114,11 +115,17 @@ module EventMachine
       #      channel.request_pty(options[:pty] || {}) do |pty,suc|
       def connect(host, user, opts = {}, &blk)
         opts[:logger] || logger.debug("#{self}.connect(#{host}, #{user}, #{opts})")
-        options = { :host => host, :user => user, :port => DEFAULT_PORT }.merge(opts)
+
+        options = {
+          host: host,
+          user: user,
+          port: DEFAULT_PORT
+        }.merge(opts)
+
         EM.connect(options[:host], options[:port], Connection, options, &blk)
       end
       alias :start :connect
-    end # << self
+    end
 
     # Pull in the constants from Net::SSH::[Transport, Connection and Authentication]
     # and define them locally.
@@ -127,11 +134,11 @@ module EventMachine
     .each do |mod|
       mod.constants.each do |name|
         const_set(name, mod.const_get(name))
-      end #  |name|
-    end #  |module|
+      end
+    end
 
-  end # class::Ssh
-end # module::EventMachine
+  end
+end
 
 EM::P::Ssh = EventMachine::Ssh
 

data/lib/em-ssh/connection.rb

@@ -130,7 +130,6 @@ module EventMachine
 
         if failed_timeout
           fail(@disconnect ? EM::Ssh::Disconnect.from_packet(@disconnect) : NegotiationTimeout.new(@host))
-
         end
       end
 
@@ -141,8 +140,9 @@ module EventMachine
       end
 
       def connection_completed
-        @contimeout.cancel
-        @nocon.cancel
+        [@contimeout, @nocon].each(&:cancel)
+        @contimeout = nil
+        @nocon = nil
       end
 
       def initialize(options = {})
@@ -248,6 +248,14 @@ module EventMachine
         end #  |string|
       end # host_as_string
 
+      # Taken from Net::SSH::Transport::Session
+      def host_keys
+        @host_keys ||= begin
+          known_hosts = options.fetch(:known_hosts, Net::SSH::KnownHosts)
+          known_hosts.search_for(options[:host_key_alias] || host_as_string, options)
+        end
+      end
+
       alias :logger :log
 
 
@@ -351,6 +359,6 @@ module EventMachine
           end # paranoid.respond_to?(:verify)
         end # paranoid
       end # select_host_key_verifier(paranoid)
-    end # class::Connection < EventMachine::Connection
-  end # module::Ssh
-end # module::EventMachine
+    end
+  end
+end

data/lib/em-ssh/session.rb

@@ -42,14 +42,20 @@ module EventMachine
         # channel localy and the connection will just spin.
         if transport.closed?
           channels.each do |id, c|
+            # remove the connection reference to facilitate Garbage Collection
             c.instance_variable_set(:@connection, nil)
           end
           channels.clear
         else
-          channels.each { |id, channel| channel.close }
+          channels.each do |id, channel|
+            channel.close
+            # force one last pass through the channel's send loop, so that
+            # net-ssh will properly set the values for local_closed
+            channel.process
+          end
           loop { channels.any? && !transport.closed?  }
         end
-        # remove the reference to the connection to facilitate Garbage Collection
+        # remove the reference to the transport to facilitate Garbage Collection
         transport, @transport = @transport, nil
         @listeners.clear
         transport.close
@@ -72,11 +78,14 @@ module EventMachine
           # at some point we should override Channel#enqueue_pending_output, etc.,.
           channels.each { |id, channel| channel.process unless channel.closing? }
         end
-      end # register_callbacks
+      end
 
       def channel_close(packet)
         channel = channels[packet[:local_id]]
         super(packet).tap do
+          # force one last pass through the channel's send loop, so that
+          # net-ssh will properly set the values for local_closed
+          channel.process
           # remove the connection reference to facilitate Garbage Collection
           channel.instance_variable_set(:@connection, nil)
         end
@@ -89,7 +98,6 @@ module EventMachine
           channel.instance_variable_set(:@connection, nil)
         end
       end
-
-    end # class::Session
-  end # class::Ssh
-end # module::EventMachine
+    end
+  end
+end

data/lib/em-ssh/shell.rb

@@ -78,7 +78,12 @@ module EventMachine
         @pass            = pass
         @options         = opts
         @logger          = opts[:logger] if opts[:logger]
-        @connect_opts    = {:password => pass, :port => 22, :auth_methods => ['publickey', 'password'], :logger => log}.merge(opts[:net_ssh] || {})
+        @connect_opts    = {
+          password: pass,
+          port: opts[:port] || 22,
+          auth_methods: ['publickey', 'password'],
+          logger: log
+        }.merge(opts[:net_ssh] || {})
         @session         = opts[:session]
         @parent          = opts[:parent]
         @children        = []

data/lib/em-ssh/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   class Ssh
-    VERSION='0.7.0'
+    VERSION='0.8.0'
   end
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: em-ssh
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Caleb Crane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: ruby-termios
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 description: ''
 email:
 - em-ssh@simulacre.org
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: An EventMachine compatible net-ssh