delano-rye 0.7.6 → 0.8.0

data/CHANGES.txt

@@ -7,6 +7,18 @@ TODO
 * Add S3 support for Rye::Box.upload / download
 
 
+#### 0.8.0 (2009-06-21) #############################
+
+* FIXED: safely and unsafely (Rye::Box) now return the block return value
+* ADDED: Rye::Set#parallel and Rye::Set#parallel= methods
+* ADDED: Rye::Box#quietly
+* CHANGE: Updated Rye::Set#inspect and Rye::Set#to_s
+* CHANGE: Exception hook now receives: ex, cmd, user, host, nickname
+* CHANGE: Increased Kernel.sleep to 0.03 in Rye::Set.run_command_parallel
+* CHANGE: Renamed Rye::Cmd#upload and Rye::Cmd#download to file_upload and file_download
+* CHANGE: Rye::Cmd#file_exists? now executes quietly (doesn't pollute logging)
+
+
 #### 0.7.6 (2009-06-19) #############################
 
 * FIXED: Raise Rye::NoPty exception when Net::SSH returns message 

data/README.rdoc

@@ -1,4 +1,4 @@
-= Rye - v0.7
+= Rye - v0.8
 
 Safely run SSH commands on a bunch of machines at the same time (from Ruby).
 
@@ -42,7 +42,7 @@ You can specify environment variables
     rbox.env             # => ['HOME=/home/rye', 'RYE=Forty Creek', ...]
     
     
-== EXAMPLE 3 -- Accessing Multiple Machines
+== EXAMPLE 3a -- Accessing Multiple Machines
 
     rset = Rye::Set.new
     rbox = Rye::Box.new
@@ -54,25 +54,33 @@ Calling methods on Rye::Set objects is very similar to calling them on Rye::Box
     p rset.uptime        # => [[14:19:02 up 32 days, 19:35 ...], [14:19:02 up 30 days, 01:35]]
     p rset['/etc'].ls    # => [['file1', 'file2', ...], ['life1', 'life2', ...]]
     
-    
-== EXAMPLE 4 -- FILE TRANSFERS
+== EXAMPLE 3b -- Accessing Multiple Machines -- In Parallel
+   
+By default, Rye:Set connects to each machine sequentially in the order they were added to the set. Commands can also be run in parallel:
+
+   rset = Rye::Set.new('set-name', :parallel => true)
+     OR
+   rset.parallel = true
+   
+   
+== EXAMPLE 4 -- File Transfers
 
     rbox = Rye::Box.new("localhost", :info => true)
 
     dir_upload = "#{Rye.sysinfo.tmpdir}/rye-upload/"
     dir_download = "#{Rye.sysinfo.tmpdir}/rye-download/"
     
-    rbox.upload("#{RYE_HOME}/README.rdoc", 
+    rbox.file_upload("#{RYE_HOME}/README.rdoc", 
                 "#{RYE_HOME}/LICENSE.txt", dir_upload)
 
     applejack = StringIO.new("Some in-memory content")
-    rbox.upload(applejack, "#{dir_upload}/applejack.txt")
+    rbox.file_upload(applejack, "#{dir_upload}/applejack.txt")
 
     p rbox.ls(dir_upload)      # => [README.rdoc, LICENSE.txt, applejack.txt]
     p rbox.cat("#{dir_upload}/applejack.txt")   # => "Some in-memory content"
 
     filecontent = StringIO.new
-    rbox.download("#{dir_upload}/applejack.txt", filecontent)
+    rbox.file_download("#{dir_upload}/applejack.txt", filecontent)
 
     p filecontent.read
 

data/lib/rye.rb

@@ -1,8 +1,4 @@
 
-# Temporary fix before Highline 1.5.1 is release. This fixes
-# a the issue with Ruby 1.9 that causes the prompts to hang.
-$:.unshift File.join(File.dirname(__FILE__), '..', 'vendor', 'highline-1.5.1', 'lib')
-
 require 'logger'
 require 'thread'
 require 'base64'
@@ -47,7 +43,7 @@ module Rye
   extend self
 
   unless defined?(SYSINFO)
-    VERSION = 0.7.freeze
+    VERSION = "0.8.0".freeze
     SYSINFO = SysInfo.new.freeze
   end
   
@@ -205,7 +201,8 @@ module Rye
   # NOTE: shell is a bit paranoid so it escapes every argument. This means
   # you can only use literal values. That means no asterisks too. 
   #
-  # Returns a Rye::Rap object containing the 
+  # Returns a Rye::Rap object.
+  #
   def shell(cmd, *args)
     args = args.flatten.compact
     cmd = cmd.to_s if cmd.is_a?(Symbol)

data/lib/rye/box.rb

@@ -34,20 +34,24 @@ module Rye
     def safe; @rye_safe; end
     def user; (@rye_opts || {})[:user]; end
     
-    # A storage area +@rye_stash+
+    # Returns the current value of the stash +@rye_stash+
     def stash; @rye_stash; end
+    def quiet; @rye_quiet; 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+
+    # Store a value to the stash +@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
     
+    def enable_quiet_mode;  @rye_quiet = true; end
+    def disable_quiet_mode; @rye_quiet = false; end
+    
     # The most recent value from Box.cd or Box.[]
     def current_working_directory; @rye_current_working_directory; end
 
@@ -94,6 +98,7 @@ module Rye
         :debug => nil,
         :error => STDERR,
         :getenv => true,
+        :quiet => false
       }.merge(opts)
       
       # Close the SSH session before Ruby exits. This will do nothing
