oxidized 0.29.1 → 0.30.0

data/lib/oxidized/output/file.rb

@@ -12,7 +12,7 @@ module Oxidized
     def setup
       return unless @cfg.empty?
 
-      Oxidized.asetus.user.output.file.directory = File.join(Config::Root, 'configs')
+      Oxidized.asetus.user.output.file.directory = File.join(Config::ROOT, 'configs')
       Oxidized.asetus.save :user
       raise NoConfig, 'no output file config, edit ~/.config/oxidized/config'
     end

data/lib/oxidized/output/git.rb

@@ -1,5 +1,7 @@
 module Oxidized
   class Git < Output
+    using Refinements
+
     class GitError < OxidizedError; end
     begin
       require 'rugged'
@@ -18,7 +20,7 @@ module Oxidized
       if @cfg.empty?
         Oxidized.asetus.user.output.git.user  = 'Oxidized'
         Oxidized.asetus.user.output.git.email = 'o@example.com'
-        Oxidized.asetus.user.output.git.repo = File.join(Config::Root, 'oxidized.git')
+        Oxidized.asetus.user.output.git.repo = File.join(Config::ROOT, 'oxidized.git')
         Oxidized.asetus.save :user
         raise NoConfig, 'no output git config, edit ~/.config/oxidized/config'
       end
@@ -34,8 +36,8 @@ module Oxidized
 
     def store(file, outputs, opt = {})
       @msg   = opt[:msg]
-      @user  = (opt[:user]  || @cfg.user)
-      @email = (opt[:email] || @cfg.email)
+      @user  = opt[:user]  || @cfg.user
+      @email = opt[:email] || @cfg.email
       @opt   = opt
       @commitref = nil
       repo = @cfg.repo

data/lib/oxidized/output/gitcrypt.rb

@@ -1,5 +1,6 @@
 module Oxidized
   class GitCrypt < Output
+    using Refinements
     class GitCryptError < OxidizedError; end
     begin
       require 'git'
@@ -23,7 +24,7 @@ module Oxidized
       if @cfg.empty?
         Oxidized.asetus.user.output.gitcrypt.user  = 'Oxidized'
         Oxidized.asetus.user.output.gitcrypt.email = 'o@example.com'
-        Oxidized.asetus.user.output.gitcrypt.repo = File.join(Config::Root, 'oxidized.git')
+        Oxidized.asetus.user.output.gitcrypt.repo = File.join(Config::ROOT, 'oxidized.git')
         Oxidized.asetus.save :user
         raise NoConfig, 'no output git config, edit ~/.config/oxidized/config'
       end
@@ -63,8 +64,8 @@ module Oxidized
 
     def store(file, outputs, opt = {})
       @msg   = opt[:msg]
-      @user  = (opt[:user]  || @cfg.user)
-      @email = (opt[:email] || @cfg.email)
+      @user  = opt[:user]  || @cfg.user
+      @email = opt[:email] || @cfg.email
       @opt   = opt
       @commitref = nil
       repo = @cfg.repo

data/lib/oxidized/signals.rb

@@ -0,0 +1,44 @@
+# Monkey patch Signal.trap for Puma to keep it from overriding our handlers
+# Also prevent Puma from registering its own SIGHUP handler
+module Puma
+  class Signal
+    class << self
+      alias os_trap trap
+      def Signal.trap(sig, &block)
+        sigshortname = sig.gsub "SIG", ''
+        Oxidized::Signals.register_signal(sig, block) unless sigshortname.eql? 'HUP'
+      end
+    end
+  end
+end
+
+module Oxidized
+  class Signals
+    @handlers = Hash.new { |h, k| h[k] = [] }
+    class << self
+      attr_accessor :handlers
+
+      def register_signal(sig, procobj)
+        # Compute short name of the signal (without SIG prefix)
+        sigshortname = sig.gsub "SIG", ''
+        signum = Signal.list[sigshortname]
+
+        # Register the handler with OS
+        Signal.trap signum do
+          Oxidized::Signals.handle_signal(signum)
+        end
+
+        # Add the proc to the handler list for the requested signal
+        @handlers[signum].push(procobj)
+      end
+
+      def handle_signal(signum)
+        return unless handlers.has_key?(signum)
+
+        @handlers[signum].each do |handler|
+          handler.call
+        end
+      end
+    end
+  end
+end

