oxidized 0.29.1 → 0.37.0

data/lib/oxidized/worker.rb

@@ -2,6 +2,8 @@ module Oxidized
   require 'oxidized/job'
   require 'oxidized/jobs'
   class Worker
+    include SemanticLogger::Loggable
+
     def initialize(nodes)
       @jobs_done  = 0
       @nodes      = nodes
@@ -17,24 +19,28 @@ module Oxidized
       @jobs.work
 
       while @jobs.size < @jobs.want
-        Oxidized.logger.debug "lib/oxidized/worker.rb: Jobs running: #{@jobs.size} of #{@jobs.want} - ended: #{@jobs_done} of #{@nodes.size}"
+        logger.debug "Jobs running: #{@jobs.size} of #{@jobs.want} - ended: " \
+                     "#{@jobs_done} of #{@nodes.size}"
         # ask for next node in queue non destructive way
         nextnode = @nodes.first
-        unless nextnode.last.nil?
-          # Set unobtainable value for 'last' if interval checking is disabled
-          last = Oxidized.config.interval.zero? ? Time.now.utc + 10 : nextnode.last.end
-          break if last + Oxidized.config.interval > Time.now.utc
-        end
+        break if Oxidized.config.interval.zero? && !nextnode.nexted?
+
+        nextnode.nexted = false
+        break if !nextnode.last.nil? && (nextnode.last.end + Oxidized.config.interval > Time.now.utc)
+
         # shift nodes and get the next node
         node = @nodes.get
         node.running? ? next : node.running = true
 
         @jobs.push Job.new node
-        Oxidized.logger.debug "lib/oxidized/worker.rb: Added #{node.group}/#{node.name} to the job queue"
+        logger.debug "Added #{node.group}/#{node.name} to the job queue"
       end
 
-      run_done_hook if cycle_finished?
-      Oxidized.logger.debug("lib/oxidized/worker.rb: #{@jobs.size} jobs running in parallel") unless @jobs.empty?
+      if cycle_finished?
+        run_done_hook
+        exit 0 if Oxidized.config.run_once
+      end
+      logger.debug("#{@jobs.size} jobs running in parallel") unless @jobs.empty?
     end
 
     def process(job)
@@ -49,26 +55,52 @@ module Oxidized
         process_failure node, job
       end
     rescue NodeNotFound
-      Oxidized.logger.warn "#{node.group}/#{node.name} not found, removed while collecting?"
+      logger.warn "#{node.group}/#{node.name} not found, removed while collecting?"
+    end
+
+    def reload
+      @nodes.load
     end
 
     private
 
+    def significant_changes?(job, output)
+      node = job.node
+      model = node.model
+      return true unless model.vars(:output_store_mode) == "on_significant"
+
+      unless output.respond_to?(:fetch)
+        logger.error("Detection of significant changes needs an output " \
+                     "capable of fetching the last configuration")
+        return true
+      end
+
+      old = model.significant_changes output.fetch(node, node.group)
+      new = model.significant_changes job.config.to_cfg
+      if old == new
+        logger.debug "No significant change on node #{node.name}"
+        false
+      else
+        true
+      end
+    end
+
     def process_success(node, job)
       @jobs_done += 1 # needed for :nodes_done hook
-      Oxidized.hooks.handle :node_success, node: node,
-                                           job:  job
+      Oxidized.hooks.node_success(node: node, job: job)
       msg = "update #{node.group}/#{node.name}"
       msg += " from #{node.from}" if node.from
       msg += " with message '#{node.msg}'" if node.msg
       output = node.output.new
-      if output.store node.name, job.config,
-                      msg: msg, email: node.email, user: node.user, group: node.group
+
+      significant_changes = significant_changes?(job, output)
+      if output.store(node.name, job.config,
+                      msg: msg, email: node.email, user: node.user,
+                      group: node.group,
+                      significant_changes: significant_changes)
         node.modified
-        Oxidized.logger.info "Configuration updated for #{node.group}/#{node.name}"
-        Oxidized.hooks.handle :post_store, node:      node,
-                                           job:       job,
-                                           commitref: output.commitref
+        logger.info "Configuration updated for #{node.group}/#{node.name}"
+        Oxidized.hooks.post_store(node: node, job: job, commitref: output.commitref)
       end
       node.reset
     end
