oxidized 0.33.0 → 0.34.0

data/lib/oxidized/cli.rb

@@ -1,5 +1,9 @@
+require 'semantic_logger'
+
 module Oxidized
   class CLI
+    include SemanticLogger::Loggable
+
     require 'slop'
     require 'oxidized'
     require 'English'
@@ -9,7 +13,7 @@ module Oxidized
       Process.daemon if @opts[:daemonize]
       write_pid
       begin
-        Oxidized.logger.info "Oxidized starting, running as pid #{$PROCESS_ID}"
+        logger.info "Oxidized starting, running as pid #{$PROCESS_ID}"
         Oxidized.new
       rescue StandardError => e
         crash e
@@ -23,13 +27,13 @@ module Oxidized
       _args, @opts = parse_opts
 
       Config.load(@opts)
-      Oxidized.setup_logger
+      Oxidized::Logger.setup
 
       @pidfile = File.expand_path(Oxidized.config.pid)
     end
 
     def crash(error)
-      Oxidized.logger.fatal "Oxidized crashed, crashfile written in #{Config::CRASH}"
+      logger.fatal "Oxidized crashed, crashfile written in #{Config::CRASH}"
       File.open Config::CRASH, 'w' do |file|
         file.puts '-' * 50
         file.puts Time.now.utc

data/lib/oxidized/config/vars.rb

@@ -6,11 +6,15 @@ module Oxidized
         model_name = @node.model.class.name.to_s.downcase
         if @node.vars&.has_key?(name)
           @node.vars[name]
-        elsif Oxidized.config.groups.has_key?(@node.group) && Oxidized.config.groups[@node.group].models.has_key(model_name) && Oxidized.config.groups[@node.group].models[model_name].vars.has_key?(name.to_s)
+        elsif Oxidized.config.groups.has_key?(@node.group) &&
+              Oxidized.config.groups[@node.group].models.has_key(model_name) &&
+              Oxidized.config.groups[@node.group].models[model_name].vars.has_key?(name.to_s)
           Oxidized.config.groups[@node.group].models[model_name].vars[name.to_s]
-        elsif Oxidized.config.groups.has_key?(@node.group) && Oxidized.config.groups[@node.group].vars.has_key?(name.to_s)
+        elsif Oxidized.config.groups.has_key?(@node.group) &&
+              Oxidized.config.groups[@node.group].vars.has_key?(name.to_s)
           Oxidized.config.groups[@node.group].vars[name.to_s]
-        elsif Oxidized.config.models.has_key(model_name) && Oxidized.config.models[model_name].vars.has_key?(name.to_s)
+        elsif Oxidized.config.models.has_key(model_name) &&
+              Oxidized.config.models[model_name].vars.has_key?(name.to_s)
           Oxidized.config.models[model_name].vars[name.to_s]
         elsif Oxidized.config.vars.has_key?(name.to_s)
           Oxidized.config.vars[name.to_s]

data/lib/oxidized/config.rb

@@ -27,7 +27,6 @@ module Oxidized
       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
       asetus.default.run_once      = false
       asetus.default.threads       = 30

data/lib/oxidized/core.rb

@@ -6,6 +6,8 @@ module Oxidized
   end
 
   class Core
+    include SemanticLogger::Loggable
+
     class NoNodesFound < OxidizedError; end
 
     def initialize(_args)
@@ -33,7 +35,7 @@ module Oxidized
 
       # Initialize oxidized-web if requested
       if Oxidized.config.has_key? 'rest'
-        Oxidized.logger.warn(
+        logger.warn(
           'configuration: "rest" is deprecated. Migrate to ' \
           '"extensions.oxidized-web" and remove "rest" from the configuration'
         )
@@ -61,14 +63,13 @@ module Oxidized
     private
 
     def reload
-      Oxidized.logger.info("Reloading node list and log files")
+      logger.info("Reloading node list")
       @worker.reload
-      Oxidized.logger.reopen
       @need_reload = false
     end
 
     def run
-      Oxidized.logger.debug "lib/oxidized/core.rb: Starting the worker..."
+      logger.debug "Starting the worker..."
       loop do
         reload if @need_reload
         @worker.work

data/lib/oxidized/hook/ciscosparkdiff.rb

@@ -14,30 +14,32 @@ class CiscoSparkDiff < Oxidized::Hook
     return unless ctx.node
     return unless ctx.event.to_s == "post_store"
 
-    log "Connecting to Cisco Spark"
+    logger.info "Connecting to Cisco Spark"
     CiscoSpark.configure do |config|
       config.api_key = cfg.accesskey
       config.proxy = cfg.proxy if cfg.has_key?('proxy')
     end
     room = CiscoSpark::Room.new(id: cfg.space)
-    log "Connected"
+    logger.info "Connected"
 
     if cfg.has_key?("diff") ? cfg.diff : 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}"
