scutil 0.2.3 → 0.2.4

data/CHANGELOG

@@ -1,6 +1,13 @@
 
 ==Changelog
 
+===0.2.4 | 2011-10-02
+
+* More verbose logging.
+* Better error handling.
+* Minor bug fixes.
+* Documentation corrections.
+
 ===0.2.3 | 2011-09-27
 
 * Fixed bug in Scutil.clear!

data/README

@@ -28,9 +28,8 @@ PTYs is beyond the scope of this documentation.
 The "_automatic_" part of PTY requests comes from a regex in
 Scutil.exec_command.  Basically, if _sudo_ is at the start of the
 command to be executed, scutil will request a PTY.  This regex is
-configurable through +:scutil_pty_regex+.  In a near future release it
-will be.  You can force a PTY request by specifying
-+:scutil_force_pty+ in the various _options_ arguments.
+configurable through +:scutil_pty_regex+.  You can force a PTY request
+by specifying +:scutil_force_pty+ in the various _options_ arguments.
 
 All of this syntactic sugar can be used as a simple class method with
 Scutil.exec_command, as an instantiable class with Scutil::Exec, or as

data/THANKS

@@ -1,7 +1,7 @@
 
 ===Thanks
 
-* Kevin McAllister <kevin@mcallister.com> for the name and much
+* Kevin McAllister <kevin@mcallister.ws> for the name and much
   feedback and discussion.
   
 * Jamis Buck <jamis@37signals.com> for writing Net::SSH, on which

data/lib/scutil.rb

@@ -30,14 +30,14 @@ require 'scutil/connection_cache'
 require 'scutil/system_connection'
 
 module Scutil
-  SCUTIL_VERSION = '0.2.3'
+  SCUTIL_VERSION = '0.2.4'
   # By default, buffer 10M of data before writing.
   DEFAULT_OUTPUT_BUFFER_SIZE = 0xA00000
   # Checks for a command starting with _sudo_ by default.
   DEFAULT_PTY_REGEX = /^\s*sudo/
   @connection_cache = ConnectionCache.new
   @output_buffer_size = DEFAULT_OUTPUT_BUFFER_SIZE
-
+  
   class << self
     # All successfully established connections end up here for reuse
     # later.
@@ -45,7 +45,7 @@ module Scutil
     # Set to 10M by default, this can be adjusted to tell scutil when
     # to write command output to _output_.
     attr_accessor :output_buffer_size
-
+    
     # Should we request a PTY?  Uses custom regex if defined in
     # +:scutil_pty_regex+.
     #
@@ -86,7 +86,7 @@ module Scutil
     # open file handle.*  Finally, if _output_ is omitted, or an empty
     # string, all command output will be directed to _$stdout_.
     #
-    # <em>**NB:* This isn't actually true.  The only check made is to
+    # <em>*NB:* This isn't actually true.  The only check made is to
     # see if _output_ responds to +:write+.  The idea being that not
     # only will a file handle have a +write+ method, but also
     # something like +StringIO+.  Using +StringIO+ here makes it easy
@@ -94,17 +94,15 @@ module Scutil
     # better way to do this are definitely welcome.</em>
     #
     # Scutil will automatically request a PTY if _sudo_ is at the
-    # start of _cmd_.  Right now the regex that drives this isn't
-    # configurable.  In a near future release it will be.  You can
-    # force a PTY request by specifying +:scutil_force_pty+ in
-    # _options_.
+    # start of _cmd_.  This is driven by a regex which is customizable
+    # via the option +:scutil_pty_regex+.  You can also force a PTY
+    # request by specifying +:scutil_force_pty+ in _options_.
     #
     # Scutil.exec_command takes the following options:
     #
     # * :scutil_verbose   => Extra output.
     # * :scutil_force_pty => Force a PTY request (or not) for every channel.
-    # * :scutil_pty_regex => Specific a custom regex here for use when
-    #                        scutil decides whether or not to request a PTY.
+    # * :scutil_pty_regex => Specific a custom regex here for use when scutil decides whether or not to request a PTY.
     #
     # In addition, any other options passed Scutil.exec_command will
     # be passed on to Net::SSH, _except_ those prefixed with
@@ -126,17 +124,19 @@ module Scutil
       begin
         if (Scutil.connection_cache.exists?(hostname))
           sys_conn = Scutil.connection_cache.fetch(hostname)
-          $stderr.print "[#{hostname}] Using existing connection\n" if options[:scutil_verbose]
+          print "[#{hostname}] Using existing connection\n" if options[:scutil_verbose]
           conn = sys_conn.get_connection(hostname, username, pty_needed, options)
         else
           sys_conn = SystemConnection.new(hostname)
           # Call get_connection first.  Don't add to cache unless established.
           conn = sys_conn.get_connection(hostname, username, pty_needed, options)
-          $stderr.print "[#{hostname}] Adding new connection to cache\n" if options[:scutil_verbose]
+          print "[#{hostname}] Adding new connection to cache\n" if options[:scutil_verbose]
           Scutil.connection_cache << sys_conn
         end
       rescue Net::SSH::AuthenticationFailed => err
         raise Scutil::Error.new("Error: Authenication failed for user: #{username}", hostname)
+      rescue SocketError => err
+        raise Scutil::Error.new("Error: " + err.message, hostname)
       end
       
       fh = $stdout
@@ -156,9 +156,9 @@ module Scutil
       edata = ""
       exit_status = 0
       chan = conn.open_channel do |channel|
-        $stderr.print "[#{conn.host}:#{channel.local_id}] Setting up callbacks...\n" if options[:scutil_verbose]
+        print "[#{conn.host}:#{channel.local_id}] Setting up callbacks...\n" if options[:scutil_verbose]
         if (pty_needed)
-          $stderr.print "[#{conn.host}:#{channel.local_id}] Requesting PTY...\n" if options[:scutil_verbose]
+          print "[#{conn.host}:#{channel.local_id}] Requesting PTY...\n" if options[:scutil_verbose]
           # OPOST is necessary, CS8 makes sense.  Revisit after broader testing.
           channel.request_pty(:modes => { Net::SSH::Connection::Term::CS8 => 1, Net::SSH::Connection::Term::OPOST => 0 } ) do |ch, success|
             raise Scutil::Error.new("Failed to get a PTY", hostname) if !success
@@ -166,9 +166,9 @@ module Scutil
         end
         
         channel.on_data do |ch, data|
-#          $stderr.print "on_data: #{data.size}\n" if options[:scutil_verbose]
+#          print "on_data: #{data.size}\n" if options[:scutil_verbose]
           odata += data
-
+          
           # Only buffer some of the output before writing to disk (10M by default).
           if (odata.size >= Scutil.output_buffer_size)
             fh.write odata
@@ -177,26 +177,23 @@ module Scutil
         end
         
         channel.on_extended_data do |ch, type, data|
-#          $stderr.print "on_extended_data: #{data.size}\n" if options[:scutil_verbose]
+#          print "on_extended_data: #{data.size}\n" if options[:scutil_verbose]
           edata += data
         end
         
         channel.on_close do |ch|
-          $stderr.print "[#{conn.host}:#{channel.local_id}] on_close\n" if options[:scutil_verbose]
+          print "[#{conn.host}:#{channel.local_id}] on_close\n" if options[:scutil_verbose]
         end
         
         channel.on_open_failed do |ch, code, desc|
           raise Scutil::Error.new("Failed to open channel: #{desc}", hostname, code) if !success
         end
-
+        
         channel.on_request("exit-status") do |ch, data|
           exit_status = data.read_long
+          print "[#{conn.host}:#{channel.local_id}] on_request(\"exit-status\"): #{exit_status}\n" if options[:scutil_verbose]
         end
         
-#        channel.on_open_failed do |ch, code, desc|
-#          
-#        end
-        
         channel.exec(cmd)
 #        channel.wait
       end

data/lib/scutil/connection_cache.rb

@@ -29,7 +29,11 @@ module Scutil
       end
       false
     end
