oxidized 0.32.0 → 0.33.0

data/lib/oxidized/output/git.rb

@@ -64,8 +64,8 @@ module Oxidized
       # Returns the configuration of group/node_name
       #
       # #fetch is called by Nodes#fetch
-      # Nodes#fetch creates a new Output object each time, so we cannot
-      # store the repo index in memory. But as we keep the repo index up
+      # Nodes#fetch creates a new Output object each time, so it not easy
+      # to cache the repo index in memory. But as we keep the repo index up
       # to date on disk in #update_repo, we can read it from disk instead of
       # rebuilding it each time.
       def fetch(node, group)
@@ -79,29 +79,13 @@ module Oxidized
         'node not found'
       end
 
-      # give a hash of all oid revision for the given node, and the date of the commit
+      # give a hash of all oid revisions for the given node, and the date of
+      # the commit.
+      #
+      # Called by Nodes#version
       def version(node, group)
-        repo, path = yield_repo_and_path(node, group)
-
-        repo = Rugged::Repository.new repo
-        walker = Rugged::Walker.new(repo)
-        walker.sorting(Rugged::SORT_DATE)
-        walker.push(repo.head.target.oid)
-        i = -1
-        tab = []
-        walker.each do |commit|
-          # Diabled rubocop because the suggested .empty? does not work here.
-          next if commit.diff(paths: [path]).size.zero? # rubocop:disable Style/ZeroLengthPredicate
-
-          hash = {}
-          hash[:date] = commit.time.to_s
-          hash[:oid] = commit.oid
-          hash[:author] = commit.author
-          hash[:message] = commit.message
-          tab[i += 1] = hash
-        end
-        walker.reset
-        tab
+        repo_path, node_path = yield_repo_and_path(node, group)
+        self.class.hash_list(node_path, repo_path)
       rescue StandardError
         'node not found'
       end
@@ -143,6 +127,79 @@ module Oxidized
         'no diffs'
       end
 
+      # Return the list of oids for node_path in the repository repo_path
+      def self.hash_list(node_path, repo_path)
+        update_cache(repo_path)
+        @gitcache[repo_path][:nodes][node_path] || []
+      end
+
+      # Update @gitcache, a class instance variable, ensuring persistence
+      # by saving the cache independently of object instances
+      def self.update_cache(repo_path)
+        # initialize our cache as a class instance variable
+        @gitcache ||= {}
+        # When single_repo == false, we have multiple repositories
+        unless @gitcache[repo_path]
+          @gitcache[repo_path] = {}
+          @gitcache[repo_path][:nodes] = {}
+          @gitcache[repo_path][:last_commit] = nil
+        end
+
+        repo = Rugged::Repository.new repo_path
+
+        walker = Rugged::Walker.new(repo)
+        walker.sorting(Rugged::SORT_DATE)
+        walker.push(repo.head.target.oid)
+
+        # We store the commits into a temporary cache. It will be prepended
+        # to @gitcache to preserve the order of the commits.
+        cache = {}
+        walker.each do |commit|
+          if commit.oid == @gitcache[repo_path][:last_commit]
+            # we have reached the last cached commit, so we're done
+            break
+          end
+
+          commit.diff.each_delta do |delta|
+            next unless delta.added? || delta.modified?
+
+            hash = {}
+            # We keep :date for reverse compatibility on oxidized-web <= 0.15.1
+            hash[:date] = commit.time.to_s
+            # date as a Time instance for more flexibility in oxidized-web
+            hash[:time] = commit.time
+            hash[:oid] = commit.oid
+            hash[:author] = commit.author
+            hash[:message] = commit.message
+
+            filename = delta.new_file[:path]
+            if cache[filename]
+              cache[filename].append hash
+            else
+              cache[filename] = [hash]
+            end
+          end
+        end
+
+        cache.each_pair do |filename, hashlist|
+          if @gitcache[repo_path][:nodes][filename]
+            # using the splat operator (*) should be OK as hashlist should
+            # not be very big when working on deltas
+            @gitcache[repo_path][:nodes][filename].prepend(*hashlist)
+          else
+            @gitcache[repo_path][:nodes][filename] = hashlist
+          end
+        end
+
+        # Store the most recent commit
+        @gitcache[repo_path][:last_commit] = repo.head.target.oid
+      end
+
+      # Currently only used in unit tests
+      def self.clear_cache
+        @gitcache = nil
+      end
+
       private
 
       def yield_repo_and_path(node, group)
@@ -181,14 +238,7 @@ module Oxidized
         end
       end
 
-      # Uploads data into file in the repo
-      #
-      # @param [String] file: the file to save the configuration to
-      # @param [String] data: the configuration to save
-      # @param [Rugged::Repository] repo: the git repository to use
-      #
-      # If Oxidized.config.output.git.single_repo = false (which is the default),
-      # there will one repository for each group.
+      # Uploads data into file in the repository repo
       #
       # update_repo caches the index on disk. An index is usually used in a
       # working directory and not in a bare repository, which confuses users.