@@ -87,26 +119,22 @@ module Oxidized
         @jobs_done += 1
         msg += ", retries exhausted, giving up"
         node.retry = 0
-        Oxidized.hooks.handle :node_fail, node: node,
-                                          job:  job
+        Oxidized.hooks.node_fail(node: node, job: job)
       end
-      Oxidized.logger.warn msg
+      logger.warn msg
     end
 
     def cycle_finished?
-      if @jobs_done > @nodes.count
-        true
-      else
-        @jobs_done.positive? && (@jobs_done % @nodes.count).zero?
-      end
+      @jobs_done > @nodes.count ||
+        (@jobs_done.positive? && (@jobs_done % @nodes.count).zero?)
     end
 
     def run_done_hook
-      Oxidized.logger.debug "lib/oxidized/worker.rb: Running :nodes_done hook"
-      Oxidized.hooks.handle :nodes_done
+      logger.debug "Running :nodes_done hook"
+      Oxidized.hooks.nodes_done
     rescue StandardError => e
       # swallow the hook erros and continue as normal
-      Oxidized.logger.error "lib/oxidized/worker.rb: #{e.message}"
+      logger.error e.message
     ensure
       @jobs_done = 0
     end

data/lib/oxidized.rb

@@ -1,8 +1,10 @@
 require 'fileutils'
 require 'refinements'
+require 'semantic_logger'
 
 module Oxidized
   class OxidizedError < StandardError; end
+  include SemanticLogger::Loggable
 
   Directory = File.expand_path(File.join(File.dirname(__FILE__), '../'))
 
@@ -13,7 +15,9 @@ module Oxidized
   require 'oxidized/nodes'
   require 'oxidized/manager'
   require 'oxidized/hook'
+  require 'oxidized/signals'
   require 'oxidized/core'
+  require 'oxidized/logger'
 
   def self.asetus
     @@asetus
@@ -26,28 +30,4 @@ module Oxidized
   def self.config
     asetus.cfg
   end
-
-  def self.logger
-    @@logger
-  end
-
-  def self.logger=(val)
-    @@logger = val
-  end
-
-  def self.setup_logger
-    FileUtils.mkdir_p(Config::Log) unless File.directory?(Config::Log)
-    self.logger = if config.has_key?('use_syslog') && config.use_syslog
-                    require 'syslog/logger'
-                    Syslog::Logger.new('oxidized')
-                  else
-                    require 'logger'
-                    if config.has_key?('log')
-                      Logger.new(File.expand_path(config.log))
-                    else
-                      Logger.new(STDERR)
-                    end
-                  end
-    logger.level = Logger::INFO unless config.debug
-  end
 end

data/lib/refinements.rb

@@ -25,9 +25,29 @@ module Refinements
     end
 
     # sets @cmd and @name unless @name is already set
-    def set_cmd(command)
+    def process_cmd(command)
       @cmd = command
+      # rubocop:disable Naming/MemoizedInstanceVariableName
       @name ||= @cmd.to_s.strip.gsub(/\s+/, '_') # what to do when command is proc? #to_s seems ghetto
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+    end
+
+    # keeps lines matching any pattern (String or Regexp)
+    def keep_lines(patterns)
+      each_line.select do |line|
+        patterns.any? do |pattern|
+          pattern.is_a?(Regexp) ? line =~ pattern : line.include?(pattern)
+        end
+      end.join
+    end
+
+    # remove lines matching any pattern (String or Regexp)
+    def reject_lines(patterns)
+      each_line.reject do |line|
+        patterns.any? do |pattern|
+          pattern.is_a?(Regexp) ? line =~ pattern : line.include?(pattern)
+        end
+      end.join
     end
 
     # Initializes the String instance variables from another String instance

data/oxidized.gemspec

@@ -12,33 +12,57 @@ Gem::Specification.new do |s|
   s.homepage          = 'http://github.com/ytti/oxidized'
   s.summary           = 'feeble attempt at rancid'
   s.description       = 'software to fetch configuration from network devices and store them'
-  s.rubyforge_project = s.name
-  s.files             = %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.files             = %x(git ls-files -z).split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
   s.executables       = %w[oxidized]
   s.require_path      = 'lib'
 
   s.metadata['rubygems_mfa_required'] = 'true'
 
+  # Ruby version strategy
+  #
+  # We try to keep the minimum version of Ruby to match supported LTS versions
+  # of common Linux distributions, as long as the maintenance effort remains
+  # reasonable.
   s.required_ruby_version = '>= 3.0'
 
-  s.add_runtime_dependency 'asetus',       '~> 0.1'
-  s.add_runtime_dependency 'bcrypt_pbkdf', '~> 1.0'
-  s.add_runtime_dependency 'ed25519',      '~> 1.2'
-  s.add_runtime_dependency 'net-ssh',      '~> 7.1'
-  s.add_runtime_dependency 'net-telnet',   '~> 0.2'
-  s.add_runtime_dependency 'rugged',       '~> 1.6'
-  s.add_runtime_dependency 'slop',         '~> 4.6'
+  # Gemspec strategy
+  #
+  # For dependency and optional dependencies, we try to set the minimal
+  # dependency lower or equal to the Debian 13 "Trixie" package version,
+  # so that native packages can be used.
+  # We limit the maximal minor version so that dependabot can warn about new
+  # major versions and we can test them before activating them in Oxidized.
 
-  s.add_development_dependency 'bundler',             '~> 2.2'
-  s.add_development_dependency 'git',                 '~> 1'
-  s.add_development_dependency 'minitest',            '~> 5.18'
-  s.add_development_dependency 'mocha',               '~> 1.2'
-  s.add_development_dependency 'pry',                 '~> 0.14.2'
-  s.add_development_dependency 'rake',                '~> 13.0'
-  s.add_development_dependency 'rubocop',             '~> 1.48.0'
-  s.add_development_dependency 'rubocop-minitest',    '~> 0.29.0'
-  s.add_development_dependency 'rubocop-rake',        '~> 0.6.0'
-  s.add_development_dependency 'simplecov',           '~> 0.22.0'
-  s.add_development_dependency 'simplecov-cobertura', '~> 2.1.0'
-  s.add_development_dependency 'simplecov-html',      '~> 0.12.3'
+  s.add_dependency 'asetus',               '~> 0.4'
+  s.add_dependency 'bcrypt_pbkdf',         '~> 1.0'
+  s.add_dependency 'ed25519',              '~> 1.2'
+  s.add_dependency 'net-ftp',              '~> 0.2'
+  s.add_dependency 'net-http-digest_auth', '~> 1.4'
+  s.add_dependency 'net-ssh',              '~> 7.3'
+  s.add_dependency 'net-telnet',           '~> 0.2'
+  s.add_dependency 'psych',                '~> 5.0'
+  s.add_dependency 'rugged',               '~> 1.6'
+  s.add_dependency 'semantic_logger',      '~> 4.17'
+  s.add_dependency 'slop',                 '~> 4.6'
+  s.add_dependency 'syslog',               '~> 0.3'
+  s.add_dependency 'syslog_protocol',      '~> 0.9'
+
+  s.add_development_dependency 'minitest',         '>= 5.18', '<7'
+  s.add_development_dependency 'mocha',            '>= 2.1', '<4'
+  s.add_development_dependency 'pry',              '~> 0.15'
+  s.add_development_dependency 'rake',             '~> 13.0'
+  # Rubocop introduces new rules in minor versions, so we limit automatic
+  # updates to patches
+  s.add_development_dependency 'rubocop',          '~> 1.86.0'
+  s.add_development_dependency 'rubocop-minitest', '~> 0.39.1'
+  s.add_development_dependency 'rubocop-rake',     '~> 0.7.0'
+  s.add_development_dependency 'rubocop-sequel',   '~> 0.4.0'
+  s.add_development_dependency 'simplecov',        '~> 0.22'
+
+  # Dependencies on optional libraries, used for unit tests & development
+  s.add_development_dependency 'git',              '>= 2.0', '< 5'
+  s.add_development_dependency 'net-scp',          '~> 4.1'
+  s.add_development_dependency 'net-tftp',         '~> 0.1.0'
+  s.add_development_dependency 'oxidized-web',     '>= 0.17.1'
+  s.add_development_dependency 'sequel',           '>= 5.63.0', '< 6'
 end