oxidized 0.21.0 → 0.22.0

data/extra/oxidized.logrotate

@@ -0,0 +1,7 @@
+/var/log/oxidized/*.log {
+    weekly
+    rotate 3
+    size 10M
+    compress
+    delaycompress
+}

data/extra/oxidized.service

@@ -10,7 +10,7 @@ Wants=network-online.target
 [Service]
 ExecStart=/usr/local/bin/oxidized
 User=oxidized
-KillSignal=SIGINT
+KillSignal=SIGKILL
 
 [Install]
 WantedBy=multi-user.target

data/extra/rest_client.rb

@@ -6,10 +6,10 @@ module Oxidized
     require 'asetus'
 
     class Config
-      Root      = Root = ENV['OXIDIZED_HOME'] || File.join(ENV['HOME'], '.config', 'oxidized')
+      Root = Root = ENV['OXIDIZED_HOME'] || File.join(ENV['HOME'], '.config', 'oxidized')
     end
 
-    CFGS = Asetus.new :name=>'oxidized', :load=>false, :key_to_s=>true
+    CFGS = Asetus.new :name => 'oxidized', :load => false, :key_to_s => true
     CFGS.default.rest = '127.0.0.1:8888'
 
     begin
@@ -28,13 +28,13 @@ module Oxidized
     PATH = URI(restcfg).path
 
     class << self
-      def next opt={}, host=HOST, port=PORT
+      def next opt = {}, host = HOST, port = PORT
         web = new host, port
         web.next opt
       end
     end
 
-    def initialize host=HOST, port=PORT
+    def initialize host = HOST, port = PORT
       @web = Net::HTTP.new host, port
     end
 
@@ -42,6 +42,5 @@ module Oxidized
       data = JSON.dump opt
       @web.put PATH + '/node/next/' + opt[:name].to_s, data
     end
-
   end
 end

data/extra/syslog.rb

@@ -27,13 +27,12 @@ require 'resolv'
 require_relative 'rest_client'
 
 module Oxidized
-  
   require 'asetus'
   class Config
-    Root      = File.join ENV['HOME'], '.config', 'oxidized'
+    Root = File.join ENV['HOME'], '.config', 'oxidized'
   end
 
-  CFGS = Asetus.new :name=>'oxidized', :load=>false, :key_to_s=>true
+  CFGS = Asetus.new :name => 'oxidized', :load => false, :key_to_s => true
   CFGS.default.syslogd.port        = 514
   CFGS.default.syslogd.file        = 'messages'
   CFGS.default.syslogd.resolve     = true
@@ -43,7 +42,7 @@ module Oxidized
   rescue => error
     raise InvalidConfig, "Error loading config: #{error.message}"
   ensure
-    CFG = CFGS.cfg  # convenienence, instead of Config.cfg.password, CFG.password
+    CFG = CFGS.cfg # convenienence, instead of Config.cfg.password, CFG.password
   end
 
   class SyslogMonitor
@@ -59,12 +58,13 @@ module Oxidized
     }
 
     class << self
-      def udp port=Oxidized::CFG.syslogd.port, listen=0
+      def udp port = Oxidized::CFG.syslogd.port, listen = 0
         io = UDPSocket.new
         io.bind listen, port
         new io, :udp
       end
-      def file syslog_file=Oxidized::CFG.syslogd.file
+
+      def file syslog_file = Oxidized::CFG.syslogd.file
         io = open syslog_file, 'r'
         io.seek 0, IO::SEEK_END
         new io, :file
@@ -73,7 +73,7 @@ module Oxidized
 
     private
 
-    def initialize io, mode=:udp
+    def initialize io, mode = :udp
       @mode = mode
       run io
     end
@@ -84,24 +84,24 @@ module Oxidized
 
     def ios ip, log, i
       # TODO: we need to fetch 'ip/name' in mode == :file here
-      user = log[i+5]
+      user = log[i + 5]
       from = log[-1][1..-2]
-      rest( :user => user, :from => from, :model => 'ios', :ip => ip,
-            :name => getname(ip) )
+      rest(:user => user, :from => from, :model => 'ios', :ip => ip,
+           :name => getname(ip))
     end
 
     def jnpr ip, log, i
       # TODO: we need to fetch 'ip/name' in mode == :file here
-      user = log[i+2][1..-2]
-      msg  = log[(i+6)..-1].join(' ')[10..-2]
+      user = log[i + 2][1..-2]
+      msg  = log[(i + 6)..-1].join(' ')[10..-2]
       msg  = nil if msg == 'none'
-      rest( :user => user, :msg => msg, :model => 'jnpr', :ip => ip,
-            :name => getname(ip) )
+      rest(:user => user, :msg => msg, :model => 'jnpr', :ip => ip,
+           :name => getname(ip))
     end
 
     def handle_log log, ip
       log = log.to_s.split ' '
-      if i = log.find_index { |e| e.match( MSG[:ios] ) }
+      if i = log.find_index { |e| e.match(MSG[:ios]) }
         ios ip, log,  i
       elsif i = log.index(MSG[:junos])
         jnpr ip, log, i
@@ -140,4 +140,4 @@ module Oxidized
 end
 
 Oxidized::SyslogMonitor.udp
-#Oxidized::SyslogMonitor.file '/var/log/poop'
+# Oxidized::SyslogMonitor.file '/var/log/poop'

data/lib/oxidized/cli.rb

@@ -40,11 +40,11 @@ module Oxidized
     end
 
     def parse_opts
-      opts = Slop.new(:help=>true) do
+      opts = Slop.new(:help => true) do
         on 'd', 'debug', 'turn on debugging'
         on 'daemonize',  'Daemonize/fork the process'
         on 'v', 'version', 'show version' do
-          puts Oxidized::VERSION
+          puts Oxidized::VERSION_FULL
           Kernel.exit
         end
       end
@@ -62,7 +62,7 @@ module Oxidized
     def write_pid
       if pidfile?
         begin
-          File.open(pidfile, ::File::CREAT | ::File::EXCL | ::File::WRONLY){|f| f.write("#{Process.pid}") }
+          File.open(pidfile, ::File::CREAT | ::File::EXCL | ::File::WRONLY) { |f| f.write("#{Process.pid}") }
           at_exit { File.delete(pidfile) if File.exists?(pidfile) }
         rescue Errno::EEXIST
           check_pid

data/lib/oxidized/config.rb

@@ -13,13 +13,14 @@ module Oxidized
     HookDir   = File.join Directory, %w(lib oxidized hook)
     Sleep     = 1
 
-    def self.load(cmd_opts={})
+    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.resolve_dns   = true # if false, don't resolve DNS to IP
       asetus.default.interval      = 3600
       asetus.default.use_syslog    = false
       asetus.default.debug         = false
@@ -34,9 +35,11 @@ module Oxidized
       asetus.default.models        = {}               # model level configuration
       asetus.default.pid           = File.join(Oxidized::Config::Root, 'pid')
 
-      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.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.input.ftp.passive  = true  # ftp passive mode
+      asetus.default.input.utf8_encoded = true  # configuration is utf8 encoded or ascii-8bit
 
       asetus.default.output.default = 'file'  # file, git
       asetus.default.source.default = 'csv'   # csv, sql

data/lib/oxidized/core.rb

@@ -11,9 +11,9 @@ module Oxidized
     def initialize args
       Oxidized.mgr = Manager.new
       Oxidized.Hooks = HookManager.from_config(Oxidized.config)
-      nodes        = Nodes.new
+      nodes = Nodes.new
       raise NoNodesFound, 'source returns no usable nodes' if nodes.size == 0
-      @worker      = Worker.new nodes
+      @worker = Worker.new nodes
       trap('HUP') { nodes.load }
       if Oxidized.config.rest?
         begin
@@ -22,7 +22,7 @@ module Oxidized
           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, Oxidized.config.rest
+        @rest = API::Web.new nodes, Oxidized.config.rest
         @rest.run
       end
       run

data/lib/oxidized/hook.rb

@@ -1,89 +1,88 @@
 module Oxidized
-class HookManager
-  class << self
-    def from_config cfg
-      mgr = new
-      cfg.hooks.each do |name,h_cfg|
-        h_cfg.events.each do |event|
-          mgr.register event.to_sym, name, h_cfg.type, h_cfg
+  class HookManager
+    class << self
+      def from_config cfg
+        mgr = new
+        cfg.hooks.each do |name, h_cfg|
+          h_cfg.events.each do |event|
+            mgr.register event.to_sym, name, h_cfg.type, h_cfg
+          end
         end
+        mgr
       end
-      mgr
     end
-  end
-
-  # HookContext is passed to each hook. It can contain anything related to the
-  # event in question. At least it contains the event name
-  class HookContext < OpenStruct; end
 
-  # RegisteredHook is a container for a Hook instance
-  class RegisteredHook < Struct.new(:name, :hook); end
+    # HookContext is passed to each hook. It can contain anything related to the
+    # event in question. At least it contains the event name
+    class HookContext < OpenStruct; end
 
-  Events = [
-    :node_success,
-    :node_fail,
-    :post_store,
-    :nodes_done
-  ]
-  attr_reader :registered_hooks
+    # RegisteredHook is a container for a Hook instance
+    class RegisteredHook < Struct.new(:name, :hook); end
 
-  def initialize
-    @registered_hooks = Hash.new {|h,k| h[k] = []}
-  end
+    Events = [
+      :node_success,
+      :node_fail,
+      :post_store,
+      :nodes_done
+    ]
+    attr_reader :registered_hooks
 
-  def register event, name, hook_type, cfg
-    unless Events.include? event
-      raise ArgumentError,
-        "unknown event #{event}, available: #{Events.join ','}"
+    def initialize
+      @registered_hooks = Hash.new { |h, k| h[k] = [] }
     end
 
-    Oxidized.mgr.add_hook hook_type
-    begin
-      hook = Oxidized.mgr.hook.fetch(hook_type).new
-    rescue KeyError
-      raise KeyError, "cannot find hook #{hook_type.inspect}"
-    end
+    def register event, name, hook_type, cfg
+      unless Events.include? event
+        raise ArgumentError,
+              "unknown event #{event}, available: #{Events.join ','}"
+      end
 
-    hook.cfg = cfg
+      Oxidized.mgr.add_hook hook_type
+      begin
+        hook = Oxidized.mgr.hook.fetch(hook_type).new
+      rescue KeyError
+        raise KeyError, "cannot find hook #{hook_type.inspect}"
+      end
 
-    @registered_hooks[event] << RegisteredHook.new(name, hook)
-    Oxidized.logger.debug "Hook #{name.inspect} registered #{hook.class} for event #{event.inspect}"
-  end
+      hook.cfg = cfg
 
-  def handle event, ctx_params={}
-    ctx = HookContext.new ctx_params
-    ctx.event = event
+      @registered_hooks[event] << RegisteredHook.new(name, hook)
+      Oxidized.logger.debug "Hook #{name.inspect} registered #{hook.class} for event #{event.inspect}"
+    end
 
-    @registered_hooks[event].each do |r_hook|
-      begin
-        r_hook.hook.run_hook ctx
-      rescue => e
-        Oxidized.logger.error "Hook #{r_hook.name} (#{r_hook.hook}) failed " +
-                  "(#{e.inspect}) for event #{event.inspect}"
+    def handle event, ctx_params = {}
+      ctx = HookContext.new ctx_params
+      ctx.event = event
+
+      @registered_hooks[event].each do |r_hook|
+        begin
+          r_hook.hook.run_hook ctx
+        rescue => e
+          Oxidized.logger.error "Hook #{r_hook.name} (#{r_hook.hook}) failed " +
+                                "(#{e.inspect}) for event #{event.inspect}"
+        end
       end
     end
   end
-end
 
-# Hook abstract base class
-class Hook
-  attr_reader :cfg
+  # Hook abstract base class
+  class Hook
+    attr_reader :cfg
 
-  def initialize
-  end
+    def initialize
+    end
 
-  def cfg=(cfg)
-    @cfg = cfg
-    validate_cfg! if self.respond_to? :validate_cfg!
-  end
+    def cfg=(cfg)
+      @cfg = cfg
+      validate_cfg! if self.respond_to? :validate_cfg!
+    end
 
-  def run_hook ctx
-    raise NotImplementedError
-  end
+    def run_hook ctx
+      raise NotImplementedError
+    end
 
-  def log(msg, level=:info)
-    Oxidized.logger.send(level, "#{self.class.name}: #{msg}")
+    def log(msg, level = :info)
+      Oxidized.logger.send(level, "#{self.class.name}: #{msg}")
+    end
   end
-
-end
 end

data/lib/oxidized/hook/awssns.rb

@@ -19,9 +19,8 @@ class AwsSns < Oxidized::Hook
         :node => ctx.node.name.to_s
       )
     end
-    topic.publish({
+    topic.publish(
       message: message.to_json
-    })
+    )
   end
-
 end

data/lib/oxidized/hook/ciscosparkdiff.rb

@@ -0,0 +1,49 @@
+require 'cisco_spark'
+
+# defaults to posting a diff, if messageformat is supplied them a message will be posted too
+# diffenable defaults to true
+# Modified from slackdiff
+
+class CiscoSparkDiff < Oxidized::Hook
+  def validate_cfg!
+    raise KeyError, 'hook.accesskey is required' unless cfg.has_key?('accesskey')
+    raise KeyError, 'hook.space is required' unless cfg.has_key?('space')
+  end
+
+  def run_hook(ctx)
+    return unless ctx.node
+    return unless ctx.event.to_s == "post_store"
+    log "Connecting to Cisco Spark"
+    CiscoSpark.configure do |config|
+      config.api_key = cfg.accesskey
+      config.proxy = cfg.proxy if cfg.has_key?('proxy')
+    end
+    space = cfg.space
+    client = CiscoSpark::Room.new(id: space)
+    client.fetch
+    log "Connected"
+    diffenable = true
+    if cfg.has_key?('diff') == true
+      if cfg.diff == false
+        diffenable = false
+      end
+    end
+    if diffenable == true
+      gitoutput = ctx.node.output.new
+      diff = gitoutput.get_diff ctx.node, ctx.node.group, ctx.commitref, nil
+      title = ctx.node.name.to_s
+      log "Posting diff as snippet to #{cfg.space}"
+      message = CiscoSpark::Message.new(text: 'Device ' + title + ' modified:' + "\n" + diff[:patch].lines.to_a[4..-1].join)
+      room = CiscoSpark::Room.new(id: space)
+      room.send_message(message)
+    end
+    if cfg.has_key?('message') == true
+      log cfg.message
+      msg = cfg.message % { :node => ctx.node.name.to_s, :group => ctx.node.group.to_s, :commitref => ctx.commitref, :model => ctx.node.model.class.name.to_s.downcase }
+      log msg
+      log "Posting message to #{cfg.space}"
+      client.chat_postMessage(channel: cfg.channel, text: msg, as_user: true)
+    end
+    log "Finished"
+  end
+end

data/lib/oxidized/hook/exec.rb

@@ -23,10 +23,9 @@ class Exec < Oxidized::Hook
       @cmd = cfg.cmd
       raise "invalid cmd value" unless @cmd.is_a?(String) || @cmd.is_a?(Array)
     end
-
   rescue RuntimeError => e
     raise ArgumentError,
-      "#{self.class.name}: configuration invalid: #{e.message}"
+          "#{self.class.name}: configuration invalid: #{e.message}"
   end
 
   def run_hook ctx
@@ -45,7 +44,7 @@ class Exec < Oxidized::Hook
   def run_cmd! env
     pid, status = nil, nil
     Timeout.timeout(@timeout) do
-      pid = spawn env, @cmd , :unsetenv_others => true
+      pid = spawn env, @cmd, :unsetenv_others => true
       pid, status = wait2 pid
       unless status.exitstatus.zero?
         msg = "#{@cmd.inspect} failed with exit value #{status.exitstatus}"
@@ -53,11 +52,11 @@ class Exec < Oxidized::Hook
         raise msg
       end
     end
-  rescue TimeoutError
+  rescue Timeout::Error
     kill "TERM", pid
     msg = "#{@cmd} timed out"
     log msg, :error
-    raise TimeoutError, msg
+    raise Timeout::Error, msg
   end
 
   def make_env ctx
@@ -71,6 +70,7 @@ class Exec < Oxidized::Hook
         "OX_NODE_FROM" => ctx.node.from.to_s,
         "OX_NODE_MSG" => ctx.node.msg.to_s,
         "OX_NODE_GROUP" => ctx.node.group.to_s,
+        "OX_NODE_MODEL" => ctx.node.model.class.name,
         "OX_REPO_COMMITREF" => ctx.commitref.to_s,
         "OX_REPO_NAME" => ctx.node.repo.to_s,
       )