-      room.send_message CiscoSpark::Message.new(text: 'Device ' + title + ' modified:' + "\n" + diff[:patch].lines.to_a[4..-1].join)
+      logger.info "Posting diff as snippet to #{cfg.space}"
+      room.send_message CiscoSpark::Message.new(text: "Device #{title} modified:\n" +
+                                                      diff[:patch].lines.to_a[4..-1].join)
     end
 
     if cfg.message?
-      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}"
+      logger.info 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 }
+      logger.info msg
+      logger.info "Posting message to #{cfg.space}"
       room.send_message CiscoSpark::Message.new(text: msg)
     end
 
-    log "Finished"
+    logger.info "Finished"
   end
 end

data/lib/oxidized/hook/exec.rb

@@ -28,7 +28,7 @@ class Exec < Oxidized::Hook
 
   def run_hook(ctx)
     env = make_env ctx
-    log "Execute: #{@cmd.inspect}", :debug
+    logger.debug "Execute: #{@cmd.inspect}"
     th = Thread.new do
       run_cmd! env
     rescue StandardError => e
@@ -38,20 +38,21 @@ class Exec < Oxidized::Hook
   end
 
   def run_cmd!(env)
-    pid, status = nil, nil
+    pid = nil
+    status = nil
     Timeout.timeout(@timeout) do
       pid = spawn env, @cmd, unsetenv_others: true
       pid, status = wait2 pid
       unless status.exitstatus.zero?
         msg = "#{@cmd.inspect} failed with exit value #{status.exitstatus}"
-        log msg, :error
+        logger.error msg
         raise msg
       end
     end
   rescue Timeout::Error
     kill "TERM", pid
     msg = "#{@cmd} timed out"
-    log msg, :error
+    logger.error msg
     raise Timeout::Error, msg
   end
 

data/lib/oxidized/hook/githubrepo.rb

@@ -6,8 +6,13 @@ class GithubRepo < Oxidized::Hook
   end
 
   def run_hook(ctx)
+    unless ctx.node
+      logger.error 'GithubRepo.run_hook: no node provided'
+      return
+    end
+
     unless ctx.node.repo
-      log "Oxidized output is not git, can't push to remote", :error
+      logger.error "Oxidized output is not git, can't push to remote"
       return
     end
     repo  = Rugged::Repository.new(ctx.node.repo)
@@ -15,12 +20,11 @@ class GithubRepo < Oxidized::Hook
     url   = remote_repo(ctx.node)
 
     if url.nil? || url.empty?
-      log "No repository defined for #{ctx.node.group}/#{ctx.node.name}", :error
+      logger.error "No repository defined for #{ctx.node.group}/#{ctx.node.name}"
       return
     end
 
-    log "Pushing local repository(#{repo.path})..."
-    log "to remote: #{url}"
+    logger.info "Pushing local repository(#{repo.path}) to remote: #{url}"
 
     if repo.remotes['origin'].nil?
       repo.remotes.create('origin', url)
@@ -34,10 +38,10 @@ class GithubRepo < Oxidized::Hook
       remote.push([repo.head.name], credentials: creds)
     rescue Rugged::NetworkError => e
       if e.message == 'unsupported URL protocol'
-        log "Rugged does not support the git URL '#{url}'.", :warn
+        logger.warn "Rugged does not support the git URL '#{url}'."
         unless Rugged.features.include?(:ssh)
-          log 'You may need to install Rugged with ssh support ' \
-              '(gem install rugged -- --with-ssh)', :warn
+          logger.warn "Note: Rugged isn't installed with ssh support. You may need " \
+                      '"gem install rugged -- --with-ssh"'
         end
       end
       # re-raise exception for the calling method
@@ -47,28 +51,28 @@ class GithubRepo < Oxidized::Hook
 
   def fetch_and_merge_remote(repo, creds)
     result = repo.fetch('origin', [repo.head.name], credentials: creds)
-    log result.inspect, :debug
+    logger.debug result.inspect
 
     their_branch = remote_branch(repo)
 
     unless their_branch
-      log 'remote branch does not exist yet, nothing to merge', :debug
+      logger.debug 'remote branch does not exist yet, nothing to merge'
       return
     end
 
     result = repo.merge_analysis(their_branch.target_id)
 
     if result.include? :up_to_date