data/lib/oxidized/source/csv.rb

@@ -7,7 +7,7 @@ module Oxidized
 
     def setup
       if @cfg.empty?
-        Oxidized.asetus.user.source.csv.file      = File.join(Config::Root, 'router.db')
+        Oxidized.asetus.user.source.csv.file      = File.join(Config::ROOT, 'router.db')
         Oxidized.asetus.user.source.csv.delimiter = /:/
         Oxidized.asetus.user.source.csv.map.name  = 0
         Oxidized.asetus.user.source.csv.map.model = 1

data/lib/oxidized/source/http.rb

@@ -6,6 +6,7 @@ module Oxidized
     end
 
     def setup
+      Oxidized.setup_logger
       return unless @cfg.url.empty?
 
       raise NoConfig, 'no source http url config, edit ~/.config/oxidized/config'
@@ -18,9 +19,14 @@ module Oxidized
 
     def load(node_want = nil)
       nodes = []
-      data = JSON.parse(read_http(node_want))
-      data = string_navigate(data, @cfg.hosts_location) if @cfg.hosts_location?
-      data.each do |node|
+      uri = URI.parse(@cfg.url)
+      data = JSON.parse(read_http(uri, node_want))
+      node_data = data
+      node_data = string_navigate(data, @cfg.hosts_location) if @cfg.hosts_location?
+      node_data = pagination(data, node_want) if @cfg.pagination?
+
+      # at this point we have all the nodes; pagination or not
+      node_data.each do |node|
         next if node.empty?
 
         # map node parameters
@@ -56,8 +62,23 @@ module Oxidized
       object
     end
 
-    def read_http(node_want)
-      uri = URI.parse(@cfg.url)
+    def pagination(data, node_want)
+      node_data = []
+      raise Oxidized::OxidizedError, "if using pagination, 'pagination_key_name' setting must be set" unless @cfg.pagination_key_name?
+
+      next_key = @cfg.pagination_key_name
+      loop do
+        node_data += string_navigate(data, @cfg.hosts_location) if @cfg.hosts_location?
+        break if data[next_key].nil?
+
+        new_uri = URI.parse(data[next_key]) if data.has_key?(next_key)
+        data = JSON.parse(read_http(new_uri, node_want))
+        node_data += string_navigate(data, @cfg.hosts_location) if @cfg.hosts_location?
+      end
+      node_data
+    end
+
+    def read_http(uri, node_want)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.scheme == 'https'
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @cfg.secure

data/lib/oxidized/source/source.rb

@@ -3,8 +3,8 @@ module Oxidized
     class NoConfig < OxidizedError; end
 
     def initialize
-      @model_map = (Oxidized.config.model_map || {})
-      @group_map = (Oxidized.config.group_map || {})
+      @model_map = Oxidized.config.model_map || {}
+      @group_map = Oxidized.config.group_map || {}
     end
 
     def map_model(model)

data/lib/oxidized/source/sql.rb

@@ -10,7 +10,7 @@ module Oxidized
       return unless @cfg.empty?
 
       Oxidized.asetus.user.source.sql.adapter   = 'sqlite'
-      Oxidized.asetus.user.source.sql.database  = File.join(Config::Root, 'sqlite.db')
+      Oxidized.asetus.user.source.sql.database  = File.join(Config::ROOT, 'sqlite.db')
       Oxidized.asetus.user.source.sql.table     = 'devices'
       Oxidized.asetus.user.source.sql.map.name  = 'name'
       Oxidized.asetus.user.source.sql.map.model = 'rancid'
@@ -68,8 +68,8 @@ module Oxidized
                        sslkey:  @cfg.ssl_key?)
       end
       Sequel.connect(options)
-    rescue Sequel::AdapterNotFound => error
-      raise OxidizedError, "SQL adapter gem not installed: " + error.message
+    rescue Sequel::AdapterNotFound => e
+      raise OxidizedError, "SQL adapter gem not installed: " + e.message
     end
   end
 end

data/lib/oxidized/version.rb

@@ -1,6 +1,6 @@
 module Oxidized
-  VERSION = '0.29.1'.freeze
-  VERSION_FULL = '0.29.1'.freeze
+  VERSION = '0.30.0'.freeze
+  VERSION_FULL = '0.30.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

@@ -33,7 +33,10 @@ module Oxidized
         Oxidized.logger.debug "lib/oxidized/worker.rb: Added #{node.group}/#{node.name} to the job queue"
       end
 
-      run_done_hook if cycle_finished?
+      if cycle_finished?
+        run_done_hook
+        exit 0 if Oxidized.config.run_once
+      end
       Oxidized.logger.debug("lib/oxidized/worker.rb: #{@jobs.size} jobs running in parallel") unless @jobs.empty?
     end
 
@@ -52,6 +55,10 @@ module Oxidized
       Oxidized.logger.warn "#{node.group}/#{node.name} not found, removed while collecting?"
     end
 
+    def reload
+      @nodes.load
+    end
+
     private
 
     def process_success(node, job)

data/lib/oxidized.rb

@@ -13,6 +13,7 @@ module Oxidized
   require 'oxidized/nodes'
   require 'oxidized/manager'
   require 'oxidized/hook'
+  require 'oxidized/signals'
   require 'oxidized/core'
 
   def self.asetus
@@ -36,7 +37,7 @@ module Oxidized
   end
 
   def self.setup_logger
-    FileUtils.mkdir_p(Config::Log) unless File.directory?(Config::Log)
+    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')
@@ -45,7 +46,7 @@ module Oxidized
                     if config.has_key?('log')
                       Logger.new(File.expand_path(config.log))
                     else
-                      Logger.new(STDERR)
+                      Logger.new($stderr)
                     end
                   end
     logger.level = Logger::INFO unless config.debug

data/lib/refinements.rb

@@ -25,7 +25,7 @@ module Refinements
     end
 
     # sets @cmd and @name unless @name is already set
-    def set_cmd(command)
+    def process_cmd(command)
       @cmd = command
       @name ||= @cmd.to_s.strip.gsub(/\s+/, '_') # what to do when command is proc? #to_s seems ghetto
     end

data/oxidized.gemspec

@@ -24,19 +24,22 @@ Gem::Specification.new do |s|
   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-ftp',      '~> 0.2'
+  s.add_runtime_dependency 'net-scp',      '~> 4.0'
   s.add_runtime_dependency 'net-ssh',      '~> 7.1'
   s.add_runtime_dependency 'net-telnet',   '~> 0.2'
+  s.add_runtime_dependency 'psych',        '~> 3.3.2'
   s.add_runtime_dependency 'rugged',       '~> 1.6'
   s.add_runtime_dependency 'slop',         '~> 4.6'
 
   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 'mocha',               '~> 2.1'
   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',             '~> 1.62.0'
+  s.add_development_dependency 'rubocop-minitest',    '~> 0.35.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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oxidized
 version: !ruby/object:Gem::Version
-  version: 0.29.1
+  version: 0.30.0
 platform: ruby
 authors:
 - Saku Ytti
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2024-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asetus
@@ -54,6 +54,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: net-ftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +110,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.2
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -158,14 +200,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -200,28 +242,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.0
+        version: 1.62.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.0
+        version: 1.62.0
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.35.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.35.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -299,6 +341,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Dockerfile
 - Gemfile
 - LICENSE
@@ -311,11 +354,14 @@ files:
 - docs/Creating-Models.md
 - docs/Hooks.md
 - docs/Model-Notes/ADVA.md
+- docs/Model-Notes/APC_AOS.md
 - docs/Model-Notes/AireOS.md
 - docs/Model-Notes/ArbOS.md
 - docs/Model-Notes/Comware.md
 - docs/Model-Notes/Cumulus.md
 - docs/Model-Notes/EOS.md
+- docs/Model-Notes/FSOS.md
+- docs/Model-Notes/FortiOS.md
 - docs/Model-Notes/IOS.md
 - docs/Model-Notes/JunOS.md
 - docs/Model-Notes/LenovoNOS.md
@@ -335,6 +381,15 @@ files:
 - docs/Sources.md
 - docs/Supported-OS-Types.md
 - docs/Troubleshooting.md
+- examples/podman-compose/Makefile
+- examples/podman-compose/README.md
+- examples/podman-compose/docker-compose.yml
+- examples/podman-compose/model-simulation/Dockerfile-model
+- examples/podman-compose/model-simulation/asternos.sh
+- examples/podman-compose/oxidized-config/.gitignore
+- examples/podman-compose/oxidized-config/config
+- examples/podman-compose/oxidized-config/router.db
+- examples/podman-compose/oxidized-ssh/README.md
 - extra/auto-reload-config.runit
 - extra/gitdiff-msteams.sh
 - extra/nagios_check_failing_nodes.rb
@@ -371,6 +426,7 @@ files:
 - lib/oxidized/input/ftp.rb
 - lib/oxidized/input/http.rb
 - lib/oxidized/input/input.rb
+- lib/oxidized/input/scp.rb
 - lib/oxidized/input/ssh.rb
 - lib/oxidized/input/telnet.rb
 - lib/oxidized/input/tftp.rb
@@ -380,6 +436,7 @@ files:
 - lib/oxidized/model/acmepacket.rb
 - lib/oxidized/model/acos.rb
 - lib/oxidized/model/acsw.rb
+- lib/oxidized/model/addpack.rb
 - lib/oxidized/model/adtran.rb
 - lib/oxidized/model/adva.rb
 - lib/oxidized/model/aen.rb
@@ -396,6 +453,7 @@ files:
 - lib/oxidized/model/arbos.rb
 - lib/oxidized/model/aricentiss.rb
 - lib/oxidized/model/asa.rb
+- lib/oxidized/model/asternos.rb
 - lib/oxidized/model/asyncos.rb
 - lib/oxidized/model/audiocodes.rb
 - lib/oxidized/model/audiocodesmp.rb
@@ -426,6 +484,7 @@ files:
 - lib/oxidized/model/dcnos.rb
 - lib/oxidized/model/dellx.rb
 - lib/oxidized/model/dlink.rb
+- lib/oxidized/model/dlinknextgen.rb
 - lib/oxidized/model/dnos.rb
 - lib/oxidized/model/eciapollo.rb
 - lib/oxidized/model/edgecos.rb
@@ -443,6 +502,7 @@ files:
 - lib/oxidized/model/firewareos.rb
 - lib/oxidized/model/fortios.rb
 - lib/oxidized/model/fortiwlc.rb
+- lib/oxidized/model/fsos.rb
 - lib/oxidized/model/ftos.rb
 - lib/oxidized/model/fujitsupy.rb
 - lib/oxidized/model/gaiaos.rb
@@ -469,6 +529,8 @@ files:
 - lib/oxidized/model/linksyssrw.rb
 - lib/oxidized/model/linuxgeneric.rb
 - lib/oxidized/model/masteros.rb
+- lib/oxidized/model/mimosab11.rb
+- lib/oxidized/model/ml66.rb
 - lib/oxidized/model/mlnxos.rb
 - lib/oxidized/model/model.rb
 - lib/oxidized/model/mtrlrfs.rb
@@ -482,6 +544,8 @@ files:
 - lib/oxidized/model/nsxconfig.rb
 - lib/oxidized/model/nsxfirewall.rb
 - lib/oxidized/model/nxos.rb
+- lib/oxidized/model/ocnos.rb
+- lib/oxidized/model/onefinity.rb
 - lib/oxidized/model/oneos.rb
 - lib/oxidized/model/openbsd.rb
 - lib/oxidized/model/opengear.rb
@@ -499,6 +563,7 @@ files:
 - lib/oxidized/model/qtech.rb
 - lib/oxidized/model/quantaos.rb
 - lib/oxidized/model/raisecom.rb
+- lib/oxidized/model/rgos.rb
 - lib/oxidized/model/routeros.rb
 - lib/oxidized/model/saos.rb
 - lib/oxidized/model/screenos.rb
@@ -534,8 +599,10 @@ files:
 - lib/oxidized/model/zteolt.rb
 - lib/oxidized/model/zy1308.rb
 - lib/oxidized/model/zynos.rb
+- lib/oxidized/model/zynosadsl.rb
 - lib/oxidized/model/zynoscli.rb
 - lib/oxidized/model/zynosgs.rb
+- lib/oxidized/model/zynosmgs.rb
 - lib/oxidized/node.rb
 - lib/oxidized/node/stats.rb
 - lib/oxidized/nodes.rb
@@ -544,6 +611,7 @@ files:
 - lib/oxidized/output/gitcrypt.rb
 - lib/oxidized/output/http.rb
 - lib/oxidized/output/output.rb
+- lib/oxidized/signals.rb
 - lib/oxidized/source/csv.rb
 - lib/oxidized/source/http.rb
 - lib/oxidized/source/source.rb
@@ -572,7 +640,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: feeble attempt at rancid