delano-rye 0.7.4 → 0.7.5

data/CHANGES.txt

@@ -7,6 +7,16 @@ TODO
 * Add S3 support for Rye::Box.upload / download
 
 
+#### 0.7.5 (2009-06-14) #############################
+
+* FIXED: Rye::Set methods were not accepting or passing blocks. 
+* ADDED: Rye::Set#user and Rye::Set#opts methods
+* ADDED: Rye::Box#nickname
+* ADDED: exception hooks for Rye::Box.
+* CHANGE: Rye::Set method missing now forwards to Rye::Box 
+  methods instead of Rye::Cmd
+
+
 #### 0.7.4 (2009-06-04) #############################
 
 * FIXED: Bug in Rye::Box#interactive_ssh related to instance variable renaming from 0.7.0.

data/lib/rye/box.rb

@@ -34,9 +34,17 @@ module Rye
     def safe; @rye_safe; end
     def user; (@rye_opts || {})[:user]; end
     
+    # A storage area +@rye_stash+
+    def stash; @rye_stash; end
+    def nickname; @rye_nickname || host; end
+      
     def host=(val); @rye_host = val; end
     def opts=(val); @rye_opts = val; end
     
+    # Returns the storage area +@rye_stash+
+    def stash=(val); @rye_stash = val; end
+    def nickname=(val); @rye_nickname = val; end
+    
     def enable_safe_mode;  @rye_safe = true; end
     def disable_safe_mode; @rye_safe = false; end
     
@@ -45,14 +53,15 @@ module Rye
 
     # The most recent valud for umask (or 0022)
     def current_umask; @rye_current_umask; end
-
-    def ssh; @rye_ssh; end
+    
     def info; @rye_info; end
     def debug; @rye_debug; end
     def error; @rye_error; end
 
     def pre_command_hook=(val); @rye_pre_command_hook = val; end
     def post_command_hook=(val); @rye_post_command_hook = val; end
+    # A Hash. The keys are exception classes, the values are Procs to execute
+    def exception_hook=(val); @rye_exception_hook = val; end
 
     # * +host+ The hostname to connect to. The default is localhost.
     # * +opts+ a hash of optional arguments.
@@ -72,6 +81,7 @@ module Rye
     # Net::SSH.start that is not already mentioned above.
     #
     def initialize(host='localhost', opts={})
+      @rye_exception_hook = {}
       @rye_host = host
       
       # These opts are use by Rye::Box and also passed to Net::SSH
@@ -222,7 +232,7 @@ module Rye
         debug "ssh-add stdout: #{ret.stdout}"
         debug "ssh-add stderr: #{ret.stderr}"
       end
-      self #MUST RETURN itself
+      self # MUST RETURN self
     end
     alias :add_key :add_keys
     
@@ -279,8 +289,8 @@ module Rye
     def to_s; '%s@rye_%s' % [user, @rye_host]; end
     
     def inspect
-      %q{#<%s:%s cwd=%s umask=%s env=%s safe=%s opts=%s>} % 
-      [self.class.to_s, self.host, 
+      %q{#<%s:%s name=%s cwd=%s umask=%s env=%s safe=%s opts=%s>} % 
+      [self.class.to_s, self.host, self.nickname,
        @rye_current_working_directory, @rye_current_umask,
        (@rye_current_environment_variables || '').inspect,
        self.safe, self.opts.inspect]
@@ -424,7 +434,9 @@ module Rye
     # A handler for undefined commands. 
     # Raises Rye::CommandNotFound exception.
     def method_missing(meth, *args, &block)
-      raise Rye::CommandNotFound, "#{meth.to_s}"
+      ex = Rye::CommandNotFound.new(meth.to_s)
+      raise ex unless @rye_exception_hook.has_key? ex.class
+      @rye_exception_hook[Rye::CommandNotFound].call ex
     end
     
     # Returns the command an arguments as a String. 
@@ -444,6 +456,27 @@ module Rye
       @rye_pre_command_hook
     end
     
+    # Supply a block to be called whenever there's an Exception. It's called
+    # with 1 argument: the exception class. If the exception block returns 
+    # :retry, the command will be executed again. 
+    #
+    # e.g.
+    #     rbox.exception_hook(CommandNotFound) do |ex|
+    #       STDERR.puts "An error occurred: #{ex.class}"
+    #       choice = Annoy.get_user_input('(S)kip  (R)etry  (A)bort: ')
+    #       if choice == 'R'
+    #         :retry 
+    #       elsif choice == 'S'
+    #         # do nothing
+    #       else
+    #         exit  # !
+    #       end
+    #     end
+    def exception_hook(klass, &block)
+      @rye_exception_hook[klass] = block if block
+      @rye_exception_hook[klass]
+    end
+    
     # Execute a block in the context of an instance of Rye::Box. 
     #
     #     rbox = Rye::Box.new
@@ -622,12 +655,11 @@ 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)  
+        @rye_pre_command_hook.call(cmd, args, user, host, nickname) 
       end
       
       ## NOTE: Do not raise a CommandNotFound exception in this method.
@@ -639,25 +671,30 @@ module Rye
       # this is good enough for now. 
       ## raise Rye::CommandNotFound unless self.can?(cmd)
       
-      stdout, stderr, ecode, esignal = net_ssh_exec!(cmd_clean)
-      
-      rap = Rye::Rap.new(self)
-      rap.add_stdout(stdout || '')
-      rap.add_stderr(stderr || '')
-      rap.add_exit_code(ecode)
-      rap.exit_signal = esignal
-      rap.cmd = cmd
-      
-      if @rye_post_command_hook.is_a?(Proc)
-        @rye_post_command_hook.call(rap)
-      else
+      begin
+        stdout, stderr, ecode, esignal = net_ssh_exec!(cmd_clean)
+        
+        rap = Rye::Rap.new(self)
+        rap.add_stdout(stdout || '')
+        rap.add_stderr(stderr || '')
+        rap.add_exit_code(ecode)
+        rap.exit_signal = esignal
+        rap.cmd = cmd
+        
         # 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
+        
+      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
       end
       
+      @rye_post_command_hook.call(rap) if @rye_post_command_hook.is_a?(Proc)
+      
       rap
     end
     alias :cmd :run_command
@@ -722,7 +759,7 @@ module Rye
       
       channel.wait  # block until we get a response
       channel.request_pty do |ch, success|
-        raise "Could not obtain pty (i.e. an interactive ssh session)" if !success
+        raise Rye::NoPty if !success
       end
       
       channel[:exit_code] = 0 if channel[:exit_code] == nil

data/lib/rye/cmd.rb

@@ -67,6 +67,7 @@ module Rye;
     def chown(*args); cmd('chown', args); end
     def unzip(*args); cmd('unzip', args); end
     def bzip2(*args); cmd('bzip2', args); end
+    def which(*args); cmd('which', args); end
     
     def umount(*args); cmd("umount", args); end
     def uptime(*args); cmd("uptime", args); end

data/lib/rye/set.rb

@@ -42,6 +42,9 @@ module Rye
       add_keys(@opts[:keys])
     end
     
+    def opts; @opts; end
+    def user; (@opts || {})[:user]; end
+    
     # * +boxes+ one or more boxes. Rye::Box objects will be added directly 
     # to the set. Hostnames will be used to create new instances of Rye::Box 
     # and those will be added to the list. 
@@ -97,7 +100,12 @@ module Rye
       run_command(:cd, key)
       self
     end
-
+    
+    # Are there any boxes in this set?
+    def empty?
+      @boxes.nil? || @boxes.empty?
+    end
+    
     # Catches calls to Rye::Box commands. If +meth+ is the name of an 
     # instance method defined in Rye::Cmd then we call it against all 
     # the boxes in +@boxes+. Otherwise this method raises a
@@ -105,33 +113,32 @@ module Rye
     # exception if this set has no boxes defined. 
     #
     # Returns a Rye::Rap object containing the responses from each Rye::Box. 
-    def method_missing(meth, *args)
+    def method_missing(meth, *args, &block) 
       # Ruby 1.8 populates Module.instance_methods with Strings. 1.9 uses Symbols.
       meth = (Rye.sysinfo.ruby[1] == 8) ? meth.to_s : meth.to_sym
       raise Rye::NoBoxes if @boxes.empty?
-      raise Rye::CommandNotFound, meth.to_s unless Rye::Cmd.instance_methods.member?(meth)
-      run_command(meth, *args)
+      raise Rye::CommandNotFound, meth.to_s unless Rye::Box.instance_methods.member?(meth)
+      run_command(meth, *args, &block)
     end
     
   private
     
     # Determines whether to call the serial or parallel method, then calls it. 
-    def run_command(meth, *args)
+    def run_command(meth, *args, &block)
       runner = @parallel ? :run_command_parallel : :run_command_serial
-      self.send(runner, meth, *args)
+      self.send(runner, meth, *args, &block)
     end
     
     
     # Run the command on all boxes in parallel
-    def run_command_parallel(meth, *args)
-      p @boxes
+    def run_command_parallel(meth, *args, &block)
       debug "P: #{meth} on #{@boxes.size} boxes (#{@boxes.collect {|b| b.host }.join(', ')})"
       threads = []
       
       raps = Rye::Rap.new(self)
       (@boxes || []).each do |box|
         threads << Thread.new do
-          Thread.current[:rap] = box.send(meth, *args) # Store the result in the thread
+          Thread.current[:rap] = box.send(meth, *args, &block) # Store the result in the thread
         end
       end
       
@@ -148,11 +155,11 @@ module Rye
     
     
     # Run the command on all boxes in serial
-    def run_command_serial(meth, *args)
+    def run_command_serial(meth, *args, &block)
       debug "S: #{meth} on #{@boxes.size} boxes (#{@boxes.collect {|b| b.host }.join(', ')})"
       raps = Rye::Rap.new(self)
       (@boxes || []).each do |box|
-        raps << box.send(meth, *args)
+        raps << box.send(meth, *args, &block)
       end
       raps
     end

data/lib/rye.rb

@@ -63,6 +63,9 @@ module Rye
   class NoHost < RuntimeError; end
   class NotConnected < RuntimeError; end
   class CommandNotFound < RuntimeError; end
+  class NoPty < RuntimeError
+    def message; "Could not obtain pty (i.e. an interactive ssh session)"; end
+  end
   class CommandError < RuntimeError
     attr_reader :rap
     # * +rap+ a Rye::Rap object

data/rye.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "rye"
   s.rubyforge_project = "rye"
-  s.version = "0.7.4"
+  s.version = "0.7.5"
   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: delano-rye
 version: !ruby/object:Gem::Version 
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors: 
 - Delano Mandelbaum