@@ -105,6 +110,7 @@ module Rye
       @rye_safe, @rye_debug = @rye_opts.delete(:safe), @rye_opts.delete(:debug)
       @rye_info, @rye_error = @rye_opts.delete(:info), @rye_opts.delete(:error)
       @rye_getenv = {} if @rye_opts.delete(:getenv) # Enable getenv with a hash
+      @rye_quiet = @rye_opts.delete(:quiet)
       
       # Just in case someone sends a true value rather than IO object
       @rye_debug = STDERR if @rye_debug == true
@@ -279,11 +285,11 @@ module Rye
     def to_s; '%s@rye_%s' % [user, @rye_host]; end
     
     def inspect
-      %q{#<%s:%s name=%s cwd=%s umask=%s env=%s safe=%s opts=%s>} % 
+      %q{#<%s:%s name=%s cwd=%s umask=%s env=%s safe=%s opts=%s keys=%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]
+       self.safe, self.opts.inspect, self.keys.inspect]
     end
     
     # Compares itself with the +other+ box. If the hostnames
@@ -372,7 +378,7 @@ module Rye
         if self.file_exists?(akey_path)
           # TODO: Make Rye::Cmd.incremental_backup
           self.cp(akey_path, "#{akey_path}-previous")
-          authorized_keys = self.download("#{homedir}/#{akey_path}")
+          authorized_keys = self.file_download("#{homedir}/#{akey_path}")
         end
         authorized_keys ||= StringIO.new
         
@@ -391,7 +397,7 @@ module Rye
         authorized_keys.rewind
         
         self.mkdir(:p, :m, '700', File.dirname(akey_path))
-        self.upload(authorized_keys, "#{homedir}/#{akey_path}")
+        self.file_upload(authorized_keys, "#{homedir}/#{akey_path}")
         self.chmod('0600', akey_path)
         self.chown(:R, this_user.to_s, File.dirname(akey_path))
       end
@@ -490,18 +496,35 @@ module Rye
     def unsafely(*args, &block)
       previous_state = @rye_safe
       disable_safe_mode
-      self.instance_exec *args, &block
+      ret = self.instance_exec *args, &block
       @rye_safe = previous_state
+      ret
     end
     
     # See unsafely (except in reverse)
     def safely(*args, &block)
       previous_state = @rye_safe
       enable_safe_mode
-      self.instance_exec *args, &block
+      ret = self.instance_exec *args, &block
       @rye_safe = previous_state
+      ret
     end
     
+    # Like batch, except it enables quiet mode before executing the block. 
+    # After executing the block, quiet mode is returned back to whichever
+    # state it was previously in. In other words, this method won't enable
+    # quiet mode if it was already disabled.
+    #
+    # In quiet mode, the pre and post command hooks are not called. This 
+    # is used internally when calling commands like +ls+ to check whether
+    # a file path exists (to prevent polluting the logs).
+    def quietly(*args, &block)
+      previous_state = @rye_quiet
+      enable_quiet_mode
+      ret = self.instance_exec *args, &block
+      @rye_quiet = previous_state
+      ret
+    end
     
     # instance_exec for Ruby 1.8 written by Mauricio Fernandez
     # http://eigenclass.org/hiki/instance_exec
@@ -646,22 +669,24 @@ module Rye
       raise Rye::NotConnected, @rye_host unless @rye_ssh && !@rye_ssh.closed?
       
       cmd_clean = Rye.escape(@rye_safe, cmd, args)
-      cmd_clean = prepend_env(cmd_clean)
+      
+      # This following is the command we'll actually execute. cmd_clean
+      # can be used for logging, otherwise the output is confusing.
+      cmd_internal = prepend_env(cmd_clean)
       
       # Add the current working directory before the command if supplied. 
       # The command will otherwise run in the user's home directory.
       if @rye_current_working_directory
         cwd = Rye.escape(@rye_safe, 'cd', @rye_current_working_directory)
-        cmd_clean = [cwd, cmd_clean].join(' && ')
+        cmd_internal = [cwd, cmd_internal].join(' && ')
       end
       
       # ditto (same explanation as cwd)
       if @rye_current_umask
         cwd = Rye.escape(@rye_safe, 'umask', @rye_current_umask)
-        cmd_clean = [cwd, cmd_clean].join(' && ')
+        cmd_internal = [cwd, cmd_internal].join(' && ')
       end
       
-      
       ## NOTE: Do not raise a CommandNotFound exception in this method.
       # We want it to be possible to define methods to a single instance
       # of Rye::Box. i.e. def rbox.rm()...
@@ -673,20 +698,21 @@ module Rye
       
       begin
         info "COMMAND: #{cmd_clean}"
-        debug "Executing: %s" % cmd_clean
+        debug "Executing: #{cmd_internal}"
 
-        if @rye_pre_command_hook.is_a?(Proc)
+        if !@rye_quiet && @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)
+        rap.cmd = cmd_clean
+        
+        stdout, stderr, ecode, esignal = net_ssh_exec!(cmd_internal)
+        
         rap.add_stdout(stdout || '')
         rap.add_stderr(stderr || '')
         rap.add_exit_code(ecode)
         rap.exit_signal = esignal
