oxidized 0.29.0 → 0.29.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dfae187ce90fc83fde6d62b7044eac15ca5a803aa05f2064d99ffe04aea938d
-  data.tar.gz: d5de2f1a1770c966168ed3385623376f5d335461a6c9403a1ef44bfcbc504a57
+  metadata.gz: d5f60756df10959016092e920b8d30c1752a54c902c25dd5753f73cf9982dbbe
+  data.tar.gz: 32e8b6918df95cc21e0a7cdcfb2934385f362a70f5035c70a2271390254826d7
 SHA512:
-  metadata.gz: '0515586ff98c993834c1aaf40638e8078fb55fa44b120ceffd0c7164216b4307eb6b39145fbff0aeb0d11519f3ee10d2fb82fea73498e243808f2e0eda130e39'
-  data.tar.gz: 6afbfb306289a65a8c89799a87b920880547c06e0372f56bbbbafd5b4e85d13d452de5e1593eb2c13320d830a04159dd1046ec4c93e0a20ee7bca2669ac79b53
+  metadata.gz: 299463a15d5fdbdea8f6e67859eb9c2c9d8ea9c1fe6bf4506a1bc3fb7de9e6ed9f01887e3d999460d67ecfd8eb7994ebd193a0bca33d1cc6fe39e30b8f34293a
+  data.tar.gz: '095c7d26e35534fac3c3c1fe2615eb31e5d6b6302910c66e3d07ba23f698f9b13b8bbab9e70f84f5a627bf560a6e636e7d8dea7a85158f31012c50c845edf0cd'

data/.github/dependabot.yml

@@ -0,0 +1,31 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    target-branch: "master"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 10
+    labels:
+      - dependencies
+  - package-ecosystem: "bundler"
+    target-branch: "master"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 10
+    labels:
+      - dependencies
+  - package-ecosystem: "docker"
+    target-branch: "master"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 10
+    labels:
+      - dependencies

data/.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '44 21 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

data/.github/workflows/publishdocker.yml

@@ -1,5 +1,7 @@
 name: Publish Docker
-on: [push]
+on:
+  push:
+    branches: [ "master" ]
 jobs:
   build:
     if: github.repository_owner == 'ytti'

data/.github/workflows/stale.yml

@@ -0,0 +1,16 @@
+name: "Stale Issue/PR cleanup"
+on:
+  schedule:
+    - cron: "30 1 * * *"
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v8
+        with:
+          operations-per-run: 500

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-04-03 06:53:54 UTC using RuboCop version 1.48.1.
+# on 2023-04-14 17:17:03 UTC using RuboCop version 1.48.1.
 # 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
@@ -32,7 +32,7 @@ Metrics/PerceivedComplexity:
 # Offense count: 1
 Naming/AccessorMethodName:
   Exclude:
-    - 'lib/oxidized/string.rb'
+    - 'lib/refinements.rb'
 
 # Offense count: 8
 Naming/ConstantName:
@@ -50,7 +50,7 @@ Naming/ConstantName:
 # SupportedStylesForLeadingUnderscores: disallowed, required, optional
 Naming/MemoizedInstanceVariableName:
   Exclude:
-    - 'lib/oxidized/string.rb'
+    - 'lib/refinements.rb'
 
 # Offense count: 9
 # This cop supports safe autocorrection (--autocorrect).

data/CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## [Unreleased]
 
+## Added
+
+## Changed
+
+- Ensure Docker builds are only pushed to registry on `master` (@aschaber1)
+
+## Fixed
+
+- #2749: fix issues with `cut_both`
+
 ## [0.29.0 - 2023-04-13]
 
 - Ensure Docker Builds are tagged with latest and version (using `git describe --tags`) (@aschaber1)

data/Dockerfile

@@ -22,6 +22,8 @@ WORKDIR /tmp/oxidized
 
 # docker automated build gets shallow copy, but non-shallow copy cannot be unshallowed
 RUN git fetch --unshallow || true
