oxidized 0.9.0 → 0.10.0

data/lib/oxidized/config.rb

@@ -11,47 +11,53 @@ module Oxidized
     SourceDir = File.join Directory, %w(lib oxidized source)
     HookDir   = File.join Directory, %w(lib oxidized hook)
     Sleep     = 1
+
+    def self.load(cmd_opts={})
+      asetus = Asetus.new(name: 'oxidized', load: false, key_to_s: true)
+      Oxidized.asetus = asetus
+
+      asetus.default.username      = 'username'
+      asetus.default.password      = 'password'
+      asetus.default.model         = 'junos'
+      asetus.default.interval      = 3600
+      asetus.default.use_syslog    = false
+      asetus.default.debug         = false
+      asetus.default.threads       = 30
+      asetus.default.timeout       = 20
+      asetus.default.retries       = 3
+      asetus.default.prompt        = /^([\w.@-]+[#>]\s?)$/
+        asetus.default.rest          = '127.0.0.1:8888' # or false to disable
+      asetus.default.vars          = {}             # could be 'enable'=>'enablePW'
+      asetus.default.groups        = {}             # group level configuration
+
+      asetus.default.input.default    = 'ssh, telnet'
+      asetus.default.input.debug      = false # or String for session log file
+      asetus.default.input.ssh.secure = false # complain about changed certs
+
+      asetus.default.output.default = 'file'  # file, git
+      asetus.default.source.default = 'csv'   # csv, sql
+
+      asetus.default.model_map = {
+        'cisco'   => 'ios',
+        'juniper' => 'junos',
+      }
+
+      begin
+        asetus.load # load system+user configs, merge to Config.cfg
+      rescue => error
+        raise InvalidConfig, "Error loading config: #{error.message}"
+      end
+
+      raise NoConfig, 'edit ~/.config/oxidized/config' if asetus.create
+
+      # override if comand line flag given
+      asetus.cfg.debug = cmd_opts[:debug] if cmd_opts[:debug]
+
+      asetus
+    end
   end
+
   class << self
     attr_accessor :mgr, :Hooks
   end
-  CFGS = Asetus.new :name=>'oxidized', :load=>false, :key_to_s=>true
-  CFGS.default.username      = 'username'
-  CFGS.default.password      = 'password'
-  CFGS.default.model         = 'junos'
-  CFGS.default.interval      = 3600
-  CFGS.default.log           = File.join Config::Root, 'log'
-  CFGS.default.debug         = false
-  CFGS.default.threads       = 30
-  CFGS.default.timeout       = 20
-  CFGS.default.retries       = 3
-  CFGS.default.prompt        = /^([\w.@-]+[#>]\s?)$/
-  CFGS.default.rest          = '127.0.0.1:8888' # or false to disable
-  CFGS.default.vars          = {}             # could be 'enable'=>'enablePW'
-  CFGS.default.groups        = {}             # group level configuration
-
-  CFGS.default.input.default    = 'ssh, telnet'
-  CFGS.default.input.debug      = false # or String for session log file
-  CFGS.default.input.ssh.secure = false # complain about changed certs
-
-  CFGS.default.output.default = 'file'  # file, git
-  CFGS.default.source.default = 'csv'   # csv, sql
-
-  CFGS.default.model_map = {
-    'cisco'   => 'ios',
-    'juniper' => 'junos',
-  }
-
-  begin
-    CFGS.load # load system+user configs, merge to Config.cfg
-  rescue => error
-    raise InvalidConfig, "Error loading config: #{error.message}"
-  ensure
-    CFG = CFGS.cfg  # convenienence, instead of Config.cfg.password, CFG.password
-  end
-
-  Log.level = Logger::INFO unless CFG.debug
-  raise NoConfig, 'edit ~/.config/oxidized/config' if CFGS.create
-  Log.file = CFG.log if CFG.log
-
 end

data/lib/oxidized/config/vars.rb

@@ -2,9 +2,14 @@ module Oxidized::Config::Vars
   # convenience method for accessing node, group or global level user variables
   # nil values will be ignored
   def vars name
-    r =   @node.vars[name] unless @node.vars.nil?
-    r ||= Oxidized::CFG.groups[@node.group].vars[name.to_s] if Oxidized::CFG.groups.has_key?(@node.group)
-    r ||= Oxidized::CFG.vars[name.to_s] if Oxidized::CFG.vars.has_key?(name.to_s)
+    r = @node.vars[name] unless @node.vars.nil?
+    if Oxidized.config.groups.has_key?(@node.group)
+      if Oxidized.config.groups[@node.group].vars.has_key?(name.to_s)
+        r ||= Oxidized.config.groups[@node.group].vars[name.to_s]
+      end
+    end
+    r ||= Oxidized.config.vars[name.to_s] if Oxidized.config.vars.has_key?(name.to_s)
     r
   end
 end
+

data/lib/oxidized/core.rb

@@ -1,12 +1,4 @@
 module Oxidized
-  require 'oxidized/log'
-  require 'oxidized/string'
-  require 'oxidized/config'
-  require 'oxidized/config/vars'
-  require 'oxidized/worker'
-  require 'oxidized/nodes'
-  require 'oxidized/manager'
-  require 'oxidized/hook'
   class << self
     def new *args
       Core.new args
@@ -18,18 +10,19 @@ module Oxidized
 
     def initialize args
       Oxidized.mgr = Manager.new
-      Oxidized.Hooks = HookManager.from_config CFG
+      Oxidized.Hooks = HookManager.from_config(Oxidized.config)
       nodes        = Nodes.new
       raise NoNodesFound, 'source returns no usable nodes' if nodes.size == 0
       @worker      = Worker.new nodes
       trap('HUP') { nodes.load }
-      if CFG.rest?
+      if Oxidized.config.rest?
         begin
           require 'oxidized/web'
         rescue LoadError
-          raise OxidizedError, 'oxidized-web not found: sudo gem install oxidized-web - or disable web support by setting "rest: false" in your configuration'
+          raise OxidizedError, 'oxidized-web not found: sudo gem install oxidized-web - \
+          or disable web support by setting "rest: false" in your configuration'
         end
-        @rest        = API::Web.new nodes, CFG.rest
+        @rest        = API::Web.new nodes, Oxidized.config.rest
         @rest.run
       end
       run

data/lib/oxidized/hook.rb

@@ -46,7 +46,7 @@ class HookManager
     hook.cfg = cfg
 
     @registered_hooks[event] << RegisteredHook.new(name, hook)
-    Log.debug "Hook #{name.inspect} registered #{hook.class} for event #{event.inspect}"
+    Oxidized.logger.debug "Hook #{name.inspect} registered #{hook.class} for event #{event.inspect}"
   end
 
   def handle event, ctx_params={}
@@ -57,7 +57,7 @@ class HookManager
       begin
         r_hook.hook.run_hook ctx
       rescue => e
-        Log.error "Hook #{r_hook.name} (#{r_hook.hook}) failed " +
+        Oxidized.logger.error "Hook #{r_hook.name} (#{r_hook.hook}) failed " +
                   "(#{e.inspect}) for event #{event.inspect}"
       end
     end
@@ -66,7 +66,7 @@ end
 
 # Hook abstract base class
 class Hook
-  attr_accessor :cfg
+  attr_reader :cfg
 
   def initialize
   end
@@ -81,7 +81,7 @@ class Hook
   end
 
   def log(msg, level=:info)
-    Log.send(level, "#{self.class.name}: #{msg}")
+    Oxidized.logger.send(level, "#{self.class.name}: #{msg}")
   end
 
 end

data/lib/oxidized/hook/exec.rb

@@ -71,6 +71,8 @@ class Exec < Oxidized::Hook
         "OX_NODE_MSG" => ctx.node.msg.to_s,
         "OX_NODE_GROUP" => ctx.node.group.to_s,
         "OX_EVENT" => ctx.event.to_s,
+        "OX_REPO_COMMITREF" => ctx.commitref.to_s,
+        "OX_REPO_NAME" => ctx.node.repo.to_s,
       )
     end
     if ctx.job

data/lib/oxidized/hook/githubrepo.rb

@@ -0,0 +1,57 @@
+class GithubRepo < Oxidized::Hook
+  def validate_cfg!
+    cfg.has_key?('remote_repo') or raise KeyError, 'remote_repo is required'
+  end
+
+  def run_hook(ctx)
+    repo = Rugged::Repository.new(Oxidized.config.output.git.repo)
+    log "Pushing local repository(#{repo.path})..."
+    remote = repo.remotes['origin'] || repo.remotes.create('origin', cfg.remote_repo)
+    log "to remote: #{remote.url}"
+
+    fetch_and_merge_remote(repo)
+
+    remote.push([repo.head.name], credentials: credentials)
+  end
+
+  def fetch_and_merge_remote(repo)
+    result = repo.fetch('origin', [repo.head.name], credentials: credentials)
+    log result.inspect, :debug
+
+    unless result[:total_deltas] > 0
+      log "nothing recieved after fetch", :debug
+      return
+    end
+
+    their_branch = repo.branches["origin/master"]
+
+    log "merging fetched branch #{their_branch.name}", :debug
+
+    merge_index = repo.merge_commits(repo.head.target_id, their_branch.target_id)
+
+    if merge_index.conflicts?
+      log("Conflicts detected, skipping Rugged::Commit.create", :warn)
+      return
+    end
+
+    Rugged::Commit.create(repo, {
+      parents: [repo.head.target, their_branch.target],
+      tree: merge_index.write_tree(repo),
+      message: "Merge remote-tracking branch '#{their_branch.name}'",
+      update_ref: "HEAD"
+    })
+  end
+
+  private
+
+  def credentials
+    @credentials ||= if cfg.has_key?('username') && cfg.has_key?('password')
+      log "Using https auth", :debug
+      Rugged::Credentials::UserPassword.new(username: cfg.username, password: cfg.password)
+    else
+      log "Using ssh auth", :debug
+      Rugged::Credentials::SshKeyFromAgent.new(username: 'git')
+    end
+  end
+
+end

data/lib/oxidized/input/cli.rb

@@ -1,6 +1,7 @@
 module Oxidized
   class Input
     module CLI
+      attr_reader :node
 
       def initialize
         @post_login = []
@@ -10,7 +11,7 @@ module Oxidized
 
       def get
         connect_cli
-        d = @node.model.get
+        d = node.model.get
         disconnect
         d
       end

data/lib/oxidized/input/ftp.rb

@@ -18,7 +18,7 @@ module Oxidized
     def connect node
       @node       = node
       @node.model.cfg['ftp'].each { |cb| instance_exec(&cb) }
-      @log = File.open(Oxidized::Config::Crash + "-#{@node.ip}-ftp", 'w') if CFG.input.debug?
+      @log = File.open(Oxidized::Config::Crash + "-#{@node.ip}-ftp", 'w') if Oxidized.config.input.debug?
       @ftp = Net::FTP.new @node.ip, @node.auth[:username], @node.auth[:password]
       connected?
     end
@@ -28,7 +28,7 @@ module Oxidized
     end
 
     def cmd file
-      Log.debug "FTP: #{file} @ #{@node.name}"
+      Oxidized.logger.debug "FTP: #{file} @ #{@node.name}"
       @ftp.getbinaryfile file, nil
     end
 
@@ -47,7 +47,7 @@ module Oxidized
       @ftp.close
     #rescue Errno::ECONNRESET, IOError
     ensure
-      @log.close if CFG.input.debug?
+      @log.close if Oxidized.config.input.debug?
     end
 
   end

data/lib/oxidized/input/ssh.rb

@@ -19,11 +19,11 @@ module Oxidized
       @node       = node
       @output     = ''
       @node.model.cfg['ssh'].each { |cb| instance_exec(&cb) }
-      secure = CFG.input.ssh.secure
-      @log = File.open(Oxidized::Config::Crash + "-#{@node.ip}-ssh", 'w') if CFG.input.debug?
+      secure = Oxidized.config.input.ssh.secure
+      @log = File.open(Oxidized::Config::Crash + "-#{@node.ip}-ssh", 'w') if Oxidized.config.input.debug?
       port = vars(:ssh_port) || 22
       @ssh = Net::SSH.start @node.ip, @node.auth[:username], :port => port.to_i,
-                            :password => @node.auth[:password], :timeout => CFG.timeout,
+                            :password => @node.auth[:password], :timeout => Oxidized.config.timeout,
                             :paranoid => secure,
                             :auth_methods => %w(none publickey password keyboard-interactive),
                             :number_of_password_prompts => 0
@@ -42,8 +42,8 @@ module Oxidized
       @ssh and not @ssh.closed?
     end
 
-    def cmd cmd, expect=@node.prompt
-      Log.debug "SSH: #{cmd} @ #{@node.name}"
+    def cmd cmd, expect=node.prompt
+      Oxidized.logger.debug "SSH: #{cmd} @ #{node.name}"
       if @exec
         @ssh.exec! cmd
       else
@@ -64,17 +64,17 @@ module Oxidized
     def disconnect
       disconnect_cli
       # if disconnect does not disconnect us, give up after timeout
-      Timeout::timeout(CFG.timeout) { @ssh.loop }
+      Timeout::timeout(Oxidized.config.timeout) { @ssh.loop }
     rescue Errno::ECONNRESET, Net::SSH::Disconnect, IOError
     ensure
-      @log.close if CFG.input.debug?
+      @log.close if Oxidized.config.input.debug?
       (@ssh.close rescue true) unless @ssh.closed?
     end
 
     def shell_open ssh
       @ses = ssh.open_channel do |ch|
         ch.on_data do |_ch, data|
-          @log.print data if CFG.input.debug?
+          @log.print data if Oxidized.config.input.debug?
           @output << data
           @output = @node.model.expects @output
         end
@@ -109,7 +109,7 @@ module Oxidized
     end
 
     def expect regexp
-      Timeout::timeout(CFG.timeout) do
+      Timeout::timeout(Oxidized.config.timeout) do
         @ssh.loop(0.1) do
           sleep 0.1
           not @output.match regexp

data/lib/oxidized/input/telnet.rb

@@ -8,7 +8,7 @@ module Oxidized
 
     def connect node
       @node    = node
-      @timeout = CFG.timeout
+      @timeout = Oxidized.config.timeout
       @node.model.cfg['telnet'].each { |cb| instance_exec(&cb) }
       port = vars(:telnet_port) || 23
 
@@ -16,7 +16,7 @@ module Oxidized
               'Port'    => port.to_i,
               'Timeout' => @timeout,
               'Model'   => @node.model }
-      opt['Output_log'] = Oxidized::Config::Crash + "-#{@node.ip}-telnet" if CFG.input.debug?
+      opt['Output_log'] = Oxidized::Config::Crash + "-#{@node.ip}-telnet" if Oxidized.config.input.debug?
 
       @telnet  = Net::Telnet.new opt
       if @node.auth[:username] and @node.auth[:username].length > 0
@@ -37,7 +37,7 @@ module Oxidized
     end
 
     def cmd cmd, expect=@node.prompt
-      Log.debug "Telnet: #{cmd} @#{@node.name}"
+      Oxidized.logger.debug "Telnet: #{cmd} @#{@node.name}"
       args = { 'String' => cmd }
       args.merge!({ 'Match' => expect, 'Timeout' => @timeout }) if expect
       @telnet.cmd args

data/lib/oxidized/job.rb

@@ -1,11 +1,11 @@
 module Oxidized
   class Job < Thread
     attr_reader :start, :end, :status, :time, :node, :config
-    def initialize node
+    def initialize(node)
       @node         = node
       @start        = Time.now.utc
-      super do |node|
-        @status, @config = node.run
+      super do
+        @status, @config = @node.run
         @end             = Time.now.utc
         @time            = @end - @start
       end

data/lib/oxidized/model/fortios.rb

@@ -2,7 +2,7 @@ class FortiOS < Oxidized::Model
 
   comment  '# '
 
-  prompt /^([-\w\.]+(\s[\(\w\-\.\)]+)?\s?[#>]\s?)$/
+  prompt /^([-\w\.]+(\s[\(\w\-\.\)]+)?\~?\s?[#>]\s?)$/
 
   cmd :all do |cfg, cmdstring|
     new_cfg = comment "COMMAND: #{cmdstring}\n"

data/lib/oxidized/model/junos.rb

@@ -3,7 +3,7 @@ class JunOS < Oxidized::Model
   comment  '# '
 
   def telnet
-    @input.class.to_s.match /Telnet/
+    @input.class.to_s.match(/Telnet/)
   end
 
   cmd :all do |cfg|
@@ -12,16 +12,16 @@ class JunOS < Oxidized::Model
     cfg.lines.map { |line| line.rstrip }.join("\n") + "\n"
   end
 
-  cmd :secret do |cfg| 
-    cfg.gsub! /encrypted-password (\S+).*/, '<secret removed>'
-    cfg.gsub! /community (\S+) {/, 'community <hidden> {'
+  cmd :secret do |cfg|
+    cfg.gsub!(/encrypted-password (\S+).*/, '<secret removed>')
+    cfg.gsub!(/community (\S+) {/, 'community <hidden> {')
     cfg
   end
 
   cmd 'show configuration | display omit'
 
   cmd 'show version' do |cfg|
-    @model = $1 if cfg.match /^Model: (\S+)/
+    @model = $1 if cfg.match(/^Model: (\S+)/)
     comment cfg
   end
 
@@ -34,13 +34,11 @@ class JunOS < Oxidized::Model
     out
   end
 
-  cmd 'show chassis hardware' do |cfg|
-    comment cfg
-  end
+  cmd('show chassis hardware') { |cfg| comment cfg }
 
   cfg :telnet do
-    username  /^login:/
-    password  /^Password:/
+    username(/^login:/)
+    password(/^Password:/)
   end
 
   cfg :ssh do