expect4r 0.0.1.dev → 0.0.2.dev

data/README.rdoc

@@ -13,7 +13,7 @@ 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
    
-* Push configigurations to routers
+* Push configurations to routers
 
    ios.config 'no logging console'
    

data/lib/expect/io.rb

@@ -52,8 +52,8 @@ end
 module Expect4r
 
   class ConnectionError < RuntimeError
-    def initialize(output)
-      @output = output
+    def initialize(*args)
+      @output = args[0]
     end
     def err_msg
       "Connection Error: #{@output}"
@@ -61,22 +61,20 @@ module Expect4r
   end
 
   class ExpTimeoutError < RuntimeError
-    def initialize(output, elapsed)
-      @output, @elapsed = output, elapsed
+    def initialize(*args)
+      @output, @timeout = args
     end
     def err_msg
-      "Timeout Error: #{@output}"
+      "Timeout Error: timeout= #{@timeout}: #{@output}"
     end
   end
 
-  class NoChildError < RuntimeError
-  end
   class SpawnError < RuntimeError
-    def initialize(cmd)
-      @cmd = cmd
+    def initialize(*args)
+      @cmd = args[0]
     end
     def err_msg
-      "Error: #{msg}"
+      "Spawn Error: #{@cmd}"
     end
   end
   class Expect4rIO_Error < RuntimeError
@@ -96,7 +94,6 @@ module Expect4r
   def spawn(cmd)
     begin
       child_exited = false
-      # STDOUT.puts "*** FALSE ***"
       @thread = Thread.new do
         PTY.spawn(cmd) do |pipe_read, pipe_write, pid|
           @r, @w, @pid = pipe_read, pipe_write, pid
@@ -109,7 +106,6 @@ module Expect4r
         end
       end
       @thread.priority = -2
-      # STDOUT.puts "*** #{child_exited} ***"
       unless child_exited
         while @r.nil?
           sleep(0.05) 
@@ -122,6 +118,7 @@ module Expect4r
   
   def logout
     child_exit
+    @pid
   end
   
   def putc(c)
@@ -136,6 +133,7 @@ module Expect4r
   def exp_puts(s)
     exp_print "#{s}\r"
   end
+  
   def exp_print(s)
     exp_internal "print: #{s.inspect}, io_writer: #{@w}"
     return unless @w
@@ -192,7 +190,7 @@ module Expect4r
       end
     end
     exp_internal "#{ev.inspect} buf: #{buf.inspect}"
-    raise RuntimeError, buf if ev == :timeout
+    raise ExpTimeoutError.new(buf, ti) if ev == :timeout
     [buf, ev]
   end
 
@@ -244,9 +242,10 @@ module Expect4r
     when :abort
       elapsed = Time.now - t0
       if elapsed < timeout
+        child_exit
         raise ConnectionError.new(c)
       else
-        raise ExpTimeoutError.new(c, elapsed)
+        raise ExpTimeoutError.new(c, timeout)
       end
     else
       @lp = buf.last
@@ -260,8 +259,8 @@ module Expect4r
   #FIXME ? putline to send_cmd ? 
   # hide putline and expose cmd
   def putline(line, arg={})
-    raise NoChildError if child_exited?
-        
+    raise ConnectionError.new(line) if child_exited?
+    
     arg = {:ti=>13, :no_echo=>false, :debug=>0, :sync=> false, :no_trim=>false}.merge(arg)
     no_echo = arg[:no_echo]
     ti = arg[:ti]
@@ -306,6 +305,7 @@ module Expect4r
     when :abort
       elapsed = Time.now - t0
       if elapsed < ti
+        child_exit
         raise ConnectionError.new(line)
       else
         raise ExpTimeoutError.new(line, elapsed)

data/lib/expect4r.rb

@@ -32,7 +32,7 @@ module Expect4r
     end
     module Junos
       autoload :Modes, 'router/juniper/junos/modes'
-      autoload :Show, 'router/juniper/junos/show'
+      autoload :Show,  'router/juniper/junos/show'
     end
   end
 

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

@@ -19,6 +19,19 @@ module CiscoCommon
     @lp =~ /\(config(|.+)\)/
     Regexp.last_match(1).size == 0
   end