+
+# Ensure rugged is built with ssh support
 RUN CMAKE_FLAGS='-DUSE_SSH=ON' rake install
 
 # web interface

data/README.md

@@ -220,12 +220,9 @@ services:
     environment:
       CONFIG_RELOAD_INTERVAL: 600
     volumes:
-       - config:/home/oxidized/.config/oxidized/config
-       - router.db:/home/oxidized/.config/oxidized/router.db
-       - model:/home/oxidized/.config/oxidized/model
-       # if git is use as input
-       - data:/home/oxidized/.config/oxidized/backupcfg/
-
+       - config:/home/oxidized/.config/oxidized/
+volumes:
+  config:
 ```
 
 Create the `/etc/oxidized/router.db` (see [CSV Source](docs/Sources.md#source-csv) for further info):

data/docs/Creating-Models.md

@@ -18,6 +18,7 @@ A bare-bone example for a fictional model running the OS type `rootware` could b
 
 ```ruby
 class RootWare < Oxidized::Model
+  using Refinements
   
   cmd 'show complete-config'
 ```
@@ -50,11 +51,11 @@ require 'oxidized/model/junos.rb'
 
 
 class JunOS
+  using Refinements
 
-
-    cmd 'show interfaces diagnostics optics' do |cfg|
-        comment cfg
-    end
+  cmd 'show interfaces diagnostics optics' do |cfg|
+    comment cfg
+  end
 
 
 end
@@ -92,19 +93,17 @@ require 'oxidized/model/junos.rb'
 
 
 class JunOS
+  using Refinements
 
+  cmd 'show interface diagnostic optics' do |cfg|
+    comment cfg
+  end
 
-    cmd 'show interface diagnostic optics' do |cfg|
-        comment cfg
-    end
-
-    cmd 'show configuration | display set' do |cfg|
-        cfg.type = "junos-set"
-        cfg.name = "set"
-        cfg
-    end
-
-
+  cmd 'show configuration | display set' do |cfg|
+    cfg.type = "junos-set"
+    cfg.name = "set"
+    cfg
+  end
 end
 ```
 

data/docs/Ruby-API.md

@@ -8,12 +8,14 @@ The following objects exist in Oxidized.
 * must implement 'connect', 'get', 'cmd'
 * 'ssh', 'telnet', 'ftp', 'tftp', 'http' implemented
 
-#### http
- * Communicates with a device over http/https
- * Configurable variables from within model @username, @password, @headers.
- * @username,@password are used in a Basic Authentication method.
- * @headers is a Hash of key value pairs of headers to pass along with the request.
- * Within the sources config under input you define a YAML stanza like the below, this will tell Oxidized to validate certificates on the request
+### http
+
+* Communicates with a device over http/https
+* Configurable variables from within model @username, @password, @headers.
+* @username,@password are used in a Basic Authentication method.
+* @headers is a Hash of key value pairs of headers to pass along with the request.
+* Within the sources config under input you define a YAML stanza like the below, this will tell Oxidized to validate certificates on the request
+
 ```yaml
 input:
    http:
@@ -177,10 +179,12 @@ Resets the existing block, allowing the user to completely override its contents
 Ensures that the contents of the block are prepended, rather than appended (the
 default) to an existing block.
 
-### `String` convenience methods
+### Refinements
+
+#### `String` convenience methods
 
 Since configuration processing tasks are occasionally similar across models,
-Oxidized provides an extended [`String`](/lib/oxidized/string.rb) class with the
+Oxidized provides an refined [`String`](../lib/refinements.rb) class with the
 intention of providing convenience methods and eliminating code duplication.
 
 #### `cut_tail`

data/lib/oxidized/model/acmepacket.rb

@@ -1,4 +1,6 @@
 class ACMEPACKET < Oxidized::Model
+  using Refinements
+
   # Oracle ACME Packet 3k, 4k, 6k series
 
   prompt /^\r*([\w.@()-\/]+[#>]\s?)$/

data/lib/oxidized/model/acos.rb

@@ -1,7 +1,9 @@
 class ACOS < Oxidized::Model
+  using Refinements
+
   # A10 ACOS model for AX and Thunder series
 
-  comment  '! '
+  comment '! '
 
   # ACOS prompt changes depending on the state of the device
   prompt /^([-\w.\/:?\[\]()]+[#>]\s?)$/

data/lib/oxidized/model/acsw.rb

@@ -1,4 +1,6 @@
 class ACSW < Oxidized::Model
+  using Refinements
+
   prompt /([\w.@()\/\\-]+[#>]\s?)/
   comment  '! '
 

data/lib/oxidized/model/adtran.rb

@@ -1,4 +1,6 @@
 class Adtran < Oxidized::Model
+  using Refinements
+
   # Adtran
 
   prompt /([\w.@-]+[#>]\s?)$/

data/lib/oxidized/model/adva.rb

@@ -4,6 +4,8 @@
 # for the user that is used to fetch the configuration.
 
 class ADVA < Oxidized::Model
+  using Refinements
+
   prompt /\w+\-+[#>]\s?$/
   comment '# '
 

data/lib/oxidized/model/aen.rb

@@ -1,4 +1,6 @@
 class AEN < Oxidized::Model
+  using Refinements
+
   # Accedian
 
   comment '# '

data/lib/oxidized/model/aireos.rb

@@ -1,4 +1,6 @@
 class Aireos < Oxidized::Model
+  using Refinements
+
   # AireOS (at least I think that is what it's called, hard to find data)
   # Used in Cisco WLC 5500
 

data/lib/oxidized/model/airfiber.rb

@@ -1,4 +1,6 @@
 class Airfiber < Oxidized::Model
+  using Refinements
+
   # Ubiquiti Airfiber (tested with Airfiber 11FX)
 
   prompt /^AF[\w\.-]+#/i

data/lib/oxidized/model/airos.rb

@@ -1,4 +1,6 @@
 class Airos < Oxidized::Model
+  using Refinements
+
   # Ubiquiti AirOS circa 5.x
 
   prompt /^[^#]+# /

data/lib/oxidized/model/alteonos.rb

@@ -1,4 +1,6 @@
 class ALTEONOS < Oxidized::Model
+  using Refinements
+
   prompt  /^\(?.+\)?\s?[#>]/
 
   comment '! '

data/lib/oxidized/model/alvarion.rb

@@ -1,4 +1,6 @@
 class Alvarion < Oxidized::Model
+  using Refinements
+
   # Used in Alvarion wisp equipment
 
   # Run this command as an instance of Model so we can access node

data/lib/oxidized/model/aos.rb

@@ -1,4 +1,6 @@
 class AOS < Oxidized::Model
+  using Refinements
+
   # Alcatel-Lucent Operating System
   # used in OmniSwitch
 

data/lib/oxidized/model/aos7.rb

@@ -1,4 +1,6 @@
 class AOS7 < Oxidized::Model
+  using Refinements
+
   # Alcatel-Lucent Operating System Version 7 (Linux based)
   # used in OmniSwitch 6900/10k
 

data/lib/oxidized/model/aoscx.rb

@@ -1,4 +1,6 @@
 class Aoscx < Oxidized::Model
+  using Refinements
+
   # previous command is repeated followed by "\eE", which sometimes ends up on last line
   # ssh switches prompt may start with \r, followed by the prompt itself, regex ([\w\s.-]+[#>] ), which ends the line
   # telnet switchs may start with various vt100 control characters, regex (\e\[24;[0-9][hH]), follwed by the prompt, followed

data/lib/oxidized/model/aosw.rb

@@ -1,4 +1,6 @@
 class AOSW < Oxidized::Model
+  using Refinements
+
   # AOSW Aruba Wireless, IAP, Instant Controller and Mobility Access Switches
   # Used in Alcatel OAW-4750 WLAN controller
   # Also Dell controllers
@@ -9,7 +11,7 @@ class AOSW < Oxidized::Model
   # Support for Mobility Access Switches tested with S2500-48P & S2500-24P running 7.4.1.4_54199 and S2500-24P running 7.4.1.7_57823
   # All IAPs connected to a Instant Controller will have the same config output. Only the controller needs to be monitored.
 
-  comment  '# '
+  comment '# '
   prompt /^([\w\(:.@-]+(\)?\s?)[#>]\s?)$/
 
   cmd :all do |cfg|

data/lib/oxidized/model/apc_aos.rb

@@ -1,4 +1,6 @@
 class Apc_aos < Oxidized::Model # rubocop:disable Naming/ClassAndModuleCamelCase
+  using Refinements
+
   cmd 'config.ini' do |cfg|
     cfg.gsub! /^; Configuration file, generated on.*/, ''
   end

data/lib/oxidized/model/arbos.rb

@@ -1,4 +1,6 @@
 class ARBOS < Oxidized::Model
+  using Refinements
+
   # Arbor OS model #
 
   prompt /^[\S\s]+\n([\w.@-]+[:\/#>]+)\s?$/

data/lib/oxidized/model/aricentiss.rb

@@ -4,6 +4,8 @@
 # 0               SSE-G48-TG4   (P2-01)           1.0.16-9
 
 class AricentISS < Oxidized::Model
+  using Refinements
+
   prompt /^(\e\[27m)?[ \r]*[\w-]+# ?$/
 
   cfg :ssh do

data/lib/oxidized/model/asa.rb

@@ -1,4 +1,6 @@
 class ASA < Oxidized::Model
+  using Refinements
+
   # Cisco ASA model #
   # Only SSH supported for the sake of security
 

data/lib/oxidized/model/asyncos.rb

@@ -1,4 +1,6 @@
 class AsyncOS < Oxidized::Model
+  using Refinements
+
   # ESA prompt "(mail.example.com)> " or "mail.example.com> "
   prompt /^\r*([(]?[\w. ]+[)]?[#>]\s+)$/
   comment '! '

data/lib/oxidized/model/audiocodes.rb

@@ -1,4 +1,6 @@
 class AudioCodes < Oxidized::Model
+  using Refinements
+
   # Pull config from AudioCodes Mediant devices from version > 7.0
 
   prompt /^\r?([\w.@() -]+[#>]\s?)$/

data/lib/oxidized/model/audiocodesmp.rb

@@ -1,4 +1,6 @@
 class AudioCodesMP < Oxidized::Model
+  using Refinements
+
   # AudioCodes MediaPack MP1xx and Mediant 1000 devices (firmware v4.xx, v5.xx, v6.xx) by pedjajks@gmail.com
 
   prompt /^\/\w*>/

data/lib/oxidized/model/awplus.rb

@@ -1,4 +1,6 @@
 class AWPlus < Oxidized::Model
+  using Refinements
+
   # Allied Telesis Alliedware Plus Model#
   # https://www.alliedtelesis.com/products/software/AlliedWare-Plus
 

data/lib/oxidized/model/axos.rb

@@ -1,4 +1,6 @@
 class AxOS < Oxidized::Model
+  using Refinements
+
   prompt /(\x1b\[\?7h)?([\w.@()-]+[#]\s?)$/
   comment '! '
 

data/lib/oxidized/model/bdcom.rb

@@ -1,4 +1,6 @@
 class BDCOM < Oxidized::Model
+  using Refinements
+
   comment '! '
 
   cmd :secret do |cfg|

data/lib/oxidized/model/boss.rb

@@ -1,11 +1,13 @@
 class Boss < Oxidized::Model
+  using Refinements
+
   # Extreme Baystack Operating System Software(BOSS)
   # Created by danielcoxman@gmail.com
   # May 15, 2017
   # This was tested on ers3510, ers5530, ers4850, ers5952
   # ssh and telnet were tested with banner and without
 
-  comment  '! '
+  comment '! '
 
   prompt /^[^\s#>]+[#>]$/
 

data/lib/oxidized/model/br6910.rb

@@ -1,4 +1,6 @@
 class BR6910 < Oxidized::Model
+  using Refinements
+
   prompt /^([\w.@()-]+[#>]\s?)$/
   comment '! '
 

data/lib/oxidized/model/c4cmts.rb

@@ -1,4 +1,6 @@
 class C4CMTS < Oxidized::Model
+  using Refinements
+
   # Arris C4 CMTS
 
   prompt /^([\w.@:\/-]+[#>]\s?)$/

data/lib/oxidized/model/cambium.rb

@@ -1,4 +1,6 @@
 class Cambium < Oxidized::Model
+  using Refinements
+
   cfg_cb = lambda do
     c_page = @m.click @m_page.link_with(text: "Configuration")
     u_page = @m.click c_page.link_with(text: "Unit Settings")

data/lib/oxidized/model/cambiumepmp.rb

@@ -1,4 +1,6 @@
 class CambiumePMP < Oxidized::Model
+  using Refinements
+
   # Cambium ePMP Radios
 
   prompt /.*>/

data/lib/oxidized/model/casa.rb

@@ -1,4 +1,6 @@
 class Casa < Oxidized::Model
+  using Refinements
+
   # Casa Systems CMTS
 
   prompt /^([\w.@()-]+[#>]\s?)$/

data/lib/oxidized/model/catos.rb

@@ -1,4 +1,6 @@
 class Catos < Oxidized::Model
+  using Refinements
+
   prompt /^[\w.@-]+>\s?(\(enable\) )?$/
   comment '# '
 

data/lib/oxidized/model/ciscoce.rb

@@ -1,5 +1,7 @@
 # Supporting Cisco Catalyst Express Switches and IOS using the basic web interface
 class CiscoCE < Oxidized::Model
+  using Refinements
+
   cmd "/level/15/exec/-/show/startup-config" do |cfg|
     output = cfg.gsub(/\A.+<DL>(.+)<\/DL>.+\z/m, '\1') # Strip configuration file from within HTML response.
     output

data/lib/oxidized/model/cisconga.rb

@@ -1,4 +1,6 @@
 class CiscoNGA < Oxidized::Model
+  using Refinements
+
   comment '# '
   prompt /([\w.@-]+[#>]\s?)$/
 

data/lib/oxidized/model/ciscosma.rb

@@ -1,4 +1,6 @@
 class CiscoSMA < Oxidized::Model
+  using Refinements
+
   # SMA prompt "mail.example.com> "
   prompt /^\r*([-\w. ]+\.[-\w. ]+\.[-\w. ]+[#>]\s+)$/
   comment '! '

data/lib/oxidized/model/ciscosmb.rb

@@ -1,4 +1,6 @@
 class CiscoSMB < Oxidized::Model
+  using Refinements
+
   # Cisco Small Business 300, 500, and ESW2 series switches
   # http://www.cisco.com/c/en/us/support/switches/small-business-300-series-managed-switches/products-release-notes-list.html
 

data/lib/oxidized/model/ciscovpn3k.rb

@@ -1,4 +1,6 @@
 class CiscoVPN3k < Oxidized::Model
+  using Refinements
+
   # Used in Cisco VPN3000 concentrators
   # it have buggy code 227 reply with whitespace before trailing bracket
   # "227 Passive mode OK (172,16,0,9,4,9 )"

data/lib/oxidized/model/cnos.rb

@@ -1,5 +1,7 @@
 # model for Centec Networks CNOS based switches
 class CNOS < Oxidized::Model
+  using Refinements
+
   comment '! '
 
   cmd :all do |cfg|

data/lib/oxidized/model/comnetms.rb

@@ -1,4 +1,6 @@
 class ComnetMS < Oxidized::Model
+  using Refinements
+
   # Comnet Microsemi Switch
   prompt /^\r?([\w.@()-]+[#>]\s?)$/
   comment  '! '