expect4r 0.0.1.dev

data/lib/expect4r.rb

@@ -0,0 +1,49 @@
+require 'expect/io'
+require 'misc/passwd'
+
+module Expect4r
+
+  autoload :Iox,    'router/cisco/iox/iox'
+  autoload :Ios,    'router/cisco/ios/ios'
+  autoload :J,      'router/juniper/junos/junos'
+  autoload :Shell,  'misc/shell'
+
+  module Router
+    autoload :Common, 'router/common'
+    module Common
+      autoload :Modes, 'router/modes'
+    end
+    module Error
+      autoload :RouterError,    'router/error'
+      autoload :SyntaxError,    'router/error'
+      autoload :SemanticError,  'router/error'
+      autoload :PingError,      'router/error'
+    end
+    module CiscoCommon
+      autoload :Show, 'router/cisco/common/show'
+      autoload :Ping, 'router/cisco/common/ping'
+    end
+    module Ios
+      autoload :TermServer, 'router/cisco/ios/termserver'
+      autoload :Modes, 'router/cisco/ios/modes'
+    end
+    module Iox
+      autoload :Modes, 'router/cisco/iox/modes'
+    end
+    module Junos
+      autoload :Modes, 'router/juniper/junos/modes'
+      autoload :Show, 'router/juniper/junos/show'
+    end
+  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/passwd.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'openssl'
+require 'digest/sha1'
+module Expect4r
+  def self.cipher(this, pwd='expect4r')
+    c = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+    c.encrypt
+    c.key = key = Digest::SHA1.hexdigest(pwd)
+    e = c.update(this)
+    e << c.final
+  end
+  def self.decipher(cipher,pwd='expect4r')
+    c = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+    c.decrypt
+    c.key = key = Digest::SHA1.hexdigest(pwd)
+    d = c.update(cipher)
+    d << c.final
+  end
+end

data/lib/misc/shell.rb

@@ -0,0 +1,19 @@
+require 'expect/io'
+
+module Expect4r
+
+  class Shell
+    include Expect4r
+    def initialize()
+      ENV['PROMPT_COMMAND']="date +%k:%m:%S"
+      ENV['PS1']="shell>"
+      @ps1 = /shell>$/
+      @shell = ENV['SHELL'] || 'bash'
+      login
+    end
+    def login
+      spawn @shell
+    end
+  end
+
+end

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

@@ -0,0 +1,25 @@
+
+module Expect4r::Router
+module CiscoCommon
+  
+  def config_lvl?
+    return -1 unless config?
+    @lp =~ /\(config(|.+)\)/
+    lvl = Regexp.last_match(1).split('-').size
+    lvl == 0 ? 1 : lvl
+  end
+  
+  def top
+    return unless config?
+    1.upto(config_lvl? - 1) { putline 'exit'}
+  end
+  
+  def top?
+    return false unless config?
+    @lp =~ /\(config(|.+)\)/
+    Regexp.last_match(1).size == 0
+  end
+    
+end
+end
+

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

@@ -0,0 +1,39 @@
+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]
+    else
+      raise ArgumentError, "Invalid argument: #{arg.inspect}"
+    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
+       
+    else
+      raise PingError.new('router name here', dest, pct_success, $1.to_i, $2.to_i,$3.to_i, output)
+    end
+  end
+end
+end

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

@@ -0,0 +1,23 @@
+module Expect4r::Router::CiscoCommon
+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(' ')
+      cmd.gsub!(/running config/, 'running-config')
+      output = __send__ :exec, cmd, *args
+    else
+      super
+    end
+  end
+  
+end
+end

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

@@ -0,0 +1,65 @@
+class Expect4r::Ios < ::Expect4r::BaseObject
+  
+  include Expect4r
+  include Expect4r::Router::Common
+  include Expect4r::Router::Common::Modes
+  include Expect4r::Router::Ios::Modes
+  include Expect4r::Router::CiscoCommon
+  include Expect4r::Router::CiscoCommon::Show
+  include Expect4r::Router::CiscoCommon::Ping
+  include Expect4r::Router::Ios::TermServer
+  
+  def initialize(*args)
+    super
+    @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
+    @enable_password ||= @pwd  # FIXME
+    Expect4r.decipher(@pwd)    # password is ciphered ...
+  end
+  
+  def login
+    super(spawnee)
+    enable
+    exec "term len 0\nterm width 0"
+    self
+  end
+  
+  def putline(line,*args)
+    output, rc = super
+    return output unless error?(output)
+    raise SyntaxError.new(self.class.to_s,line)
+  end
+  
+  private
+  
+  if "a"[0]==97
+    def string_start_with_pct_char?(s)
+      return unless s
+      s[0].chr == '%' if s[0]
+    end
+  else
+    def string_start_with_pct_char?(s)
+      return unless s
+      s[0] == '%'
+    end
+  end
+  
+  def error?(output)
+    string_start_with_pct_char?(output[-2]) || string_start_with_pct_char?(output[-3])
+  end
+  
+end

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

