oxidized 0.32.1 → 0.33.0

data/lib/oxidized/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Oxidized
-  VERSION = '0.32.1'.freeze
-  VERSION_FULL = '0.32.1'.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'
@@ -46,18 +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',             '~> 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.3.3'
+  s.add_development_dependency 'rubocop-sequel',      '~> 0.4.0'
   s.add_development_dependency 'simplecov',           '~> 0.22.0'
 
   # Dependencies on optional libraries, used for unit tests & development
-  s.add_development_dependency 'oxidized-web',        '>= 0.15.0'
-  s.add_development_dependency 'sequel',              '>= 5.63.0', '<= 5.89.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.1
+  version: 0.33.0
 platform: ruby
 authors:
 - Saku Ytti
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-20 00:00:00.000000000 Z
+date: 2025-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asetus
@@ -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.0'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -270,14 +276,14 @@ 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
@@ -312,14 +318,14 @@ dependencies:
     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
@@ -338,16 +344,16 @@ dependencies:
   name: oxidized-web
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -357,7 +363,7 @@ dependencies:
         version: 5.63.0
     - - "<="
       - !ruby/object:Gem::Version
-        version: 5.89.0
+        version: 5.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -367,7 +373,7 @@ dependencies:
         version: 5.63.0
     - - "<="
       - !ruby/object:Gem::Version
-        version: 5.89.0
+        version: 5.90.0
 description: software to fetch configuration from network devices and store them
 email:
 - saku@ytti.fi
@@ -379,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"
@@ -401,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
@@ -410,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
@@ -437,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
@@ -549,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
@@ -583,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
@@ -658,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

data/examples/podman-compose/README.md

