expect4r 0.0.1.dev

data/lib/router/common.rb

@@ -0,0 +1,42 @@
+
+require 'rubygems'
+require 'highline/import'
+require 'misc/passwd'
+
+module Expect4r::Router
+module Common
+
+  def console?
+    @port.to_i > 0
+  end
+
+  def io_escape_char_cb
+    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/error.rb

@@ -0,0 +1,76 @@
+module Expect4r::Router
+module Error
+  class RouterError < RuntimeError
+    def initialize(rname, msg)
+      @rname = rname
+      @msg = msg
+    end
+    def err_msg
+      "#{@rname} [Error] : #{@msg}"
+    end
+  end
+
+  class SyntaxError < RouterError
+    def err_msg
+      "#{@rname} [SyntaxError] : #{@msg}"
+    end
+  end
+
+  class SemanticError < RouterError
+    def err_msg
+      "#{@rname} [SemanticError] : #{@msg}"
+    end
+  end
+
+  class PingError < RuntimeError
+    attr_reader :rname, :dest, :exp_pct, :act_pct, :sent, :recv
+    def initialize(rname, dest, exp_pct, act_pct, sent, recv, output)
+      @rname, @dest, @exp_pct, @act_pct, @sent, @recv = rname, dest, exp_pct, act_pct, sent, recv
+    end
+    def err_msg
+      "#{@rname} [PingError] : failed to ping #{@dest}, expected/actual pct: #{@exp_pct}/#{@act_pct}"
+    end
+  end
+end
+end
+
+
+if __FILE__ == $0
+
+  require "test/unit"
+
+  # require "router/error"
+
+  class TestRouterError < Test::Unit::TestCase
+    include Expect4r::Router::Error
+    def test_raise
+      assert_raise(RouterError) {raise RouterError.new('paris','show bogus command')} 
+      assert_err_msg 'paris [Error] : show bogus command', lambda {raise RouterError.new('paris','show bogus command')}
+      assert_err_msg 'paris [SyntaxError] : show bogus command', lambda {raise SyntaxError.new('paris','show bogus command')}
+      assert_err_msg 'paris [SemanticError] : show bogus command', lambda {raise SemanticError.new('paris','show bogus command')}
+      assert_err_msg 'paris [PingError] : failed to ping 1.1.1.1, expected/actual pct: 100/90', lambda {raise PingError.new('paris','1.1.1.1', 100, 90, 10, 9, '')}
+      assert_equal 100, exception(lambda {raise PingError.new('paris','1.1.1.1', 100, 90, 10, 9,'')}).exp_pct
+      assert_equal 'paris', exception(lambda {raise PingError.new('paris','1.1.1.1', 100, 90, 10, 9,'')}).rname
+    end
+
+    private
+
+    def assert_err_msg(err_msg, block)
+      begin 
+        block.call 
+      rescue RouterError, PingError => re
+        assert_equal err_msg, re.err_msg
+      end
+    end
+
+    def exception(block)
+      begin 
+        block.call 
+      rescue RouterError, PingError => re
+        re
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,53 @@
+class Expect4r::J < ::Expect4r::BaseObject
+  include Expect4r
+  include Expect4r::Router::Error
+  include Expect4r::Router::Common
+  include Expect4r::Router::Common::Modes
+  include Expect4r::Router::Junos::Modes
+  include Expect4r::Router::Junos::Show
+  
+  def initialize(*args)
+    super
+    @ps1 = /(^|\r\r)([-a-zA-z@_~=\.\(\)\d]+(>|\#|%)|%|\$) $/
+    @more =  /---\(more(| \d+\%)\)---/
+  end
+  
+  def login
+    ENV['TERM']='dumb'
+    super(spawnee)
+    exec 'set cli screen-length 0'
+    self
+  end
+  
+  def console?
+    @port>0
+  end
+  
+  def putline(line,arg={})
+    o, rc = super
+    raise SyntaxError.new(self.class.to_s, line) if o.join =~ /(unknown command|syntax error)\./
+    o
+  end
+  
+  def top
+    putline 'top'
+  end
+  
+  def exit
+    putline 'exit'
+  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)
+      putline 'rollback'
+      raise SemanticError.new(self.class.to_s, output)
+    end
+    output
+  end
+  
+  private
+
+end

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

@@ -0,0 +1,109 @@
+require 'router/modes'
+
+module Expect4r::Router::Junos
+module Modes
+
+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
+  else
+    mode
+  end
+end
+
+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 shell(cmd=nil, *args)
+  connected = connected?
+  login unless connected?
+  if cmd.nil?
+    to_shell
+  else
+    mode = _mode_?
+    to_shell
+    output = exp_send(cmd, *args)
+    change_mode_to mode
+    output
+  end
+end
+
+def exec?
+  @lp =~ /> $/ ? true : false
+end
+
+def config?
+  @lp =~ /^.+# $/ ? true : false
+end
+
+def shell?
+  @lp == '% ' ? true : false
+end
+
+def set_cli_logical_router(logical_router)
+  return if @ps1_bis
+  to_exec
+  arr= @lp.split(">")
+  @ps1_bis = /#{arr[0]}:#{logical_router}(\#|>)\s*$/
+  p @ps1_bis
+  putline "set cli logical-router #{logical_router}"
+end
+
+def clear_cli_logical_router()
+  return unless @ps1_bis
+  to_exec
+  @ps1_bis=nil
+  putline "clear cli logical-router"
+end
+
+private
+
+def to_config
+  return :config if config?
+  to_exec
+  putline 'edit', :debug=>1
+  raise RuntimeError, "unable to got to config mode" unless config?
+  :config
+end
+
+def to_shell
+  return in? if @ps1_bis
+  return :shell if shell? 
+  to_exec
+  putline 'start shell'
+  raise RuntimeError, "unable to got to shell mode" unless shell?
+  :shell
+end
+
+def to_exec
+  return :exec if exec?
+  top if config?
+  exit
+  raise RuntimeError, "unable to got to exec mode" unless exec?
+  :exec
+end
+
+end
+end

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

@@ -0,0 +1,23 @@
+
+module Expect4r::Router::Junos
+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/modes.rb

@@ -0,0 +1,37 @@
+module Expect4r
+module Router
+module Common
+module Modes
+  def in?(mode=:none)
+    login unless connected?
+    case mode
+    when :exec    ; exec?
+    when :shell   ; shell?
+    when :config  ; config?
+    else
+      _mode_?
+    end
+  end
+  def change_mode_to(mode)
+    login unless connected?
+    case mode
+    when :exec    ;  to_exec
+    when :shell   ;  to_shell
+    when :config  ;  to_config
+    end
+  end
+  def _mode_?
+    putline ' ', :no_trim=>true, :no_echo=>true unless @lp
+    if exec? 
+      :exec
+    elsif config?
+      :config
+    elsif shell?
+      :shell
+    else
+    end
+  end
+end
+end
+end
+end

data/test/misc/passwd_test.rb

@@ -0,0 +1,9 @@
+require "test/unit"
+require "misc/passwd"
+
+class TestMiscPasswd < Test::Unit::TestCase
+  def test_cipher
+    assert_not_equal 'my password', Expect4r.cipher('my password')
+    assert_equal 'my password', Expect4r.decipher(Expect4r.cipher('my password'))
+  end
+end

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

@@ -0,0 +1,67 @@
+require "test/unit"
+
+require "router/cisco/iox/iox"
+
+class TestRouterCiscoIoxIox < Test::Unit::TestCase
+  def test_new_hash_terse
+    x = Iox.new :ssh, 
+                :host=> '1.1.1.1',
+                :user=> 'username',
+                :pwd=> 'lab',
+                :method=> :ssh
+    assert_equal '1.1.1.1', x.host
+    assert_equal '1.1.1.1', x.hostname
+    assert_equal 0, x.port
+    assert_equal 'username', x.user
+    assert_equal 'username', x.username
+    assert_raise(NoMethodError) { x.pwd }
+    assert_not_equal "lab", x.instance_eval { @pwd }
+  end
+  def test_new_hash
+    x = Iox.new :ssh, 
+                :hostname=> '1.1.1.1',
+                :username=> 'username',
+                :password=> 'lab'
+    assert_equal '1.1.1.1', x.host
+    assert_equal '1.1.1.1', x.hostname
+    assert_equal 0, x.port
+    assert_equal 'username', x.user
+    assert_equal 'username', x.username
+    assert_raise(NoMethodError) { x.pwd }
+    assert_not_equal "lab", x.instance_eval { @pwd }
+    assert_equal :ssh, x.instance_eval { @method }
+  end
+  def test_new
+    x = Iox.new :telnet, '1.1.1.1 4002', 'username', 'lab'
+    assert_equal '1.1.1.1', x.host
+    assert_equal 4002, x.port
+    assert_equal '1.1.1.1', x.hostname
+    assert_equal 'username', x.user
+    assert_equal 'username', x.username
+    assert_raise(NoMethodError) { x.pwd }
+    assert_not_equal "lab", x.instance_eval { @pwd }
+    assert_equal :telnet, x.instance_eval { @method }
+  end
+  def test_new_ssh
+    x = Iox.new_ssh :hostname=> '1.1.1.1'
+    assert_equal '1.1.1.1', x.host
+    assert_equal '1.1.1.1', x.hostname
+    assert_equal 0, x.port
+    assert_nil x.user
+    assert_nil x.username
+    assert_raise(NoMethodError) { x.pwd }
+    assert_not_equal "lab", x.instance_eval { @pwd }
+    assert_equal :ssh, x.instance_eval { @method }    
+  end
+  def test_new_telnet
+    x = Iox.new_telnet :hostname=> '1.1.1.1'
+    assert_equal '1.1.1.1', x.host
+    assert_equal '1.1.1.1', x.hostname
+    assert_equal 0, x.port
+    assert_nil x.user
+    assert_nil x.username
+    assert_raise(NoMethodError) { x.pwd }
+    assert_not_equal "lab", x.instance_eval { @pwd }
+    assert_equal :telnet, x.instance_eval { @method }
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: expect4r
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 0
+  - 1
+  - dev
+  version: 0.0.1.dev
+platform: ruby
+authors: 
+- Jean-Michel Esnault
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  version_requirements: *id001
+description: A Ruby Library for interacting with Ios, IosXR, and Junos CLI.
+email: jesnault@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- COPYING
+- LICENSE
+- README.rdoc
+- lib/expect/io.rb
+- lib/expect4r.rb
+- lib/misc/passwd.rb
+- lib/misc/shell.rb
+- lib/router/cisco/common/common.rb
+- lib/router/cisco/common/ping.rb
+- lib/router/cisco/common/show.rb
+- lib/router/cisco/ios/ios.rb
+- lib/router/cisco/ios/modes.rb
+- lib/router/cisco/ios/termserver.rb
+- lib/router/cisco/iox/iox.rb
+- lib/router/cisco/iox/modes.rb
+- lib/router/common.rb
+- lib/router/error.rb
+- lib/router/juniper/junos/junos.rb
+- lib/router/juniper/junos/modes.rb
+- lib/router/juniper/junos/show.rb
+- lib/router/modes.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --title
+- Expect4r
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Expect4r
+test_files: 
+- test/misc/passwd_test.rb
+- test/router/cisco/iox/iox_test.rb