-      log 'nothing to merge', :debug
+      logger.debug 'nothing to merge'
       return
     end
 
-    log "merging fetched branch #{their_branch.name}", :debug
+    logger.debug "merging fetched branch #{their_branch.name}"
 
     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)
+      logger.warn "Conflicts detected, skipping Rugged::Commit.create"
       return
     end
 
@@ -85,18 +89,20 @@ class GithubRepo < Oxidized::Hook
     Proc.new do |_url, username_from_url, _allowed_types| # rubocop:disable Style/Proc
       git_user = cfg.has_key?('username') ? cfg.username : (username_from_url || 'git')
       if cfg.has_key?('password')
-        log "Authenticating using username and password as '#{git_user}'", :debug
+        logger.debug "Authenticating using username and password as '#{git_user}'"
         Rugged::Credentials::UserPassword.new(username: git_user, password: cfg.password)
       elsif cfg.has_key?('privatekey')
         pubkey = cfg.has_key?('publickey') ? cfg.publickey : nil
-        log "Authenticating using ssh keys as '#{git_user}'", :debug
+        logger.debug "Authenticating using ssh keys as '#{git_user}'"
         rugged_sshkey(git_user: git_user, privkey: cfg.privatekey, pubkey: pubkey)
-      elsif cfg.has_key?('remote_repo') && cfg.remote_repo.has_key?(node.group) && cfg.remote_repo[node.group].has_key?('privatekey')
+      elsif cfg.has_key?('remote_repo') &&
+            cfg.remote_repo.has_key?(node.group) &&
+            cfg.remote_repo[node.group].has_key?('privatekey')
         pubkey = cfg.remote_repo[node.group].has_key?('publickey') ? cfg.remote_repo[node.group].publickey : nil
-        log "Authenticating using ssh keys as '#{git_user}' for '#{node.group}/#{node.name}'", :debug
+        logger.debug "Authenticating using ssh keys as '#{git_user}' for '#{node.group}/#{node.name}'"
         rugged_sshkey(git_user: git_user, privkey: cfg.remote_repo[node.group].privatekey, pubkey: pubkey)
       else
-        log "Authenticating using ssh agent as '#{git_user}'", :debug
+        logger.debug "Authenticating using ssh agent as '#{git_user}'"
         Rugged::Credentials::SshKeyFromAgent.new(username: git_user)
       end
     end

data/lib/oxidized/hook/noophook.rb

@@ -1,9 +1,9 @@
 class NoopHook < Oxidized::Hook
   def validate_cfg!
-    log "Validate config"
+    logger.info "Validate config"
   end
 
   def run_hook(ctx)
-    log "Run hook with context: #{ctx}"
+    logger.info "Run hook with context: #{ctx}"
   end
 end

data/lib/oxidized/hook/slackdiff.rb

@@ -12,7 +12,7 @@ class SlackDiff < Oxidized::Hook
   end
 
   def slack_upload(client, title, content, channel)
-    log "Posting diff as snippet to #{channel}"
+    logger.info "Posting diff as snippet to #{channel}"
     upload_dest = client.files_getUploadURLExternal(filename:     "change",
                                                     length:       content.length,
                                                     snippet_type: "diff")
@@ -39,14 +39,14 @@ class SlackDiff < Oxidized::Hook
     return unless ctx.node
     return unless ctx.event.to_s == "post_store"
 
-    log "Connecting to slack"
+    logger.info "Connecting to slack"
     Slack::Web::Client.configure do |config|
       config.token = cfg.token
       config.proxy = cfg.proxy if cfg.has_key?('proxy')
     end
     client = Slack::Web::Client.new
     client.auth_test
-    log "Connected"
+    logger.info "Connected"
     if cfg.has_key?("diff") ? cfg.diff : true
       gitoutput = ctx.node.output.new
       diff = gitoutput.get_diff ctx.node, ctx.node.group, ctx.commitref, nil
@@ -58,12 +58,13 @@ class SlackDiff < Oxidized::Hook
     end
     # message custom formatted - optional
     if cfg.message?
-      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.channel}"
+      logger.info 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 }
+      logger.info msg
+      logger.info "Posting message to #{cfg.channel}"
       client.chat_postMessage(channel: cfg.channel, text: msg, as_user: true)
     end
-    log "Finished"
+    logger.info "Finished"
   end
 end

data/lib/oxidized/hook/xmppdiff.rb

@@ -5,35 +5,35 @@ class XMPPDiff < Oxidized::Hook
   def connect
     @client = Jabber::Client.new(Jabber::JID.new(cfg.jid))
 