-
+    
+    def remove_all
+      @cache = []
+    end
+    
     # Remove all instances of _hostname_.
     def remove(hostname)
       @cache.delete_if { |c| c.hostname == hostname }

data/lib/scutil/exec.rb

@@ -33,5 +33,6 @@ module Scutil
       @options.merge!(options)
       Scutil.exec_command(@hostname, @username, cmd, output, @options)
     end
+    # TODO: options should be customizable via an instance method.
   end
 end

data/lib/scutil/system_connection.rb

@@ -25,23 +25,23 @@ module Scutil
       if (pty_needed)
         if !@pty_connection.nil?
           # Existing PTY connection
-          $stderr.print "[#{hostname}] Using existing connection (pty)\n" if @options[:scutil_verbose]
+          print "[#{hostname}] Using existing connection (pty)\n" if @options[:scutil_verbose]
           return @pty_connection
         end
         
         # New PTY connection
-        $stderr.print "[#{hostname}] Opening new channel (pty) to system...\n" if @options[:scutil_verbose]
+        print "[#{hostname}] Opening new channel (pty) to system...\n" if @options[:scutil_verbose]
         conn = Net::SSH.start(hostname, username, @options)
         @pty_connection = conn
       else
         if !@connection.nil?
           # Existing non-PTY connection
-          $stderr.print "[#{hostname}] Using existing connection (non-pty)\n" if @options[:scutil_verbose]
+          print "[#{hostname}] Using existing connection (non-pty)\n" if @options[:scutil_verbose]
           return @connection
         end
         
         # New non-PTY connection
-        $stderr.print "[#{hostname}] Opening channel (non-pty) to system...\n" if @options[:scutil_verbose]
+        print "[#{hostname}] Opening channel (non-pty) to system...\n" if @options[:scutil_verbose]
         conn = Net::SSH.start(hostname, username, @options)
         @connection = conn
       end
@@ -57,7 +57,7 @@ module Scutil
     end
     
     def to_s
-      "#{self.class}: #{@name}, @connection = #{@connection}, @pty_connection = #{@pty_connection}"
+      "#{self.class}: #{@hostname}, @connection = #{@connection}, @pty_connection = #{@pty_connection}"
     end
   end
 end

data/scutil.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'scutil'
-  s.version     = '0.2.3'
-  s.date        = '2011-09-27'
+  s.version     = '0.2.4'
+  s.date        = '2011-10-02'
   s.summary     = 'SSH Command UTILity'
   s.description = <<-EOF
     Scutil is a library for conveniently executing commands 

data/test/test_scutil.rb

@@ -1,50 +1,138 @@
-#!/usr/bin/ruby -I../lib -w
+#!/usr/bin/ruby -I../lib -I. -w
 
 require 'test/unit'
 require 'scutil'
 require 'stringio'
 
 class TestScutil < Test::Unit::TestCase
-  def setup
-    @hostname = ARGV[0]
-    @port = ARGV[1]
-    @user = 'mas'
-    @exec = Scutil::Exec.new(@hostname, @user, 
-                             { :port => @port,
-                               # :keys => '~mas/.ssh/id_rsa', 
-                             })
-    @output = nil
-    @t_output = nil
+  TRUE_COMMAND  = '/bin/true'
+  FALSE_COMMAND = '/bin/false'
+  FAKE_COMMAND  = '/bin/no_such_command'
+
+  @hostname = nil
+  @port = nil
+  @user = nil
+  
+  class << self
+    attr_accessor :hostname,:port,:user
   end
   
   def divert_stdout
-    @t_output = $stdout
+    @tmp_output = $stdout
     $stdout = StringIO.new
   end
   
   def revert_stdout
     @output = $stdout
-    $stdout = @t_output
+    $stdout = @tmp_output
+  end
+  
+  def setup
+    @output = nil
+    @tmp_output = nil
+    @exec = Scutil::Exec.new(TestScutil.hostname, TestScutil.user, 
+                             { :port => TestScutil.port,
+                               :scutil_verbose => false })
+  end
+  
+  def teardown
+    @exec = nil
+    Scutil.connection_cache.remove_all
   end
   
-  def test_initialize_exec_object
+  def test_object_initialized
     assert_not_nil @exec
   end
   
-  def test_is_correct_instance
+  def test_object_is_correct_class
     assert_instance_of Scutil::Exec, @exec
   end
   
-  def test_run_command
+  def test_exec_doesnt_raise_an_exception
+    assert_nothing_raised do
+      @exec.exec_command(TRUE_COMMAND)
+    end
+  end
+  
+  def test_run_successful_command
+    retval = @exec.exec_command(TRUE_COMMAND)
+    assert_equal 0, retval
+  end
+  
+  def test_run_failed_command
+    retval = @exec.exec_command(FALSE_COMMAND)
+    assert_not_equal 0, retval
+  end
+  
+  def test_added_to_cache
+    @exec.exec_command(TRUE_COMMAND)
+    assert(Scutil.connection_cache.exists?(TestScutil.hostname))
+  end
+  
+  def test_exec_command_output
     divert_stdout
-    retval = @exec.exec_command('echo "alpha"')
+    @exec.exec_command('echo "alpha"')
+    # Scutil.exec_command(TestScutil.hostname, TestScutil.user, 'echo "alpha"', nil, { :port => TestScutil.port })
     revert_stdout
     assert_equal "alpha", @output.string.chomp
-    assert_equal 0, retval
+  end
+  
+  def test_clear_connection
+    @exec.exec_command(TRUE_COMMAND)
+    Scutil.clear!(TestScutil.hostname)
+    assert(!Scutil.connection_cache.exists?(TestScutil.hostname))
+  end
+  
+  def test_exception_raised
+    assert_raises(Scutil::Error) do
+      @exec.exec_command(FAKE_COMMAND)
+    end
+  end
+  
+  def test_pty_not_requested
+    @exec.exec_command(TRUE_COMMAND)
+    conn = Scutil.connection_cache.fetch(TestScutil.hostname)
+    assert_not_nil(conn.connection)
+    assert_instance_of(Net::SSH::Connection::Session, conn.connection)
+    assert_nil(conn.pty_connection)
+  end
+  
+  def test_pty_requested
+    @exec.exec_command("sudo " + TRUE_COMMAND)
+    conn = Scutil.connection_cache.fetch(TestScutil.hostname)
+    assert_not_nil(conn.pty_connection)
+    assert_instance_of(Net::SSH::Connection::Session, conn.pty_connection)
+    assert_nil(conn.connection)
+  end
+
+  def test_option_pty_regex
+    @exec.exec_command("env " + TRUE_COMMAND, nil, { :scutil_pty_regex => /^env / })
+    conn = Scutil.connection_cache.fetch(TestScutil.hostname)
+    assert_not_nil(conn.pty_connection)
+    assert_instance_of(Net::SSH::Connection::Session, conn.pty_connection)
+    assert_nil(conn.connection)    
+  end
+  
+  def test_option_verbose_set_and_local_options_take_precedence
+    divert_stdout
+    @exec.exec_command(TRUE_COMMAND, nil, { :scutil_verbose => true })
+    revert_stdout
+    assert_match(/\[#{TestScutil.hostname}\]/, @output.string)
+  end
+
+  def test_option_force_pty
+    @exec.exec_command(TRUE_COMMAND, nil, { :scutil_force_pty => true })
+    conn = Scutil.connection_cache.fetch(TestScutil.hostname)
+    assert_not_nil(conn.pty_connection)
+    assert_instance_of(Net::SSH::Connection::Session, conn.pty_connection)
+    assert_nil(conn.connection)
   end
 end
 
-if ARGV[1].nil?
-  puts "Usage: #{$0} host1 [host2 host3] port"
+if ARGV[0].nil?
+  puts "Usage: #{$0} host[:port]"
   exit(1)
 end
+
+(TestScutil.hostname, TestScutil.port) = ARGV[0].split(':')
+TestScutil.user = 'mas'

metadata

@@ -2,7 +2,7 @@
 name: scutil
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Marc Soda
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-27 00:00:00 Z
+date: 2011-10-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh