oxidized 0.32.1 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0ef1ef47a42a57f4d0b01e6a0201a604c9ff722c6b1f0452fa97d2352f0c55b
-  data.tar.gz: 15717e0e5f7344a0449054d66c412bf77a8710e59e3db003195dd3bd2eb21ee3
+  metadata.gz: 0c03871264e842280577898104fee04193865836f6a36f9e271fc899723c0490
+  data.tar.gz: f63f80d3220f6112f5e20955d7f519628d86a358502b907ebe196ad85126fdc3
 SHA512:
-  metadata.gz: 401435f585a12c13a81fd3c7a30f7190a83cf9d0a39fb417b9c80342a8dc78a0d570dac53f060fb54aed039989f579a113d4040e21405c81c25760d6a9720a4a
-  data.tar.gz: ed46c959fccbbbabdd60aecdb2a517b2262f956cb184eee34bb85558a88805c25e743d45d45d3d7a90847f8132d7a4f891c00ff95c7cb32c873a4108029102bf
+  metadata.gz: 6f2a29dd10a0ecdfd43a5b4607e237a778ad7776d017d0c09f6cbe35bb01d2a20b1eefe733a995630355346b876ec0c15a504e72f6200a2362b5597da01ca0cf
+  data.tar.gz: 5030d36380278ad562d7242d090dcd12b73572b0c97d1ac9f0d6b654a3f530349923b8d83561fc2ccd2f7b68d1b4b503e0ba405a72589ad9bd916f50b74e7e8c

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: Bug report
+about: Create a report to help us improve oxidized
+title: ''
+labels: bug
+assignees: ''
+
+---
+<!-- Check the box [X] -->
+- [ ] I have read and understood [docs/Issues.md](https://github.com/ytti/oxidized/blob/master/docs/Issues.md).
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Configure '...'
+2. Use model '....'
+3. Run '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Configuration**
+```
+If applicable, publish your configuration.
+```
+
+**Logs**
+```
+If applicable, add logs to help explain your problem.
+```
+
+**Running environment (please complete the following information):**
+<!-- complete the following information and add further details if needed.
+Always test the latest version of oxidized -->
+- OS: [e.g. Debian Bookworm, official container version xxx, ...]
+- oxidized version: [e.g. 0.32.2]
+- oxidized-web version: [e.g. 0.15.1, if applicable]
+- Manufacturer model an software version:
+- oxidized model name:
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature request
+assignees: ''
+
+---
+<!-- Check the box [X] -->
+- [ ] I have read and understood [docs/Issues.md](https://github.com/ytti/oxidized/blob/master/docs/Issues.md).
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context  about the feature request here.

data/.github/ISSUE_TEMPLATE/support-request.md

@@ -0,0 +1,39 @@
+---
+name: Support request
+about: Ask for help
+title: ''
+labels: question
+assignees: ''
+
+---
+<!-- Check the box [X] -->
+- [ ] I have read and understood [docs/Issues.md](https://github.com/ytti/oxidized/blob/master/docs/Issues.md).
+
+**Describe the problem**
+A clear and concise description of what your problem is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Configuration**
+```
+If applicable, publish your configuration.
+```
+
+**Logs**
+```
+If applicable, add logs to help explain your problem.
+```
+
+**Running environment (please complete the following information):**
+<!-- complete the following information and add further details if needed.
+Always test the latest version of oxidized -->
+- OS: [e.g. Debian Bookworm, official container version xxx, ...]
+- oxidized version: [e.g. 0.32.2]
+- oxidized-web version: [e.g. 0.15.1, if applicable]
+- Manufacturer model an software version:
+- oxidized model name:
+
+**Additional context**
+Add any other context about the problem here.
+

data/.github/workflows/publishdocker.yml

@@ -2,24 +2,43 @@ name: Publish Docker
 on:
   push:
     branches: [ "master" ]
+    tags: [ "[0-9]+.[0-9]+.[0-9]+" ]
+
 jobs:
   build:
     if: github.repository_owner == 'ytti'
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 0
-    - name: Get Release Version
-      id: get_version
-      run: echo "release-version=$(git describe --tags)" >> $GITHUB_OUTPUT
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v3
-    - name: Publish to Registry
-      uses: elgohr/Publish-Docker-Github-Action@v5
-      with:
-        name: oxidized/oxidized
-        username: ${{ secrets.DOCKER_USERNAME }}
-        password: ${{ secrets.DOCKER_PASSWORD }}
-        tags: "latest,${{ steps.get_version.outputs.release-version }}"
-        platforms: linux/amd64,linux/arm64
+
+      - name: Define tags
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            oxidized/oxidized
+          tags: |
+            type=semver,pattern={{version}}
+            type=sha,prefix=master-
+          flavor: |
+            latest=true
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          build-args: |
+            BUILDKIT_CONTEXT_KEEP_GIT_DIR=true

data/.github/workflows/ruby.yml

@@ -19,8 +19,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.1', '3.2', '3.3', '3.4', 'ruby-head']
-    continue-on-error: ${{ matrix.ruby-version == 'ruby-head' }}
+        ruby-version: ['3.1', '3.2', '3.3', '3.4']
+    # ruby-head disabled because of problem with bundler (2025-06-27)
+    #     ruby-version: ['3.1', '3.2', '3.3', '3.4', 'ruby-head']
+    # continue-on-error: ${{ matrix.ruby-version == 'ruby-head' }}
 
     steps:
     - uses: actions/checkout@v4

data/.gitignore

@@ -13,6 +13,7 @@
 Gemfile.lock
 .ruby-version
 .sass-cache/
+.vscode/
 
 # Used by dotenv library to load environment variables.
 # .env
@@ -52,3 +53,4 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+/.rake_tasks~

data/.rubocop.yml

@@ -3,8 +3,6 @@ inherit_from: .rubocop_todo.yml
 plugins:
   - rubocop-rake
   - rubocop-minitest
-
-require:
   - rubocop-sequel
 
 AllCops:
@@ -16,6 +14,8 @@ AllCops:
 Gemspec/DevelopmentDependencies:
   EnforcedStyle: gemspec
 
+# We prefer to use ”” by default and use ’’ to signal that interpolation is
+# intentionally turned off, but we don't enforce it.
 Style/StringLiterals:
   Enabled: false
 
@@ -23,7 +23,13 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 
 Layout/LineLength:
-  Enabled: false
+  Enabled: true
+  IgnoreCopDirectives: false
+  Max: 120
+  # Too much models have long lines, which is unsafe to reduce without
+  # having an existing model unit test.
+  Exclude:
+   - lib/oxidized/model/*.rb
 
 # We do not enforce the cop in the models as it would not work with the
 # DSL style of the models
@@ -46,6 +52,7 @@ Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
 
+# Explicitly allow the use of "not"
 Style/Not:
   Enabled: false
 
@@ -53,6 +60,9 @@ Style/Not:
 Style/CommandLiteral:
   EnforcedStyle: percent_x
 
+Style/ConditionalAssignment:
+  Enabled: false
+
 Style/FormatString:
   EnforcedStyle: percent
 
@@ -75,9 +85,11 @@ Style/RegexpLiteral:
   EnforcedStyle: slashes
   AllowInnerSlashes: true
 
+# Explicitly allow the use of rescue as a Modifier
 Style/RescueModifier:
   Enabled: false
 
+# Intentionally left deactivated as used in the models
 Style/SymbolProc:
   Enabled: false
 
@@ -85,19 +97,22 @@ Style/Documentation:
   Enabled: false
 
 Style/ParallelAssignment:
-  Enabled: false
+  Enabled: true
 
 Metrics/MethodLength:
   Max: 50
 
 Metrics/AbcSize:
-  Max: 28
+  Enabled: false
 
 Metrics/ClassLength:
-  Max: 200
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
 
-## Metrics/CyclomaticComplexity:
-##   Max: 7
+Metrics/CyclomaticComplexity:
+  Enabled: false
 
 # The BlockLength metric does not apply to unit tests. They are in nature
 # long and not very pretty
@@ -109,5 +124,11 @@ Metrics/BlockLength:
 Metrics/ParameterLists:
   Max: 6
 
+# Used in the models
 Lint/EmptyBlock:
   Enabled: false
+
+# Disable the cop as string concatenation is widely used in oxidized
+Style/StringConcatenation:
+  Enabled: false
+

data/.rubocop_todo.yml

@@ -1,58 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-17 10:13:53 UTC using RuboCop version 1.72.1.
+# on 2025-07-15 08:50:44 UTC using RuboCop version 1.78.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
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
-Metrics/AbcSize:
-  Enabled: false
-
-# Offense count: 17
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 12
-
-# Offense count: 14
-# 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:
     - 'lib/oxidized.rb'
@@ -65,20 +19,7 @@ Style/DoubleNegation:
   Exclude:
     - 'lib/oxidized/hook/exec.rb'
 
-# Offense count: 3
-Style/OpenStructUse:
-  Exclude:
-    - 'lib/oxidized/hook.rb'
-    - 'lib/oxidized/node.rb'
-    - 'spec/hook/githubrepo_spec.rb'
-
 # Offense count: 33
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/SlicingWithRange:
   Enabled: false
-
-# Offense count: 94
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: Mode.
-Style/StringConcatenation:
-  Enabled: false

data/CHANGELOG.md

@@ -4,8 +4,109 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
-## [0.32.0 – 2025-02-20]
-This minor release fixes a javascript issue in oxidized-web, which is included
+## [0.34.0 - 2025-07-15]
+:warning: This release introduces a [new logging system](docs/Configuration.md#logging),
+based on [semantic logger](https://logger.rocketjob.io/). The old configuration
+(`log`, `syslog`) is still supported but obsolete and will be removed in a
+future release, so be sure to migrate your configureation.
+
+### Added
+- add iosxr support to SyslogMonitor (@deesel)
+- add junos: support show chassis cluster when SRX series (@shigechika)
+- add nxos: support for complete hardware inventory (@garryshtern)
+- ssh: support 'newline "string"' cfg block method to allow defining \r\n newline (@ytti)
+- model for Netgate TNSR (@Vantomas)
+- efos: New model for Brocade Enhanced Fabric OS. Fixes #3477 (@sorano, @cetjcm, @robertcheramy)
+- output/file, output/git: clean node configurations which are not listed in the
+  source anymore. Fixes: #1805 (@robertcheramy)
+- sixwind: New model to support 6WIND Virtual Service Router (@hcaldicott)
+- model for saos10 (@penfold1972)
+
+### Changed
+- remove uri in commit-archive location for EdgeOS. Fixed #3525 (@systeembeheerder)
+- acos: remove free storage amount from show version. Fixes #3492 (@991jo)
+- Housekeeping in the code: Maximal line length: 120 char + Rubocop fixes (@robertcheramy)
+- spec/model/data uses # instead of : as a separator in the filename, so we can
+  git clone under Windows. Fixes: #3481 (@robertcheramy)
+- logging: rework of the logging system, using Semantic Logger (@robertcheramy)
+
+### Fixed
+- nxos: ignore bootflash size and permission errors (@rouven0)
+- githubrepo: explicitly tell when Rugged isn't installed with ssh support (@robertcheramy)
+- ironware: mask temperatures with more than two digits (@merelissdgr)
+- add content-type header for PUT request in rest client (@deesel)
+- docker: do not remove git. Fixes #3482 (@robertcheramy)
+- awplus: fix skip password when enable=true (@shigechika)
+- aosw: fix secret parsing (@rouven0)
+- mlnxos: handle ANSI-ESC codes and pager requests. The prompt has been
+  reengineered, open an issue if you experience timeouts. Fixes #3469 (@robertcheramy)
+- Update installation instructions on Rocky Linux 9. Fixes #3368 (@robertcheramy)
+- awplus: fix enable password when supplied (@sgsimpson)
+- Fix CodeQL scanning alerts on regular expressions (Issue #3513) in node.rb (alert 40),
+  asa (alerts 5 and 6), sonicos (4, 11), quantaos (9, 10), eltex (7), zynos (18, 19),
+  AricentISS (15) and aosw (36)
+- fabricos: remove power supply input voltage from `chassisShow` output (@hops)
+- netgear: include running-config in config output (@bradleywehmeier)
+- tmos: remove deprecated secrets (@rouven0)
+- log an error when no suitable input is found for a node. Fixes: #3346 (@robertcheramy)
+- firelinuxos: fix timeout on syntax error. Fixes #3393, #3502 (@robertcheramy)
+
+
+## [0.33.0 - 2025-03-26]
+This release changes the way to configure oxidized-web. The old `rest`
+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)
+- model for Ingate Operating System (@thanegill)
+- model for Easton Gigabit Network Card (@thanegill)
+
+### Changed
+- fortios: support for FortiADC (@electrocret)
+- output/git: cache commit log to improve performance of oxidized-web. Fixes #3121 (@robertcheramy)
+- 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
+0.32.1 not beeing built.
+
+### Changed
+- docker image: updated github CI to explicitly build tag versions (@robertcheramy)
+- docker image: update rake build_container to match the tags of GitHub CI (@robertcheramy)
+
+### Fixed
+- powerconnect: restore last line of command output, and remove spurious CR characters. Fixes #2692 (@clifcox)
+- powerconnect: Remove undesirable inserted blank lines during pagination. Fixes #3413 (@clifcox)
+- docker image: remove ubuntu user introduced in noble. Fixes #3336 (@robertcheramy)
+- docker image: correct rights under /home/oxidized. Fixes #3336 (@robertcheramy)
+- docker image: revert the use of GEM_HOME. Fixes #3331 (@robertcheramy)
+- docker image: improve the documentation. Fixes #3336 (@robertcheramy)
+- docker image: remove examples/podman-compose as this is better documented in docs/Docker.md (@robertcheramy)
+
+
+## [0.32.1 – 2025-02-20]
+This patch release fixes a javascript issue in oxidized-web, which is included
 in the Docker container of oxidized.
 
 ### Fixed

data/CONTRIBUTING.md

@@ -1,6 +1,15 @@
 # Oxidized - Contributing Guide
 You can contribute to [Oxidized](https://github.com/ytti/oxidized/) in many ways, and first of all we'd like to thank you for taking your time to improve this great project!
 
+> ## Legal Notice
+> When submitting content to this project, you must agree that you have authored 100%
+> of the content, that you have the necessary rights to the content and that the
+> content you contribute may be provided under the project license.
+>
+> If you are employed, you probably need the permission from your employer to
+> contribute to open source projects.
+
+
 ## Contribute as a user
 A great place for users to get involved is the [GitHub issues](https://github.com/ytti/oxidized/issues).
 Through the issues, you can interact with maintainers and other users. You can open an issue
@@ -9,13 +18,6 @@ if you need help, but you can also help other users by reviewing their issues an
 Before writing an issue, please read our documentation on
 [how to write good issues](/docs/Issues.md).
 
-> ## Legal Notice
-> When submitting content to this project, you must agree that you have authored 100%
-> of the content, that you have the necessary rights to the content and that the
-> content you contribute may be provided under the project license.
->
-> If you are employed, you probably need the permission from your employer to
-> contribute to open source projects.
 
 ## Contribute some content
 Content contributions are always welcome. You do not need to be a maintainer for this.
@@ -25,6 +27,7 @@ enhancements :-)
 Contributions can be submitted through pull requests in github. For a full explanation how to
 contribute some content, see [How to contribute content](#how-to-contribute-content).
 
+
 ## Help Needed
 
 As things stand right now, `oxidized` is maintained by a few people. A great
@@ -167,10 +170,17 @@ git push -u origin 1234-your-branch-name
 You can push as often as you wish. If you already opened a pull request, your pushed commits will automatically get updated there.
 
 ### Open a pull request
-Go to your github repository, and github will propose to create a pull request and will guide you.
+Go to your github repository, and github will propose to create a pull request
+and will guide you.
+
+We are happy that you are contributing to Oxidized. If something is not as it
+should be, a maintainer will probably ask you to change it when reviewing the
+pull request. And if your pull request breaks something, this can be fixed, so
+don't be shy, submit your code ;-)
 
-We are happy that you are contributing to Oxidized. If something is not as it should be, a maintainer
-will probably ask you to change it when reviewing the pull request. And if your pull request breaks something, this can be fixed, so don't be shy, submit your code ;-)
+Note: if the github CI fail on your pull request, fix the problems.
+A pull request with failed CI won't be merged into master, so maintainers may
+only review pull requests that have passed the CIs.
 
 ### Delete the branch from your repository
 When the pull request has been merged into main, github will ask if you want to delete your branch. Clean up and delete it, so that you can keep your fork clean and ready for new contributions.