expect4r 0.0.3.dev → 0.0.4.dev

data/README.rdoc

@@ -14,7 +14,13 @@ You talk to routers by connecting to them using ssh or telnet and send exec or c
    
    j = J.new_telnet :host=> '', :user=> 'lab', :pwd => 'lab'
    j.login
-   
+
+* Connect to a box via another
+
+   my_mac = RShell.new_ssh 'mac', 'me'
+   router = Iox.new_telnet 'hostname', 'username'
+   router.login_via my_mac
+
 * Push configurations to routers
 
    ios.config 'no logging console'
@@ -118,7 +124,7 @@ 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 
+* Ios Ping
 
    irb(main):016:0> ios.ping '192.168.1.23', :count=> 100, :pct_success=>90, :sweep_max_size=> 1500
    => [ 99, [146148, 146500], 
@@ -144,6 +150,8 @@ You talk to routers by connecting to them using ssh or telnet and send exec or c
          "ios#"]]]
 
 
+* Iox ping
+
    irb> iox.ping '192.168.1.100'
    => [100, [5, 5], 
         [["ping 192.168.1.100", 
@@ -178,3 +186,16 @@ You talk to routers by connecting to them using ssh or telnet and send exec or c
          "Success rate is 100 percent (1505/1505), round-trip min/avg/max = 1/1/3 ms", 
          "RP/0/0/CPU0:Paris-rp0#"]]]
 
