expect4r 0.0.7.dev → 0.0.8

data/lib/expect/io.rb

@@ -119,6 +119,7 @@ module Expect4r
   
   def logout
     child_exit
+    @lp, @_lp_1 = nil,nil
     @pid
   end
   
@@ -150,11 +151,13 @@ module Expect4r
     raise
   end
 
-  def interact(k=?\C-z)
+  def interact(k="C-z")
+    k.upcase!
+    raise unless k =~ /C\-[A-Z]/
     login unless connected?
-    STDOUT.puts "\n\#\n\# #{ctrl_key k} to terminate.\n\#\n"
+    STDOUT.puts "\n\#\n\# #{k.gsub(/C\-/,'^')} to terminate.\n\#\n"
     reader :start
-    writer k
+    writer(eval "?\\#{k}")
   rescue
   ensure
     begin
@@ -228,74 +231,6 @@ module Expect4r
   def get_prompt
     putline '', :no_trim=>true, :no_echo=>true
   end
-  
-  def putline(line, arg={})
-    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]
-    unless arg[:no_trim]==true
-      line = line.gsub(/\s+/,' ').gsub(/^\s+/,'')
-      if line.size==0 
-        log "DEBUG PUTLINE: NOT SENDING **** line = '#{line.inspect}' arg=#{arg.inspect}"
-        return [[], :empty_line]
-      end
-    end
-    sync if arg[:sync]
-    t0 = Time.now
-    exp_puts line
-    output=[]
-    rc, buf = catch(:done) do
-      @r.readbuf(arg[:ti]) do |r|
-        if r._io_exit?
-          r._io_save(no_echo)
-          throw :done, [ :abort,  r._io_buf1]
-        end
-        case r._io_string
-        when @ps1, @ps1_bis
-          unless r._io_more?
-            r._io_save no_echo, "matching PROMPT"
-            # puts  "debug IO BUF 1 #{r._io_buf1.inspect}"
-            throw(:done, [:ok, r._io_buf1])
-          end
-          exp_internal "more..."
-        when /(.+)\r\n/, "\r\n"
-          r._io_save no_echo, "matching EOL"
-        when @more
-          r._io_save no_echo, "matching MORE"
-          putc ' '
-        else
-          # For objects that include Expect4r but do not subclass base Login class.
-          @matches ||= []
-          @matches.each { |match, _send|
-            if r._io_string =~ match
-              r._io_save no_echo, "match #{match}"
-              if _send.is_a?(Proc)
-                _send.call(self)
-              else
-                exp_puts _send
-              end
-            end
-          }
-        end
-      end
-    end
-
-    case rc
-    when :abort
-      elapsed = Time.now - t0
-      if elapsed < ti
-        child_exit
-        raise ConnectionError.new(line)
-      else
-        raise ExpTimeoutError.new(line, elapsed)
-      end
-    else
-      @lp = buf.last
-    end
-    [buf, rc]
-  end
 
   def readline(ti=0.2, matches=[])
     ret = expect(/(.+)\r\n/, ti, matches)
@@ -383,6 +318,7 @@ module Expect4r
       err_msg += buf.join("\n    ")
       raise ConnectionError.new(err_msg)
     else
+      @_lp_1 = buf[-2]
       @lp = buf.last
     end
     [buf, ev]
@@ -457,17 +393,11 @@ module Expect4r
         raise ExpTimeoutError.new(line, elapsed)
       end
     else
+      @_lp_1 = buf[-2]
       @lp = buf.last
     end
     [buf, rc]
   end
-  def ctrl_key(k)
-    case k
-    when ?\C-c ; '^C'
-    when ?\C-q ; '^Q'
-    when ?\C-z ; '^Z'
-    end
-  end
 
   def writer(k)
     stty_raw
@@ -494,6 +424,7 @@ module Expect4r
             break if c.nil?
             STDOUT.putc c
           end
+        rescue Errno::EIO
         rescue => e
           p e
           p '7777777'

data/lib/expect4r.rb

@@ -6,6 +6,7 @@ module Expect4r
   autoload :Iox,    'router/cisco/iox/iox'
   autoload :Ios,    'router/cisco/ios/ios'
   autoload :J,      'router/juniper/junos/junos'
+  autoload :V,      'router/vyatta/vyatta'
   autoload :Shell,  'misc/shell'
   autoload :RShell, 'misc/shell'
 
@@ -31,6 +32,11 @@ module Expect4r
     module Iox
       autoload :Modes, 'router/cisco/iox/modes'
     end
+    module Vyatta
+      autoload :Modes, 'router/vyatta/modes'
+      autoload :Ping, 'router/vyatta/ping'
+      autoload :Show, 'router/vyatta/show'
+    end
     module Junos
       autoload :Modes, 'router/juniper/junos/modes'
       autoload :Show,  'router/juniper/junos/show'

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

@@ -27,7 +27,7 @@ module Ping
   #   :size=> 512
   #   :protocol=> 'ipv4', :count=> 20, :size=> 1500, :timeout=>5
   #
-  def ping(target_ip_address, arg={})
+  def ping(target_ip_address, arg={}, &on_error)
 
     pct_success = arg.delete(:pct_success) || 99
 
@@ -47,7 +47,8 @@ module Ping
 
     end
 
-    r = output[0].find { |x| x =~/Success.*[^\d](\d+) percent \((\d+)\/(\d+)\)/}
+    # r = output[0].find { |x| x =~/Success.*[^\d](\d+) percent \((\d+)\/(\d+)\)/}
+    r = output.join  =~/Success.*[^\d](\d+) percent \((\d+)\/(\d+)\)/
 
     if r && 
       Regexp.last_match(1) && 
@@ -65,7 +66,13 @@ module Ping
       end
 
     else
-      raise ::Expect4r::Router::Error::PingError.new(@host, target_ip_adress, pct_success, pct, tx, rx, output)
+
+      if on_error
+        on_error.call(self)
+      else
+        raise ::Expect4r::Router::Error::PingError.new(@host, target_ip_address, pct_success, pct, tx, rx, output)
+      end
+    
     end
 
   end

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

@@ -21,7 +21,7 @@ module Ping
   #   :size=> 512
   #   :protocol=> 'ipv4', :count=> 20, :size=> 1500, :timeout=>5, :ttl=>16
   #
-  def ping(host, arg={})
+  def ping(host, arg={}, &on_error)
 
     pct_success = arg.delete(:pct_success) || 99
 
@@ -45,7 +45,11 @@ module Ping
       end
 
     else
-      raise ::Expect4r::Router::Error::PingError.new(@host, host, pct_success, $1.to_i, tx, rx, output)
+      if on_error
+        on_error.call(self)
+      else
+        raise ::Expect4r::Router::Error::PingError.new(@host, host, pct_success, $1.to_i, tx, rx, output)
+      end
     end
 
   end

data/lib/router/vyatta/modes.rb

@@ -0,0 +1,124 @@
+require 'router/modes'
+
+module Expect4r::Router::Vyatta
+module Modes
+
+# Adds a Vyatta <tt>config</tt> mixin.
+#
+# Example:
+#
+#  c.config %{
+#    edit protocols bgp 100
+#      set neighbor 192.168.129.1
+#      set neighbor 192.168.129.1 capability orf prefix-list receive
+#      set neighbor 192.168.129.1 ebgp-multihop 10
+#      set neighbor 192.168.129.1 remote-as 200
+#  }
+#
+def config(stmts=nil, arg={})
+  login unless connected?
+  if stmts
+    mode = in?
+    to_config
+    output = exp_send(stmts, arg)
+    output << commit
+    change_mode_to(mode)
+    output.flatten
+  else
+    to_config
+  end
+end
+
+# Adds a Vyatta <tt>exec</tt> mixin.
+#
+# Example:
+#
+#   v.exec 'set cli screen-length 0'
+#
+def exec(cmd=nil, *args)
+  login unless connected?
+  if cmd.nil?
+    to_exec
+  else
+    if config?
+      exp_send("run #{cmd}", *args)
+    elsif exec?
+      exp_send cmd, *args
+    else
+      mode = _mode_?
+      to_exec
+      output = exp_send(cmd, *args)
+      change_mode_to mode
+      output
+    end
+  end
+end
+
+def exec?
+  if logged_as_root?
+    ! config?
+  else
+    @lp =~ /\$ $/ ? true : false
+  end
+end
+
+def config?
+  if logged_as_root?
+     @_lp_1 =~ /\[edit\]/ ? true : false
+  else
+    @lp =~ /^.+# $/ ? true : false
+  end
+end
+
+def in?(mode=:none)
+  login unless connected?
+  case mode
+  when :exec    ; exec?
+  when :config  ; config?
+  else
+    _mode_?
+  end
+end
+
+def to_config
+  return :config if config?
+  to_exec
+  putline 'configure', :debug=>1
+  raise RuntimeError, "unable to get to config mode" unless config?
+  :config
+end
+
+def to_exec
+  return :exec if exec?
+  top if config?
+  exit
+  raise RuntimeError, "unable to get to exec mode" unless exec?
+  :exec
+end
+
+def change_mode_to(mode)
+  login unless connected?
+  case mode
+  when :exec    ;  to_exec
+  when :config  ;  to_config
+  end
+end
+
+private
+
+def logged_as_root?
+  ! (@_is_root_ ||=  (@user=='root' and @lp =~ /root@/)).nil?
+end
+
+def _mode_?
+  putline ' ', :no_trim=>true, :no_echo=>true unless @lp
+  if exec? 
+    :exec
+  elsif config?
+    :config
+  else
+  end
+end
+
+end
+end

data/lib/router/vyatta/ping.rb

@@ -0,0 +1,96 @@
+require 'router/error'
+
+module Expect4r::Router::Vyatta
+module Ping
+
+  # Adds a ping method to V 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
+  # Example:
+  #    v.ping('192.168.129.1', :count=>10, :size=>256)  { |r| r.interact }
+  #--
+  # PING 192.168.129.1 (192.168.129.1) 56(84) bytes of data.
+  # 64 bytes from 192.168.129.1: icmp_req=1 ttl=64 time=0.173 ms
+  # 64 bytes from 192.168.129.1: icmp_req=2 ttl=64 time=0.132 ms
+  # 64 bytes from 192.168.129.1: icmp_req=3 ttl=64 time=0.144 ms
+  # 64 bytes from 192.168.129.1: icmp_req=4 ttl=64 time=0.128 ms
+  # 64 bytes from 192.168.129.1: icmp_req=5 ttl=64 time=0.225 ms
+  #
+  # --- 192.168.129.1 ping statistics ---
+  # 5 packets transmitted, 5 received, 0% packet loss, time 3996ms
+  # rtt min/avg/max/mdev = 0.128/0.160/0.225/0.037 ms
+  # vyatta@vyatta2:~$ 
+  #++
+  def ping(host, arg={}, &on_error)
+
+    pct_success = arg.delete(:pct_success) || 99
+
+    output = exp_send(ping_cmd(host, arg), arg)
+
+    r = output[0].find { |x| x =~/(\d+) packets transmitted, (\d+) 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
+
+      if on_error
+        on_error.call(self)
+      else
+        raise ::Expect4r::Router::Error::PingError.new(@host, host, pct_success, $1.to_i, tx, rx, output)
+      end
+
+    end
+
+  end
+
+private
+
+  # vyatta@vyatta2:~$ /bin/ping 
+  # Usage: ping [-LRUbdfnqrvVaAD] [-c count] [-i interval] [-w deadline]
+  #             [-p pattern] [-s packetsize] [-t ttl] [-I interface]
+  #             [-M pmtudisc-hint] [-m mark] [-S sndbuf]
+  #             [-T tstamp-options] [-Q tos] [hop1 ...] destination
+  def ping_cmd(host, arg={})
+    arg = {:count=>5}.merge(arg)
+    cmd = "/bin/ping"
+    cmd += " -c #{arg[:count] || arg[:repeat_count]}"   if arg[:count] || arg[:repeat_count]
+    cmd += " -s #{arg[:size]   || arg[:datagram_size]}" if arg[:size]  || arg[:datagram_size] 
+    cmd += " -p #{arg[:pattern]}"                       if arg[:pattern]
+    cmd += " -Q #{arg[:tos]}"                           if arg[:tos]
+    cmd += " -t #{arg[:ttl]}"                           if arg[:ttl]
+    cmd += " -S #{arg[:sndbuf]}"                        if arg[:sndbuf]
+    cmd += " -c #{arg[:intf] || arg[:interface]}"       if arg[:intf] || arg[:interface]
+    cmd += " -w #{arg[:deadline]}"                      if arg[:deadline]
+    cmd += " #{host}"
+    cmd
+  end
+
+end
+end

data/lib/router/vyatta/show.rb

@@ -0,0 +1,23 @@
+
+module Expect4r::Router::Vyatta
+module Show
+
+  def show(s, arg={})
+    output = []
+    s.each_line { |l|
+      output << exec("show #{l}", arg) if l.strip.size>0
+    }
+    output
+  end
+  
+  def method_missing(name, *args, &block)
+    if name.to_s =~ /^show_/
+      cmd = name.to_s.split('_').join(' ') + args.join(' ')
+      output = __send__ :exec, cmd, *args
+    else
+      super
+    end
+  end
+  
+end
+end

data/lib/router/vyatta/vyatta.rb

@@ -0,0 +1,74 @@
+class Expect4r::V < ::Expect4r::BaseLoginObject
+  include Expect4r
+  include Expect4r::Router::Error
+  include Expect4r::Router::Common
+  include Expect4r::Router::Common::Modes
+  include Expect4r::Router::Vyatta::Modes
+  include Expect4r::Router::Vyatta::Ping
+  include Expect4r::Router::Vyatta::Show
+
+  class << self
+    # v = V.new_telnet 'hostname'
+    def new_telnet(*args)
+      if args.size==1 and args[0].is_a?(String)
+        super :host=> args[0], :user=>'vyatta', :pwd=>'vyatta'
+      else
+        super
+      end
+    end
+
+    # v = V.new_ssh 'hostname'
+    def new_ssh(*args)
+      if args.size==1 and args[0].is_a?(String)
+        super :host=> args[0], :user=>'vyatta', :pwd=>'vyatta'
+      else
+        super
+      end
+    end
+  end
+  
+  def initialize(*args)
+    super
+    @ps1 = /([A-z\d]+)@([A-z\d]+)(:[^\$]+|)(#|\$) $/
+  end
+  
+  def login(arg={})
+    super(spawnee, arg)
+    putline "terminal length 0"
+    putline "terminal width 0"
+    self
+  end
+  alias :_login_ :login
+  
+  def putline(line,arg={})
+    o, rc = super
+    raise SyntaxError.new(self.class.to_s, line) if o.join =~ /(% unknown|Invalid command)/
+    o
+  end
+  
+  def top
+    putline 'top'
+  end
+  
+  def exit
+    putline 'exit'
+  end
+    
+  def exit_discard
+    putline 'exit discard'
+  end
+    
+  def commit(arg={})
+    return unless config?
+    @matches << [/Exit with uncommitted changes.+\(yes\)/, 'yes']
+    output = putline "commit", arg
+    if /error: configuration check-out failed/.match(output.join)
+      rollack
+      raise SemanticError.new(self.class.to_s, output)
+    end
+    output
+  end
+  
+  private
+
+end

metadata

@@ -1,47 +1,35 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: expect4r
-version: !ruby/object:Gem::Version 
-  prerelease: true
-  segments: 
-  - 0
-  - 0
-  - 7
-  - dev
-  version: 0.0.7.dev
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jean-Michel Esnault
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-16 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: highline
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 0
+  requirement: &70302466268900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *70302466268900
 description: A Ruby Library for interacting with IOS, IOS-XR, and JUNOS  CLI.
 email: jesnault@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - COPYING
 - LICENSE
 - README.rdoc
@@ -67,44 +55,42 @@ files:
 - lib/router/juniper/junos/ping.rb
 - lib/router/juniper/junos/show.rb
 - lib/router/modes.rb
-has_rdoc: true
+- lib/router/vyatta/modes.rb
+- lib/router/vyatta/ping.rb
+- lib/router/vyatta/show.rb
+- lib/router/vyatta/vyatta.rb
+- test/expect4r_test.rb
+- test/misc/passwd_test.rb
+- test/router/cisco/iox/iox_test.rb
 homepage: http://github.com/jesnault/expect4r
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --quiet
 - --title
 - Expect4r
 - --line-numbers
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 6
+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 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Expect4r
-test_files: 
+test_files:
 - test/expect4r_test.rb
 - test/misc/passwd_test.rb
 - test/router/cisco/iox/iox_test.rb