+
+  def method_missing(name, *args, &block)
+    if name.to_s =~ /^show_/
+      cmd = name.to_s.split('_').join(' ') + args.join(' ')
+      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
 end

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

@@ -3,37 +3,106 @@ require 'router/error'
 module Expect4r::Router::CiscoCommon
 module Ping
   include ::Expect4r::Router::Error
-  def ping(arg={})
-    if arg.is_a?(Hash)
-      arg = {:pct_success=>100}.merge(arg) 
-      pct_success = arg[:pct_success]
-    else
-      pct_success = 100
-    end
-    case arg
-    when String
-      dest = arg
-    when Hash
-      dest = arg[:dest]
+ 
+  def ping(target_ip_address, arg={})
+
+    pct_success = arg.delete(:pct_success) || 99
+
+    if arg.empty?
+
+      output = exec "ping #{target_ip_address}", arg
+
     else
-      raise ArgumentError, "Invalid argument: #{arg.inspect}"
+
+      @matches = Set.new
+
+      set_ping_base_matches target_ip_address, arg
+      set_ping_extended_matches arg
+      set_ping_sweep_matches arg
+
+      output = exec "ping", arg
+
     end
-    output = exec "ping #{dest}", arg
+
     r = output[0].find { |x| x =~/Success.*[^\d](\d+) percent \((\d+)\/(\d+)\)/}
+
     if r && 
-       Regexp.last_match(1) && 
-       Regexp.last_match(2) && 
-       Regexp.last_match(3)
-       
-       if $1.to_i < pct_success
-         raise PingError('router name here', dest, pct_success, $1.to_i, $2.to_i,$3.to_i, output)
-       else
-         [$1.to_i,[$2.to_i,$3.to_i],output]
-       end
-       
+      Regexp.last_match(1) && 
+      Regexp.last_match(2) && 
+      Regexp.last_match(3)
+      
+      pct = $1.to_i
+      tx  = $3.to_i
+      rx  = $2.to_i
+
+      if $1.to_i < pct_success
+        raise ::Expect4r::Router::Error::PingError.new(@host, target_ip_address, pct_success, pct, tx, rx, output)
+      else
+        [$1.to_i,[$2.to_i,$3.to_i],output]
+      end
+
     else
-      raise PingError.new('router name here', dest, pct_success, $1.to_i, $2.to_i,$3.to_i, output)
+      raise ::Expect4r::Router::Error::PingError.new(@host, target_ip_adress, pct_success, pct, tx, rx, output)
     end
+
   end
+
+private
+
+  def set_ping_base_matches(target_ip_address, arg={})
+    protocol          = arg[:protocol]      || ''
+    repeat_count      = arg[:repeat_count]  || arg[:count] || ''
+    datagram_size     = arg[:datagram_size] || arg[:size]  || ''
+    timeout           = arg[:timeout]       || ''
+    @matches << [/Protocol.+\: $/, protocol]
+    @matches << [/Target IP address\: $/, target_ip_address]
+    @matches << [/Repeat count.+\: $/, repeat_count]
+    @matches << [/Datagram size.+\: $/, datagram_size]
+    @matches << [/Timeout.+\: $/, timeout]
+  end
+
+  def set_ping_extended_matches(arg={})
+    extended_keys = [:source_address, :tos, :df, :pattern]
+    if (extended_keys & arg.keys).empty? and ! arg[:source_address]
+      @matches << [/Extended.+\: $/, '']
+    else
+      src_adr =  arg[:source_address]
+      tos     =  arg[:tos]     || ''
+      df      =  arg[:df]      || ''
+      pattern =  arg[:pattern] || ''
+      @matches << [/Extended.+\: $/, 'yes']
+      @matches << [/Source address or interface\: $/, src_adr]
+      @matches << [/Type of service.+\: $/, tos]
+      @matches << [/Set DF bit.+\: $/, df]
+      @matches << [/Data pattern.+\: $/, pattern]
+      @matches << [/Validate reply.+\: $/, '']     #TODO
+      @matches << [/Loose, Strict,.+\: $/, '']     #TODO
+    end
+  end
+
+  def set_ping_sweep_matches(arg={})
+    sweep_keys = [:sweep_min_size, :sweep_max_size, :sweep_interval]
+    if (sweep_keys & arg.keys).empty?
+      @matches << [/Sweep range of sizes.+: $/, 'no']
+    else
+      min_size = arg[:sweep_min_size] || ''
+      max_size = arg[:sweep_max_size] || ''
+      interval = arg[:sweep_interval] || ''
+      @matches << [/Sweep range of sizes.+: $/, 'yes']
+      @matches << [/Sweep min size.+\: $/, min_size]
+      @matches << [/Sweep max size.+\: $/, max_size]
+      @matches << [/Sweep interval.+\: $/, interval]
+    end
+  end
+
 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/common/show.rb

@@ -3,20 +3,13 @@ module Show
 
   def show(s, arg={})
     output = []
+    nlines = 0
     s.each_line { |l|
+      next unless l.strip.size>0
       output << exec("show #{l}", arg) if l.strip.size>0
+      nlines +=1
     }
-    output
-  end
-  
-  def method_missing(name, *args, &block)
-    if name.to_s =~ /^show_/
-      cmd = name.to_s.split('_').join(' ') + args.join(' ')
-      cmd.gsub!(/running config/, 'running-config')
-      output = __send__ :exec, cmd, *args
-    else
-      super
-    end
+    nlines > 1 ? output : output[0]
   end
   
 end

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

@@ -1,3 +1,5 @@
+require 'router/cisco/common/common'
+
 class Expect4r::Ios < ::Expect4r::BaseObject
   
   include Expect4r
@@ -59,7 +61,8 @@ class Expect4r::Ios < ::Expect4r::BaseObject
   end
   
   def error?(output)
-    string_start_with_pct_char?(output[-2]) || string_start_with_pct_char?(output[-3])
+    string_start_with_pct_char?(output[-2]) || 
+    string_start_with_pct_char?(output[-3])
   end
   
 end

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

@@ -1,3 +1,6 @@
+
+require 'router/cisco/common/common'
+
 class Expect4r::Iox < ::Expect4r::BaseObject
   
   include Expect4r
@@ -28,14 +31,14 @@ class Expect4r::Iox < ::Expect4r::BaseObject
     if /\% Failed to commit/.match(output.join)
       err = show_configuration_failed
       abort_config
-      raise Iox::SemanticError.new(show_configuration_failed)
+      raise Iox::SemanticError.new(self.class.to_s, show_configuration_failed)
     end
     output
   end
   
   def putline(line,*args)
     output, rc = super
-    raise SyntaxError.new(line) if output.join =~ /\% Invalid input detected at/
+    raise SyntaxError.new(self.class.to_s, line) if output.join =~ /\% Invalid input detected at/
     output
   end
 

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

@@ -5,6 +5,7 @@ class Expect4r::J < ::Expect4r::BaseObject
   include Expect4r::Router::Common::Modes
   include Expect4r::Router::Junos::Modes
   include Expect4r::Router::Junos::Show
+  include Expect4r::Router::Junos::Ping
   
   def initialize(*args)
     super

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

@@ -0,0 +1,120 @@
+require 'router/error'
+
+module Expect4r::Router::Junos
+module Ping
+
+  def ping(host, arg={})
+
+    pct_success = arg.delete(:pct_success) || 99
+
+    output = exec(ping_cmd(host, arg), arg)
+
+    r = output[0].find { |x| p x ; x =~/(\d+) packets transmitted, (\d+) packets received, (\d+)\% packet loss/}
+
+    if r && 
+      Regexp.last_match(1) && 
+      Regexp.last_match(2) && 
+      Regexp.last_match(3)
+
+      success = 100 - $3.to_i
+      tx = $2.to_i
+      rx = $3.to_i
+      
+      if (100 - $3.to_i) < pct_success
+        raise ::Expect4r::Router::Error::PingError.new(@host, host, pct_success, tx, rx, output)
+      else
+        [$1.to_i,[$2.to_i,$3.to_i],output]
+      end
+
+    else
+      raise ::Expect4r::Router::Error::PingError.new(@host, host, pct_success, $1.to_i, tx, rx, output)
+    end
+
+  end
+
+private
+
+  def ping_cmd(host, arg={})
+    cmd = "ping #{host}"
+    cmd += " rapid"
+    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]
+    cmd += " tos #{arg[:tos]}"                            if arg[:tos]
+    cmd += " ttl #{arg[:ttl]}"                            if arg[:ttl]
+    cmd
+  end
+
+end
+end
+
+__END__
+
+
+if __FILE__ == $0
+  
+  module Expect4r
+    module Router
+      module Junos
+      end
+    end
+  end
+
+end
+
+if __FILE__ == $0
+    
+  require "test/unit"
+
+  class TestLibraryFileName < Test::Unit::TestCase
+    include Expect4r::Router::Junos::Ping
+    def test_case_name
+      
+      assert_equal 'ping 1.1.1.1 rapid', ping_cmd( '1.1.1.1')
+      assert_equal 'ping 1.1.1.1 rapid size 256', ping_cmd( '1.1.1.1', :size=>256)
+      assert_equal 'ping 1.1.1.1 rapid size 256', ping_cmd( '1.1.1.1', :datagram_size=>256)
+      assert_equal 'ping 1.1.1.1 rapid pattern 0xdead', ping_cmd( '1.1.1.1', :pattern=>'0xdead')
+      assert_equal 'ping 1.1.1.1 rapid tos 2', ping_cmd( '1.1.1.1', :tos=>2)
+      assert_equal 'ping 1.1.1.1 rapid ttl 2', ping_cmd( '1.1.1.1', :ttl=>2)
+      
+    end
+  end
+  
+end
+
+
+__END__
+
+5 packets transmitted, 5 packets received, 0% packet loss
+round-trip min/avg/max/stddev = 1.483/17.024/78.904/30.940 ms
+
+
+
+Possible completions:
+  <host>               Hostname or IP address of remote host
+  atm                  Ping remote Asynchronous Transfer Mode node
+  bypass-routing       Bypass routing table, use specified interface
+  count                Number of ping requests to send (1..2000000000 packets)
+  detail               Display incoming interface of received packet
+  do-not-fragment      Don't fragment echo request packets (IPv4)
+  inet                 Force ping to IPv4 destination
+  inet6                Force ping to IPv6 destination
+  interface            Source interface (multicast, all-ones, unrouted packets)
+  interval             Delay between ping requests (seconds)
+  logical-router       Name of logical router
++ loose-source         Intermediate loose source route entry (IPv4)
+  mpls                 Ping label-switched path
+  no-resolve           Don't attempt to print addresses symbolically
+  pattern              Hexadecimal fill pattern
+  rapid                Send requests rapidly (default count of 5)
+  record-route         Record and report packet's path (IPv4)
+  routing-instance     Routing instance for ping attempt
+  size                 Size of request packets (0..65468 bytes)
+  source               Source address of echo request
+  strict               Use strict source route option (IPv4)
++ strict-source        Intermediate strict source route entry (IPv4)
+  tos                  IP type-of-service value (0..255)
+  ttl                  IP time-to-live value (IPv6 hop-limit value) (hops)
+  verbose              Display detailed output
+  vpls                 Ping VPLS MAC address
+  wait                 Delay after sending last packet (seconds)

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
+  - 2
   - dev
-  version: 0.0.1.dev
+  version: 0.0.2.dev
 platform: ruby
 authors: 
 - Jean-Michel Esnault
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-24 00:00:00 -07:00
+date: 2010-10-25 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, IosXR, and Junos CLI.
+description: A Ruby Library for interacting with IOS, IOS-XR, and JUNOS CLI.
 email: jesnault@gmail.com
 executables: []
 
@@ -61,10 +61,11 @@ files:
 - lib/router/error.rb
 - lib/router/juniper/junos/junos.rb
 - lib/router/juniper/junos/modes.rb
+- lib/router/juniper/junos/ping.rb
 - lib/router/juniper/junos/show.rb
 - lib/router/modes.rb
 has_rdoc: true
-homepage: 
+homepage: http://github.com/jesnault/expect4r
 licenses: []
 
 post_install_message: