oxidized 0.1.1

data/lib/oxidized/model/iosxr.rb

@@ -0,0 +1,47 @@
+class IOSXR < Oxidized::Model
+
+  # IOS XR model #
+
+  comment  '! '
+
+  cmd :all do |cfg|
+    cfg.each_line.to_a[2..-2].join
+  end
+
+  cmd :secret do |cfg| 
+    cfg.gsub! /^(snmp-server community).*/, '\\1 <configuration removed>'
+    cfg.gsub! /secret (\d+) (\S+).*/, '<secret hidden>'
+    cfg
+  end
+
+  cmd 'show inventory' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show platform' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg = cfg.each_line.to_a[3..-1].join
+    cfg
+  end
+
+  cfg :telnet do
+    username /^Username:/
+    password /^Password:/
+  end
+
+  cfg :telnet, :ssh do
+    post_login 'terminal length 0'
+    post_login 'terminal width 0'
+    if vars :enable
+      post_login do
+        send "enable\n"
+        send vars(:enable) + "\n"
+      end
+    end
+    pre_logout 'exit'
+  end
+
+end

data/lib/oxidized/model/ironware.rb

@@ -0,0 +1,33 @@
+class IronWare < Oxidized::Model
+
+  comment  '! '
+
+  cmd :all do |cfg|
+    cfg.each_line.to_a[1..-3].join
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg = cfg.each_line.to_a[3..-1].join
+    cfg
+  end
+
+  cmd 'show version' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show chassis' do |cfg|
+    cfg.gsub! "\xFF", '' # ugly hack - avoids JSON.dump utf-8 breakage on 1.9..
+    comment cfg
+  end
+
+  cfg :telnet do
+    username /^Username:/
+    password /^Password:/
+  end
+
+  cfg :telnet, :ssh do
+    post_login 'terminal length 0'
+    pre_logout 'exit'
+  end
+
+end

data/lib/oxidized/model/junos.rb