@@ -0,0 +1,97 @@
+require 'router/modes'
+
+module Expect4r::Router::Ios
+module Modes
+  
+  def in?(mode=:none)
+    login unless connected?
+    case mode
+    when :exec    ; exec?
+    when :user    ; user?
+    when :config  ; config?
+    else
+      _mode_?
+    end
+  end
+  
+  
+  def config(config=nil, arg={})
+    login unless connected?
+    if config
+      mode = in?
+      change_mode_to :config
+      output = exp_send(config, arg)
+      change_mode_to mode
+      output
+    else
+      change_mode_to :config
+    end
+  end
+
+  def exec(cmd=nil, arg={})
+    login unless connected?
+    if cmd.nil?
+      change_mode_to :exec
+    else
+      if exec?
+        output = exp_send(cmd, arg)
+      elsif config?
+        output = exp_send("do #{cmd}", arg)
+      else
+        mode = in?
+        change_mode_to :exec
+        output = exp_send(cmd, arg)
+        change_mode_to mode
+        output
+      end
+    end
+  end
+  
+  def _mode_?
+     if user? 
+       :user
+     elsif config?
+       :config
+     elsif exec?
+       :exec
+     end
+   end
+   
+  def config?
+    @lp =~ /\(config(|.+)\)/
+  end
+  
+  def exec?
+    ! user? and ! config?
+  end
+  
+  def user?
+    @lp =~ /.+>\s*$/
+  end
+    
+  def to_config
+    return :config if config?
+    to_exec
+    putline 'configure terminal' if exec?
+    raise RuntimeError, "unable to got to config mode" unless config?
+    :config
+  end
+  
+  def to_exec
+    return :exec if exec?
+    if config?
+      1.upto(config_lvl?) { putline 'exit'}
+    end
+    raise RuntimeError, "unable to got to exec mode" unless exec?
+    :exec
+  end
+
+  def to_user
+    return if user?
+    putline "exit"
+    raise RuntimeError, "unable to got to user mode" unless exec?
+    :user
+  end
+  
+end
+end

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

@@ -0,0 +1,20 @@
+module Expect4r::Router::Ios
+module TermServer
+  
+  def powercycle(lineno)
+    config "line #{lineno}\nmodem dtr\nmodem dtr-active"
+    sleep 2
+    config "line #{lineno}\nno modem dtr\nno modem dtr-active"
+  end
+  def clear_line(lineno)
+    confirm = [/\[confirm\]/, ""]
+    @matches << confirm
+    putline "clear line #{lineno}"
+  rescue Expect4r::Router::Error::SyntaxError => e
+    puts e.err_msg
+  ensure
+    @matches.delete confirm
+  end
+  
+end
+end

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

@@ -0,0 +1,54 @@
+class Expect4r::Iox < ::Expect4r::BaseObject
+  
+  include Expect4r
+  include Expect4r::Router
+  include Expect4r::Router::Common
+  include Expect4r::Router::Common::Modes
+  include Expect4r::Router::CiscoCommon
+  include Expect4r::Router::Iox::Modes
+  include Expect4r::Router::CiscoCommon::Show
+  include Expect4r::Router::CiscoCommon::Ping
+  
+  def initialize(*args)
+    super
+    @ps1 = /(.*)(>|#|\$)\s*$/
+    @more = / --More-- /
+  end
+  
+  def login
+    super(spawnee)
+    config 'no logging console' if port>0
+    exec "terminal len 0\nterminal width 0"
+    self
+  end
+  
+  def commit(arg={})
+    return unless config?
+    output = putline "commit", arg
+    if /\% Failed to commit/.match(output.join)
+      err = show_configuration_failed
+      abort_config
+      raise Iox::SemanticError.new(show_configuration_failed)
+    end
+    output
+  end
+  
+  def putline(line,*args)
+    output, rc = super
+    raise SyntaxError.new(line) if output.join =~ /\% Invalid input detected at/
+    output
+  end
+
+  private
+  
+  def abort_config
+    return unless config?
+    putline 'abort' # make sure buffer config is cleaned up.
+    nil
+  end
+
+  def show_configuration_failed
+    putline 'show configuration failed'
+  end
+  
+end

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

@@ -0,0 +1,101 @@
+require 'router/modes'
+
+module Expect4r::Router::Iox
+module Modes
+
+  def config(config=nil, arg={})
+    login unless connected?
+    if config
+      mode = in?
+      change_mode_to :config
+      output = exp_send(config, arg)
+      output << commit
+      change_mode_to mode
+      output
+    else
+      change_mode_to :config
+    end
+  end
+
+  def exec(cmd=nil, arg={})
+    login unless connected?
+    if cmd.nil?
+      change_mode_to :exec
+    else
+      if exec?
+        output = exp_send(cmd, arg)
+      elsif config?
+        output = exp_send("do #{cmd}", arg)
+      else
+        mode = in?
+        change_mode_to :exec
+        output = exp_send(cmd, arg)
+        change_mode_to mode
+        output
+      end
+    end
+  end
+
+  def shell(cmd=nil, arg={})
+    connected = connected?
+    login unless connected?
+    if cmd.nil?
+      to_shell
+    else
+      if shell?
+        output = exp_send(cmd, arg)        
+      elsif config?
+        output = exp_send("do run #{cmd}", arg)
+      elsif exec?
+        output = exp_send("run #{cmd}", arg)
+      else
+        raise RuntimeError # TODO
+      end
+      output
+    end
+  end
+
+  def config?
+    @lp =~ /\(config(|.+)\)/
+  end
+  
+  def submode?
+    return '' unless config?
+     @lp =~ /\(config(|.+)\)/
+     Regexp.last_match(1).split('-')[1..-1].join('-')
+  end
+  
+  def exec?
+    ! shell? and ! config?
+  end
+
+  def shell?
+    @lp == '# '
+  end
+
+  def to_config
+    return :config if config?
+    to_exec
+    putline 'configure'
+    raise RuntimeError, "unable to got to config mode" unless config?
+    :config
+  end
+
+  def to_shell
+    return :shell if shell?
+    to_exec
+    putline 'run'
+    raise RuntimeError, "unable to got to shell mode" unless shell?
+    :shell
+  end
+
+  def to_exec
+    return :exec if exec?
+    putline "exit"  if shell?
+    putline "abort" if config?
+    raise RuntimeError, "unable to got to exec mode" unless exec?
+    :exec
+  end
+
+end
+end