-    log "Connecting to XMPP"
+    logger.info "Connecting to XMPP"
     begin
       Timeout.timeout(15) do
         begin
           @client.connect
         rescue StandardError => e
-          log "Failed to connect to XMPP: #{e}"
+          logger.info "Failed to connect to XMPP: #{e}"
         end
         sleep 1
 
-        log "Authenticating to XMPP"
+        logger.info "Authenticating to XMPP"
         @client.auth(cfg.password)
         sleep 1
 
-        log "Connected to XMPP"
+        logger.info "Connected to XMPP"
 
         @muc = Jabber::MUC::SimpleMUCClient.new(@client)
         @muc.join(cfg.channel + "/" + cfg.nick)
 
-        log "Joined #{cfg.channel}"
+        logger.info "Joined #{cfg.channel}"
       end
     rescue Timeout::Error
-      log "timed out"
+      logger.info "timed out"
       @client = nil
       @muc = nil
     end
 
     @client.on_exception do
-      log "XMPP connection aborted, reconnecting"
+      logger.info "XMPP connection aborted, reconnecting"
       @client = nil
       @muc = nil
       connect
@@ -66,14 +66,14 @@ class XMPPDiff < Oxidized::Hook
           # Maybe connecting failed, so only proceed if we actually joined the MUC
           unless @muc.nil?
             title = "#{ctx.node.name} #{ctx.node.group} #{ctx.node.model.class.name.to_s.downcase}"
-            log "Posting diff as snippet to #{cfg.channel}"
+            logger.info "Posting diff as snippet to #{cfg.channel}"
 
             @muc.say(title + "\n\n" + diff[:patch].lines.to_a[4..-1].join)
           end
         end
       end
     rescue Timeout::Error
-      log "timed out"
+      logger.info "timed out"
     end
   end
 end

data/lib/oxidized/hook.rb

@@ -1,5 +1,7 @@
 module Oxidized
   class HookManager
+    include SemanticLogger::Loggable
+
     class << self
       def from_config(cfg)
         mgr = new
@@ -14,7 +16,9 @@ module Oxidized
 
     # 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
+    # The argument keyword_init: true is needed for ruby < 3.2 and can be
+    # dropped with the support of ruby 3.1
+    HookContext = Struct.new(:event, :node, :job, :commitref, keyword_init: true)
 
     # RegisteredHook is a container for a Hook instance
     RegisteredHook = Struct.new(:name, :hook)
@@ -47,7 +51,7 @@ module Oxidized
       hook.cfg = cfg
 
       @registered_hooks[event] << RegisteredHook.new(name, hook)
-      Oxidized.logger.debug "Hook #{name.inspect} registered #{hook.class} for event #{event.inspect}"
+      logger.debug "Hook #{name.inspect} registered #{hook.class} for event #{event.inspect}"
     end
 
     def handle(event, ctx_params = {})
@@ -57,14 +61,16 @@ module Oxidized
       @registered_hooks[event].each do |r_hook|
         r_hook.hook.run_hook ctx
       rescue StandardError => e
-        Oxidized.logger.error "Hook #{r_hook.name} (#{r_hook.hook}) failed " \
-                              "(#{e.inspect}) for event #{event.inspect}"
+        logger.error "Hook #{r_hook.name} (#{r_hook.hook}) failed " \
+                     "(#{e.inspect}) for event #{event.inspect}"
       end
     end
   end
 
   # Hook abstract base class
   class Hook
+    include SemanticLogger::Loggable
+
     attr_reader :cfg
 
     def cfg=(cfg)
@@ -75,9 +81,5 @@ module Oxidized
     def run_hook(_ctx)
       raise NotImplementedError
     end
-
-    def log(msg, level = :info)
-      Oxidized.logger.send(level, "#{self.class.name}: #{msg}")
-    end
   end
 end

data/lib/oxidized/input/cli.rb

@@ -20,15 +20,16 @@ module Oxidized
       end
 
       def connect_cli
-        Oxidized.logger.debug "lib/oxidized/input/cli.rb: Running post_login commands at #{node.name}"
+        logger.debug "Running post_login commands at #{node.name}"
         @post_login.each do |command, block|
-          Oxidized.logger.debug "lib/oxidized/input/cli.rb: Running post_login command: #{command.inspect}, block: #{block.inspect} at #{node.name}"
+          logger.debug "Running post_login command: #{command.inspect}, " \
+                       "block: #{block.inspect} at #{node.name}"
           block ? block.call : (cmd command)
         end
       end
 
       def disconnect_cli
-        Oxidized.logger.debug "lib/oxidized/input/cli.rb Running pre_logout commands at #{node.name}"
+        logger.debug "Running pre_logout commands at #{node.name}"
         @pre_logout.each { |command, block| block ? block.call : (cmd command, nil) }
       end
 
@@ -52,6 +53,10 @@ module Oxidized
         @password || (@password = regex)
       end
 
+      def newline(newline_str = "\n")
+        @newline || (@newline = newline_str)
+      end
+
       def login
         match_re = [@node.prompt]
         match_re << @username if @username

data/lib/oxidized/input/exec.rb

@@ -11,7 +11,7 @@ module Oxidized
     end
 
     def cmd(cmd_str)
-      Oxidized.logger.debug "EXEC: #{cmd_str} @ #{@node.name}"
+      logger.debug "EXEC: #{cmd_str} @ #{@node.name}"
       # I'd really like to do popen3 with separate arguments, but that would
       # require refactoring cmd to take parameters
       %x(#{cmd_str})

data/lib/oxidized/input/ftp.rb

@@ -15,7 +15,7 @@ module Oxidized
     }.freeze
     include Input::CLI
 
-    def connect(node)
+    def connect(node) # rubocop:disable Naming/PredicateMethod
       @node = node
       @node.model.cfg['ftp'].each { |cb| instance_exec(&cb) }
       @log = File.open(Oxidized::Config::LOG + "/#{@node.ip}-ftp", 'w') if Oxidized.config.input.debug?
@@ -30,7 +30,7 @@ module Oxidized
     end
 
     def cmd(file)
-      Oxidized.logger.debug "FTP: #{file} @ #{@node.name}"
+      logger.debug "FTP: #{file} @ #{@node.name}"
       @ftp.getbinaryfile file, nil
     end
 

data/lib/oxidized/input/http.rb

@@ -51,7 +51,7 @@ module Oxidized
       schema = @secure ? "https://" : "http://"
       uri = URI("#{schema}#{@node.ip}#{path}")
 
-      Oxidized.logger.debug "Making request to: #{uri}"
+      logger.debug "Making request to: #{uri}"
 
       ssl_verify = Oxidized.config.input.http.ssl_verify? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
 
@@ -60,16 +60,16 @@ module Oxidized
       if res.code == '401' && res['www-authenticate']&.include?('Digest')
         uri.user = @username
         uri.password = URI.encode_www_form_component(@password)
-        Oxidized.logger.debug "Server requires Digest authentication"
+        logger.debug "Server requires Digest authentication"
         auth = Net::HTTP::DigestAuth.new.auth_header(uri, res['www-authenticate'], 'GET')
 
         res = make_request(uri, ssl_verify, 'Authorization' => auth)
       elsif @username && @password
-        Oxidized.logger.debug "Falling back to Basic authentication"
+        logger.debug "Falling back to Basic authentication"
         res = make_request(uri, ssl_verify, 'Authorization' => basic_auth_header)
       end
 
-      Oxidized.logger.debug "Response code: #{res.code}"
+      logger.debug "Response code: #{res.code}"
       res.body
     end
 
@@ -77,7 +77,7 @@ module Oxidized
       Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https", verify_mode: ssl_verify) do |http|
         req = Net::HTTP::Get.new(uri)
         @headers.merge(extra_headers).each { |header, value| req.add_field(header, value) }
-        Oxidized.logger.debug "Sending request with headers: #{@headers.merge(extra_headers)}"
+        logger.debug "Sending request with headers: #{@headers.merge(extra_headers)}"
         http.request(req)
       end
     end

data/lib/oxidized/input/input.rb

@@ -2,6 +2,7 @@ module Oxidized
   class PromptUndetect < OxidizedError; end
 
   class Input
+    include SemanticLogger::Loggable
     include Oxidized::Config::Vars
 
     RESCUE_FAIL = {

data/lib/oxidized/input/scp.rb

@@ -16,7 +16,7 @@ module Oxidized
     }.freeze
     include Input::CLI
 
-    def connect(node)
+    def connect(node) # rubocop:disable Naming/PredicateMethod
       @node = node
       @node.model.cfg['scp'].each { |cb| instance_exec(&cb) }
       @log = File.open(Oxidized::Config::LOG + "/#{@node.ip}-scp", 'w') if Oxidized.config.input.debug?
@@ -29,7 +29,7 @@ module Oxidized
     end
 
     def cmd(file)
-      Oxidized.logger.debug "SCP: #{file} @ #{@node.name}"
+      logger.debug "SCP: #{file} @ #{@node.name}"
       @ssh.scp.download!(file)
     end