Merge pull request #3471 from ytti/prepare-release-0.33.0

robertcheramy · web-flow · commit 6774fbd958ce · 2025-03-26T13:57:09.000+01:00
Prepare release 0.33.0
diff --git a/.gitignore b/.gitignore
@@ -52,3 +52,4 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+/.rake_tasks~
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -3,8 +3,6 @@ inherit_from: .rubocop_todo.yml
 plugins:
   - rubocop-rake
   - rubocop-minitest
-
-require:
   - rubocop-sequel
 
 AllCops:
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -1,57 +1,31 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-26 20:32:58 UTC using RuboCop version 1.73.0.
+# on 2025-03-26 12:52:00 UTC using RuboCop version 1.74.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 30
+# Offense count: 33
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Enabled: false
 
-# Offense count: 17
+# Offense count: 19
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
   Max: 12
 
-# Offense count: 14
+# Offense count: 16
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 12
 
-# Offense count: 1
-Naming/ConstantName:
-  Exclude:
-    - 'extra/rest_client.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyleForLeadingUnderscores.
-# SupportedStylesForLeadingUnderscores: disallowed, required, optional
-Naming/MemoizedInstanceVariableName:
-  Exclude:
-    - 'lib/refinements.rb'
-
 # Offense count: 2
 Rake/DuplicateTask:
   Exclude:
     - 'Rakefile'
 
-# Offense count: 1
-Security/Eval:
-  Exclude:
-    - 'Rakefile'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'lib/oxidized/config/vars.rb'
-
 # Offense count: 2
 Style/ClassVars:
   Exclude:
@@ -77,7 +51,7 @@ Style/OpenStructUse:
 Style/SlicingWithRange:
   Enabled: false
 
