oxidized 0.28.0 → 0.29.0

data/lib/oxidized/model/truenas.rb

@@ -0,0 +1,20 @@
+class TrueNAS < Oxidized::Model
+  comment '# '
+
+  cmd('uname -a') { |cfg| comment cfg }
+  cmd('cat /etc/version') { |cfg| comment cfg }
+  cmd('sqlite3 "file:///data/freenas-v1.db?mode=ro&immutable=1" .dump') do |cfg|
+    cfg.lines.reject do |line|
+      line.match(/^INSERT INTO storage_replication /) ||
+        line.match(/^INSERT INTO system_alert /)
+    end.join
+  end
+
+  cfg :ssh do
+    exec true # don't run shell, run each command in exec channel
+  end
+
+  cfg :ssh do
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/vrp.rb

@@ -1,7 +1,7 @@
 class VRP < Oxidized::Model
   # Huawei VRP
 
-  prompt /^(<[\w.-]+>)$/
+  prompt /^.*(<[\w.-]+>)$/
   comment '# '
 
   cmd :secret do |cfg|

data/lib/oxidized/model/xos.rb

@@ -1,7 +1,7 @@
 class XOS < Oxidized::Model
   # Extreme Networks XOS
 
-  prompt /^\*?\s?[-\w.~]+(:\d+)? [#>] $/
+  prompt /^\s?\*?\s?[-\w]+\s?[-\w.~]+(:\d+)? [#>] $/
   comment  '# '
 
   cmd :all do |cfg|
@@ -23,7 +23,8 @@ class XOS < Oxidized::Model
   end
 
   cmd 'show switch' do |cfg|
-    comment cfg.each_line.reject { |line| line.match(/Time:/) || line.match(/boot/i) }.join
+    cfg.gsub! /Next periodic save on.*/, ''
+    comment cfg.each_line.reject { |line| line.match(/Time:/) || line.match(/boot/i) || line.match(/Next periodic/) }.join
   end
 
   cmd 'show configuration' do |cfg|
@@ -43,7 +44,7 @@ class XOS < Oxidized::Model
   cfg :telnet, :ssh do
     post_login do
       data = cmd 'disable clipaging session'
-      match = data.match /^disable clipaging session\n\*?[\w .-]+(:\d+)? [#>] $/m
+      match = data.match /^disable clipaging session\n\r?\*?\s?[-\w]+\s?[-\w.~]+(:\d+)? [#>] $/m
       next if match
 
       cmd 'disable clipaging'

data/lib/oxidized/model/yamaha.rb

@@ -0,0 +1,57 @@
+class Yamaha < Oxidized::Model
+  prompt /^([\w.@()-]+[#>]\s?)$/
+  comment '# '
+
+  expect /^---more---$/ do |data, re|
+    send ' '
+    data.sub re, ''
+  end
+
+  # non-preferred way to handle additional PW prompt
+  # expect /^[\w.]+>$/ do |data|
+  #  send "enable\n"
+  #  send vars(:enable) + "\n"
+  #  data
+  # end
+
+  expect /^Save new configuration/ do |data, re|
+    send "N\n"
+    data.sub re, ''
+  end
+
+  cmd :all do |cfg|
+    # cfg.gsub! /\cH+\s{8}/, ''         # example how to handle pager
+    # cfg.gsub! /\cH+/, ''              # example how to handle pager
+    # get rid of errors for commands that don't work on some devices
+    cfg.gsub! /^Error: Invalid command name$|^\s+\^$/, ''
+    cfg.cut_both
+  end
+
+  cmd 'show config' do |cfg|
+    cfg.gsub! /^(# Reporting Date:\s+)(.*)$/, '\1<stripped>'
+    cfg
+  end
+
+  cfg :telnet do
+    password /^Password:/i
+  end
+
+  cfg :telnet, :ssh do
+    # preferred way to handle additional passwords
+    post_login 'console lines infinity'
+    post_login 'console columns  200'
+    post_login 'console character ascii'
+    post_login do
+      if vars(:enable) == true
+        cmd "administrator"
+      elsif vars(:enable)
+        cmd "administrator", /^[pP]assword:/
+        cmd vars(:enable)
+      end
+    end
+    pre_logout do
+      cmd 'exit'
+    end
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/zteolt.rb

@@ -0,0 +1,52 @@
+class ZTEOLT < Oxidized::Model
+  # Tested with C320 and C300 olt, firware 1.2.5P3 and 2.1.0
+
+  prompt /^([\w.@()-]+[#>]\s?)$/
+  comment  '! '
+
+  cmd :all do |cfg|
+    cfg.gsub! /^% Invalid input detected at '\^' marker\.$|^\s+\^$/, ''
+    cfg.cut_both
+  end
+
+  cmd :secret do |cfg|
+    cfg.gsub! /^(snmp-server community).*/, '\\1 <configuration removed>'
+    cfg.gsub! /^(tacacs-server (.+ )?key) .+/, '\\1 <secret hidden>'
+    cfg.gsub! /^username (\S+) privilege (\d+) (\S+).*/, '<secret hidden>'
+    cfg.gsub! /^(enable (password|secret)( level \d+)? \d) .+/, '\\1 <secret hidden>'
+    cfg
+  end
+
+  cmd 'show version-running' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show patch-running' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg.gsub! /^timestamp_write: .*\n/, ''
+    cfg
+  end
+
+  cfg :telnet do
+    username /^Username:/i
+    password /^Password:/i
+  end
+
+  cfg :telnet, :ssh do
+    # preferred way to handle additional passwords
+    post_login do
+      if vars(:enable) == true
+        cmd "enable"
+      elsif vars(:enable)
+        cmd "enable", /^[pP]assword:/
+        cmd vars(:enable)
+      end
+    end
+    post_login 'terminal length 0'
+    pre_logout 'disable'
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/zy1308.rb

@@ -0,0 +1,11 @@
+# For Zyxel OLTs series 1308
+class Zy1308 < Oxidized::Model
+  # For Zyxel OLTs series 1308
+
+  cmd '/config_OLT-1308S-22.log'
+  cfg :http do
+    @username = @node.auth[:username]
+    @password = @node.auth[:password]
+    @secure = false
+  end
+end

data/lib/oxidized/node/stats.rb

@@ -2,6 +2,7 @@ module Oxidized
   class Node
     class Stats
       attr_reader :mtimes
+
       MAX_STAT = 10
 
       # @param [Job] job job whose information add to stats

data/lib/oxidized/node.rb

@@ -4,9 +4,10 @@ module Oxidized
   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, :repo
-    attr_accessor :running, :user, :email, :msg, :from, :stats, :retry
+    attr_accessor :running, :user, :email, :msg, :from, :stats, :retry, :err_type, :err_reason
     alias running? running
 
     def initialize(opt)
@@ -28,6 +29,8 @@ module Oxidized
       @stats = Stats.new
       @retry = 0
       @repo = resolve_repo opt
+      @err_type = nil
+      @err_reason = nil
 
       # model instance needs to access node instance
       @model.node = self
@@ -73,6 +76,8 @@ module Oxidized
           resc  = " (rescued #{resc})"
         end
         Oxidized.logger.send(level, '%s raised %s%s with msg "%s"' % [ip, err.class, resc, err.message])
+        @err_type = err.class.to_s
+        @err_reason = err.message.to_s
         false
       rescue StandardError => err
         crashdir  = Oxidized.config.crash.directory
@@ -86,6 +91,8 @@ module Oxidized
           fh.puts err.backtrace
         end
         Oxidized.logger.error '%s raised %s with msg "%s", %s saved' % [ip, err.class, err.message, crashfile]
+        @err_type = err.class.to_s
+        @err_reason = err.message.to_s
         false
       end
     end
@@ -153,6 +160,7 @@ module Oxidized
       inputs = resolve_key :input, opt, Oxidized.config.input.default
       inputs.split(/\s*,\s*/).map do |input|
         Oxidized.mgr.add_input(input) || raise(MethodNotFound, "#{input} not found for node #{ip}") unless Oxidized.mgr.input[input]
+
         Oxidized.mgr.input[input]
       end
     end
@@ -160,6 +168,7 @@ module Oxidized
     def resolve_output(opt)
       output = resolve_key :output, opt, Oxidized.config.output.default
       Oxidized.mgr.add_output(output) || raise(MethodNotFound, "#{output} not found for node #{ip}") unless Oxidized.mgr.output[output]
+
       Oxidized.mgr.output[output]
     end
 
@@ -202,19 +211,15 @@ module Oxidized
       end
 
       # group
-      if Oxidized.config.groups.has_key?(@group)
-        if Oxidized.config.groups[@group].has_key?(key_str)
-          value = Oxidized.config.groups[@group][key_str]
-          Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from group"
-        end
+      if Oxidized.config.groups.has_key?(@group) && Oxidized.config.groups[@group].has_key?(key_str)
+        value = Oxidized.config.groups[@group][key_str]
+        Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from group"
       end
 
       # model
-      if Oxidized.config.models.has_key?(@model.class.name.to_s.downcase)
-        if Oxidized.config.models[@model.class.name.to_s.downcase].has_key?(key_str)
-          value = Oxidized.config.models[@model.class.name.to_s.downcase][key_str]
-          Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from model"
-        end
+      if Oxidized.config.models.has_key?(@model.class.name.to_s.downcase) && Oxidized.config.models[@model.class.name.to_s.downcase].has_key?(key_str)
+        value = Oxidized.config.models[@model.class.name.to_s.downcase][key_str]
+        Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from model"
       end
 
       # node

data/lib/oxidized/nodes.rb

@@ -3,6 +3,7 @@ module Oxidized
   require 'oxidized/node'
   class Oxidized::NotSupported < OxidizedError; end
   class Oxidized::NodeNotFound < OxidizedError; end
+
   class Nodes < Array
     attr_accessor :source, :jobs
     alias put unshift
@@ -36,6 +37,7 @@ module Oxidized
 
       node_want_ip = (IPAddr.new(node_want) rescue false)
       name_is_ip   = (IPAddr.new(node[:name]) rescue false)
+      # rubocop:todo Lint/DuplicateBranch
       if name_is_ip && (node_want_ip == node[:name])
         true
       elsif node[:ip] && (node_want_ip == node[:ip])
@@ -43,6 +45,7 @@ module Oxidized
       elsif node_want.match node[:name]
         true unless name_is_ip
       end
+      # rubocop:enable Lint/DuplicateBranch
     end
 
     def list
@@ -159,13 +162,11 @@ module Oxidized
       old = dup
       replace(nodes)
       each do |node|
-        begin
-          if (i = old.find_node_index(node.name))
-            node.stats = old[i].stats
-            node.last  = old[i].last
-          end
-        rescue Oxidized::NodeNotFound
+        if (i = old.find_node_index(node.name))
+          node.stats = old[i].stats
+          node.last  = old[i].last
         end
+      rescue Oxidized::NodeNotFound
       end
       sort_by! { |x| x.last.nil? ? Time.new(0) : x.last.end }
     end

data/lib/oxidized/output/file.rb

@@ -5,6 +5,7 @@ module Oxidized
     attr_reader :commitref
 
     def initialize
+      super
       @cfg = Oxidized.config.output.file
     end
 
@@ -21,7 +22,7 @@ module Oxidized
       file = File.join File.dirname(file), opt[:group] if opt[:group]
       FileUtils.mkdir_p file
       file = File.join file, node
-      File.open(file, 'w') { |fh| fh.write outputs.to_cfg }
+      File.write(file, outputs.to_cfg)
       @commitref = file
     end
 

data/lib/oxidized/output/git.rb

@@ -10,6 +10,7 @@ module Oxidized
     attr_reader :commitref
 
     def initialize
+      super
       @cfg = Oxidized.config.output.git
     end
 
@@ -78,7 +79,7 @@ module Oxidized
       i = -1
       tab = []
       walker.each do |commit|
-        next if commit.diff(paths: [path]).size.zero?
+        next if commit.diff(paths: [path]).empty?
 
         hash = {}
         hash[:date] = commit.time.to_s
@@ -158,11 +159,11 @@ module Oxidized
       begin
         repo = Rugged::Repository.new repo
         update_repo repo, file, data
-      rescue Rugged::OSError, Rugged::RepositoryError => open_error
+      rescue Rugged::OSError, Rugged::RepositoryError => e
         begin
           Rugged::Repository.init_at repo, :bare
         rescue StandardError => create_error
-          raise GitError, "first '#{open_error.message}' was raised while opening git repo, then '#{create_error.message}' was while trying to create git repo"
+          raise GitError, "first '#{e.message}' was raised while opening git repo, then '#{create_error.message}' was while trying to create git repo"
         end
         retry
       end

data/lib/oxidized/output/gitcrypt.rb

@@ -10,6 +10,7 @@ module Oxidized
     attr_reader :commitref
 
     def initialize
+      super
       @cfg = Oxidized.config.output.gitcrypt
       @gitcrypt_cmd = "/usr/bin/git-crypt"
       @gitcrypt_init = @gitcrypt_cmd + " init"
@@ -194,13 +195,13 @@ module Oxidized
 
       begin
         update_repo repo, file, data, @msg, @user, @email
-      rescue Git::GitExecuteError, ArgumentError => open_error
-        Oxidized.logger.debug "open_error #{open_error} #{file}"
+      rescue Git::GitExecuteError, ArgumentError => e
+        Oxidized.logger.debug "open_error #{e} #{file}"
         begin
           grepo = Git.init repo
           crypt_init grepo
         rescue StandardError => create_error
-          raise GitCryptError, "first '#{open_error.message}' was raised while opening git repo, then '#{create_error.message}' was while trying to create git repo"
+          raise GitCryptError, "first '#{e.message}' was raised while opening git repo, then '#{create_error.message}' was while trying to create git repo"
         end
         retry
       end
@@ -214,11 +215,7 @@ module Oxidized
         unlock grepo
         File.write(file, data)
         grepo.add(file)
-        if grepo.status[file].nil?
-          grepo.commit(msg)
-          @commitref = grepo.log(1).first.objectish
-          true
-        elsif !grepo.status[file].type.nil?
+        if grepo.status[file].nil? || !grepo.status[file].type.nil?
           grepo.commit(msg)
           @commitref = grepo.log(1).first.objectish
           true

data/lib/oxidized/output/http.rb

@@ -1,7 +1,9 @@
 module Oxidized
   class Http < Output
     attr_reader :commitref
+
     def initialize
+      super
       @cfg = Oxidized.config.output.http
     end
 

data/lib/oxidized/source/csv.rb

@@ -32,6 +32,7 @@ module Oxidized
           keys[key.to_sym] = node_var_interpolate data[position]
         end
         keys[:model] = map_model keys[:model] if keys.has_key? :model
+        keys[:group] = map_group keys[:group] if keys.has_key? :group
 
         # map node specific vars
         vars = {}

data/lib/oxidized/source/http.rb

@@ -29,6 +29,7 @@ module Oxidized
           keys[key.to_sym] = node_var_interpolate string_navigate(node, want_position)
         end
         keys[:model] = map_model keys[:model] if keys.has_key? :model
+        keys[:group] = map_group keys[:group] if keys.has_key? :group
 
         # map node specific vars
         vars = {}
@@ -61,6 +62,9 @@ module Oxidized
       http.use_ssl = true if uri.scheme == 'https'
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @cfg.secure
 
+      # Add read_timeout to handle case of big list of nodes (default value is 60 seconds)
+      http.read_timeout = Integer(@cfg.read_timeout) if @cfg.has_key? "read_timeout"
+
       # map headers
       headers = {}
       @cfg.headers.each do |header, value|

data/lib/oxidized/source/source.rb

@@ -3,11 +3,16 @@ module Oxidized
     class NoConfig < OxidizedError; end
 
     def initialize
-      @map = (Oxidized.config.model_map || {})
+      @model_map = (Oxidized.config.model_map || {})
+      @group_map = (Oxidized.config.group_map || {})
     end
 
     def map_model(model)
-      @map.has_key?(model) ? @map[model] : model
+      @model_map.has_key?(model) ? @model_map[model] : model
+    end
+
+    def map_group(group)
+      @group_map.has_key?(group) ? @group_map[group] : group
     end
 
     def node_var_interpolate(var)

data/lib/oxidized/source/sql.rb

@@ -31,6 +31,7 @@ module Oxidized
         keys = {}
         @cfg.map.each { |key, sql_column| keys[key.to_sym] = node_var_interpolate node[sql_column.to_sym] }
         keys[:model] = map_model keys[:model] if keys.has_key? :model
+        keys[:group] = map_group keys[:group] if keys.has_key? :group
 
         # map node specific vars
         vars = {}
@@ -53,11 +54,20 @@ module Oxidized
     end
 
     def connect
-      Sequel.connect(adapter:  @cfg.adapter,
-                     host:     @cfg.host?,
-                     user:     @cfg.user?,
-                     password: @cfg.password?,
-                     database: @cfg.database)
+      options = {
+        adapter:  @cfg.adapter,
+        host:     @cfg.host?,
+        user:     @cfg.user?,
+        password: @cfg.password?,
+        database: @cfg.database,
+        ssl_mode: @cfg.ssl_mode?
+      }
+      if @cfg.with_ssl?
+        options.merge!(sslca:   @cfg.ssl_ca?,
+                       sslcert: @cfg.ssl_cert?,
+                       sslkey:  @cfg.ssl_key?)
+      end
+      Sequel.connect(options)
     rescue Sequel::AdapterNotFound => error
       raise OxidizedError, "SQL adapter gem not installed: " + error.message
     end

data/lib/oxidized/string.rb

@@ -5,17 +5,23 @@ module Oxidized
 
     # @return [Oxidized::String] copy of self with last line removed
     def cut_tail(lines = 1)
-      Oxidized::String.new each_line.to_a[0..-1 - lines].join
+      return Oxidized::String.new("") if length.zero?
+
+      Oxidized::String.new each_line.to_a[0..(-1 - lines)].join
     end
 
     # @return [Oxidized::String] copy of self with first line removed
     def cut_head(lines = 1)
+      return Oxidized::String.new("") if length.zero?
+
       Oxidized::String.new each_line.to_a[lines..-1].join
     end
 
     # @return [Oxidized::String] copy of self with first and last lines removed
     def cut_both(head = 1, tail = 1)
-      Oxidized::String.new each_line.to_a[head..-1 - tail].join
+      return Oxidized::String.new("") if length.zero?
+
+      Oxidized::String.new each_line.to_a[head..(-1 - tail)].join
     end
 
     # sets @cmd and @name unless @name is already set
@@ -26,7 +32,7 @@ module Oxidized
 
     def initialize(str = '')
       super
-      return unless str.class == Oxidized::String
+      return unless str.instance_of?(Oxidized::String)
 
       @cmd  = str.cmd
       @name = str.name

data/lib/oxidized/version.rb

@@ -1,6 +1,6 @@
 module Oxidized
-  VERSION = '0.28.0'.freeze
-  VERSION_FULL = '0.28.0'.freeze
+  VERSION = '0.29.0'.freeze
+  VERSION_FULL = '0.29.0'.freeze
   def self.version_set
     version_full = %x(git describe --tags).chop rescue ""
     version      = %x(git describe --tags --abbrev=0).chop rescue ""

data/lib/oxidized/worker.rb

@@ -5,7 +5,7 @@ module Oxidized
     def initialize(nodes)
       @jobs_done  = 0
       @nodes      = nodes
-      @jobs       = Jobs.new(Oxidized.config.threads, Oxidized.config.interval, @nodes)
+      @jobs       = Jobs.new(Oxidized.config.threads, Oxidized.config.use_max_threads, Oxidized.config.interval, @nodes)
       @nodes.jobs = @jobs
       Thread.abort_on_exception = true
     end
@@ -56,7 +56,7 @@ module Oxidized
 
     def process_success(node, job)
       @jobs_done += 1 # needed for :nodes_done hook
-      Oxidized.Hooks.handle :node_success, node: node,
+      Oxidized.hooks.handle :node_success, node: node,
                                            job:  job
       msg = "update #{node.group}/#{node.name}"
       msg += " from #{node.from}" if node.from
@@ -66,7 +66,7 @@ module Oxidized
                       msg: msg, email: node.email, user: node.user, group: node.group
         node.modified
         Oxidized.logger.info "Configuration updated for #{node.group}/#{node.name}"
-        Oxidized.Hooks.handle :post_store, node:      node,
+        Oxidized.hooks.handle :post_store, node:      node,
                                            job:       job,
                                            commitref: output.commitref
       end
@@ -87,7 +87,7 @@ module Oxidized
         @jobs_done += 1
         msg += ", retries exhausted, giving up"
         node.retry = 0
-        Oxidized.Hooks.handle :node_fail, node: node,
+        Oxidized.hooks.handle :node_fail, node: node,
                                           job:  job
       end
       Oxidized.logger.warn msg
@@ -103,7 +103,7 @@ module Oxidized
 
     def run_done_hook
       Oxidized.logger.debug "lib/oxidized/worker.rb: Running :nodes_done hook"
-      Oxidized.Hooks.handle :nodes_done
+      Oxidized.hooks.handle :nodes_done
     rescue StandardError => e
       # swallow the hook erros and continue as normal
       Oxidized.logger.error "lib/oxidized/worker.rb: #{e.message}"

data/oxidized.gemspec

@@ -17,22 +17,28 @@ Gem::Specification.new do |s|
   s.executables       = %w[oxidized]
   s.require_path      = 'lib'
 
-  s.required_ruby_version =           '>= 2.3'
-  s.add_runtime_dependency 'asetus',  '~> 0.1'
+  s.metadata['rubygems_mfa_required'] = 'true'
+
+  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', '~> 5'
-  s.add_runtime_dependency 'net-telnet', '~> 0.2'
-  s.add_runtime_dependency 'rugged',  '~> 0.28.0'
-  s.add_runtime_dependency 'slop',    '~> 4.6'
+  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'
 
-  s.add_development_dependency 'bundler', '~> 2.0'
-  s.add_development_dependency 'codecov' if ENV['CI'] == 'true'
-  s.add_development_dependency 'git',      '~> 1'
-  s.add_development_dependency 'minitest', '~> 5.8'
-  s.add_development_dependency 'mocha',    '~> 1.1'
-  s.add_development_dependency 'pry',      '~> 0'
-  s.add_development_dependency 'rake',     '~> 10.0'
-  s.add_development_dependency 'rubocop',  '~> 0.80.0'
-  s.add_development_dependency 'simplecov'
+  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'
 end