-        rap.cmd = cmd
         
         #info "stdout: #{rap.stdout}"
         #info "stderr: #{rap.stderr}"
@@ -699,10 +725,11 @@ module Rye
         raise Rye::CommandError.new(rap) if ecode != 0
         
       rescue Exception => ex
+        return rap if @rye_quiet
         choice = nil
         @rye_exception_hook.each_pair do |klass,act|
           next unless ex.kind_of? klass
-          choice = @rye_exception_hook[klass].call(ex)
+          choice = act.call(ex, cmd_clean, user, host, nickname)
           break
         end
         if choice == :retry
@@ -714,7 +741,9 @@ module Rye
         end
       end
       
-      @rye_post_command_hook.call(rap) if @rye_post_command_hook.is_a?(Proc)
+      if !@rye_quiet && @rye_post_command_hook.is_a?(Proc)
+        @rye_post_command_hook.call(rap)
+      end
       
       rap
     end
@@ -775,7 +804,7 @@ module Rye
           raise Rye::NoPty if data =~ /Pseudo-terminal will not/
           
         end
-
+        
       end
       
       channel = @rye_ssh.exec(command, &block)

data/lib/rye/cmd.rb

@@ -92,7 +92,7 @@ module Rye;
     # Always return nil.
     #
     # NOTE: Changes to current working directory with +cd+ or +[]+ are ignored.
-    def upload(*files); net_scp_transfer!(:upload, *files); end
+    def file_upload(*files); net_scp_transfer!(:upload, *files); end
 
     # Transfer files from a machine via Net::SCP. 
     # * +files+ is an Array of files to download. The last element must be the 
@@ -105,7 +105,7 @@ module Rye;
     # Return nil or a StringIO object, if specified as the target.
     #
     # NOTE: Changes to current working directory with +cd+ or +[]+ are ignored.
-    def download(*files); net_scp_transfer!(:download, *files); end
+    def file_download(*files); net_scp_transfer!(:download, *files); end
     
     # Append +newcontent+ to remote +filepath+. If the file doesn't exist
     # it will be created. If +backup+ is specified, +filepath+ will be 
@@ -113,7 +113,7 @@ module Rye;
     def file_append(filepath, newcontent, backup=false)
       if self.file_exists?(filepath)
         self.cp filepath, "#{filepath}-previous" if backup
-        file_content = self.download filepath
+        file_content = self.file_download filepath
       end
       
       file_content ||= StringIO.new
@@ -124,13 +124,13 @@ module Rye;
         file_content.puts newcontent
       end
       
-      self.upload file_content, filepath
+      self.file_upload file_content, filepath
     end
     
     # Does +path+ from the current working directory?
     def file_exists?(path)
       begin
-        ret = self.ls(path)
+        ret = self.quietly { ls(path) }
       rescue Rye::CommandError => ex
         ret = ex.rap
       end

data/lib/rye/set.rb

@@ -8,6 +8,10 @@ module Rye
     attr_reader :boxes
     attr_reader :opts
     
+      # Run commands in parallel? A Boolean value. Default: false.
+    attr_accessor :parallel
+    
+    
     # * +name+ The name of the set of machines
     # * +opts+ a hash of optional arguments 
     #
@@ -83,11 +87,12 @@ module Rye
     end
     
     def to_s
-      "%s: %s" % [self.name, ]
+      "%s:%s" % [self.class.to_s, @name]
     end
     
     def inspect
-      %q{#<%s:%s boxes=%s opts=%s>} % [self.class.to_s, self.name, self.boxes.join(','), self.opts.inspect]
+      a = [self.class.to_s, @name, @parallel, @opts.inspect, @boxes.inspect]
+      %q{#<%s:%s parallel=%s opts=%s boxes=%s>} % a
     end
     
     # See Rye::Box.[]
@@ -142,12 +147,11 @@ module Rye
         end
       end
       
-      # Should it bubble up the exception for a single box?
-      # socket errors?
+      # Should it bubble up the exception for a single box? socket errors?
       threads.each do |t| 
-        sleep 0.01        # Give the thread some breathing room
-        t.join            # Wait for the thread to finish
-        raps << t[:rap]   # Grab the result
+        Kernel.sleep 0.03     # Give the thread some breathing room
+        t.join                # Wait for the thread to finish
+        raps << t[:rap]       # Grab the result
       end
       
       raps

data/rye.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "rye"
   s.rubyforge_project = "rye"
-  s.version = "0.7.6"
+  s.version = "0.8.0"
   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.6
+  version: 0.8.0
 platform: ruby
 authors: 
 - Delano Mandelbaum