data/lib/oxidized/output/gitcrypt.rb

@@ -114,7 +114,10 @@ module Oxidized
         tab = []
         walker.each do |commit|
           hash = {}
+          # We keep :date for reverse compatibility on oxidized-web <= 0.15.1
           hash[:date] = commit.date.to_s
+          # date as a Time instance for more flexibility in oxidized-web
+          hash[:time] = commit.date
           hash[:oid] = commit.objectish
           hash[:author] = commit.author
           hash[:message] = commit.message

data/lib/oxidized/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Oxidized
-  VERSION = '0.32.0'.freeze
-  VERSION_FULL = '0.32.0'.freeze
+  VERSION = '0.33.0'
+  VERSION_FULL = '0.33.0'
   def self.version_set
     version_full = %x(git describe --tags).chop rescue ""
     version      = %x(git describe --tags --abbrev=0).chop rescue ""
@@ -12,8 +14,8 @@ module Oxidized
     const_set(:VERSION, version)
     const_set(:VERSION_FULL, version_full)
     file = File.readlines(__FILE__)
-    file[1] = "  VERSION = '%s'.freeze\n" % VERSION
-    file[2] = "  VERSION_FULL = '%s'.freeze\n" % VERSION_FULL
+    file[3] = "  VERSION = '%s'\n" % VERSION
+    file[4] = "  VERSION_FULL = '%s'\n" % VERSION_FULL
     File.write(__FILE__, file.join)
   end
 end

data/lib/oxidized/worker.rb

@@ -101,11 +101,8 @@ module Oxidized
     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

data/lib/refinements.rb

@@ -27,7 +27,9 @@ module Refinements
     # 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

data/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'
@@ -21,7 +20,18 @@ 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'
@@ -35,20 +45,18 @@ Gem::Specification.new do |s|
   s.add_dependency 'slop',                 '~> 4.6'
 
   s.add_development_dependency 'bundler',             '~> 2.2'
-  s.add_development_dependency 'git',                 '~> 2'
+  s.add_development_dependency 'git',                 '>= 2.0', '<=3.0'
   s.add_development_dependency 'minitest',            '~> 5.25.4'
   s.add_development_dependency 'mocha',               '~> 2.1'
   s.add_development_dependency 'pry',                 '~> 0.15.0'
   s.add_development_dependency 'rake',                '~> 13.0'
-  s.add_development_dependency 'rubocop',             '~> 1.72.0'
-  s.add_development_dependency 'rubocop-minitest',    '~> 0.36.0'
-  s.add_development_dependency 'rubocop-rake',        '~> 0.6.0'
-  s.add_development_dependency 'rubocop-sequel',      '~> 0.3.3'
+  s.add_development_dependency 'rubocop',             '~> 1.74.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.4.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.13.1'
 
   # Dependencies on optional libraries, used for unit tests & development
-  s.add_development_dependency 'oxidized-web',        '>= 0.15.0'
-  s.add_development_dependency 'sequel',              '~> 5.88.0'
+  s.add_development_dependency 'oxidized-web',        '~> 0.16'
+  s.add_development_dependency 'sequel',              '>= 5.63.0', '<= 5.90.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oxidized
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.33.0
 platform: ruby
 authors:
 - Saku Ytti
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-03-26 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
@@ -198,16 +198,22 @@ dependencies:
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -270,56 +276,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.72.0
+        version: 1.74.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.72.0
+        version: 1.74.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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -335,61 +341,39 @@ 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
+  name: oxidized-web
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: oxidized-web
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 5.63.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.0
-- !ruby/object:Gem::Dependency
-  name: sequel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.88.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: 5.63.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 5.88.0
+        version: 5.90.0
 description: software to fetch configuration from network devices and store them
 email:
 - saku@ytti.fi
@@ -401,6 +385,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/ISSUE_TEMPLATE/support-request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/dependabot.yml"
 - ".github/workflows/codeql.yml"
@@ -423,6 +410,7 @@ files:
 - docs/Configuration.md
 - docs/Creating-Models.md
 - docs/DeviceSimulation.md
+- docs/Docker.md
 - docs/Hooks.md
 - docs/Issues.md
 - docs/Model-Notes/ADVA.md
@@ -432,6 +420,7 @@ files:
 - docs/Model-Notes/Comware.md
 - docs/Model-Notes/Cumulus.md
 - docs/Model-Notes/EOS.md
+- docs/Model-Notes/EatonNetwork.md
 - docs/Model-Notes/FSOS.md
 - docs/Model-Notes/FortiOS.md
 - docs/Model-Notes/HPEAruba.md
@@ -459,20 +448,6 @@ 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/gitserver/.gitignore
-- examples/podman-compose/gitserver/Dockerfile
-- 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/config_csv-file
-- examples/podman-compose/oxidized-config/config_csv-gitserver
-- examples/podman-compose/oxidized-config/router.db
-- 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
@@ -571,6 +546,7 @@ files:
 - lib/oxidized/model/dlink.rb
 - lib/oxidized/model/dlinknextgen.rb
 - lib/oxidized/model/dnos.rb
+- lib/oxidized/model/eatonnetwork.rb
 - lib/oxidized/model/eciapollo.rb
 - lib/oxidized/model/edgecos.rb
 - lib/oxidized/model/edgeos.rb
@@ -605,6 +581,7 @@ files:
 - lib/oxidized/model/hpmsm.rb
 - lib/oxidized/model/ibos.rb
 - lib/oxidized/model/icotera.rb
+- lib/oxidized/model/ingate.rb
 - lib/oxidized/model/ios.rb
 - lib/oxidized/model/iosxe.rb
 - lib/oxidized/model/iosxr.rb
@@ -680,6 +657,7 @@ files:
 - lib/oxidized/model/trango.rb
 - lib/oxidized/model/truenas.rb
 - lib/oxidized/model/ucs.rb
+- lib/oxidized/model/unifiap.rb
 - lib/oxidized/model/uplinkolt.rb
 - lib/oxidized/model/viptela.rb
 - lib/oxidized/model/voltaire.rb

data/examples/podman-compose/Makefile

@@ -1,103 +0,0 @@
-# Make sure these targets always run
-.PHONY: help rights clean-rights
-
-help:
-	@: $(info $(HELP))
-
-rights:
-	podman unshare chown -R 30000:30000 oxidized-config oxidized-ssh
-	podman unshare chown -R 30001 gitserver/repo.git
-
-clean-rights:
-	podman unshare chown -R 0:0 *
-
-start: gitserver-createrepo rights images
-	if [ -f oxidized-config/config ]; then \
-	  podman-compose -p oxidized up ; \
-	else { \
-	  echo "\n########\noxidized-config/config does not exist"; \
-	  echo "create one or copy an example in the folder"; \
-	} fi
-
-run: start
-
-stop:
-	podman-compose -p oxidized down
-	$(MAKE) clean-rights
-
-start-local:
-	if [ -f oxidized-config/config.local ]; then \
-	  cp oxidized-config/config.local oxidized-config/config; \
-	else \
-	  echo "\n########\noxidized-config/config.local does not exist"; \
-	fi
-	$(MAKE) start
-
-stop-local: stop
-	if [ -f oxidized-config/config.local ]; then \
-	  git checkout -- oxidized-config/config; \
-	else \
-	  echo "\n########\noxidized-config/config.local does not exist"; \
-	fi
-
-# creates a container image for the model simulation
-model-image:
-	podman image exists local/model || \
-	  podman build -t local/model -f model-simulation/Dockerfile-model .
-
-model-clean:
-	podman rmi local/model
-
-# creates a container image for gitserver
-gitserver-image:
-	podman image exists local/gitserver || \
-	  podman build -t local/gitserver gitserver/
-
-# create the repo repo.git inside the gitserver mapped volume
-gitserver-createrepo: clean-rights
-	if [ ! -d gitserver/repo.git ]; then \
-	  git init --bare gitserver/repo.git; \
-	fi
-
-gitserver-clean:
-	podman rmi local/gitserver
-	rm -rf gitserver/repo.git
-
-gitserver-getkey:
-	podman exec --user oxidized -t oxidized_oxidized_1 sh -c "ssh-keyscan gitserver > /home/oxidized/.ssh/known_hosts"
-
-# build all helper containter images
-images: model-image gitserver-image oxidized-image
-
-# build the oxidized image from the curent repository
-oxidized-image:
-	  podman build -t oxidized:`git describe --tags` -t oxidized:latest ../../
-
-# removes the oxidized image
-oxidized-image-clean:
-	podman rmi local/oxidized
-
-# run evey clean line, even if the previous fails
-clean:
-	-$(MAKE) stop-local
-	-$(MAKE) model-clean
-	-$(MAKE) gitserver-clean
-	-$(MAKE) oxidized-image-clean
-
-define HELP
-make help           - This help
-make rights         - Change the rights of mapped folders for the users inside
-                      the container
-make clean-rights   - Revert the rights of mapped folders to the local user
-make start          - Start the pod with all containers (alias - make run)
-                      You can interrupt with Ctrl-C, but make sure you run
-                      'make stop' to realy stop the container
-make stop           - Stop the pod
-make start-local    - Starts the pod with the local configuration
-                      oxidized-config/config.local
-make stop-local     - Stops the pod and restores
-                      oxidized-config/config from git
-make gitserver-getkey - stores the public key of the gitserver into
-                      oxidized-ssh/known_hosts (the pod must be running)
-make clean          - reverts everything to its original state
-endef