@@ -1,94 +0,0 @@
-# Running Oxidized with podman-compose
-This example demonstrates running Oxidized within an OCI container using
-podman-compose. It’s actively used in Oxidized development to validate the
-container’s functionality and to simulate potential issues.
-
-While this example uses podman and podman-compose, it should also be compatible
-with docker, as podman supports docker’s CLI.
-
-To make this example work seamlessly, a simulated network device is included.
-The asternos model is used here for simplicity, as it requires minimal commands
-to implement. The simulated output doesn’t replicate real device responses but
-provides changing lines over time to test Oxidized’s functionality.
-
-
-The example also provides a Git server to test the interaction with it.
-
-# Run the example
-> :warning: the example builds local containers and will require at least 2 GB
-> of disk space along with some CPU and time during the first run.
-
-To start the example, simply run `make start`. Ensure you have installed the
-necessary [dependencies](#dependencies) before.
-
-To stop, press `CTRL-C` or run `make stop` in a separate shell. If you exit
-with `CTRL-C`, make sure to run `make stop` afterward to properly clean up the
-environment.
-
-## Running Environment
-This example of oxidized with podman-compose is running on Debian
-Bookworm (Version 12). It should work with few adaptations on any Linux
-box running podman, and maybe also with docker.
-
-## Dependencies
-To get started, install the required packages on your Debian system:
-```shell
-sudo apt install podman containers-storage podman-compose make
-```
-
-Ensure Podman is using the overlay driver for image storage.
-Without this driver, Podman may save every container layer separately rather
-than only the changes, which can quickly consume disk space.
-
-This issue can occur if podman was run before installing the
-`container-storage`  package.
-
-```shell
-podman info | grep graphDriverName
-```
-
-You should get this reply
-```shell
-  graphDriverName: overlay
-```
-
-If not, the quick way I found to solve it is to delete `~/.local/share/containers/`.
-Beware - this will delete **all** your containers!
-
-## Adapting to your needs
-Feel free to customize this setup as you wish! You may want to edit
-`docker-compose.yml` to remove any containers simulating specific components.
-
-## Use your own oxidized configuration in the git repository
-When developing oxidized or testing the container, you may want to use a custom
-configuration. This can be done by saving it under `oxidized-config/config.local`
-
-`make start-local` will recognize the local configuration and copy it to
-`oxidized-config/config` before starting the container.
-
-You should stop the container with `make stop-local` in order to restore the
-original configuration from the git repository.
-
-In the folder `oxidized-config/, you will also find some example configs,
-for example `config_csv-gitserver`. To use them, just copy the file to `config`.
-
-## Git server public keys
-To enable Oxidized to access the Git server, you'll need to retrieve the
-servers' public SSH keys and store them under `oxidized-ssh/known_hosts`.
-Without this, you will encounter the following error:
-
-```
-ERROR -- : Hook push_to_remote (#<GithubRepo:0x00007f4cff47d918>) failed (#<Rugged::SshError: invalid or unknown remote ssh hostkey>) for event :post_store
-```
-
-While the container environment is running (`make start`), open a separate shell
-and run:
-```
-make gitserver-getkey
-```
-
-You do not need to restart the container environment; Oxidized will
-automatically use the key the next time it pushes to the remote Git repository.
-
-
-

data/examples/podman-compose/docker-compose.yml

@@ -1,30 +0,0 @@
-services:
-  oxidized:
-    # Choose the image that you want to test
-    # image: docker.io/oxidized/oxidized:0.30.1
-    # image: docker.io/oxidized/oxidized:latest
-    # local/oxidized is build by "make oxidized-image" and "make run"
-    image: local/oxidized
-    ports:
-      - 127.0.0.1:8042:8888/tcp
-    environment:
-      # Reload hosts list once per day
-      CONFIG_RELOAD_INTERVAL: 86400
-      # Needed when you push to a remote git repository
-      OXIDIZED_SSH_PASSPHRASE: xxxxPassphasexxxx
-    volumes:
-       - ./oxidized-config:/home/oxidized/.config/oxidized
-       - ./oxidized-ssh:/home/oxidized/.ssh
-
-  # This is a simulated network device for the example to work out of the box
-  asternos-device:
-    image: localhost/local/model
-    volumes:
-      - ./model-simulation/asternos.sh:/home/oxidized/.profile
-      - ./model-simulation/asternos.sh:/home/admin/.profile
-
-  # This is a gitserver to push our configs
-  gitserver:
-    image: localhost/local/gitserver
-    volumes:
-      - ./gitserver/repo.git:/home/git/repo.git

data/examples/podman-compose/gitserver/.gitignore

@@ -1 +0,0 @@
-repo.git

data/examples/podman-compose/gitserver/Dockerfile

@@ -1,14 +0,0 @@
-FROM docker.io/phusion/baseimage:noble-1.0.0
-
-# Use baseimage-docker's init system.
-CMD ["/sbin/my_init"]
-
-# enable ssh
-RUN rm -f /etc/service/sshd/down
-RUN /etc/my_init.d/00_regen_ssh_host_keys.sh
-
-# Add user for the gitserver. The password is "git"
-RUN useradd -m git -p '$6$32WDb0LTFyQkLffy$u15COVx7CQ4tgp4JT4DO4LJ96q/jwFSpuZC3WrllNQDNa6nW1LhJKW9rLV57ak3rj9Ln./aRA85jzeof1B0Gi1' -s /bin/bash -u 30001
-
-# And install git
-RUN install_clean git

data/examples/podman-compose/model-simulation/Dockerfile-model

@@ -1,13 +0,0 @@
-FROM docker.io/phusion/baseimage:noble-1.0.0
-
-# Use baseimage-docker's init system.
-CMD ["/sbin/my_init"]
-
-# enable ssh
-RUN rm -f /etc/service/sshd/down
-RUN /etc/my_init.d/00_regen_ssh_host_keys.sh
-
-# Add users to login. The password is "oxidized"
-RUN useradd -m oxidized -p '$y$j9T$UoDYxDiE.8iBGmoaD/acn1$kVvYvoEIJdKUmIKFVBRYKLIVzmEBP1RKrCM6Vfx.V55' -s /bin/bash
-RUN useradd -m admin -p '$y$j9T$UoDYxDiE.8iBGmoaD/acn1$kVvYvoEIJdKUmIKFVBRYKLIVzmEBP1RKrCM6Vfx.V55' -s /bin/bash
-

data/examples/podman-compose/model-simulation/asternos.sh

@@ -1,36 +0,0 @@
-# if running bash
-if [ -n "$BASH_VERSION" ]; then
-    # include .bashrc if it exists
-    if [ -f "$HOME/.bashrc" ]; then
-        . "$HOME/.bashrc"
-    fi
-fi
-
-# Display a MOTD
-cat << EOF
-This is the welcome message of this device
-it is muliline
-End of the MOTD
-EOF
-
-function show() {
-  if [ "$*" == "version" ]; then
-    echo "Version 1.2.3"
-    # Make the output change over time
-    date
-  elif [ "$*" == "runningconfiguration all" ]; then
-          cat << EOF
-! begin of the configuration
-! this is the running config
-!
-I have no idea how a configuration in asternos looks like ;-)
-!
-! End of the Configuration
-EOF
-  else
-    echo "command 'show $*' not implemented"
-  fi
-}
-
-PS1="asternos$"
-

data/examples/podman-compose/oxidized-config/.gitignore

@@ -1,10 +0,0 @@
-# Ignore local configurations, which will override the git config
-config.local
-router.db.local
-
-# Ignore logs, retrieved configs...
-pid
-configs/
-crash
-logs/
-oxidized.git/

data/examples/podman-compose/oxidized-config/config

@@ -1,46 +0,0 @@
----
-username: oxidized
-password: oxidized
-resolve_dns: true
-interval: 3600
-use_syslog: false
-debug: false
-threads: 30
-use_max_threads: true
-timeout: 20
-retries: 3
-prompt: !ruby/regexp /^([\w.@-]+[#>]\s?)$/
-rest: 0.0.0.0:8888
-next_adds_job: false
-vars: {}
-groups: {}
-group_map: {}
-models: {}
-pid: "~/.config/oxidized/pid"
-crash:
-  directory: "~/.config/oxidized/crashes"
-  hostnames: false
-stats:
-  history_size: 10
-input:
-  default: ssh
-  debug: false
-  ssh:
-    secure: false
-  ftp:
-    passive: true
-  utf8_encoded: true
-output:
-  default: file
-  file:
-    directory: "~/.config/oxidized/configs/"
-source:
-  default: csv
-  csv:
-    file: "~/.config/oxidized/router.db"
-    delimiter: !ruby/regexp /:/
-    map:
-      name: 0
-      model: 1
-      ip: 2
-    gpg: false

data/examples/podman-compose/oxidized-config/config_csv-file

@@ -1,46 +0,0 @@
----
-username: oxidized
-password: oxidized
-resolve_dns: true
-interval: 3600
-use_syslog: false
-debug: false
-threads: 30
-use_max_threads: true
-timeout: 20
-retries: 3
-prompt: !ruby/regexp /^([\w.@-]+[#>]\s?)$/
-rest: 0.0.0.0:8888
-next_adds_job: false
-vars: {}
-groups: {}
-group_map: {}
-models: {}
-pid: "~/.config/oxidized/pid"
-crash:
-  directory: "~/.config/oxidized/crashes"
-  hostnames: false
-stats:
-  history_size: 10
-input:
-  default: ssh
-  debug: false
-  ssh:
-    secure: false
-  ftp:
-    passive: true
-  utf8_encoded: true
-output:
-  default: file
-  file:
-    directory: "~/.config/oxidized/configs/"
-source:
-  default: csv
-  csv:
-    file: "~/.config/oxidized/router.db"
-    delimiter: !ruby/regexp /:/
-    map:
-      name: 0
-      model: 1
-      ip: 2
-    gpg: false