scutil 0.3.3 → 0.4.0

data/CHANGELOG.rdoc

@@ -1,6 +1,11 @@
 
 ==Changelog
 
+===0.4.0 | 2011-02-21
+
+* Added built-in sudo password support.
+* Some new tests and documentation fixes.
+
 ===0.3.3 | 2011-12-20
 
 * Fixed bug when writing file to disk and then immediately reading the

data/README.rdoc

@@ -3,42 +3,39 @@
 
 ==Description:
 
-Scutil <em>(pronounced "scuttle")</em> is a small Ruby library that
-makes using {Net::SSH}[http://net-ssh.github.com] to execute commands
-on remote systems even more convenient.
+Scutil <em>(pronounced "scuttle")</em> is a small Ruby library that makes using
+{Net::SSH}[http://net-ssh.github.com] to execute commands on remote systems even
+more convenient.
 
 It does this in three ways:
 
-First, it defines Scutil.exec_command which abstracts the callbacks
-and other setup necessary to connect to a system, execute a command,
-and capture the output and return value of that command.  You can
-roughly think of it as a generic <em>"Capistrano lite"</em> in this
-regard.
+First, it defines Scutil.exec_command which abstracts the callbacks and other
+setup necessary to connect to a system, execute a command, and capture the
+output and return value of that command.  You can roughly think of it as a
+generic <em>"Capistrano lite"</em> in this regard.
 
-Second, it tracks the connections used on all systems and reuses
-these connections where ever possible.
+Second, it tracks the connections used on all systems and reuses these
+connections where ever possible.
 
-Finally, scutil takes away the burden of managing data transfers over
-PTY connections.  It automatically requests PTYs where needed and
-makes them "binary safe" (this functionality is configurable and can
-be disabled).  PTYs are needed for some curses-based programs and,
-most importantly in scutil's context, for sudo.  A full discussion on
-PTYs is beyond the scope of this documentation.
+Finally, scutil takes away the burden of managing data transfers over PTY
+connections.  It automatically requests PTYs where needed and makes them "binary
+safe" (this functionality is configurable and can be disabled).  PTYs are needed
+for some curses-based programs and, most importantly in scutil's context, for
+sudo.  A full discussion on 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+.  You can force a PTY request
-by specifying +:scutil_force_pty+ in the various _options_ arguments.
+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+.  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
-a mixin with the module Scutil.
+Scutil.exec_command, as an instantiable class with Scutil::Exec, or as a mixin
+with the module Scutil.
 
 ==Synopsis:
 
-You can use scutil in a few different ways, for more usage examples
-see Scutil.
+You can use scutil in a few different ways, for more usage examples see Scutil.
 
   require 'scutil'
 
@@ -72,7 +69,7 @@ see Scutil.
   require 'stringio'
 
   command_output = StringIO.new
-  Scutil.exec_command('servername1', 'mas', 'sudo cat /root/secrets.txt', command_output)
+  Scutil.exec_command('servername1', 'sudo cat /root/secrets.txt', command_output)
   puts command_output.string
 
 == Installation:
@@ -83,22 +80,21 @@ see Scutil.
 
 The MIT License (MIT)
 
-Copyright (c) 2011 by Marc Soda
+Copyright (c) 2012 by Marc Soda
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/scutil/exec.rb

@@ -15,7 +15,7 @@ module Scutil
   class Exec
     include Scutil
     attr_reader :hostname,:username
-
+    
     # Defaults to current user (ENV['USER'] if _username_ is not
     # specified.
     def initialize(hostname, username=nil, options={})
@@ -35,9 +35,8 @@ module Scutil
       set_options(options)
       Scutil.exec_command(@hostname, @username, cmd, output, @options)
     end
-
+    
     def set_options(options={})
-      # Local map has precedence.
       @options.merge!(options)      
     end
     
@@ -49,7 +48,7 @@ module Scutil
         sys_conn = Scutil.connection_cache.fetch(@hostname)
         conn = sys_conn.get_connection(@hostname, @username, pty_needed, @options)
       else
-        sys_conn = SystemConnection.new(@hostname)
+        sys_conn = SystemConnection.new(@hostname, @options)
         conn = sys_conn.get_connection(@hostname, @username, pty_needed, @options)
       end
       conn

data/lib/scutil/system_connection.rb

@@ -19,9 +19,9 @@ module Scutil
       conn = nil
       # Local map has precedence.
       @options.merge!(options)
-      
-      scrub_options @options
-      
+
+      ssh_options = scrub_options @options
+      options = @options
       if (pty_needed)
         if !@pty_connection.nil?
           # Existing PTY connection
@@ -31,7 +31,7 @@ module Scutil
         
         # New PTY connection
         print "[#{hostname}] Opening new channel (pty) to system...\n" if @options[:scutil_verbose]
-        conn = Net::SSH.start(hostname, username, @options)
+        conn = Net::SSH.start(hostname, username, ssh_options)
         @pty_connection = conn
       else
         if !@connection.nil?
@@ -42,18 +42,19 @@ module Scutil
         
         # New non-PTY connection
         print "[#{hostname}] Opening channel (non-pty) to system...\n" if @options[:scutil_verbose]
-        conn = Net::SSH.start(hostname, username, @options)
+        conn = Net::SSH.start(hostname, username, ssh_options)
         @connection = conn
       end
-      
       return conn
     end
     
     # Remove scutil specific options.  The rest go to Net::SSH.
     def scrub_options(options)
-      options.delete(:scutil_verbose) if (options.has_key?(:scutil_verbose))
-      options.delete(:scutil_force_pty) if (options.has_key?(:scutil_force_pty))
-      options.delete(:scutil_pty_regex) if (options.has_key?(:scutil_pty_regex))
+      ssh_options = {}
+      options.each do |k, v|
+        ssh_options[k] = v if (k !~ /^scutil_+/)
+      end
+      return ssh_options
     end
     
     def to_s

data/lib/scutil.rb

@@ -2,25 +2,24 @@
 =begin
 The MIT License (MIT)
 
-Copyright (C) 2011 by Marc Soda
+Copyright (C) 2012 by Marc Soda
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 =end
 
 require 'net/ssh'
@@ -30,96 +29,105 @@ require 'scutil/connection_cache'
 require 'scutil/system_connection'
 
 module Scutil
-  SCUTIL_VERSION = '0.3.3'
+  SCUTIL_VERSION = '0.4.0'
+  
   # 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/
+  
+  # Default password prompt is _[sudo] password for_.  Redhat based systems use
+  # _Password:_ instead.
+  DEFAULT_SUDO_PASSWD_REGEX = /^\[sudo\] password for/
+  # DEFAULT_PASSWD_REGEX = /^Password:/
+  
+  # Default password failed prompt is _Sorry, try again_.
+  DEFAULT_SUDO_PASSWD_FAILED_REGEX = /^Sorry, try again/
+  
   @connection_cache = ConnectionCache.new
   @output_buffer_size = DEFAULT_OUTPUT_BUFFER_SIZE
   
   class << self
-    # All successfully established connections end up here for reuse
-    # later.
+    # All successfully established connections end up here for reuse later.
     attr_accessor :connection_cache
-    # Set to 10M by default, this can be adjusted to tell scutil when
-    # to write command output to _output_.
+    # 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+.
     #
-    def check_pty_needed?(cmd, options, hostname)
-      regex = DEFAULT_PTY_REGEX
-      if (options[:scutil_force_pty].nil?)
-        # If a custom regex has been defined, use it.
-        if (!options[:scutil_pty_regex].nil?)
-          if options[:scutil_pty_regex].kind_of? Regexp
-            regex = options[:scutil_pty_regex]
-          else
-            raise Scutil::Error.new("Error: :scutil_pty_regex must be a kind of Regexp", hostname)
-          end
-        else
-          return (cmd =~ regex) ? true : false
-        end
-      else
-        return options[:scutil_force_pty] ? true : false
+    def check_pty_needed?(cmd, options, hostname)      
+      if options[:scutil_force_pty]
+        return true
+      end
+      
+      if !options[:scutil_pty_regex].kind_of? Regexp
+        raise Scutil::Error.new(":scutil_pty_regex must be a kind of Regexp", hostname)
       end
+      return (cmd =~ options[:scutil_pty_regex]) ? true : false
     end
     
     # Drops all instances of +hostname+ from @connection_cache.
     def clear!(hostname)
       if (Scutil.connection_cache.exists?(hostname))
         Scutil.connection_cache.remove(hostname)
-      else
-        raise Scutil::Error.new("Error: :scutil_pty_regex must be a kind of Regexp", hostname)
       end
     end
     
-    # Scutil.exec_command is used to execute a command, specified in
-    # _cmd_, on a remote system.  The return value and any ouput of
-    # the command are captured.
+    # Scutil.exec_command is used to execute a command, specified in _cmd_, on a
+    # remote system.  The return value and any ouput of the command are
+    # captured.
     #
-    # If _output_ is a string it will be treated as a filename to be
-    # opened (mode 'w') and all command output will be written to
-    # this file.  If _output_ is an IO object it will be treated as an
-    # open file handle.*  Finally, if _output_ is omitted, or an empty
-    # string, all command output will be directed to _$stdout_.
+    # If _output_ is a string it will be treated as a filename to be opened
+    # (mode 'w') and all command output will be written to this file.  If
+    # _output_ is an IO object it will be treated as an 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
-    # 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
-    # to capture the command's output in a string.  Suggestions on a
-    # better way to do this are definitely welcome.</em>
+    # <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 to capture the command's output in a string.
+    # Suggestions on a better way to do this are definitely welcome.</em>
     #
-    # Scutil will automatically request a PTY if _sudo_ is at the
-    # 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 will automatically request a PTY if _sudo_ is at the 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_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_sudo_passwd_regex        => If sudo requires a password you can specify the
+    #                                       prompt to look for, e.g., _Password:_ .
+    # * :scutil_sudo_passwd_failed_regex => Regular expression for a sudo password failure.
+    # * :scutil_sudo_passwd              => The sudo password.
     #
-    # In addition, any other options passed Scutil.exec_command will
-    # be passed on to Net::SSH, _except_ those prefixed with
-    # _scutil__.
+    # In addition, any other options passed Scutil.exec_command will be passed
+    # on to Net::SSH, _except_ those prefixed with _scutil__.
     #
-    # All calls to Scutil.exec_command, regardless of the way it's
-    # used, will return the remote command's return value.
+    # All calls to Scutil.exec_command, regardless of the way it's used, will
+    # return the remote command's return value.
     #
     #   retval = Scutil.exec_command('hostname', 'username', '/bin/true')
     #   puts "True is false!" if retval != 0
     #
-    def exec_command(hostname, username, cmd, output=nil, options={})      
+    # See the test/ directory for more usage examples.
+    def exec_command(hostname, username, cmd, output=nil, new_options={})
+      # Fill in defaults
+      options = get_default_options
+      options.merge! new_options
+      
       # Do we need a PTY?
       pty_needed = check_pty_needed? cmd, options, hostname
       
-      # Check for an existing connection in the cache based on the hostname.  If the 
-      # hostname exists find a suitable connection.
+      # Check for an existing connection in the cache based on the hostname.  If
+      # the hostname exists find a suitable connection.
       conn = nil
       begin
         if (Scutil.connection_cache.exists?(hostname))
@@ -127,47 +135,99 @@ module Scutil
           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)
+          sys_conn = SystemConnection.new(hostname, options)
           # Call get_connection first.  Don't add to cache unless established.
           conn = sys_conn.get_connection(hostname, username, pty_needed, options)
           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)
