expect4r 0.0.9 → 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46b8625696193f9bb771295b2241b1d883ad31c7
+  data.tar.gz: aea806dc760988161a7fe2dfaa31de9930e4af35
+SHA512:
+  metadata.gz: 524998e2c125d35b21b53a5ca329b6bf74f4a293289469f0d9d8d99ae5bbcc7622b29d220cd9f6e7d4fff221ff4d51ba3bb524c9024503cfcbb2df6059a4067b
+  data.tar.gz: 421532f69db8e08bd329901d82080206ce1ce8c75181fa5012db558e047dc1aea29a0d4dc9c666db54083ef340935a79b6a7bc88cb14b6fcfe5fe10159fc8051

data/lib/expect/io.rb

@@ -151,13 +151,21 @@ module Expect4r
     raise
   end
 
-  def interact(k="C-z")
-    k.upcase!
-    raise unless k =~ /C\-[A-Z]/
+  def interact(k="C-t")
+    raise unless k =~ /C\-[A-Z]/i
+    unless STDOUT.tty? and STDIN.tty?
+      $stderr.puts "Cannot interact: not running from terminal!"
+      return
+    end
     login unless connected?
-    STDOUT.puts "\n\#\n\# #{k.gsub(/C\-/,'^')} to terminate.\n\#\n"
-    reader :start
-    writer(eval "?\\#{k}")
+    @@interact_mutex ||= Mutex.new
+
+    @@interact_mutex.synchronize {
+      k.upcase!
+      STDOUT.puts "\n\#\n\# #{k.gsub(/C\-/,'^')} to terminate.\n\#\n"
+      reader :start
+      writer(eval "?\\#{k}")
+    }
   rescue
   ensure
     begin
@@ -239,6 +247,13 @@ module Expect4r
     ''
   end
 
+  def read_until(match,ti=0.2)
+    ret = expect(match, ti, [])
+    ret[0][0].chomp
+  rescue ExpTimeoutError => ex
+    ''
+  end
+
   def connected?
     @r && (not child_exited?)
   end
@@ -271,6 +286,19 @@ module Expect4r
           exp_internal "readbuf: _io_exit?"
           throw :done, [ :cnx_error,  read_pipe._io_buf1]
         end
+        
+        @pre_matches ||= []
+        @pre_matches.each do |match, _send|
+          if read_pipe._io_string =~ match
+            read_pipe._io_save no_echo, "match #{match}"
+            if _send.is_a?(Proc)
+              _send.call
+            else
+              exp_puts _send.to_s
+            end
+          end
+        end
+        
         case read_pipe._io_string
         when spawnee_prompt
           read_pipe._io_save no_echo, "match PROMPT"

data/lib/misc/base.rb

@@ -5,7 +5,7 @@ module Expect4r
     class << self
       attr_reader :routers
       def all
-        @arr
+        @arr || []
       end
       def add(r)
         @arr ||=[]
@@ -49,41 +49,95 @@ module Expect4r
     # Adds a login to a Expect4r::BaseLoginObject"
     #
     # Constructor: 
-    # * <tt>new</tt>  <method>, <username>, <password>, [port_number]
+    # * <tt>new</tt>  <method>, <username>, <password>, <enable_password>, <port>
+    # * <tt>new</tt>  <method>, <username>, <password>, <enable_password>
+    # * <tt>new</tt>  <method>, <username>, <password>, <port>
+    # * <tt>new</tt>  <method>, <username>, <password>
+    #
     # * <tt>new</tt>  <method>, options={}
     #
     # Options are:  
     # * <tt>:host</tt> or <tt>:hostname</tt>
     # * <tt>:user</tt> or <tt>:username</tt>
     # * <tt>:pwd</tt> or <tt>:password</tt>
+    # * <tt>:enable_password</tt>
+    # * <tt>:port</tt>
     #
     # Examples:
-    #   new :telnet, :host=> '1.1.1.1', :user=> 'lab', :password=>'lab'
+    #
+    #   new :telnet, :host=> '1.1.1.1', 
+    #                :user=> 'lab', 
+    #                :password=>'lab', 
+    #                :enable_password=>'secret', 
+    #                :port=>2001
+    # 
     #   new :ssh, :host=> '1.1.1.1', :user=> 'jme'
-    #   new :ssh, '1.1.1.1', 'me', 'secret'
+    #   new :telnet, '1.1.1.1', 'jme', 'myPwd', 'myEnablePwd', 2001
     #
+    #  
+    
+=begin rdoc
+
+@method, host, @user, pwd, enable_pwd, port = args
+@method, host, @user, pwd, enable_pwd       = args
+@method, host, @user, pwd, port             = args
+@method, host, @user, pwd                   = args
+
+@method, host+port, @user, pwd, enable_pwd  = args
+@method, host+port, @user, pwd              = args
+  
+=end
+    
     def initialize(*args)
-      ciphered_password=nil
+      host, _pwd, _enable_pwd, ciphered_password=[nil]*5
       if args.size>2 and args[1].is_a?(String)
-        @method, host, @user, pwd = args
-        @host, port = host.split
-        @port = (port || 0).to_i
+        case args.size
+        when 6
+          @method, host, @user, _pwd, _enable_pwd, port = args
+        when 5
+          if args.last.is_a?(Fixnum)
+            @method, host, @user, _pwd, port = args
+          else
+            @method, host, @user, _pwd, _enable_pwd = args
+          end
+        else
+          @method, host, @user, _pwd, port = args
+        end
+
+        raise ArgumentError if host.split.size>1 and port
+            
+        @host, _port = host.split
+        @port = port || (_port || 0).to_i
+
       elsif args.size == 2 and args[1].is_a?(Hash) and args[0].is_a?(Symbol)
         @method = args[0]
         @host = args[1][:host] || args[1][:hostname]
         port = args[1][:port]
         @port = (port || 0).to_i
         @user = args[1][:user]|| args[1][:username]
-        pwd  = args[1][:pwd]  || args[1][:password]
+
+        _pwd  = args[1][:pwd]  || args[1][:password]
         ciphered_password  = args[1][:ciphered_password]
+
+        _enable_pwd  = args[1][:enable_password]
+        ciphered_enable_password  = args[1][:ciphered_enable_password]
+
       else
         raise
       end
+      
       @pwd = if ciphered_password
         ciphered_password
       else
-        Expect4r.cipher(pwd) if pwd
+        Expect4r.cipher(_pwd) if _pwd
       end
+
+      @enable_pwd = if ciphered_enable_password
+        ciphered_enable_password
+      else
+          Expect4r.cipher(_enable_pwd || _pwd) if _enable_pwd || _pwd
+      end
+      
       @ps1 = /(.*)(>|#|\$)\s*$/
       @more = / --More-- /
       @matches=Set.new
@@ -92,6 +146,7 @@ module Expect4r
     end
 
     attr_writer :host, :username, :port
+    alias :hostname= :host=
     
     def method=(arg)
       case arg
@@ -102,7 +157,6 @@ module Expect4r
       end
     end
 
-
     def spawnee
       case method
       when :telnet  ; "telnet #{host} #{port if port>0}"
@@ -128,51 +182,41 @@ module Expect4r
       end
     end
 
+    def password
+      @pwd
+    end
+
+    def enable_password
+      @enable_pwd
+    end
+    
+    def cmp(o)
+      o.spawnee == spawnee and o.password == password and o.enable_password == enable_password
+    end      
+
     private
 
     def spawnee_password
-      if @pwd.nil?
-        @pwd = Expect4r.cipher( ask("(#{self}) Enter your password:  ") { |q| q.echo = "X" } )
-        @asked4pwd=true
-      end
-      Expect4r.decipher(@pwd)
+      @pwd ||= Expect4r.cipher( ask("(#{self}) Enter your password:  ") { |q| q.echo = "X" } )
+      Expect4r.decipher(password)
+    end
+    
+    def spawnee_enable_password
+        @enable_pwd ||= Expect4r.cipher( ask("(#{self}) Enter your enable password:  ") { |q| q.echo = "X" } )
+      Expect4r.decipher(enable_password)
     end
     
     def spawnee_reset
-      @pwd=nil if @asked4pwd
+      @pwd=nil
+      @enable_pwd=nil
     end
 
   end
 end
 
-if __FILE__ != $0
-
-  at_exit { 
-    if Expect4r::Base.all
-      Expect4r::Base.all.each { |o| o.logout if o.respond_to? :logout }
-    end
-  }
-
-else
-
-  require "test/unit"
-
-  class Expect4r::Base
-    def initialize
-      Expect4r::Base.add(self)
-    end
+at_exit { 
+  if Expect4r::Base.all
+    Expect4r::Base.all.each { |o| o.logout if o.respond_to? :logout }
   end
+}
 
-  class Base < Test::Unit::TestCase
-    include Expect4r
-
-    def test_add
-      assert [], Base.all
-      Base.new
-      assert 1, Base.all.size
-      Base.new 
-      assert_equal 2, Base.all.size
-    end
-  end
-
-end

data/lib/router/cisco/common/common.rb

@@ -42,6 +42,43 @@ module CiscoCommon
       super
     end
   end
+  
+  def enable
+    proc = Proc.new {
+      puts "FOUND WE HAVE A BAD PASSWORD SITUATION"
+    }
+    @pre_matches ||= []
+    @pre_matches << [/Bad Password/i, proc]
+
+    enable_pwd = [/^Password: $/, spawnee_enable_password]
+    @matches << enable_pwd
+    exp_send 'enable'
+    @matches =[]
+    @pre_matches=[]
+    exec "term len 0\nterm width 0"
+  rescue 
+    raise
+  ensure
+    @matches.delete enable_pwd
+  end
+    
+  def login(arg={})
+    # Skip the default banner.
+    proc = Proc.new {
+      read_until /QUICK START GUIDE/, 2
+    }
+    @pre_matches = []
+    @pre_matches << [/Cisco Configuration Professional/, proc]
+    
+    super(spawnee,arg)
+    enable unless arg[:no_enable]
+
+    self
+  end
+  # FIXME: 1.9.2 bug: 
+  # It calls LoginBaseOject#login() instead of calling J#login()
+  # modified login_by_proxy to call _login_ seems to work.
+  alias :_login_ :login
     
 end
 end

data/lib/router/cisco/ios/ios.rb

@@ -16,39 +16,11 @@ class Expect4r::Ios < ::Expect4r::BaseLoginObject
     @ps1 = /(.*)(>|#|\$)\s*$/
     @more = / --More-- /
   end
-  
-  def enable
-    @enable_password ||= @pwd
-    enable_pwd = [/^Password: $/, enable_password]
-    @matches << enable_pwd
-    exp_send 'enable'
-  rescue 
-    raise
-  ensure
-    @matches.delete enable_pwd
-  end
-  
-  def enable_password
-    return unless @pwd || @enable_password
-    @enable_password ||= @pwd  # FIXME
-    Expect4r.decipher(@pwd)    # password is ciphered ...
-  end
-  
-  def login(arg={})
-    super(spawnee,arg)
-    enable
-    exec "term len 0\nterm width 0"
-    self
-  end
-  # FIXME: 1.9.2 bug: 
-  # It calls LoginBaseOject#login() instead of calling J#login()
-  # modified login_by_proxy to call _login_ seems to work.
-  alias :_login_ :login
-  
-  
+    
   def putline(line,*args)
     output, rc = super
     return output unless error?(output)
+    raise BadPasswordError.new(self.class.to_s,line) if output =~ /Bad password/ 
     raise SyntaxError.new(self.class.to_s,line)
   end
   
@@ -70,5 +42,32 @@ class Expect4r::Ios < ::Expect4r::BaseLoginObject
     string_start_with_pct_char?(output[-2]) || 
     string_start_with_pct_char?(output[-3])
   end
+
+  def method_missing(name, *args, &block)
+    if name.to_s =~ /^show_/
+      filters=[]
+      if args.last.is_a?(Hash)
+        _begin = args.last.delete(:begin) 
+        _section = args.last.delete(:section)
+        _count = args.last.delete(:count)
+        _exclude = args.last.delete(:exclude)
+        _include = args.last.delete(:include)
+        filters << "| begin #{_begin}" if _begin
+        filters << "| count #{_count}" if _count
+        filters << "| section #{_section}" if _section
+        filters << "| exclude #{_exclude}" if _exclude
+        filters << "| include #{_include}" if _include
+      end   
+      cmd = name.to_s.split('_').join(' ')
+      cmd += " " + filters.join(' ') if filters
+      cmd.gsub!(/running config/, 'running-config')
+      output = __send__ :exec, cmd, *args
+    elsif name.to_s =~ /^shell_/
+      cmd = name.to_s.split('_')[1..-1].join(' ') + args.join(' ')
+      output = __send__ :shell, cmd, *args
+    else
+      super
+    end
+  end
   
 end

data/lib/router/error.rb

@@ -16,6 +16,12 @@ module Error
     end
   end
 
+  class BadPasswordError < RouterError
+    def err_msg
+      "#{@rname} [BadPassword] : #{@msg}"
+    end
+  end
+
   class SemanticError < RouterError
     def err_msg
       "#{@rname} [SemanticError] : #{@msg}"

data/test/misc/base_test.rb

@@ -0,0 +1,87 @@
+require "test/unit"
+require "misc/base"
+
+
+require "test/unit"
+
+class Base < Test::Unit::TestCase
+  include Expect4r
+
+  def test_add
+    assert_equal( [], Base.all)
+    Base.new
+    assert_equal( 1, Base.all.size)
+    Base.new 
+    assert_equal( 2, Base.all.size)
+  end
+
+end
+
+require 'misc/passwd'
+require 'set'
+
+class TestBaseLoginObject < Test::Unit::TestCase
+  include Expect4r
+
+  def setup
+    @pwd  = "MySecretPassword"
+    @cpwd = Expect4r.cipher(@pwd)
+  end
+
+  def test_we_are_not_caching_password_in_the_clear
+    o = BaseLoginObject.new :telnet, :host=> '1.1.1.1', :user=> 'lab', :password=>'lab'
+    assert_not_equal "lab", o.instance_eval { @pwd }
+    o = BaseLoginObject.new :telnet, :host=> '1.1.1.1', :user=> 'lab', :password=>'lab'
+    assert_not_equal "lab", o.instance_eval { @pwd }
+    assert ! o.respond_to?(:spawnee_enable_password), "certain things are better kept private!"
+    assert ! o.respond_to?(:spawnee_password), "certain things are better kept private!"
+  end
+
+  def test_that_default_enable_password_is_set_to_password
+    o = BaseLoginObject.new :telnet, :host=> '1.1.1.1', :user=> 'lab', :password=>'lab'
+    assert_equal(o.password, o.enable_password)
+  end
+
+  def test_dedicated_enable_password
+    o = BaseLoginObject.new :telnet, :host=> '1.1.1.1', :user=> 'lab', :password=>'lab', :enable_password=>'LAB'
+    assert_not_equal(o.password, o.enable_password)
+  end
+
+  def test_new_4_args
+    o1 = BaseLoginObject.new :telnet, '1.1.1.1', 'lab', 'lab'
+    o2 = BaseLoginObject.new :telnet, :host=> '1.1.1.1', :user=> 'lab', :password=>'lab'
+    assert o1.cmp(o2)
+  end
+
+  def test_new_5th_arg_is_port_number
+    o1 = BaseLoginObject.new :telnet, '1.1.1.1', 'lab', 'lab', 2001
+    o2 = BaseLoginObject.new :telnet, :host=> '1.1.1.1', :user=> 'lab', :password=>'lab'
+    assert ! o1.cmp(o2)
+    o2.port=2001
+    assert   o1.cmp(o2)
+  end
+
+  def test_new_5th_arg_is_enable_password
+    o1 = BaseLoginObject.new :telnet, '1.1.1.1', 'lab', 'lab', 'secret'
+    o2 = BaseLoginObject.new :telnet, :host=> '1.1.1.1', :user=> 'lab', :password=>'lab', :enable_password=>'secret'
+    assert   o1.cmp(o2)
+  end
+
+  def test_new_6_args
+    o1 = BaseLoginObject.new :telnet, '1.1.1.1', 'user', 'pwd', 'enable', 2001
+    o2 = BaseLoginObject.new :telnet, :host=> '1.1.1.1', :user=> 'user', :password=>'pwd', :enable_password=>'enable', :port=>2001
+    assert o1.cmp(o2)
+  end
+
+  def test_verify_private_spawnee_passord
+    o1 = BaseLoginObject.new :telnet, '1.1.1.1', 'user', 'pwd', 'enable', 2001
+    assert_equal("pwd", o1.instance_eval { spawnee_password})
+  end
+
+  def test_verify_private_spawnee_enable_passord
+    o1 = BaseLoginObject.new :telnet, '1.1.1.1', 'user', 'pwd', 'enable', 2001
+    assert_equal("enable", o1.instance_eval { spawnee_enable_password})
+  end
+
+end
+

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: expect4r
 version: !ruby/object:Gem::Version
-  version: 0.0.9
-  prerelease: 
+  version: 0.0.10
 platform: ruby
 authors:
 - Jean-Michel Esnault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-09 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.0
 description: A Ruby Library for interacting with IOS, IOS-XR, and JUNOS  CLI.
@@ -66,11 +63,13 @@ files:
 - lib/router/vyatta/show.rb
 - lib/router/vyatta/vyatta.rb
 - test/expect4r_test.rb
+- test/misc/base_test.rb
 - test/misc/passwd_test.rb
 - test/misc/rspec.rb
 - test/router/cisco/iox/iox_test.rb
 homepage: http://github.com/jesnault/expect4r
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --quiet
@@ -80,25 +79,24 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Expect4r
 test_files:
 - test/expect4r_test.rb
+- test/misc/base_test.rb
 - test/misc/passwd_test.rb
 - test/misc/rspec.rb
 - test/router/cisco/iox/iox_test.rb