+
+* Junos ping
+
+   irb> j.ping '192.168.1.123'
+   => [5, [5, 0], 
+      [["ping 192.168.1.123 rapid ", 
+        "PING 192.168.1.123 (192.168.1.123): 56 data bytes", 
+        "!!!!!", 
+        "--- 192.168.1.123 ping statistics ---", 
+        "5 packets transmitted, 5 packets received, 0% packet loss", 
+        "round-trip min/avg/max/stddev = 2.310/2.943/4.390/0.753 ms", 
+        "", 
+        junos> "]]]

data/examples/jex1.rb

@@ -0,0 +1,104 @@
+require 'expect4r'
+require "enumerator"
+include Expect4r
+include Expect4r::Router::Error
+
+paris_config = %|
+top
+edit logical-router Paris interface fxp0 unit 25
+  set vlan-id 25
+  set family inet address 40.0.1.1/24
+top
+edit logical-router Paris interface fxp1 unit 22
+  set vlan-id 22
+  set family inet address 40.0.2.1/24
+top
+edit logical-router Paris interface lo0 unit 1
+  set family inet address 192.168.127.1/32
+top
+edit logical-router Paris interface fxp0 unit 24
+  set vlan-id 24
+  set family inet address 40.0.0.2/24
+top
+edit logical-router Paris 
+  set routing-options autonomous-system 200
+top
+  edit logical-router Paris protocols bgp
+    edit group session-to-300
+      set type external
+      set peer-as 300
+      set neighbor 40.0.1.2 peer-as 300
+      exit
+    edit group session-to-210
+      set type external
+      set peer-as 210
+      set neighbor 40.0.2.2 peer-as 210
+      exit
+    edit group session-to-100
+      set type external
+      set peer-as 100
+      set neighbor 40.0.0.1 peer-as 100
+|
+
+orleans_config = %|
+top
+edit logical-router Orleans interface fxp2 unit 22
+  set vlan-id 22
+  set family inet address 40.0.2.2/24
+top
+edit logical-router Orleans 
+  set routing-options autonomous-system 100
+top
+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
+|
+
+begin
+
+  paris   = J.new_telnet('olive', 'jme').login
+  orleans = J.new_telnet('olive', 'jme').login
+
+  threads =[]
+  threads << Thread.new {  paris.config paris_config }
+  threads << Thread.new { p orleans.config orleans_config }
+  threads.each { |th| th.join }
+
+rescue ConnectionError => e
+  
+  p 'CONNECTION ERROR'
+
+  puts e.err_msg
+
+rescue SyntaxError, SemanticError => e
+
+  p 'CONFIG ERROR'
+  puts e.err_msg
+
+else
+
+  begin
+
+    paris.ping '40.0.2.1', :logical_router=>'Paris', :count=>100
+    orleans.ping '40.0.2.2', :logical_router=>'Orleans', :count=>100
+
+  rescue PingError => e
+
+    p 'PING ERROR'
+    puts e.err_msg
+
+  end
+
+ensure
+  
+  [paris, orleans].each { |r|  r.logout }
+
+end
+
+
+
+
+
+

data/examples/jex2.rb

@@ -0,0 +1,88 @@
+require "test/unit"
+require 'expect4r'
+
+class TestPingTest < Test::Unit::TestCase
+  include Expect4r
+  include Expect4r::Router::Error
+  
+  def setup
+    
+    paris_config = %|
+    top
+    edit logical-router Paris interface fxp0 unit 25
+      set vlan-id 25
+      set family inet address 40.0.1.1/24
+    top
+    edit logical-router Paris interface fxp1 unit 22
+      set vlan-id 22
+      set family inet address 40.0.2.1/24
+    top
+    edit logical-router Paris interface lo0 unit 1
+      set family inet address 192.168.127.1/32
+    top
+    edit logical-router Paris interface fxp0 unit 24
+      set vlan-id 24
+      set family inet address 40.0.0.2/24
+    top
+    edit logical-router Paris 
+      set routing-options autonomous-system 200
+    top
+      edit logical-router Paris protocols bgp
+        edit group session-to-300
+          set type external
+          set peer-as 300
+          set neighbor 40.0.1.2 peer-as 300
+          exit
+        edit group session-to-210
+          set type external
+          set peer-as 210
+          set neighbor 40.0.2.2 peer-as 210
+          exit
+        edit group session-to-100
+          set type external
+          set peer-as 100
+          set neighbor 40.0.0.1 peer-as 100
+    |
+
+    orleans_config = %|
+    top
+    edit logical-router Orleans interface fxp2 unit 22
+      set vlan-id 22
+      set family inet address 40.0.2.2/24
+    top
+    edit logical-router Orleans 
+      set routing-options autonomous-system 100
+    top
+    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
+    |
+    
+    @paris   = J.new_ssh('olive', 'jesnault', 'HomeLab').login
+    @orleans = J.new_ssh('olive', 'jesnault', 'HomeLab').login
+    threads =[]
+    threads << Thread.new {  @paris.config paris_config }
+    threads << Thread.new {  @orleans.config orleans_config }
+    threads.each { |th| th.join }
+    
+  end
+  
+  def teardown
+    @paris.config "delete logical-routers"
+    [@paris, @orleans].each { |r| r.logout }
+  end
+  
+  def test_ping_test
+    assert_nothing_raised(Exception) {
+      threads =[]
+      threads << Thread.new { @paris.ping '40.0.2.1', :logical_router=>'Paris', :count=>100 }
+      threads << Thread.new { @orleans.ping '40.0.2.2', :logical_router=>'Orleans', :count=>100 }
+      threads.each { |th| th.join }
+    }
+    
+  end
+  
+end
+

data/lib/expect/io.rb

@@ -230,12 +230,12 @@ module Expect4r
       @r.readbuf(timeout) do |read_pipe|
         if read_pipe._io_exit?
           exp_internal "readbuf: _io_exit?"
-          throw :done, [ :abort,  output]
+          throw :done, [ :cnx_error,  read_pipe._io_buf1]
         end
         case read_pipe._io_string
         when spawnee_prompt
-          read_pipe._io_save false, "match PROMPT"
-          throw(:done, [:ok, output])
+          read_pipe._io_save no_echo, "match PROMPT"
+          throw(:done, [:ok, read_pipe._io_buf1])
         when /Last (L|l)ogin:/
           read_pipe._io_save no_echo   # consumes 
         when /(user\s*name\s*|login):\s*$/i
@@ -249,22 +249,22 @@ module Expect4r
           io_escape_char_cb
         when /.*\r\n/
           exp_internal "match EOL"
-          read_pipe._io_save no_echo, "match EOL", "\r\n"
+          read_pipe._io_save no_echo, "match EOL"
         when /Are you sure you want to continue connecting \(yes\/no\)\?/
           read_pipe._io_save no_echo, "match continue connecting"
           exp_puts 'yes'
+        when /(Login incorrect|denied, please try again)/
+          spawnee_reset
         end
       end
     end
     case ev
-    when :abort
-      elapsed = Time.now - t0
-      if elapsed < timeout
-        child_exit
-        raise ConnectionError.new(cmd)
-      else
-        raise ExpTimeoutError.new(cmd, timeout)
-      end
+    when :cnx_error
+      child_exit
+      err_msg = "Could not connect to #{@host}:\n"
+      err_msg += " >> #{cmd}\n    "
+      err_msg += buf.join("\n    ")
+      raise ConnectionError.new(err_msg)
     else
       @lp = buf.last
     end
@@ -305,12 +305,12 @@ module Expect4r
         case r._io_string
         when @ps1, @ps1_bis
           unless r._io_more?
-            r._io_save false, "matching PROMPT"
+            r._io_save no_echo, "matching PROMPT"
             throw(:done, [:ok, r._io_buf1])
           end
           exp_internal "more..."
         when /(.+)\r\n/, "\r\n"
-          r._io_save no_echo, "matching EOL", "\r\n"
+          r._io_save no_echo, "matching EOL"
         when @more
           r._io_save no_echo, "matching MORE"
           putc ' '
@@ -433,9 +433,19 @@ end
 module Expect4r
   class BaseLoginObject
     class << self
+      # Examples:
+      #   my_mac = RShell.new_telnet '1.1.1.1', 'me', 'secret'
+      #   ios = Ios.new_telnet '1.1.1.1', 'lab', 'lab'
+      #   iox = Iox.new_telnet '1.1.1.1', 'username', 'pwd'
+      #
       def new_telnet(*args)
         new :telnet, *args
       end
+      # Examples:
+      #   my_mac = RShell.new_ssh '1.1.1.1', 'me', 'secret'
+      #   iox = Ios.new_ssh '1.1.1.1', 'lab', 'lab'
+      #   ios = Iosx.new_ssh '1.1.1.1', 'username', 'pwd'
+      #
       def new_ssh(*args)
         new :ssh, *args
       end
@@ -460,8 +470,9 @@ module Expect4r
     # * <tt>:pwd</tt> or <tt>:password</tt>
     #
     # Examples:
-    #   new :telnet, :user=> 'lab', :password=>'lab'
-    #   new :ssh, :user=> 'jme'
+    #   new :telnet, :host=> '1.1.1.1', :user=> 'lab', :password=>'lab'
+    #   new :ssh, :host=> '1.1.1.1', :user=> 'jme'
+    #   new :ssh, '1.1.1.1', 'me', 'secret'
     #
     def initialize(*args)
       ciphered_password=nil
@@ -516,9 +527,16 @@ module Expect4r
     private
 
     def spawnee_password
-      @pwd = Expect4r.cipher( ask("(#{self}) Enter your password:  ") { |q| q.echo = "X" } ) unless @pwd
+      if @pwd.nil?
+        @pwd = Expect4r.cipher( ask("(#{self}) Enter your password:  ") { |q| q.echo = "X" } )
+        @asked4pwd=true
+      end
       Expect4r.decipher(@pwd)
     end
+    
+    def spawnee_reset
+      @pwd=nil if @asked4pwd
+    end
 
   end
 end

data/lib/expect4r.rb

@@ -39,13 +39,3 @@ module Expect4r
   end
 
 end
-
-if __FILE__ == $0
-  module Expect4r
-    p Expect4r::Iox.new_ssh 'hostname', 'username'
-    p Expect4r::Iox.new_telnet 'hostname', 'username'
-    p Expect4r::Ios.new_ssh 'hostname', 'username'
-    p Expect4r::J.new_ssh 'hostname', 'username'
-    p Expect4r::Shell.new
-  end
-end

data/lib/misc/shell.rb

@@ -14,6 +14,7 @@ module Expect4r
   end
   class RShell < ::Expect4r::BaseLoginObject
     include Expect4r
+    
     def initialize(*args)
       super
       default_ps1
@@ -35,7 +36,7 @@ module Expect4r
       # Assumes bash
       @ps1_bis = /#{val}$/
       cmd %? export PS1='#{val}' ?
-      @ps1 = @ps1_bi
+      @ps1 = @ps1_bis
     end
     def cmd(*args)
       exp_send *args

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

@@ -66,14 +66,14 @@ module Modes
   end
   
   #
-  # returns <tt>true</tt> if router is in <tt>:exec</tt> (enabled) mode,  <tt>false</tt> otherwise.
+  # returns *true* if router is in <tt>:exec</tt> (enabled) mode,  *false* otherwise.
   #
   def exec?
     ! user? and ! config?
   end
   
   #
-  # returns <tt>true</tt> if router is in <tt>:user</tt> mode,  <tt>false</tt> otherwise.
+  # returns *true* if router is in <tt>:user</tt> mode,  *false* otherwise.
   #
   def user?
     @lp =~ /.+>\s*$/

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

@@ -3,7 +3,7 @@ require 'router/modes'
 module Expect4r::Router::Iox
 module Modes
 
-  # Adds an Iox <tt>config>/tt> mixin.
+  # Adds an Iox <tt>config</tt> mixin.
   #
   # Options are:
   #

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

@@ -29,10 +29,16 @@ class Expect4r::J < ::Expect4r::BaseLoginObject
   
   def putline(line,arg={})
     o, rc = super
-    raise SyntaxError.new(self.class.to_s, line) if o.join =~ /(unknown command|syntax error)\./
+    raise SyntaxError.new(self.class.to_s, line) if o.join =~ /(unknown command|syntax error)/
     o
   end
   
+  def rollback
+    return unless config?
+    top
+    putline 'rollback'
+  end
+  
   def top
     putline 'top'
   end
@@ -46,7 +52,7 @@ class Expect4r::J < ::Expect4r::BaseLoginObject
     @matches << [/Exit with uncommitted changes.+\(yes\)/, 'yes']
     output = putline "commit", arg
     if /error: configuration check-out failed/.match(output.join)
-      putline 'rollback'
+      rollack
       raise SemanticError.new(self.class.to_s, output)
     end
     output

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

@@ -23,7 +23,7 @@ def config(stmts=nil, arg={})
     output = exp_send(stmts, arg)
     output << commit
     change_mode_to(mode)
-    output
+    output.flatten
   else
     to_config
   end
@@ -69,21 +69,21 @@ def shell(cmd=nil, *args)
 end
 
 #
-# returns <tt>true</tt> if router is in <tt>:exec</tt> mode,  <tt>false</tt> otherwise.
+# returns *true* if router is in <tt>:exec</tt> mode,  *false* otherwise.
 #
 def exec?
   @lp =~ /> $/ ? true : false
 end
 
 #
-# returns <tt>true</tt> if router is in <tt>:config</tt> mode, <tt>false</tt> otherwise.
+# returns *true* if router is in <tt>:config</tt> mode, *false* otherwise.
 #
 def config?
   @lp =~ /^.+# $/ ? true : false
 end
 
 #
-# returns <tt>true</tt> if router is in <tt>:shell</tt> mode, <tt>false</tt> otherwise.
+# returns *true* if router is in <tt>:shell</tt> mode, *false* otherwise.
 #
 def shell?
   @lp == '% ' ? true : false

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

@@ -27,7 +27,7 @@ module Ping
 
     output = exec(ping_cmd(host, arg), arg)
 
-    r = output[0].find { |x| p x ; x =~/(\d+) packets transmitted, (\d+) packets received, (\d+)\% packet loss/}
+    r = output[0].find { |x| x =~/(\d+) packets transmitted, (\d+) packets received, (\d+)\% packet loss/}
 
     if r && 
       Regexp.last_match(1) && 
@@ -55,6 +55,7 @@ private
   def ping_cmd(host, arg={})
     cmd = "ping #{host}"
     cmd += " rapid"
+    cmd += " logical-router #{arg[:logical_router]}" if arg[:logical_router]
     cmd += " count #{arg[:count] || arg[:repeat_count]}"  if arg[:count] || arg[:repeat_count]
     cmd += " size #{arg[:size]   || arg[:datagram_size]}" if arg[:size]  || arg[:datagram_size] 
     cmd += " pattern #{arg[:pattern]}"                    if arg[:pattern]

data/lib/router/modes.rb

@@ -7,16 +7,17 @@ module Modes
   #
   # 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
+  #  >> iox.in?
+  #  => *:exec*
+  #  >> iox.config
+  #  => *:config*
+  #  >> iox.in?
+  #  => *:config*
+  #  >> iox.shell
+  #  => *:shell*
+  #  >> iox.in?
+  #  => *:shell*
+  #
   def in?(mode=:none)
     login unless connected?
     case mode

data/test/expect4r_test.rb

@@ -0,0 +1,12 @@
+require 'expect4r'
+require "test/unit"
+class TestAutoload < Test::Unit::TestCase
+  include Expect4r
+  def test_autoload
+    assert Expect4r::Iox.new_ssh 'hostname', 'username'
+    assert Expect4r::Iox.new_telnet 'hostname', 'username'
+    assert Expect4r::Ios.new_ssh 'hostname', 'username'
+    assert Expect4r::J.new_ssh 'hostname', 'username'
+    assert Expect4r::Shell.new    
+  end
+end

data/test/router/cisco/iox/iox_test.rb

@@ -1,8 +1,8 @@
+require 'expect4r'
 require "test/unit"
 
-require "router/cisco/iox/iox"
-
 class TestRouterCiscoIoxIox < Test::Unit::TestCase
+  include Expect4r
   def test_new_hash_terse
     x = Iox.new :ssh, 
                 :host=> '1.1.1.1',

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
+  - 4
   - dev
-  version: 0.0.3.dev
+  version: 0.0.4.dev
 platform: ruby
 authors: 
 - Jean-Michel Esnault
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 -07:00
+date: 2010-10-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,8 @@ files:
 - COPYING
 - LICENSE
 - README.rdoc
+- examples/jex1.rb
+- examples/jex2.rb
 - lib/expect/io.rb
 - lib/expect4r.rb
 - lib/misc/passwd.rb
@@ -84,8 +86,8 @@ required_ruby_version: !ruby/object:Gem::Requirement
       segments: 
       - 1
       - 8
-      - 7
-      version: 1.8.7
+      - 6
+      version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">"
@@ -103,5 +105,6 @@ signing_key:
 specification_version: 3
 summary: Expect4r
 test_files: 
+- test/expect4r_test.rb
 - test/misc/passwd_test.rb
 - test/router/cisco/iox/iox_test.rb