+        raise Scutil::Error.new("Authenication failed for user: #{username}", hostname)
       rescue SocketError => err
-        raise Scutil::Error.new("Error: " + err.message, hostname)
+        raise Scutil::Error.new(err.message, hostname)
       end
       
       fh = $stdout
       if (output.nil?)
         fh = $stdout
-      elsif (output.respond_to? :write)
-        # XXX: This may not be a safe assumuption...
+      elsif (output.respond_to? :write)  # XXX: This may not be a safe assumuption...
         fh = output
       elsif (output.class == String)
         fh = File.open(output, 'w') unless output.empty?
       else
-        raise Scutil::Error.new("Error: Invalid output object type: #{output.class}.", hostname)
+        raise Scutil::Error.new("Invalid output object type: #{output.class}.", hostname)
+      end
+      
+      # If a custom password prompt regex has been defined, use it.
+      if (!options[:scutil_sudo_passwd_regex].nil? && 
+          (options[:scutil_sudo_passwd_regex].kind_of? Regexp))
+        passwd_regex = options[:scutil_sudo_passwd_regex]
+      else
+        raise Scutil::Error.new(":scutil_sudo_passwd_regex must be a kind of Regexp", hostname)
+      end
+      
+      # If a custom bad password prompt regex has been defined, use it.
+      if (!options[:scutil_sudo_passwd_failed_regex].nil? && 
+          (options[:scutil_sudo_passwd_failed_regex].kind_of? Regexp))
+        passwd_failed_regex = options[:scutil_sudo_passwd_failed_regex]
+      else
+        raise Scutil::Error.new(":scutil_sudo_passwd_failed_regex must be a kind of Regexp", hostname)
       end
       
       # Setup channel callbacks
       odata = ""
       edata = ""
       exit_status = 0
+      # Catch the first call to on_data
+      sudo_passwd_state = :new
       chan = conn.open_channel do |channel|
         print "[#{conn.host}:#{channel.local_id}] Setting up callbacks...\n" if options[:scutil_verbose]
         if (pty_needed)
           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|
+          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
           end
         end
         
         channel.on_data do |ch, data|
 #          print "on_data: #{data.size}\n" if options[:scutil_verbose]
-          odata += data
+          
+          # sudo password states are as follows:
+          #  :new     => Connection established, first data packet.
+          #  :waiting => Password sent, wating for reply.
+          #  :done    => Authenication complete or not required.
+          case (sudo_passwd_state)
+          when :new
+            if (data =~ passwd_regex)
+              if (options[:scutil_sudo_passwd].nil?)
+                # No password defined
+                raise Scutil::Error.new("[#{conn.host}:#{channel.local_id}] Password required for sudo.  
+Define in :scutil_sudo_passwd.", hostname)
+                channel.close
+              end
+              ch.send_data options[:scutil_sudo_passwd] + "\n"
+              sudo_passwd_state = :waiting
+            else
+              odata += data
+              sudo_passwd_state = :done
+            end
+          when :waiting
+#            if (data == "\n")
+            if (data =~ passwd_failed_regex)
+              # Bad sudo password
+              raise Scutil::Error.new("[#{conn.host}:#{channel.local_id}] Password failed for sudo.  
+Define in :scutil_sudo_passwd or check :scutil_sudo_failed_passwd for the correct failure response.", 
+                                      hostname)
+              channel.close
+              sudo_passwd_state = :done
+            else
+              # NoOp for "\n"
+            end
+          else
+            odata += data
+          end
           
           # Only buffer some of the output before writing to disk (10M by default).
           if (odata.size >= Scutil.output_buffer_size)
@@ -177,7 +237,7 @@ module Scutil
         end
         
         channel.on_extended_data do |ch, type, data|
-#          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
         
@@ -198,18 +258,31 @@ module Scutil
       end
       
       conn.loop
-
+      
       # Write whatever is left
       fh.write odata
       
       # Close the file or you'll chase red herrings for two hours...
       fh.close unless fh == $stdout
-
+      
       # If extended_data was recieved there was a problem...
       raise Scutil::Error.new("Error: #{edata}", hostname, exit_status) unless (edata.empty?)
-
+      
       # The return value of the remote command.
       return exit_status
     end
+    
+    private
+    # Set the default options for connection.
+    def get_default_options
+      { 
+        :scutil_verbose                  => false,
+        :scutil_force_pty                => false,
+        :scutil_pty_regex                => DEFAULT_PTY_REGEX,
+        :scutil_sudo_passwd_regex        => DEFAULT_PASSWD_REGEX,
+        :scutil_sudo_passwd_failed_regex => DEFAULT_PASSWD_FAILED_REGEX,
+        :scutil_sudo_passwd              => nil
+      }
+    end
   end
 end

data/scutil.gemspec

@@ -1,8 +1,8 @@
 
 Gem::Specification.new do |s|
   s.name        = 'scutil'
-  s.version     = '0.3.3'
-  s.date        = '2011-12-20'
+  s.version     = '0.4.0'
+  s.date        = '2012-02-21'
   s.summary     = 'SSH Command UTILity'
   s.description = <<-EOF
     Scutil is a library for conveniently executing commands 

data/test/test_scutil.rb

@@ -8,6 +8,8 @@ class TestScutil < Test::Unit::TestCase
   TRUE_COMMAND  = '/bin/true'
   FALSE_COMMAND = '/bin/false'
   FAKE_COMMAND  = '/bin/no_such_command'
+#  VERBOSE       = true
+  VERBOSE       = false
 
   @hostname = nil
   @port = nil
@@ -32,7 +34,8 @@ class TestScutil < Test::Unit::TestCase
     @tmp_output = nil
     @exec = Scutil::Exec.new(TestScutil.hostname, TestScutil.user, 
                              { :port => TestScutil.port,
-                               :scutil_verbose => false })
+                               :scutil_verbose => VERBOSE
+                             })
   end
   
   def teardown
@@ -72,7 +75,6 @@ class TestScutil < Test::Unit::TestCase
   def test_exec_command_output
     divert_stdout
     @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
   end
@@ -98,13 +100,27 @@ class TestScutil < Test::Unit::TestCase
   end
   
   def test_pty_requested
-    @exec.exec_command("sudo " + TRUE_COMMAND)
+    # XXX: check retvals everywhere!
+    ret_val = @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)
+    assert_equal(0, ret_val)
   end
-
+  
+  def test_pty_requested_and_echo
+    divert_stdout
+    ret_val = @exec.exec_command('sudo ' + 'echo "bravo"')
+    revert_stdout
+    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)
+    assert_equal(0, ret_val)
+    assert_equal "bravo", @output.string.chomp
+  end
+  
   def test_option_pty_regex
     @exec.exec_command("env " + TRUE_COMMAND, nil, { :scutil_pty_regex => /^env / })
     conn = Scutil.connection_cache.fetch(TestScutil.hostname)
@@ -119,7 +135,7 @@ class TestScutil < Test::Unit::TestCase
     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)
@@ -141,13 +157,54 @@ class TestScutil < Test::Unit::TestCase
     revert_stdout
     assert_match(/\[#{TestScutil.hostname}\]/, @output.string)
   end
+  
+#  def test_sudo_passwd
+#    ret_val = @exec.exec_command('sudo ' + TRUE_COMMAND, nil, { :scutil_sudo_passwd => "p4ssw0rd", :scutil_sudo_passwd_regex => /^Password:/ })
+#    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)
+#    assert_equal(0, ret_val)
+#  end
+#  
+#  def test_bad_sudo_passwd
+#    assert_raises(Scutil::Error) do
+#      @exec.exec_command('sudo ' + TRUE_COMMAND, nil, { :scutil_sudo_passwd => "4ssw0rd", :scutil_sudo_passwd_regex => /^Password:/ })
+#    end
+#    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_no_sudo_passwd
+#    assert_raises(Scutil::Error) do
+#      @exec.exec_command('sudo ' + TRUE_COMMAND, nil, { :scutil_sudo_passwd_regex => /^Password:/ })
+#    end
+#    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_sudo_passwd_output
+#    divert_stdout
+#    ret_val = @exec.exec_command('sudo ' + 'echo "charlie"', nil, { :scutil_sudo_passwd => "p4ssw0rd" })
+#    revert_stdout
+#    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)
+#    assert_equal(0, ret_val)
+#    assert_equal "charlie", @output.string.chomp
+#  end
 end
 
 class TestScutilAlt < Test::Unit::TestCase
   TRUE_COMMAND  = '/bin/true'
   FALSE_COMMAND = '/bin/false'
   FAKE_COMMAND  = '/bin/no_such_command'
-
+  
   @hostname = nil
   @port = nil
   @user = nil
@@ -198,18 +255,17 @@ class TestScutilAlt < Test::Unit::TestCase
     revert_stdout
     assert_equal "alpha", @output.string.chomp
   end
-
+  
   def teardown
     Scutil.connection_cache.remove_all
   end
 end
 
-# XXX: This breaks --name, et al.
-if ARGV[0].nil?
-  puts "Usage: #{$0} host[:port]"
+if (ARGV[0].nil? || (ARGV[0] !~ /\w+:\d+/))
+  puts "Usage: #{$0} host:port"
   exit(1)
 end
 
-(TestScutil.hostname, TestScutil.port) = ARGV[0].split(':')
-ARGV[0] = nil;
+connect_string = ARGV.shift
+(TestScutil.hostname, TestScutil.port) = connect_string.split(':')
 TestScutil.user = 'mas'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scutil
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-20 00:00:00.000000000 Z
+date: 2012-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &20792060 !ruby/object:Gem::Requirement
+  requirement: &11786280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *20792060
+  version_requirements: *11786280
 description: ! "    Scutil is a library for conveniently executing commands \n    remotely
   via SSH.\n"
 email: marcantoniosr@gmail.com
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: SSH Command UTILity