@@ -0,0 +1,56 @@
+class JunOS < Oxidized::Model
+
+  comment  '# '
+
+  def telnet
+    @input.class.to_s.match /Telnet/
+  end
+
+  cmd :all do |cfg|
+    # we don't need screen-scraping in ssh due to exec
+    cfg = cfg.lines.to_a[1..-2].join if telnet
+    cfg
+  end
+
+  cmd :secret do |cfg| 
+    cfg.gsub! /encrypted-password (\S+).*/, '<secret removed>'
+    cfg.gsub! /community (\S+) {/, 'community <hidden> {'
+    cfg
+  end
+
+  cmd 'show configuration'
+
+  cmd 'show version' do |cfg|
+    @model = $1 if cfg.match /^Model: (\S+)/
+    comment cfg
+  end
+
+  post do
+    out = ''
+    case @model
+    when 'mx960'
+      out << cmd('show chassis fabric reachability')  { |cfg| comment cfg }
+    end
+    out
+  end
+
+  cmd 'show chassis hardware' do |cfg|
+    comment cfg
+  end
+
+  cfg :telnet do
+    username  /^login:/
+    password  /^Password:/
+  end
+
+  cfg :ssh do
+    exec true  # don't run shell, run each command in exec channel
+  end
+
+  cfg :telnet, :ssh do
+    post_login 'set cli screen-length 0'
+    post_login 'set cli screen-width 0'
+    pre_logout 'exit'
+  end
+
+end

data/lib/oxidized/model/model.rb

@@ -0,0 +1,152 @@
+module Oxidized
+  class Model
+    include Oxidized::Config::Vars
+
+    class << self
+      def inherited klass
+        klass.instance_variable_set '@cmd',   Hash.new { |h,k| h[k] = [] }
+        klass.instance_variable_set '@cfg',   Hash.new { |h,k| h[k] = [] }
+        klass.instance_variable_set '@procs', Hash.new { |h,k| h[k] = [] }
+        klass.instance_variable_set '@expect', []
+        klass.const_set :CFG, CFG
+      end
+      def comment _comment='# '
+        return @comment if @comment
+        @comment = block_given? ? yield : _comment
+      end
+      def prompt _prompt=nil
+        @prompt or @prompt = _prompt
+      end
+      def cfg *methods, &block
+        [methods].flatten.each do |method|
+          @cfg[method.to_s] << block
+        end
+      end
+      def cfgs
+        @cfg
+      end
+      def cmd _cmd=nil, &block
+        if _cmd.class == Symbol
+          @cmd[_cmd] << block
+        else
+          @cmd[:cmd] << [_cmd, block]
+        end
+      end
+      def cmds
+        @cmd
+      end
+      def expect re, &block
+        @expect << [re, block]
+      end
+      def expects
+        @expect
+      end
+
+      # calls the block at the end of the model, prepending the output of the
+      # block to the output string
+      #
+      # @author Saku Ytti <saku@ytti.fi>
+      # @since 0.0.39
+      # @yield expects block which should return [String]
+      # @return [void]
+      def pre &block
+        @procs[:pre] << block
+      end
+
+      # calls the block at the end of the model, adding the output of the block
+      # to the output string
+      #
+      # @author Saku Ytti <saku@ytti.fi>
+      # @since 0.0.39
+      # @yield expects block which should return [String]
+      # @return [void]
+      def post &block
+        @procs[:post] << block
+      end
+
+      # @author Saku Ytti <saku@ytti.fi>
+      # @since 0.0.39
+      # @return [Hash] hash proc procs :pre+:post to be prepended/postfixed to output
+      def procs
+        @procs
+      end
+    end
+
+    attr_accessor :input, :node
+
+    def cmd string, &block
+      out = @input.cmd string
+      return false unless out
+      out = Oxidized::String.new out
+      self.class.cmds[:all].each do |all_block|
+        out = instance_exec out, string, &all_block
+      end
+      if vars :remove_secret
+        self.class.cmds[:secret].each do |all_block|
+          out = instance_exec out, string, &all_block
+        end
+      end
+      out = instance_exec out, &block if block
+      out
+    end
+
+    def output
+      @input.output
+    end
+
+    def send data
+      @input.send data
+    end
+
+    def expect re, &block
+      self.class.expect re, &block
+    end
+
+    def cfg
+      self.class.cfgs
+    end
+
+    def prompt
+      self.class.prompt
+    end
+
+    def expects data
+      self.class.expects.each do |re, cb|
+        if data.match re
+          if cb.arity == 2
+            data = instance_exec [data, re], &cb
+          else
+            data = instance_exec data, &cb
+          end
+        end
+      end
+      data
+    end
+
+    def get
+      data, pre = '', ''
+      procs = self.class.procs
+      self.class.cmds[:cmd].each do |command, block|
+        out = cmd command, &block
+        return false unless out
+        data << out.to_s
+      end
+      procs[:pre].each do |pre_proc|
+        pre << instance_eval(&pre_proc).to_s
+      end
+      procs[:post].each do |post_proc|
+        data << instance_eval(&post_proc).to_s
+      end
+      pre + data
+    end
+
+    def comment _comment
+      data = ''
+      _comment.each_line do |line|
+        data << self.class.comment << line
+      end
+      data
+    end
+
+  end
+end

data/lib/oxidized/model/powerconnect.rb

@@ -0,0 +1,38 @@
+class PowerConnect < Oxidized::Model
+
+  prompt /^([\w\s.@-]+[#>]\s?)$/ # allow spaces in hostname..dell does not limit it.. #
+
+  comment  '! '
+
+  expect /^\s--More--\s+.*$/ do |data, re|
+     send ' '
+     data.sub re, ''
+  end
+
+  cmd :all do |cfg|
+    cfg.each_line.to_a[1..-3].join
+  end
+
+  cmd 'show version' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show system' do |cfg|
+    cfg = cfg.each_line.take_while { |line| not line.match(/uptime/i) }
+    comment cfg
+  end
+
+  cmd 'show running-config'
+
+  cfg :telnet do
+    username /^User( Name)?:/
+    password /^\r?Password:/
+  end
+
+  cfg :telnet, :ssh do
+    post_login 'terminal datadump'
+    post_login 'enable'
+    pre_logout 'exit'
+  end
+
+end

data/lib/oxidized/model/procurve.rb

@@ -0,0 +1,45 @@
+class Procurve < Oxidized::Model
+
+  # FIXME: this is way too unsafe
+  prompt /.*?(\w+# ).*/m
+
+  comment  '! '
+
+  expect /Press any key to continue/ do
+     send ' '
+     ""
+  end
+
+  cmd :all do |cfg|
+    cfg = cfg.each_line.to_a[1..-3].join
+    cfg = cfg.gsub /\r/, ''
+    new_cfg = ''
+    cfg.each_line do |line|
+      line.sub! /^\e.*(\e.*)/, '\1'  #leave last escape
+      line.sub! /\e\[24;1H/, ''      #remove last escape, is it always this?
+      new_cfg << line
+    end
+    new_cfg
+  end
+
+  cmd 'show version' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show system-information' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show running-config'
+
+  cfg :telnet do
+    username /Username:/
+    password /Password:/
+  end
+
+  cfg :telnet, :ssh do
+    post_login 'no page'
+    pre_logout "logout\ny\nn"
+  end
+
+end

data/lib/oxidized/model/timos.rb

@@ -0,0 +1,45 @@
+class TiMOS < Oxidized::Model
+
+  # Alcatel-Lucent TiMOS (Timetra)
+  # used in SR/ESS/SAS routers
+ 
+  comment  '# '
+
+  prompt /^([-\w\.:>\*]+\s?[#>]\s?)$/
+
+  cmd :all do |cfg, cmdstring|
+    new_cfg = comment "COMMAND: #{cmdstring}\n"
+    new_cfg << cfg.each_line.to_a[1..-2].join
+  end
+
+  cmd 'show bof' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show system information' do |cfg|
+    # strip uptime
+    cfg.sub! /^System Up Time.*\n/, ''
+    comment cfg
+  end
+
+  cmd 'show card state' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show boot-messages' do |cfg|
+    cfg.gsub! /\r/, ""
+    comment cfg
+  end
+
+  cmd 'admin display-config'
+
+  cfg :telnet do
+    username /^Login: /
+    password /^Password: /
+  end
+
+  cfg :telnet, :ssh do
+    post_login 'environment no more'
+    pre_logout 'logout'
+  end
+end

data/lib/oxidized/node.rb

@@ -0,0 +1,169 @@
+module Oxidized
+  require 'resolv'
+  require 'ostruct'
+  require_relative 'node/stats'
+  class MethodNotFound < OxidizedError; end
+  class ModelNotFound  < OxidizedError; end
+  class Node
+    attr_reader :name, :ip, :model, :input, :output, :group, :auth, :prompt, :vars, :last
+    attr_accessor :running, :user, :msg, :from, :stats, :retry
+    alias :running? :running
+    def initialize opt
+      @name           = opt[:name]
+      @ip             = Resolv.getaddress @name
+      @group          = opt[:group]
+      @input          = resolve_input opt
+      @output         = resolve_output opt
+      @model          = resolve_model opt
+      @auth           = resolve_auth opt
+      @prompt         = resolve_prompt opt
+      @vars           = opt[:vars]
+      @stats          = Stats.new
+      @retry          = 0
+
+      # model instance needs to access node instance
+      @model.node = self
+    end
+
+    def run
+      status, config = :fail, nil
+      @input.each do |input|
+        @model.input = input = input.new
+        if config=run_input(input)
+          status = :success
+          break
+        else
+          status = :no_connection
+        end
+      end
+      @model.input = nil
+      [status, config]
+    end
+
+    def run_input input
+      rescue_fail = {}
+      [input.class::RescueFail, input.class.superclass::RescueFail].each do |hash|
+        hash.each do |level,errors|
+          errors.each do |err|
+            rescue_fail[err] = level
+          end
+        end
+      end
+      begin
+        if input.connect self
+          input.get
+        end
+      rescue *rescue_fail.keys => err
+        resc  = ''
+        if not level = rescue_fail[err.class]
+          resc  = err.class.ancestors.find{|e|rescue_fail.keys.include? e}
+          level = rescue_fail[resc]
+          resc  = " (rescued #{resc})"
+        end
+        Log.send(level, '%s raised %s%s with msg "%s"' % [self.ip, err.class, resc, err.message])
+        return false
+      rescue => err
+        file = Oxidized::Config::Crash + '.' + self.ip.to_s
+        open file, 'w' do |fh|
+          fh.puts Time.now.utc
+          fh.puts err.message + ' [' + err.class.to_s + ']'
+          fh.puts '-' * 50
+          fh.puts err.backtrace
+        end
+        Log.error '%s raised %s with msg "%s", %s saved' % [self.ip, err.class, err.message, file]
+      end
+    end
+
+    def serialize
+      h = {
+        :name      => @name,
+        :full_name => @name,
+        :ip        => @ip,
+        :group     => @group,
+        :model     => @model.class.to_s,
+        :last      => nil,
+        :vars      => @vars,
+      }
+      h[:full_name] = [@group, @name].join('/') if @group
+      if @last
+        h[:last] = {
+          :start  => @last.start,
+          :end    => @last.end,
+          :status => @last.status,
+          :time   => @last.time,
+        }
+      end
+      h
+    end
+
+    def last= job
+      if job
+        ostruct = OpenStruct.new
+        ostruct.start  = job.start
+        ostruct.end    = job.end
+        ostruct.status = job.status
+        ostruct.time   = job.time
+        @last = ostruct
+      else
+        @last = nil
+      end
+    end
+
+    def reset
+      @user = @msg = @from = nil
+      @retry = 0
+    end
+
+    private
+
+    def resolve_prompt opt
+      prompt =   opt[:prompt]
+      prompt ||= @model.prompt
+      prompt ||= CFG.prompt
+    end
+
+    def resolve_auth opt
+      # Resolve configured username/password, give priority to group level configuration
+      # TODO: refactor to use revised behaviour of Asetus
+      cfg_username, cfg_password =
+        if CFG.groups.has_key?(@group) and ['username', 'password'].all? {|e| CFG.groups[@group].has_key?(e)}
+          [CFG.groups[@group].username, CFG.groups[@group].password]
+        elsif ['username', 'password'].all? {|e| CFG.has_key?(e)}
+          [CFG.username, CFG.password]
+        else
+          [nil, nil]
+        end
+      auth = {}
+      auth[:username] = (opt[:username] or cfg_username)
+      auth[:password] = (opt[:password] or cfg_password)
+      auth
+    end
+
+    def resolve_input opt
+      inputs = (opt[:input]  or CFG.input.default)
+      inputs.split(/\s*,\s*/).map do |input|
+        if not Oxidized.mgr.input[input]
+          Oxidized.mgr.add_input input or raise MethodNotFound, "#{input} not found for node #{ip}"
+        end
+        Oxidized.mgr.input[input]
+      end
+    end
+
+    def resolve_output opt
+      output = (opt[:output] or CFG.output.default)
+      if not Oxidized.mgr.output[output]
+        Oxidized.mgr.add_output output or raise MethodNotFound, "#{output} not found for node #{ip}"
+      end
+      Oxidized.mgr.output[output]
+    end
+
+    def resolve_model opt
+      model = (opt[:model] or CFG.model)
+      if not Oxidized.mgr.model[model]
+        Oxidized.mgr.add_model model or raise ModelNotFound, "#{model} not found for node #{ip}"
+      end
+      Oxidized.mgr.model[model].new
+    end
+
+  end
+end