-# Offense count: 94
+# Offense count: 99
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: Mode.
 Style/StringConcatenation:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,10 @@ configuration is still supported but deprecated. The new configuration works
 with oxidized-web 0.16.0 or later.
 See [docs/Configuration.md](/docs/Configuration.md#oxidized-web-RESTful-API-and-web-interface).
 
+The docker container includes
+[security fixes to ruby-rake](https://ubuntu.com/security/notices/USN-7366-1),
+so be sure to update to the latest version.
+
 ### Added
 - unifiap: new model for Unifi APs, switches, and AirOS APs (@clifcox)
 - github: Issue templates for bugs, feature requests and support requests (@robertcheramy)
@@ -19,18 +23,20 @@ See [docs/Configuration.md](/docs/Configuration.md#oxidized-web-RESTful-API-and-
 ### Changed
 - fortios: support for FortiADC (@electrocret)
 - output/git: cache commit log to improve performance of oxidized-web. Fixes #3121 (@robertcheramy)
-- digest auth handles special characters in passwords by itself (no need to url encode them manually) (@einglasvollkakao)
+- input/http: digest auth handles special characters in passwords by itself (no need to url encode them manually) (@einglasvollkakao)
 - changed the configuration for oxidized-web from rest: to extensions.oxidized-web (@robertcheramy)
 - netgear: add pager-handler workaround, fixes: #2394 and #3341 (@candlerb, @syn-bit)
 - Output#version (git/gitcrypt) returns a Time object in its hash for more flexibility in oxidized-web (@robertcheramy)
 - ios: hide secret key of aaa radius (@martinberg, @robertcheramy)
+- container: update to phusion/baseimage:noble-1.0.1 (@robertcheramy)
 
 ### Fixed
 - powerconnect: Mask the changing temperature issue for non-stacked switches. Fixes #2088 (@clifcox)
 - Fix frozen string literals (@robertcheramy)
 - powerconnect: Cleanup login/logout logic. Fixes #3437 (@clifcox)
 - aos7: remove extra lines occuring when `show hardware-info` runs slow (@rouven0)
 - srosmd: add ignore regex for 64-bit system uptime (@emiliaaah)
+- removed some rubocop warnings (@robertcheramy)
 
 ## [0.32.2 – 2025-02-27]
 This patch release mainly fixes the docker building process, wich resulted in
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ It is light and extensible and supports over 130 operating system types.
 Feature highlights:
 
 * Automatically adds/removes threads to meet configured retrieval interval
-* Restful API to a move node immediately to head-of-queue (GET/POST /node/next/[NODE])
+* Restful API to a move node immediately to head-of-queue (GET/PUT /node/next/[NODE])
 * Syslog udp+file example to catch config change events (IOS/JunOS) and trigger a config fetch
   * Will signal which IOS/JunOS user made the change, can then be used by output modules (via POST)
   * The `git` output module uses this info - 'git blame' will show who changed each line
diff --git a/Rakefile b/Rakefile
@@ -2,7 +2,7 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require_relative 'lib/oxidized/version'
 
-gemspec = eval(File.read(Dir['*.gemspec'].first))
+gemspec = Gem::Specification.load(Dir['*.gemspec'].first)
 gemfile = [gemspec.name, gemspec.version].join('-') + '.gem'
 
 # Integrate Rubocop if available
@@ -41,11 +41,6 @@ task :version_set do
   Bundler::GemHelper.instance.gemspec.version = Oxidized::VERSION
 end
 
-# desc 'Install gem'
-# task install: :build do
-#    system "sudo -Es sh -c \'umask 022; gem install gems/#{gemfile}\'"
-# end
-
 desc 'Remove gems'
 task :clean do
   FileUtils.rm_rf 'pkg'
diff --git a/docs/Model-Notes/HPEAruba.md b/docs/Model-Notes/HPEAruba.md
@@ -26,6 +26,7 @@ is the operating system for the newer CX-Series.
 The Oxidized model is [aoscx](/lib/oxidized/model/aoscx.rb).
 
 ## Older Models
-Older Devices like ProCurve or 3Com/Comware are listed under the Vendor "HP" in
-the [Supported OS Types](docs/Supported-OS-Types.md) list.
+Older Devices like [ProCurve](/lib/oxidized/model/procurve.rb) or 3Com/Comware
+are listed under the Vendor "HP" in the
+[Supported OS Types](/docs/Supported-OS-Types.md) list.
 
diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
@@ -114,7 +114,7 @@
 |Huawei              |VRP                           |[vrp](/lib/oxidized/model/vrp.rb)                |                 |[VRP-Huawei](Model-Notes/VRP-Huawei.md)
 |                    |SmartAX series                |[smartax](/lib/oxidized/model/smartax.rb)        |                 |[SmartAX-Huawei](Model-Notes/SmartAX-Huawei.md)
 |Icotera             |6400 series                   |[icotera](/lib/oxidized/model/icotera.rb)
-|Ingate              |SIParator/Firewalls           |[ingate](/lib/oxidized/model/ingate.rb) |@thanegill
+|Ingate              |SIParator/Firewalls           |[ingate](/lib/oxidized/model/ingate.rb)          |@thanegill
 |IP Infusion         |OcNOS                         |[ocnos](/lib/oxidized/model/ocnos.rb)
 |Juniper             |JunOS                         |[junos](/lib/oxidized/model/junos.rb)            |                 |[MX/QFX/EX/SRX/J Series](Model-Notes/JunOS.md)
 |                    |ScreenOS (Netscreen)          |[screenos](/lib/oxidized/model/screenos.rb)
diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md
@@ -99,8 +99,8 @@ Follow these steps to do so:
 5. Restart oxidized - you're done!
 
 Note that slow performance in oxidized-web when listing the versions of a device
-are due to the necessity to go through the whole git log to search for the
-versions. See Issue #3121, the fix will come with oxidized version 0.32.0.
+are due to the necessity to go through the whole git log to search the
+history. See Issue #3121, the fix will come with oxidized version 0.33.0.
 
 ## Oxidized ignores the changes I made to its git repository
 First of all: you shouldn't manipulate the git repository of oxidized. Don't
diff --git a/extra/rest_client.rb b/extra/rest_client.rb
@@ -6,7 +6,7 @@ class RestClient
     require 'asetus'
 
     class Config
-      Root = ENV['OXIDIZED_HOME'] || File.join(Dir.home, '.config', 'oxidized')
+      ROOT = ENV['OXIDIZED_HOME'] || File.join(Dir.home, '.config', 'oxidized')
     end
 
     CFGS = Asetus.new name: 'oxidized', load: false, key_to_s: true
diff --git a/lib/oxidized/config/vars.rb b/lib/oxidized/config/vars.rb
@@ -1,17 +1,21 @@
-module Oxidized::Config::Vars
-  # convenience method for accessing node, group or global level user variables
-  def vars(name)
-    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)
-      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)
-      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)
-      Oxidized.config.models[model_name].vars[name.to_s]
-    elsif Oxidized.config.vars.has_key?(name.to_s)
-      Oxidized.config.vars[name.to_s]
+module Oxidized
+  class Config
+    module Vars
+      # convenience method for accessing node, group or global level user variables
+      def vars(name)
+        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)
+          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)
+          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)
+          Oxidized.config.models[model_name].vars[name.to_s]
+        elsif Oxidized.config.vars.has_key?(name.to_s)
+          Oxidized.config.vars[name.to_s]
+        end
+      end
     end
   end
 end
diff --git a/lib/refinements.rb b/lib/refinements.rb
@@ -27,7 +27,9 @@ def cut_both(head = 1, tail = 1)
     # sets @cmd and @name unless @name is already set
     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
 
     # Initializes the String instance variables from another String instance
diff --git a/oxidized.gemspec b/oxidized.gemspec
@@ -12,7 +12,6 @@ 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(/^(test|spec|features)\//) }
   s.executables       = %w[oxidized]
   s.require_path      = 'lib'
@@ -58,6 +57,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov',           '~> 0.22.0'
 
   # Dependencies on optional libraries, used for unit tests & development
-  s.add_development_dependency 'oxidized-web',        '>= 0.16.0'
+  s.add_development_dependency 'oxidized-web',        '~> 0.16'
   s.add_development_dependency 'sequel',              '>= 5.63.0', '<= 5.90.0'
 end

Original file line number	Diff line number	Diff line change
`@@ -52,3 +52,4 @@ build-iPhoneSimulator/`
`52`	`52`
`53`	`53`	`# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:`
`54`	`54`	`.rvmrc`
	`55`	`+/.rake_tasks~`