rye 0.7.5 → 0.7.6

data/CHANGES.txt

@@ -7,7 +7,20 @@ TODO
 * Add S3 support for Rye::Box.upload / download
 
 
-#### 0.7.5 (2009-06-14) #############################
+#### 0.7.6 (2009-06-19) #############################
+
+* FIXED: Raise Rye::NoPty exception when Net::SSH returns message 
+  "Pseudo-terminal will not be allocated because stdin is not a terminal."
+* FIXED: Rye::Box#disconnect would hang in some instances. Now waits 3 seconds. 
+* FIXED: Bug in net_ssh_exec which was causing it to not return an exit code
+* CHANGE: All exceptions now inherit from Rye::Error (Runtimerror)  
+* CHANGE: A NoPassword exception is raised when a password prompt returns nil.
+* CHANGE: pre_command_hook block arguments have changed: 
+     NEW: complete command, user, host, nickname
+     OLD: command, args, user, host, nickname
+     
+     
+#### 0.7.5 (2009-06-13) #############################
 
 * FIXED: Rye::Set methods were not accepting or passing blocks. 
 * ADDED: Rye::Set#user and Rye::Set#opts methods

data/lib/rye.rb

@@ -11,6 +11,7 @@ require 'net/scp'
 require 'openssl'
 require 'tempfile'
 require 'highline'
+require 'timeout'
 
 require 'storable'
 require 'sysinfo'
@@ -59,21 +60,25 @@ module Rye
   # Accessor for an instance of SystemInfo
   def sysinfo; SYSINFO;  end
   
-  class NoBoxes < RuntimeError; end
-  class NoHost < RuntimeError; end
-  class NotConnected < RuntimeError; end
-  class CommandNotFound < RuntimeError; end
-  class NoPty < RuntimeError
+  class RyeError < RuntimeError; end
+  class NoBoxes < RyeError; end
+  class NoPassword < RyeError
+    def message; "Password prompt did not return a value"; end
+  end
+  class NoHost < RyeError; end
+  class NotConnected < RyeError; end
+  class CommandNotFound < RyeError; end
+  class NoPty < RyeError
     def message; "Could not obtain pty (i.e. an interactive ssh session)"; end
   end
-  class CommandError < RuntimeError
+  class CommandError < RyeError
     attr_reader :rap
     # * +rap+ a Rye::Rap object
     def initialize(rap)
       @rap = rap
     end
     def message
-      "(code: %s) %s" % [@rap.exit_code, @rap.stderr.join($/)]
+      "%s (code: %s)" % [@rap.stderr.join($/), @rap.exit_code]
     end
     def stderr; @rap.stderr if @rap; end
     def stdout; @rap.stdout if @rap; end

data/lib/rye/box.rb

@@ -194,17 +194,7 @@ module Rye
       disconnect
       connect
     end
-    
-    
-    # Close the SSH session  with +@rye_host+. This is called 
-    # automatically at exit if the connection is open. 
-    def disconnect
-      return unless @rye_ssh && !@rye_ssh.closed?
-      @rye_ssh.loop(0.1) { @rye_ssh.busy? }
-      debug "Closing connection to #{@rye_ssh.host}"
-      @rye_ssh.close
-    end
-    
+
     
     # Open an interactive SSH session. This only works if STDIN.tty?
     # returns true. Otherwise it returns the SSH command that would 
@@ -594,6 +584,22 @@ module Rye
       self
     end
     
+    # Close the SSH session  with +@rye_host+. This is called 
+    # automatically at exit if the connection is open. 
+    def disconnect
+      return unless @rye_ssh && !@rye_ssh.closed?
+      begin
+        Timeout::timeout(3) do
+          @rye_ssh.loop(0.3) { @rye_ssh.busy?; }
+        end
+      rescue Timeout::Error => ex
+        error "Disconnect timeout (was something still running?)"
+      end
+      
+      debug "Closing connection to #{@rye_ssh.host}"
+      @rye_ssh.close
+    end
+    
     
   private
       
@@ -655,12 +661,6 @@ module Rye
         cmd_clean = [cwd, cmd_clean].join(' && ')
       end
       
-      info "COMMAND: #{cmd_clean}"
-      debug "Executing: %s" % cmd_clean
-      
-      if @rye_pre_command_hook.is_a?(Proc)
-        @rye_pre_command_hook.call(cmd, args, user, host, nickname) 
-      end
       
       ## NOTE: Do not raise a CommandNotFound exception in this method.
       # We want it to be possible to define methods to a single instance
@@ -672,6 +672,13 @@ module Rye
       ## raise Rye::CommandNotFound unless self.can?(cmd)
       
       begin
+        info "COMMAND: #{cmd_clean}"
+        debug "Executing: %s" % cmd_clean
+
+        if @rye_pre_command_hook.is_a?(Proc)
+          @rye_pre_command_hook.call(cmd_clean, user, host, nickname) 
+        end
+        
         stdout, stderr, ecode, esignal = net_ssh_exec!(cmd_clean)
         
         rap = Rye::Rap.new(self)
