em-ssh 0.3.0.pre1 → 0.3.0

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
 	EM.run do
@@ -63,33 +63,51 @@ Em-ssh provides an expect-like shell abstraction layer on top of net-ssh in EM::
 ### Example
 	require 'em-ssh/shell'
 	EM.run {
-	  EM::Ssh::Shell.new(host, 'caleb', "") do |shell|
-	    shell.should be_a(EventMachine::Ssh::Shell)
-	    shell.wait_for(']$')
-	    shell.send_and_wait('uname -a', ']$')
-	    shell.wait_for(']$')
-	    shell.send_and_wait('/sbin/ifconfig -a', ']$')
-	    timer.cancel
-	    EM.stop
+	  EM::Ssh::Shell.new(host, ENV['USER'], "") do |shell|
+	    shell.callback do
+	      shell.expect('~]$ ')
+	      shell.expect('~]$ ','uname -a')
+	      shell.expect('~]$ ')
+	      shell.expect('~]$ ', '/sbin/ifconfig -a')
+	      EM.stop
+	    end
+	    shell.errback do
+	      puts "error: #{err} (#{err.class})" 
+	      EM.stop
+	    end
 	  end
 	}
 
-#### Synchrony Example
-	require 'em-ssh/shell'
-	EM.run {
-		Fiber.new {
-			shell = EM::Ssh::Shell.new(host, 'caleb', '')
-			shell.wait_for(']$')
-			shell.send_and_wait('sudo su -', 'password for caleb: ')
-			shell.send_and_wait('password', ']$')
-			output = shell.send_and_wait('/etc/init.d/openvpn restart', ']$')
-			# ...
-			shell.send_and_wait('exit', ']$')
-			shell.send_data('exit')
-		}.resume
-	}
-
+### Run Multiple Commands in Parallel
+  require 'em-ssh/shell'
+  EM.run do
+    EM::Ssh::Shell.new(host, ENV['USER'], '') do |shell|
+      shell.errback do |err|
+        puts "error: #{err} (#{err.class})"
+        EM.stop
+      end 
+
+      shell.callback do 
+        commands.clone.each do |command|
+          mys = shell.split # provides a second session over the same connection
+          mys.on(:closed) do
+            commands.delete(command)
+            EM.stop if commands.empty?
+          end
 
+          puts("waiting for: #{waitstr.inspect}")
+          # When given a block, Shell#expect does not 'block'
+          mys.expect(waitstr) do 
+            puts "sending #{command.inspect} and waiting for #{waitstr.inspect}"
+            mys.expect(waitstr, command) do |result|
+              puts "#{mys} result: '#{result}'"
+              mys.close
+            end 
+          end 
+        end 
+      end 
+    end 
+  end 
 
 ## Other Examples
 See bin/em-ssh for an example of a basic replacement for system ssh.

data/bin/em-ssh

@@ -43,8 +43,10 @@ end # host.nil?
 abort("a host is required") if host.nil?
 
 options[:user], host = *host.split('@') if host.include?('@')
-options[:user], options[:password] = *options[:user].split(':') if options[:user].include?(':')
+options[:user], options[:password] = *options[:user].split(':') if options[:user] && options[:user].include?(':')
 host, options[:port] = *host.split(':') if host.include?(':')
+options[:user] = ENV['USER'] unless options[:user]
+options[:password] = HighLine.new.ask("#{options[:user]}'s password: "){|q| q.echo = "*" } unless options[:password]
 connected = false
 
 
@@ -68,7 +70,7 @@ end
 EM.run do
   EM::Ssh.start(host, options[:user], options) do |ssh|
     ssh.errback do |err|
-      puts "#{err} (#{err.class})"
+      puts "error: #{err} (#{err.class})"
       EM.stop
     end 
 

data/bin/em-ssh-shell

@@ -15,14 +15,18 @@ def abort(msg)
   Process.exit
 end # abort(msg)
 
-options = {}
-opts    = OptionParser.new
+options     = {:auth_methods => ['publickey', 'password'], :port => 22}
+opts        = OptionParser.new
 opts.banner += " [user:[password]@]host[:port] wait_string command [command command ...]"
-options[:port] = 22
+
 opts.on('-u', '--user String', String) { |u| options[:user] = u }
 opts.on('-p', '--password [String]', String) do |p| 
   options[:password] = p.nil? ? HighLine.new.ask("password: "){|q| q.echo = "*" } : p
 end
+opts.on('-t', '--timeout Integer', Integer) { |t| options[:timeout] = t }
+opts.on('--[no-]publickey', "don't attempt public key auth") do |pk|
+  options[:auth_methods] = ['password'] unless pk
+end 
 opts.on('-v', '--verbose') do 
   EM::Ssh.logger.level = EM::Ssh.logger.level - 1 unless EM::Ssh.logger.level == 0 
   options[:verbose] = EM::Ssh.logger.level
@@ -36,36 +40,43 @@ end # host.nil?
 abort("a host is required") if host.nil?
 
 options[:user], host = *host.split('@') if host.include?('@')
-options[:user], options[:password] = *options[:user].split(':') if options[:user].include?(':')
+options[:user], options[:password] = *options[:user].split(':') if options[:user] && options[:user].include?(':')
 host, options[:port] = *host.split(':') if host.include?(':')
+options[:user]       = ENV['USER'] unless options[:user]
+options[:password]   = HighLine.new.ask("#{options[:user]}'s password: "){|q| q.echo = "*" } unless options[:password]
 
 
-waitstr = ARGV.shift
+waitstr  = ARGV.shift
 commands = ARGV
 abort("wait_string is required") if waitstr.nil?
 abort("command is required") if commands.empty?
+waitstr = Regexp.escape(waitstr)
 
 
 EM.run do
-  EM::Ssh::Shell.new(host, options[:user], options[:password], :net_ssh => options) do |shell|
-    commands.each do |command|
-      mys = shell.split
-      mys.on(:closed) { info("#{mys} has closed") }
-      
-      EM.next_tick do
-        Fiber.new {
-          debug("#{mys} waited for: '#{mys.wait_for(waitstr)}'")
-          debug("#{mys} send: #{command.inspect}")
-          puts "#{mys} result: '#{mys.send_and_wait(command, waitstr)}'"
-          mys.close
-        }.resume
-      end
-    end #  |command|
-    
-    shell.on(:childless) do
-      info("#{shell}'s children all closed")
-      shell.close
+  EM::Ssh::Shell.new(host, options[:user], options[:password], :timeout => options[:timeout], :net_ssh => options) do |shell|
+    shell.errback do |err|
+      puts "error: #{err} (#{err.class})"
       EM.stop
-    end # :childless
-  end #  |shell|
-end # EM.run
+    end 
+
+    shell.callback do 
+      commands.clone.each do |command|
+        mys = shell.split
+        mys.on(:closed) do
+          commands.delete(command)
+          EM.stop if commands.empty?
+        end
+
+        puts("waiting for: #{waitstr.inspect}")
+        mys.expect(waitstr) do 
+          puts "sending #{command.inspect} and waiting for #{waitstr.inspect}"
+          mys.expect(waitstr, command) do |result|
+            puts "#{mys} result: '#{result}'"
+            mys.close
+          end 
+        end 
+      end 
+    end 
+  end 
+end 

data/lib/em-ssh/connection.rb

@@ -261,7 +261,7 @@ module EventMachine
                 end # begin
               end.resume
             else
-              @queue.push(packet)
+              @queue.push(packet) unless packet.type >= CHANNEL_OPEN
               if algorithms.allow?(packet)
                 fire(:packet, packet)
                 fire(:session_packet, packet) if packet.type >= GLOBAL_REQUEST

data/lib/em-ssh/shell.rb

@@ -6,8 +6,8 @@ module EventMachine
     # @example Retrieve the output of ifconfig -a on a server
     #   EM.run{
     #     shell = EM::Ssh::Shell.new(host, user, password)
-    #     shell.wait_for('@icaleb ~]$')
-    #     interfaces = send_and_wait('/sbin/ifconfig -a', '@icaleb ~]$')
+    #     shell.expect('~]$ ')
+    #     interfaces = expect('~]$ ', '/sbin/ifconfig -a')
     #
     # Shells can be easily and quickly duplicated (#split) without the need to establish another connection.
     # Shells provide :closed, :childless, and :split callbacks.
@@ -21,10 +21,11 @@ module EventMachine
     #
     #   admin_shell = shell.split
     #   admin_shell.on(:closed) { warn("admin shell has closed") }
-    #   admin_shell.send_and_wait('sudo su -', ']$')
+    #   admin_shell.expect(']$', 'sudo su -')
     class Shell
       include Log
       include Callbacks
+      include EM::Deferrable
 
       # Global timeout for wait operations; can be overriden by :timeout option to new
       TIMEOUT = 15
@@ -75,11 +76,12 @@ module EventMachine
         @reconnect       = opts[:reconnect]
         @buffer          = ''
 
-        if block_given?
-          Fiber.new { open(&blk).tap{|r| raise r if r.is_a?(Exception) } }.resume
-        else
-          open.tap{|r| raise r if r.is_a?(Exception) }
-        end # block_given?
+        # TODO make all methods other than #callback and #errback inaccessible until connected? == true
+        yield self if block_given?
+        Fiber.new {
+          open rescue fail($!)
+          succeed(self) if connected? && !closed?
+        }.resume
       end
 
       # @return [Boolean] true if the connection should be automatically re-established; default: false
@@ -91,7 +93,7 @@ module EventMachine
       # Disconnected shells cannot be split.
       def disconnect
         close
-        connection.close
+        connection && connection.close
       end
 
       # @return [Boolean] true if the connection is still alive
@@ -115,6 +117,40 @@ module EventMachine
         @closed == true
       end
 
+      # Wait for a number of seconds until a specified string or regexp is matched by the
+      # data returned from the ssh connection. Optionally send a given string first.
+      #
+      # If a block is not provided the current Fiber will yield until strregex matches or
+      # :timeout # is reached.
+      #
+      # If a block is provided expect will return.
+      #
+      # @param [String, Regexp] strregex to match against
+      # @param [String] send_str the data to send before waiting
+      # @param [Hash] opts
+      # @option opts [Fixnum] :timeout (@timeout) number of seconds to wait when there is no activity
+      # @return [Shell, String] all data received up to an including strregex if a block is not provided.
+      #                         the Shell if a block is provided
+      # @example expect a prompt
+      #   expect(' ~]$ ')
+      # @example send a command and wait for a prompt
+      #   expect(' ~]$ ', '/sbin/ifconfig')
+      # @example expect a prompt and within 5 seconds
+      #   expect(' ~]$ ', :timeout => 5)
+      # @example send a command and wait up to 10 seconds for a prompt
+      #   expect(' ~]$ ', '/etc/sysconfig/openvpn restart', :timeout => 10)
+      def expect(strregex, send_str = nil, opts = {})
+        send_str, opts = nil, send_str if send_str.is_a?(Hash)
+        if block_given?
+          Fiber.new {
+            yield send_str ? send_and_wait(send_str, strregex, opts) : wait_for(strregex, opts)
+          }.resume
+          self
+        else
+          send_str ? send_and_wait(send_str, strregex, opts) : wait_for(strregex, opts)
+        end
+      end
+
       # Send a string to the server and wait for a response containing a specified String or Regex.
       # @param [String] send_str
       # @return [String] all data in the buffer including the wait_str if it was found
@@ -155,12 +191,10 @@ module EventMachine
         data_callback = on(:data) do
           timer && timer.cancel
           if matched
-            debug("data_callback invoked when already matched")
+            warn("data_callback invoked when already matched")
             next
           end
-          matched = @buffer.match(strregex)
-          if matched
-            debug("data matched")
+          if (matched = @buffer.match(strregex))
             data_callback.cancel
             @buffer=matched.post_match
             f.resume(matched.pre_match + matched.to_s)
@@ -176,10 +210,13 @@ module EventMachine
 
         timer = EM::Timer.new(opts[:timeout], &timeout)
         debug("set timer: #{timer} for #{opts[:timeout]}")
-        res = Fiber.yield
-        raise(res, res.message, Array(res.backtrace) + trace) if res.is_a?(Exception)
-        yield(res) if block_given?
-        res
+        Fiber.yield.tap do |res|
+          if res.is_a?(Exception)
+            res.set_backtrace(Array(res.backtrace) + trace)
+            raise res
+          end
+          yield(res) if block_given?
+        end
       end
 
 
@@ -191,45 +228,35 @@ module EventMachine
         f      = Fiber.current
         trace  = caller
 
-        conerr = nil
-        unless connected?
-          conerr = on(:error) do |e|
-            error("#{e} (#{e.class})")
-            e.set_backtrace(trace + Array(e.backtrace))
-            debug(e.backtrace)
-            conerr = e
-            f.resume(e)
-          end #  |e|
+        begin
           connect
-        end # connected?
-
-        connection || raise(ConnectionError, "failed to create shell for #{host}: #{conerr} (#{conerr.class})")
-
-        connection.open_channel do |channel|
-          debug "**** channel open: #{channel}"
-          channel.request_pty(options[:pty] || {}) do |pty,suc|
-            debug "***** pty open: #{pty}; suc: #{suc}"
-            pty.send_channel_request("shell") do |shell,success|
-              unless success
-                f.resume(ConnectionError.new("Failed to create shell").tap{|e| e.set_backtrace(caller) })
-              end
-              conerr && conerr.cancel
-              debug "***** shell open: #{shell}"
-              @closed = false
-              @shell = shell
-              @shell.on_data do |ch,data|
-                debug("data: #{@buffer.dump}")
-                @buffer += data
-                fire(:data)
-              end
-
-              Fiber.new { yield(self) if block_given? }.resume
-              f.resume(self)
-            end # |shell,success|
-          end # |pty,suc|
-        end # |channel|
-
-        return Fiber.yield
+          connection.open_channel do |channel|
+            debug "**** channel open: #{channel}"
+            channel.request_pty(options[:pty] || {}) do |pty,suc|
+              debug "***** pty open: #{pty}; suc: #{suc}"
+              pty.send_channel_request("shell") do |shell,success|
+                if !success
+                  f.resume(ConnectionError.new("Failed to create shell").tap{|e| e.set_backtrace(caller) })
+                else
+                  debug "***** shell open: #{shell}"
+                  @closed = false
+                  @shell  = shell
+                  @shell.on_data do |ch,data|
+                    @buffer += data
+                    debug("data: #{@buffer.dump}")
+                    fire(:data)
+                  end
+                  Fiber.new { yield(self) if block_given? }.resume
+                  f.resume(self)
+                end
+              end # |shell,success|
+            end # |pty,suc|
+          end # |channel|
+        rescue => e
+          raise ConnectionError.new("failed to create shell for #{host}: #{e} (#{e.class})")
+        end
+
+        return Fiber.yield.tap { |r| raise r if r.is_a?(Exception) }
       end
 
       # Create a new shell using the same ssh connection.
@@ -254,20 +281,19 @@ module EventMachine
       # Does not open the shell; use #open or #split
       # You generally won't need to call this on your own.
       def connect
-        return if connected?
+        return @connection if connected?
         trace = caller
         f = Fiber.current
         ::EM::Ssh.start(host, user, connect_opts) do |connection|
           connection.callback do |ssh|
             f.resume(@connection = ssh)
-          end # ssh
+          end
           connection.errback do |e|
             e.set_backtrace(trace + Array(e.backtrace))
-            fire(:error, e)
             f.resume(e)
-          end # err
+          end
         end
-        return Fiber.yield
+        return Fiber.yield.tap { |r| raise r if r.is_a?(Exception) }
       end
 
 

data/lib/em-ssh/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   class Ssh
-    VERSION='0.3.0.pre1'
+    VERSION='0.3.0'
   end # class::Ssh
 end # module::EventMachine

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: em-ssh
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre1
-  prerelease: 6
+  version: 0.3.0
+  prerelease: 
 platform: ruby
 authors:
 - Caleb Crane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-04 00:00:00.000000000 Z
+date: 2012-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -123,3 +123,4 @@ signing_key:
 specification_version: 3
 summary: An EventMachine compatible net-ssh
 test_files: []
+has_rdoc: