expect4r 0.0.2.dev → 0.0.3.dev

data/README.rdoc

@@ -1,3 +1,5 @@
+= Expect4r -- Interact with Cisco IOS, IOS-XR, and Juniper JUNOS CLI.
+
 Expect4r is a library that enables a ruby program to 'talk' to routers following a written ruby script.
 You talk to routers by connecting to them using ssh or telnet and send exec or config command and collect router output than can be parsed using ruby.
 
@@ -21,16 +23,21 @@ You talk to routers by connecting to them using ssh or telnet and send exec or c
      interface loopback0
        shutdown
    }
-   
-   
+
    iox.config
    iox.exp_send 'interface GigabitEthernet0/2/0/0'
    iox.exp_send 'desc to switch port 13'
    iox.exp_send 'ipv4 address 190.0.0.9 255.255.255.252'
    iox.exp_send 'no shut'
    iox.commit
-   
-   
+
+   iox.config %|
+      interface GigabitEthernet0/2/0/0
+      desc to switch port 13'
+      ipv4 address 190.0.0.9 255.255.255.252'
+      no shut'
+   |
+
    j.config %{
      edit logical-router Orleans protocols bgp
        edit group session-to-200
@@ -41,7 +48,6 @@ You talk to routers by connecting to them using ssh or telnet and send exec or c
 
 * exec commands
 
-
     j.exec 'set cli screen-length 0'
 
     iox.exec "terminal len 0\nterminal width 0"
@@ -54,7 +60,6 @@ You talk to routers by connecting to them using ssh or telnet and send exec or c
 
 * interact with CLI.
 
-
    irb> r.interact
 
    #
@@ -98,13 +103,13 @@ You talk to routers by connecting to them using ssh or telnet and send exec or c
    Parsing a response becomes a matter of iterating an array using the 
    Arrays's enumerator methods such as find, find_all ...
 
-   irb(main):025:0> output = ts.exec %{
-   irb(main):026:0" show terminal | include History
-   irb(main):027:0" show line | include AUX
-   irb(main):028:0" }
+   irb> output = ts.exec %{
+   irb" show terminal | include History
+   irb" show line | include AUX
+   irb" }
    => [
-        ["show terminal | include History", "History is enabled, history size is 10.", "PEA#"], 
-        ["show line | include AUX", "    17 AUX   9600/9600  -           0/0       -", "PEA#"]
+        ["show terminal | include History", "History is enabled, history size is 10.", "ios#"], 
+        ["show line | include AUX", "    17 AUX   9600/9600  -           0/0       -", "ios#"]
       ]
    
    output[0] contains output for 1st command 'show terminal'.
@@ -113,14 +118,63 @@ You talk to routers by connecting to them using ssh or telnet and send exec or c
    output[n-1] contains output for nth command.
 
 
-
-
-
-
-
-
-
-
-
-
+* Ping 
+
+   irb(main):016:0> ios.ping '192.168.1.23', :count=> 100, :pct_success=>90, :sweep_max_size=> 1500
+   => [ 99, [146148, 146500], 
+       [["ping", 
+         "Protocol [ip]: ", "", 
+         "Target IP address: ", "192.168.1.23", 
+         "Repeat count [5]: ", "100", 
+         "Datagram size [100]: ", "", 
+         "Timeout in seconds [2]: ", "", 
+         "Extended commands [n]: ", "", 
+         "Sweep range of sizes [n]: ", "yes", 
+         "Sweep min size [36]: ", "", 
+         "Sweep max size [18024]: ", "1500", 
+         "Sweep interval [1]: ", "", 
+         "Type escape sequence to abort.", 
+         "Sending 146500, [36..1500]-byte ICMP Echos to 192.168.1.23, timeout is 2 seconds:", 
+         "!!!!!!!!!!!!!!!!!!!!!!!!!!!!.!!!!!!!!!!!!.!!!!!!!!.!!!!!!!!!!!!!!!!!!!", 
+         "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!", 
+            ...
+         "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!", 
+         "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!", 
+         "Success rate is 99 percent (146148/146500), round-trip min/avg/max = 1/7/924 ms", 
+         "ios#"]]]
+
+
+   irb> iox.ping '192.168.1.100'
+   => [100, [5, 5], 
+        [["ping 192.168.1.100", 
+          "\rTue Oct 26 08:42:58.235 UTC", 
+          "Type escape sequence to abort.", 
+          "Sending 5, 100-byte ICMP Echos to 192.168.1.100, timeout is 2 seconds:", 
+          "!!!!!", 
+          "Success rate is 100 percent (5/5), round-trip min/avg/max = 1/1/2 ms", 
+          "RP/0/0/CPU0:Paris-rp0#"]]]
+
+
+   irb> iox.ping '192.168.1.100', :sweep_min_size => 1000, :sweep_max_size => 1300
+   => [100, [1505, 1505], 
+       [["ping", 
+         "\rTue Oct 26 08:44:33.024 UTC", 
+         "Protocol [ipv4]: ", "", 
+         "\rTarget IP address: ", "192.168.1.100", 
+         "\rRepeat count [5]: ", "", "\rDatagram size [100]: ", "", 
+         "\rTimeout in seconds [2]: ", "", 
+         "\rExtended commands? [no]: ", "", 
+         "\rSweep range of sizes? [no]: ", "yes", 
+         "\rSweep min size [36]: ", "1000", 
+         "\rSweep max size [18024]: ", "1300", 
+         "\rSweep interval [1]: ", "", 
+         "\rType escape sequence to abort.", 
+         "Sending 1505, [1000..1300]-byte ICMP Echos to 192.168.1.100, timeout is 2 seconds:", 
+         "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!", 
+         "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!", 
+            ...
+         "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!", 
+         "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!", 
+         "Success rate is 100 percent (1505/1505), round-trip min/avg/max = 1/1/3 ms", 
+         "RP/0/0/CPU0:Paris-rp0#"]]]
 

data/lib/expect/io.rb

@@ -81,14 +81,15 @@ module Expect4r
   end
 
   def child_exit
-    if @pid
-      Process.kill(:KILL, @pid)
-      @thread.kill
-      @lp, @r, @w, @pid = [nil]*4
+    if @proxy
+      @proxy.logout
+    else
+      Process.kill(:KILL, @pid) if @pid
+      @thread.kill if @thread
     end
   rescue Errno::ESRCH, Errno::ECHILD => e
   ensure
-    @lp, @r, @w, @pid = [nil]*4
+    @lp, @r, @w, @pid, @proxy = [nil]*5
   end
   
   def spawn(cmd)
@@ -150,6 +151,7 @@ module Expect4r
   end
 
   def interact(k=?\C-z)
+    login unless connected?
     STDOUT.puts "\n\#\n\# #{ctrl_key k} to terminate.\n\#\n"
     reader :start
     writer k
@@ -202,14 +204,25 @@ module Expect4r
     @r && (not child_exited?)
   end
 
-  def login(c, o={})
+  def login_by_proxy(proxy)
+    raise ArgumentError, "Don't know how to login to #{proxy}" unless proxy.respond_to? :_login_
+    _login_ :proxy=> proxy
+  end
+  alias :login_via :login_by_proxy
+
+  def login(cmd, arg={})
+    
     return if connected?
 
-    spawn c
+    if arg[:proxy]
+      login_proxy cmd, arg
+    else
+      spawn cmd
+    end
 
-    o={:timeout=>13, :no_echo=>false}.merge(o)
-    timeout =   o[:timeout]
-    no_echo = o[:no_echo]
+    arg={:timeout=>13, :no_echo=>false}.merge(arg)
+    timeout = arg[:timeout]
+    no_echo = arg[:no_echo]
 
     output=[]
     t0 = Time.now
@@ -223,7 +236,9 @@ module Expect4r
         when spawnee_prompt
           read_pipe._io_save false, "match PROMPT"
           throw(:done, [:ok, output])
-        when /(user\s*name\s*|login):\r*$/i
+        when /Last (L|l)ogin:/
+          read_pipe._io_save no_echo   # consumes 
+        when /(user\s*name\s*|login):\s*$/i
           read_pipe._io_save no_echo, "match USERNAME"
           exp_puts spawnee_username
         when /password:\s*$/i
@@ -235,6 +250,9 @@ module Expect4r
         when /.*\r\n/
           exp_internal "match EOL"
           read_pipe._io_save no_echo, "match EOL", "\r\n"
+        when /Are you sure you want to continue connecting \(yes\/no\)\?/
+          read_pipe._io_save no_echo, "match continue connecting"
+          exp_puts 'yes'
         end
       end
     end
@@ -243,18 +261,24 @@ module Expect4r
       elapsed = Time.now - t0
       if elapsed < timeout
         child_exit
-        raise ConnectionError.new(c)
+        raise ConnectionError.new(cmd)
       else
-        raise ExpTimeoutError.new(c, timeout)
+        raise ExpTimeoutError.new(cmd, timeout)
       end
     else
       @lp = buf.last
     end
     [buf, ev]
-    
   end
   
   private
+  
+  def login_proxy(cmd, arg)
+    @proxy = arg[:proxy].dup
+    @proxy.login
+    @proxy.exp_puts cmd
+    @r, @w, @pid = @proxy.instance_eval { [@r, @w, @pid] }
+  end
  
   #FIXME ? putline to send_cmd ? 
   # hide putline and expose cmd
@@ -407,7 +431,7 @@ module Kernel
 end
 
 module Expect4r
-  class BaseObject
+  class BaseLoginObject
     class << self
       def new_telnet(*args)
         new :telnet, *args
@@ -421,11 +445,26 @@ module Expect4r
         @routers << r
       end
     end
-    attr_reader :host, :user, :method, :port
+    attr_reader :host, :user, :method, :port, :proxy
     alias :username :user
     alias :hostname :host
+    # Adds a login to a Expect4r::BaseLoginObject"
+    #
+    # Constructor: 
+    # * <tt>new</tt>  <method>, <username>, <password>, [port_number]
+    # * <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>
+    #
+    # Examples:
+    #   new :telnet, :user=> 'lab', :password=>'lab'
+    #   new :ssh, :user=> 'jme'
+    #
     def initialize(*args)
-      ciphered_pwd=nil
+      ciphered_password=nil
       if args.size>2 and args[1].is_a?(String)
         @method, host, @user, pwd = args
       elsif args.size == 2 and args[1].is_a?(Hash) and args[0].is_a?(Symbol)
@@ -433,29 +472,62 @@ module Expect4r
         host = args[1][:host] || args[1][:hostname]
         @user = args[1][:user]|| args[1][:username]
         pwd  = args[1][:pwd]  || args[1][:password]
-        ciphered_pwd  = args[1][:ciphered_pwd]
+        ciphered_password  = args[1][:ciphered_password]
       end
       @host, port = host.split
       @port = port.to_i
-      @pwd = if ciphered_pwd
-        ciphered_pwd
+      @pwd = if ciphered_password
+        ciphered_password
       else
         Expect4r.cipher(pwd) if pwd
       end
       @ps1 = /(.*)(>|#|\$)\s*$/
       @more = / --More-- /
       @matches=Set.new
-      BaseObject.add(self)
+      BaseLoginObject.add(self)
       self
     end
+
+    def spawnee
+      case method
+      when :telnet  ; "telnet #{host} #{port if port>0}"
+      when :ssh     ; "ssh #{spawnee_username}@#{host}"
+      else
+        raise RuntimeError
+      end
+    end
+
+    def spawnee_username
+      @user
+    end
+
+    def spawnee_prompt
+      @ps1
+    end
+    
+    def dup
+      if @pwd
+        self.class.new @method, @host, @user, Expect4r.decipher(@pwd)
+      else
+        self.class.new @method, @host, @user
+      end
+    end
+
+    private
+
+    def spawnee_password
+      @pwd = Expect4r.cipher( ask("(#{self}) Enter your password:  ") { |q| q.echo = "X" } ) unless @pwd
+      Expect4r.decipher(@pwd)
+    end
+
   end
 end
 
 if __FILE__ != $0
 
   at_exit { 
-    if Expect4r::BaseObject.routers
-      Expect4r::BaseObject.routers.each { |r| r.logout if r.respond_to? :logout }
+    if Expect4r::BaseLoginObject.routers
+      Expect4r::BaseLoginObject.routers.each { |r| r.logout if r.respond_to? :logout }
     end
   }
   
@@ -463,21 +535,21 @@ else
 
   require "test/unit"
 
-  class Expect4r::BaseObject
+  class Expect4r::BaseLoginObject
     def initialize
-      Expect4r::BaseObject.add(self)
+      Expect4r::BaseLoginObject.add(self)
     end
   end
 
-  class TestRouterBaseObject < Test::Unit::TestCase
+  class TestRouterBaseLoginObject < Test::Unit::TestCase
     include Expect4r
 
     def test_add
-      assert [], BaseObject.routers
-      BaseObject.new
-      assert 1, BaseObject.routers.size
-      BaseObject.new 
-      assert_equal 2, BaseObject.routers.size
+      assert [], BaseLoginObject.routers
+      BaseLoginObject.new
+      assert 1, BaseLoginObject.routers.size
+      BaseLoginObject.new 
+      assert_equal 2, BaseLoginObject.routers.size
     end
   end
 

data/lib/expect4r.rb

@@ -7,6 +7,7 @@ module Expect4r
   autoload :Ios,    'router/cisco/ios/ios'
   autoload :J,      'router/juniper/junos/junos'
   autoload :Shell,  'misc/shell'
+  autoload :RShell, 'misc/shell'
 
   module Router
     autoload :Common, 'router/common'
@@ -33,6 +34,7 @@ module Expect4r
     module Junos
       autoload :Modes, 'router/juniper/junos/modes'
       autoload :Show,  'router/juniper/junos/show'
+      autoload :Ping, 'router/juniper/junos/ping'
     end
   end
 

data/lib/misc/shell.rb

@@ -1,7 +1,4 @@
-require 'expect/io'
-
 module Expect4r
-
   class Shell
     include Expect4r
     def initialize()
@@ -15,5 +12,44 @@ module Expect4r
       spawn @shell
     end
   end
+  class RShell < ::Expect4r::BaseLoginObject
+    include Expect4r
+    def initialize(*args)
+      super
+      default_ps1
+    end
+    def logout
+      default_ps1
+      super
+    end
+    def login(arg={}) 
+      super(spawnee, arg)
+      cmd %{export COLUMNS=1024}
+    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 ps1=(val)
+      # Assumes bash
+      @ps1_bis = /#{val}$/
+      cmd %? export PS1='#{val}' ?
+      @ps1 = @ps1_bi
+    end
+    def cmd(*args)
+      exp_send *args
+    end
+
+    private
+    
+    def default_ps1
+      @ps1 = /.+[^\#](\#|\$)\s+$/
+    end
+  end
+end
+
+__END__
+
 
-end
+cmd %? PROMPT_COMMAND="echo -n [$(date +%k:%m:%S)]: && pwd" && export PS1='#{val}' ?

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

@@ -2,6 +2,16 @@
 module Expect4r::Router
 module CiscoCommon
   
+  #
+  # Returns the config level depths:
+  #
+  #  Example:
+  #
+  #    iox(config-ospf-ar)#
+  #
+  #    irb> iox.config_lvl?
+  #    => 3
+  # 
   def config_lvl?
     return -1 unless config?
     @lp =~ /\(config(|.+)\)/

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

@@ -4,6 +4,29 @@ module Expect4r::Router::CiscoCommon
 module Ping
   include ::Expect4r::Router::Error
  
+  # Adds a <tt>ping</tt> method to <tt>CiscoCommon::Ping mixin</tt>:
+  #
+  # Options are:
+  # * <tt>:protocol</tt>
+  # * <tt>:repeat_count</tt> or <tt>:count</tt>
+  # * <tt>:datagram_size</tt> or <tt>:size</tt>
+  # * <tt>:timeout</tt>
+  # * <tt>:source_address</tt> 
+  # * <tt>:tos</tt>
+  # * <tt>:df</tt>
+  # * <tt>:pattern</tt>
+  # * <tt>:sweep_min_size</tt>
+  # * <tt>:sweep_max_size</tt>
+  # * <tt>:sweep_interval</tt>
+  # * <tt>:pct_success</tt> - default is 99.
+  #
+  # Option examples:
+  #   :protocol => 'ipv4'
+  #   :count => 10
+  #   :timeout => 1
+  #   :size=> 512
+  #   :protocol=> 'ipv4', :count=> 20, :size=> 1500, :timeout=>5
+  #
   def ping(target_ip_address, arg={})
 
     pct_success = arg.delete(:pct_success) || 99
@@ -98,11 +121,3 @@ private
 end
 end
 
-__END__
-
-p.ping '192.168.1.23'
-p.ping '192.168.1.23', :sweep_max_size=> 1512, :pct_success => 95
-p.ping '192.168.1.23', :source_address => '192.168.1.199', :count=> 100, :pct_success=> 90
-
-puts output[2][0].join("\n").split(": \n").join(": ")
-

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

@@ -1,6 +1,6 @@
 require 'router/cisco/common/common'
 
-class Expect4r::Ios < ::Expect4r::BaseObject
+class Expect4r::Ios < ::Expect4r::BaseLoginObject
   
   include Expect4r
   include Expect4r::Router::Common
@@ -33,12 +33,17 @@ class Expect4r::Ios < ::Expect4r::BaseObject
     Expect4r.decipher(@pwd)    # password is ciphered ...
   end
   
-  def login
-    super(spawnee)
+  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

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

@@ -3,6 +3,10 @@ require 'router/modes'
 module Expect4r::Router::Ios
 module Modes
   
+  # Adds a <tt>in?</tt> mixin.
+  #
+  # Returns the mode the router is in:  :user, :exec, :config
+  #
   def in?(mode=:none)
     login unless connected?
     case mode
@@ -61,10 +65,16 @@ module Modes
     @lp =~ /\(config(|.+)\)/
   end
   
+  #
+  # returns <tt>true</tt> if router is in <tt>:exec</tt> (enabled) mode,  <tt>false</tt> otherwise.
+  #
   def exec?
     ! user? and ! config?
   end
   
+  #
+  # returns <tt>true</tt> if router is in <tt>:user</tt> mode,  <tt>false</tt> otherwise.
+  #
   def user?
     @lp =~ /.+>\s*$/
   end

data/lib/router/cisco/iox/iox.rb

@@ -1,7 +1,7 @@
 
 require 'router/cisco/common/common'
 
-class Expect4r::Iox < ::Expect4r::BaseObject
+class Expect4r::Iox < ::Expect4r::BaseLoginObject
   
   include Expect4r
   include Expect4r::Router
@@ -18,12 +18,16 @@ class Expect4r::Iox < ::Expect4r::BaseObject
     @more = / --More-- /
   end
   
-  def login
-    super(spawnee)
+  def login(arg={})
+    super(spawnee, arg)
     config 'no logging console' if port>0
     exec "terminal len 0\nterminal 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 commit(arg={})
     return unless config?

data/lib/router/cisco/iox/modes.rb

@@ -3,6 +3,19 @@ require 'router/modes'
 module Expect4r::Router::Iox
 module Modes
 
+  # Adds an Iox <tt>config>/tt> mixin.
+  #
+  # Options are:
+  #
+  # Option examples:
+  #
+  #   iox.config %{
+  #      interface GigabitEthernet0/2/0/0
+  #      desc to switch port 13'
+  #      ipv4 address 190.0.0.9 255.255.255.252'
+  #      no shut'
+  #   }
+  #
   def config(config=nil, arg={})
     login unless connected?
     if config

data/lib/router/cisco/iox/ping.rb

@@ -0,0 +1,55 @@
+
+__END__
+
+RP/0/0/CPU0:Paris-rp0#ping ipv4 1.1.1.1 count 5 ?
+  donotfrag  set DF bit in IP header
+  pattern    data pattern
+  size       datagram size
+  source     source address or source interface
+  sweep      sweep ping
+  timeout    timeout in seconds
+  type       type of service
+  validate   validate return packet
+  verbose    verbose output
+  <cr>       
+RP/0/0/CPU0:Paris-rp0#ping ipv4 1.1.1.1 count 5  size ?
+  <36-18024>  datagram size
+RP/0/0/CPU0:Paris-rp0#ping ipv4 1.1.1.1 count 5  size 100 ?
+  donotfrag  set DF bit in IP header
+  pattern    data pattern
+  source     source address or source interface
+  sweep      sweep ping
+  timeout    timeout in seconds
+  type       type of service
+  validate   validate return packet
+  verbose    verbose output
+  <cr>       
+RP/0/0/CPU0:Paris-rp0#ping ipv4 1.1.1.1 count 5  size 100 donotfrag ?
+  pattern   data pattern
+  source    source address or source interface
+  sweep     sweep ping
+  timeout   timeout in seconds
+  type      type of service
+  validate  validate return packet
+  verbose   verbose output
+  <cr>      
+RP/0/0/CPU0:Paris-rp0#ping ipv4 1.1.1.1 count 5  size 100 donotfrag pattern ?
+  <0-65535>  data pattern
+RP/0/0/CPU0:Paris-rp0#ping ipv4 1.1.1.1 count 5  size 100 donotfrag pattern 0xdead type 2 ?
+  source    source address or source interface
+  sweep     sweep ping
+  timeout   timeout in seconds
+  validate  validate return packet
+  verbose   verbose output
+  <cr>      
+RP/0/0/CPU0:Paris-rp0#ping ipv4 1.1.1.1 count 5  size 100 donotfrag pattern 0xdead type 2 timeout 10 sweep ?
+  source    source address or source interface
+  validate  validate return packet
+  verbose   verbose output
+  <cr>      
+RP/0/0/CPU0:Paris-rp0#ping ipv4 1.1.1.1 count 5  size 100 donotfrag pattern 0xdead type 2 timeout 10 sweep ?
+  source    source address or source interface
+  validate  validate return packet
+  verbose   verbose output
+  <cr>      
+RP/0/0/CPU0:Paris-rp0#

data/lib/router/common.rb

@@ -14,29 +14,5 @@ module Common
     putc "\n" if console?
   end
 
-  def spawnee
-    case method
-    when :telnet  ; "telnet #{host} #{port if port>0}"
-    when :ssh     ; "ssh #{spawnee_username}@#{host}"
-    else
-      raise RuntimeError
-    end
-  end
-
-  def spawnee_username
-    @user
-  end
-
-  def spawnee_prompt
-    @ps1
-  end
-
-private
-
-  def spawnee_password
-    @pwd = Expect4r.cipher( ask("Enter your password:  ") { |q| q.echo = "X" } ) unless @pwd
-    Expect4r.decipher(@pwd)
-  end
-
 end
 end

data/lib/router/juniper/junos/junos.rb

@@ -1,4 +1,4 @@
-class Expect4r::J < ::Expect4r::BaseObject
+class Expect4r::J < ::Expect4r::BaseLoginObject
   include Expect4r
   include Expect4r::Router::Error
   include Expect4r::Router::Common
@@ -13,12 +13,15 @@ class Expect4r::J < ::Expect4r::BaseObject
     @more =  /---\(more(| \d+\%)\)---/
   end
   
-  def login
-    ENV['TERM']='dumb'
-    super(spawnee)
+  def login(arg={})
+    super(spawnee, arg)
     exec 'set cli screen-length 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 console?
     @port>0

data/lib/router/juniper/junos/modes.rb

@@ -3,6 +3,18 @@ require 'router/modes'
 module Expect4r::Router::Junos
 module Modes
 
+# Adds a Junos <tt>config</tt> mixin.
+#
+# Example:
+#
+#  j.config %{
+#    edit logical-router Orleans protocols bgp
+#      edit group session-to-200
+#        set type external
+#        set peer-as 200
+#        set neighbor 40.0.2.1 peer-as 200
+#  }
+#
 def config(stmts=nil, arg={})
   login unless connected?
   if stmts
@@ -13,10 +25,16 @@ def config(stmts=nil, arg={})
     change_mode_to(mode)
     output
   else
-    mode
+    to_config
   end
 end
 
+# Adds a Junos <tt>exec</tt> mixin.
+#
+# Example:
+#
+#   j.exec 'set cli screen-length 0'
+#
 def exec(cmd=nil, *args)
   login unless connected?
   if cmd.nil?
@@ -50,14 +68,23 @@ def shell(cmd=nil, *args)
   end
 end
 
+#
+# returns <tt>true</tt> if router is in <tt>:exec</tt> mode,  <tt>false</tt> otherwise.
+#
 def exec?
   @lp =~ /> $/ ? true : false
 end
 
+#
+# returns <tt>true</tt> if router is in <tt>:config</tt> mode, <tt>false</tt> otherwise.
+#
 def config?
   @lp =~ /^.+# $/ ? true : false
 end
 
+#
+# returns <tt>true</tt> if router is in <tt>:shell</tt> mode, <tt>false</tt> otherwise.
+#
 def shell?
   @lp == '% ' ? true : false
 end

data/lib/router/juniper/junos/ping.rb

@@ -3,6 +3,24 @@ require 'router/error'
 module Expect4r::Router::Junos
 module Ping
 
+  # Adds a ping method to J class:
+  #
+  # Options are:
+  # * <tt>:count</tt> or <tt>:repeat_count</tt>
+  # * <tt>:size</tt> or <tt>:datagram_size</tt>
+  # * <tt>:datagram_size</tt> or <tt>:size</tt>
+  # * <tt>:timeout</tt>
+  # * <tt>:tos</tt>
+  # * <tt>:ttl</tt>
+  # * <tt>:pattern</tt>
+  # * <tt>:pct_success</tt> - default is 99.
+  #
+  # Option examples:
+  #   :count => 10
+  #   :timeout => 1
+  #   :size=> 512
+  #   :protocol=> 'ipv4', :count=> 20, :size=> 1500, :timeout=>5, :ttl=>16
+  #
   def ping(host, arg={})
 
     pct_success = arg.delete(:pct_success) || 99

data/lib/router/modes.rb

@@ -2,6 +2,21 @@ module Expect4r
 module Router
 module Common
 module Modes
+  
+  # Adds a <tt>in?</tt> mixin.
+  #
+  # Examples:
+  #
+  #  irb(main):007:0> iox.in?
+  #  => :exec
+  #  irb(main):008:0> iox.config
+  #  => :config
+  #  irb(main):009:0> iox.in?
+  #  => :config
+  #  irb(main):010:0> iox.shell
+  #  => :shell
+  #  irb(main):011:0> iox.in?
+  #  => :shell
   def in?(mode=:none)
     login unless connected?
     case mode

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
+  - 3
   - dev
-  version: 0.0.2.dev
+  version: 0.0.3.dev
 platform: ruby
 authors: 
 - Jean-Michel Esnault
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-25 00:00:00 -07:00
+date: 2010-10-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
         version: 1.5.0
   type: :runtime
   version_requirements: *id001
-description: A Ruby Library for interacting with IOS, IOS-XR, and JUNOS CLI.
+description: A Ruby Library for interacting with IOS, IOS-XR, and JUNOS  CLI.
 email: jesnault@gmail.com
 executables: []
 
@@ -57,6 +57,7 @@ files:
 - lib/router/cisco/ios/termserver.rb
 - lib/router/cisco/iox/iox.rb
 - lib/router/cisco/iox/modes.rb
+- lib/router/cisco/iox/ping.rb
 - lib/router/common.rb
 - lib/router/error.rb
 - lib/router/juniper/junos/junos.rb