@@ -681,16 +688,30 @@ module Rye
         rap.exit_signal = esignal
         rap.cmd = cmd
         
+        #info "stdout: #{rap.stdout}"
+        #info "stderr: #{rap.stderr}"
+        #info "exit_code: #{rap.exit_code}"
+        
         # It seems a convention for various commands to return -1
         # when something only mildly concerning happens. ls even 
         # returns -1 for apparently no reason sometimes. In any
         # case, the real errors are the ones greater than zero
-        raise Rye::CommandError.new(rap) if ecode > 0
+        raise Rye::CommandError.new(rap) if ecode != 0
         
       rescue Exception => ex
-        raise ex unless @rye_exception_hook.has_key? ex.class
-        ret = @rye_exception_hook[ex.class].call(ex)
-        retry if ret == :retry
+        choice = nil
+        @rye_exception_hook.each_pair do |klass,act|
+          next unless ex.kind_of? klass
+          choice = @rye_exception_hook[klass].call(ex)
+          break
+        end
+        if choice == :retry
+          retry
+        elsif choice == :skip
+          # do nothing
+        else
+          raise ex
+        end
       end
       
       @rye_post_command_hook.call(rap) if @rye_post_command_hook.is_a?(Proc)
@@ -729,42 +750,63 @@ module Rye
     # http://www.ruby-forum.com/topic/169997
     #
     def net_ssh_exec!(command)
-      
+
       block ||= Proc.new do |channel, type, data|
+        
         channel[:stdout] ||= ""
         channel[:stderr] ||= ""
-        channel[:exit_code] ||= 0
         channel[:stdout] << data if type == :stdout
+        
         if type == :stderr
           # NOTE: Use sudo to test this since it prompts for a passwords. 
           # Use sudo -K to kill the user's timestamp (ask for a password every time)
           if data =~ /Password:/
             ret = Annoy.get_user_input("Password: ", '*')
+            raise Rye::NoPassword if ret.nil?
             channel.send_data "#{ret}\n"
           else
             channel[:stderr] << data 
           end
+
+          # If someone tries to open an interactive ssh session
+          # through a regular Rye::Box command, Net::SSH will
+          # return the following error and appear to hang. We
+          # catch it and raise the appropriate exception.
+          raise Rye::NoPty if data =~ /Pseudo-terminal will not/
+          
         end
-        channel.on_request("exit-status") do |ch, data|
-          # Anything greater than 0 is an error
-          channel[:exit_code] = data.read_long
-        end
-        channel.on_request("exit-signal") do |ch, data|
-          # This should be the POSIX SIGNAL that ended the process
-          channel[:exit_signal] = data.read_long
-        end
+
       end
       
       channel = @rye_ssh.exec(command, &block)
       
+      channel.on_request("exit-status") do |ch, data|
+        # Anything greater than 0 is an error
+        channel[:exit_code] = data.read_long
+      end
+      channel.on_request("exit-signal") do |ch, data|
+        # This should be the POSIX SIGNAL that ended the process
+        channel[:exit_signal] = data.read_long
+      end
+      
       channel.wait  # block until we get a response
       channel.request_pty do |ch, success|
         raise Rye::NoPty if !success
       end
       
-      channel[:exit_code] = 0 if channel[:exit_code] == nil
+      ## I'm getting weird behavior with exit codes. Sometimes
+      ## a command which usually returns an exit code will not
+      ## return one the next time it's run. The following crap
+      ## was from the debugging.
+      ##Kernel.sleep 5
+      ###channel.close
+      #channel.eof!
+      ##p [:active, channel.active?]
+      ##p [:closing, channel.closing?]
+      ##p [:eof, channel.eof?]
+      
+      channel[:exit_code] ||= 0
       channel[:exit_code] &&= channel[:exit_code].to_i
-      
       channel[:stderr].gsub!(/bash: line \d+:\s+/, '') if channel[:stderr]
       
       [channel[:stdout], channel[:stderr], channel[:exit_code], channel[:exit_signal]]

data/lib/rye/rap.rb

@@ -76,13 +76,12 @@ module Rye;
     # it's just an exit code returned by Net::SSH. 
     # Returns the exit code as an Integer. 
     def add_exit_code(code)
-      code = -1 unless code
+      code = 0 if code.nil?
       if code.is_a?(Process::Status)
         @exit_code, @pid = code.exitstatus.to_i, code.pid
       else
         @exit_code = code.to_i
       end
-      @exit_code
     end
     def code; @exit_code; end
     
@@ -91,7 +90,7 @@ module Rye;
     def to_s
       return self.first if self.size == 1
       return "" if self.size == 0
-      self
+      super
     end
     
     # Output STDOUT content to (remote) +path+ 

data/rye.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "rye"
   s.rubyforge_project = "rye"
-  s.version = "0.7.5"
+  s.version = "0.7.6"
   s.summary = "Rye: Safely run SSH commands on a bunch of machines at the same time (from Ruby)."
   s.description = s.summary
   s.author = "Delano Mandelbaum"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rye
 version: !ruby/object:Gem::Version 
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-13 00:00:00 -04:00
+date: 2009-06-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency