oxidized 0.31.0 → 0.32.1

data/lib/oxidized/model/enterprise_sonic.rb

@@ -0,0 +1,46 @@
+class Enterprise_SONiC < Oxidized::Model # rubocop:disable Naming/ClassAndModuleCamelCase
+  using Refinements
+
+  # Remove ANSI escape codes
+  expect /\e\[[0-?]*[ -\/]*[@-~]\r?/ do |data, re|
+    data.gsub re, ''
+  end
+
+  # Matches both sonic-cli and linux terminal
+  prompt /^(?:[\w.-]+@[\w.-]+:[~\w\/-]+\$|[\w.-]+#)\s*/
+  comment "# "
+
+  def add_comment(comment)
+    "\n##### #{comment} #####\n"
+  end
+
+  post do
+    cmd 'show running-configuration' do |cfg|
+      add_comment('CONFIGURATION') + cfg
+    end
+  end
+
+  cmd 'show version' do |cfg|
+    cfg = cfg.each_line.reject { |line| line.match /Uptime/ }.join
+    add_comment('VERSION') + cfg
+  end
+
+  cmd 'show platform syseeprom' do |cfg|
+    add_comment('SYSEEPROM') + cfg
+  end
+
+  cmd :all do |cfg|
+    cfg.cut_both
+  end
+
+  cfg :ssh do
+    # if user logs in to linux == has admin rights
+    if vars(:admin) == true
+      post_login do
+        cmd "sonic-cli\n"
+      end
+    end
+    post_login 'terminal length 0'
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/fsos.rb

@@ -2,6 +2,7 @@ class FSOS < Oxidized::Model
   # Fiberstore / fs.com
   using Refinements
   comment '! '
+  prompt /^([\w.@()-]+[#>]\s?)$/
 
   # Handle paging
   expect /^ --More--.*$/ do |data, re|
@@ -13,6 +14,9 @@ class FSOS < Oxidized::Model
     cfg.gsub! /(secret \w+) (\S+).*/, '\\1 <secret hidden>'
     cfg.gsub! /(password \d+) (\S+).*/, '\\1 <secret hidden>'
     cfg.gsub! /(snmp-server community \d+) (\S+).*/, '\\1 <secret hidden>'
+    cfg.gsub! /^(snmp-server host \S+( udp-port \d+)?( permit|deny \d+)?( informs?)?( traps?)?(( version v3 (priv|auth|noauth))|( version (v1|v2c))?)) +\S+( .*)?$*/, '\\1 <secret hidden>'
+    cfg.gsub! /^(snmp-server user \S+ \S+ v3( priv (des|aes128|aes256|aes256-c))?( auth (md5|sha|sha256) \d+)) +\S+( .*)?$*/, '\\1 <secret hidden>'
+    cfg.gsub! /^(.*key \d+) (\S+).*/, '\\1 <secret hidden>'
     cfg
   end
 
@@ -37,7 +41,7 @@ class FSOS < Oxidized::Model
   cfg :telnet, :ssh do
     post_login 'enable'
     post_login 'terminal length 0'
-    post_login 'terminal width 256'
+    post_login 'terminal width 512'
     pre_logout 'exit'
     pre_logout 'exit'
   end

data/lib/oxidized/model/garderos.rb

@@ -4,12 +4,12 @@ class Garderos < Oxidized::Model
   # Routers for harsh environments
   # grs = Garderos Router Software
 
-  # remove all ANSI escape codes, as GRS uses them :-(
-  # the prompt does not need to match escape codes, as they have been removed
-  expect /\e\[\d*m\r?/ do |data, re|
+  # Remove ANSI escape codes
+  expect /\e\[[0-?]*[ -\/]*[@-~]\r?/ do |data, re|
     data.gsub re, ''
   end
 
+  # the prompt does not need to match escape codes, as they have been removed above
   prompt /[\w-]+# /
   comment '# '
 
@@ -29,7 +29,7 @@ class Garderos < Oxidized::Model
   # If we have a radio modem installed, we'd like to list the SIM Card
   cmd 'show hardware wwan wwan0 sim' do |cfg|
     if cfg.start_with? 'Unknown command'
-      ''
+      String.new('')
     else
       comment "#{cfg}\n"
     end

data/lib/oxidized/model/junos.rb

@@ -26,7 +26,7 @@ class JunOS < Oxidized::Model
   end
 
   post do
-    out = ''
+    out = String.new('')
     case @model
     when 'mx960'
       out << cmd('show chassis fabric reachability') { |cfg| comment cfg }

data/lib/oxidized/model/kornfeldos.rb

@@ -0,0 +1,33 @@
+class KornfeldOS < Oxidized::Model
+  using Refinements
+
+  # For switches running Kornfeld OS
+  #
+  # Tested with : Kornfeld D1156 and Kornfeld D2132
+
+  comment  '# '
+
+  cmd :all do |cfg|
+    cfg.gsub! /^% Invalid input detected at '\^' marker\.$|^\s+\^$/, ''
+    cfg.each_line.to_a[2..-2].join
+  end
+
+  cmd 'show version | except REPOSITORY | except docker | except Uptime' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show platform firmware' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show running-configuration' do |cfg|
+    cfg.each_line.to_a[0..-1].join
+  end
+
+  cfg :ssh do
+    username /^Login:/
+    password /^Password:/
+    post_login 'terminal length 0'
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/model.rb

@@ -184,7 +184,7 @@ module Oxidized
     end
 
     def comment(str)
-      data = ''
+      data = String.new('')
       str.each_line do |line|
         data << self.class.comment << line
       end
@@ -202,7 +202,7 @@ module Oxidized
       # Also, XML Comments must not contain --. So we put a space between
       # any double hyphens, by replacing any - that is followed by another -
       # with '- '
-      data = ''
+      data = String.new('')
       str.each_line do |_line|
         data << '<!-- ' << str.gsub(/-(?=-)/, '- ').chomp << " -->\n"
       end

data/lib/oxidized/model/powerconnect.rb

@@ -15,7 +15,7 @@ class PowerConnect < Oxidized::Model
   end
 
   cmd :secret do |cfg|
-    cfg.gsub! /^(username \S+ password (?:encrypted )?)\S+(.*)/, '\1<hidden>\2'
+    cfg.gsub! /^((?:enable |username \S+ )?password (?:level\s\d{1,2} |encrypted ){,2})\S+(.*)/, '\1<hidden>\2'
     cfg.gsub! /^(tacacs-server key) \S+/, '\\1 <secret hidden>'
     cfg
   end

data/lib/oxidized/model/sonicos.rb

@@ -3,8 +3,14 @@ class SonicOS < Oxidized::Model
 
   # Applies to Sonicwall NSA series firewalls
 
-  prompt /^\w+@\w+[>]\(?.+\)?\s?/
-  comment  '! '
+  prompt /^\w+@[\w\-]+[>]\(?.+\)?\s?/
+  comment '! '
+
+  # Accept policiy message (see Issue #3339). Tested on 6.5 and 7.1
+  expect /Accept The Policy Banner \(yes\)\?\r\nyes: $/ do |data, re|
+    send "yes\n"
+    data.sub re, ''
+  end
 
   cmd :all do |cfg|
     cfg.each_line.to_a[1..-2].join

data/lib/oxidized/model/tplink.rb

@@ -58,6 +58,7 @@ class TPLink < Oxidized::Model
       if vars(:enable) == true
         cmd "enable"
       elsif vars(:enable)
+        cmd "enable", /^[pP]assword:/
         cmd vars(:enable)
       end
     end

data/lib/oxidized/model/xos.rb

@@ -13,7 +13,7 @@ class XOS < Oxidized::Model
   end
 
   cmd :secret do |cfg|
-    cfg.gsub! /^(configure radius (netlogin|mgmt-access) (primary|secondary) shared-secret encrypted).+/, '\\1 <secret hidden>'
+    cfg.gsub! /^(configure (radius|radius-accounting) (netlogin|mgmt-access) (primary|secondary) shared-secret encrypted).+/, '\\1 <secret hidden>'
     cfg.gsub! /^(configure account admin encrypted).+/, '\\1 <secret hidden>'
     cfg.gsub! /^(create account (admin|user) (.+) encrypted).+/, '\\1 <secret hidden>'
     cfg

data/lib/oxidized/source/source.rb

@@ -8,12 +8,42 @@ module Oxidized
         @group_map = Oxidized.config.group_map || {}
       end
 
+      # common code of #map_model and #map_group
+      def map_value(map_hash, original_value)
+        map_hash.each do |key, new_value|
+          mthd = key.instance_of?(Regexp) ? :match : :eql?
+          return new_value if original_value.send(mthd, key)
+        end
+        original_value
+      end
+
+      # search a match for model in the configuration and returns it.
+      # If no match is found, return model
+      #
+      # model can be matched against a string or a regexp:
+      #
+      # model_map:
+      #   cisco: ios
+      #   juniper: junos
+      #   !ruby/regexp /procurve/: procurve
       def map_model(model)
-        @model_map.has_key?(model) ? @model_map[model] : model
+        map_value(@model_map, model)
       end
 
+      # search a match for group in the configuration and returns it.
+      # If no match is found, return group
+      #
+      # group can be matched against a string or a regexp:
+      #
+      # group_map:
+      #   alias1: groupA
+      #   alias2: groupA
+      #   alias3: groupB
+      #   alias4: groupB
+      #   !ruby/regexp /specialgroup/: groupS
+      #   aliasN: groupZ
       def map_group(group)
-        @group_map.has_key?(group) ? @group_map[group] : group
+        map_value(@group_map, group)
       end
 
       def node_var_interpolate(var)

data/lib/oxidized/version.rb

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

data/oxidized.gemspec

@@ -21,33 +21,43 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 3.1'
 
-  s.add_dependency 'asetus',               '~> 0.1'
+  # Gemspec strategy
+  #
+  # For dependency and optional dependencies, we try to set the minimal
+  # dependency lower than the Ubuntu Noble or Debian Bookworm package version,
+  # so that native packages can be used.
+  # We limit the maximal version so that dependabot can warn about new versions
+  # and we can test them before activating them in Oxidized.
+  #
+  # development dependencies are set to the latest minor version of a library
+  # and updated after having tested them
+
+  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-scp',              '~> 4.0'
+  s.add_dependency 'net-scp',              '~> 4.1'
   s.add_dependency 'net-ssh',              '~> 7.3'
   s.add_dependency 'net-telnet',           '~> 0.2'
+  s.add_dependency 'ostruct',              '~> 0.6'
   s.add_dependency 'psych',                '~> 5.0'
   s.add_dependency 'rugged',               '~> 1.6'
   s.add_dependency 'slop',                 '~> 4.6'
 
   s.add_development_dependency 'bundler',             '~> 2.2'
   s.add_development_dependency 'git',                 '~> 2'
-  s.add_development_dependency 'minitest',            '~> 5.18'
+  s.add_development_dependency 'minitest',            '~> 5.25.4'
   s.add_development_dependency 'mocha',               '~> 2.1'
-  s.add_development_dependency 'pry',                 '~> 0.14.2'
+  s.add_development_dependency 'pry',                 '~> 0.15.0'
   s.add_development_dependency 'rake',                '~> 13.0'
-  s.add_development_dependency 'rubocop',             '~> 1.68.0'
-  s.add_development_dependency 'rubocop-minitest',    '~> 0.36.0'
-  s.add_development_dependency 'rubocop-rake',        '~> 0.6.0'
+  s.add_development_dependency 'rubocop',             '~> 1.72.0'
+  s.add_development_dependency 'rubocop-minitest',    '~> 0.37.0'
+  s.add_development_dependency 'rubocop-rake',        '~> 0.7.0'
   s.add_development_dependency 'rubocop-sequel',      '~> 0.3.3'
   s.add_development_dependency 'simplecov',           '~> 0.22.0'
-  s.add_development_dependency 'simplecov-cobertura', '~> 2.1.0'
-  s.add_development_dependency 'simplecov-html',      '~> 0.13.1'
 
   # Dependencies on optional libraries, used for unit tests & development
-  s.add_development_dependency 'oxidized-web',        '>= 0.14.0'
-  s.add_development_dependency 'sequel',              '~> 5.63'
+  s.add_development_dependency 'oxidized-web',        '>= 0.15.0'
+  s.add_development_dependency 'sequel',              '>= 5.63.0', '<= 5.89.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oxidized
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.1
 platform: ruby
 authors:
 - Saku Ytti
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asetus
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
   requirement: !ruby/object:Gem::Requirement
@@ -88,14 +88,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +124,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -200,14 +214,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.18'
+        version: 5.25.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.18'
+        version: 5.25.4
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -228,14 +242,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -256,42 +270,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.68.0
+        version: 1.72.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.68.0
+        version: 1.72.0
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: 0.37.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: 0.37.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rubocop-sequel
   requirement: !ruby/object:Gem::Requirement
@@ -320,62 +334,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: simplecov-cobertura
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: simplecov-html
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: oxidized-web
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.63'
+        version: 5.63.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.89.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.63.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '5.63'
+        version: 5.89.0
 description: software to fetch configuration from network devices and store them
 email:
 - saku@ytti.fi
@@ -408,6 +400,7 @@ files:
 - bin/oxidized
 - docs/Configuration.md
 - docs/Creating-Models.md
+- docs/DeviceSimulation.md
 - docs/Hooks.md
 - docs/Issues.md
 - docs/Model-Notes/ADVA.md
@@ -437,33 +430,13 @@ files:
 - docs/Model-Notes/VRP-Huawei.md
 - docs/Model-Notes/Viptela.md
 - docs/Model-Notes/XGS4600-Zyxel.md
+- docs/ModelUnitTests.md
 - docs/Outputs.md
 - docs/Release.md
 - docs/Ruby-API.md
 - docs/Sources.md
 - docs/Supported-OS-Types.md
 - docs/Troubleshooting.md
-- examples/device-simulation/README.md
-- examples/device-simulation/cmdsets/aoscx
-- examples/device-simulation/cmdsets/arubainstant
-- examples/device-simulation/cmdsets/asa
-- examples/device-simulation/cmdsets/ios
-- examples/device-simulation/cmdsets/nxos
-- examples/device-simulation/cmdsets/routeros
-- examples/device-simulation/cmdsets/srosmd
-- examples/device-simulation/device2yaml.rb
-- examples/device-simulation/yaml/aoscx_R0X25A-6410_FL.10.10.1100.yaml
-- examples/device-simulation/yaml/aoscx_R8N85A-C6000-48G-CL4_PL.10.08.1010.yaml
-- examples/device-simulation/yaml/arubainstant_IAP515_8.10.0.6_VWLC.yaml
-- examples/device-simulation/yaml/asa_5512_9.12-4-67_single-context.yaml
-- examples/device-simulation/yaml/asr920_16.8.1b.yaml
-- examples/device-simulation/yaml/garderos_R7709_003_006_068.yaml
-- examples/device-simulation/yaml/iosxe_C9200L-24P-4G_17.09.04a.yaml
-- examples/device-simulation/yaml/iosxe_C9800-L-F-K9_17.06.05.yaml
-- examples/device-simulation/yaml/riverbed_915.yaml
-- examples/device-simulation/yaml/routeros_CHR_7.10.1.yaml
-- examples/device-simulation/yaml/routeros_CHR_7.16.yaml
-- examples/device-simulation/yaml/routeros_L009UiGS_7.15.2.yaml
 - examples/podman-compose/Makefile
 - examples/podman-compose/README.md
 - examples/podman-compose/docker-compose.yml
@@ -479,6 +452,7 @@ files:
 - examples/podman-compose/oxidized-ssh/.gitignore
 - examples/podman-compose/oxidized-ssh/README.md
 - extra/auto-reload-config.runit
+- extra/device2yaml.rb
 - extra/gitdiff-msteams.sh
 - extra/nagios_check_failing_nodes.rb
 - extra/oxidized-report-git-commits
@@ -582,6 +556,7 @@ files:
 - lib/oxidized/model/eltex.rb
 - lib/oxidized/model/enterasys.rb
 - lib/oxidized/model/enterasys800.rb
+- lib/oxidized/model/enterprise_sonic.rb
 - lib/oxidized/model/eos.rb
 - lib/oxidized/model/f5os.rb
 - lib/oxidized/model/fabricos.rb
@@ -615,6 +590,7 @@ files:
 - lib/oxidized/model/ironware.rb
 - lib/oxidized/model/isam.rb
 - lib/oxidized/model/junos.rb
+- lib/oxidized/model/kornfeldos.rb
 - lib/oxidized/model/lancom.rb
 - lib/oxidized/model/lenovonos.rb
 - lib/oxidized/model/linksyssrw.rb