snmp-open 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67cb5790febed285507e8f2872aa8dbb3f025a02
-  data.tar.gz: d1504724d8f8572a03624bca255d10757636d40f
+SHA256:
+  metadata.gz: b13230f5561531372236208bfe42c5a0d44ef032d8075316fd02bf78ec7e78b3
+  data.tar.gz: 2fc93d9967c5fc37918b7f371147e14f9942d356699a02e4ce46b06763bfceb0
 SHA512:
-  metadata.gz: fff2fcd5e4c3a42d921112c4d0f36e96914b037aee168c73b2981796375597e82e7564352030cd0860043c40f24e61a7e44cd8fe3ae7b7f481b7c60e4d973631
-  data.tar.gz: 240aebb9fd9938b76a1d0bc37e56c77d70eb8cd5958a73f952b1766df793c8baabf43a437b0a0207c0c391ea5648018c7948c9ad92572f6b2cabb5555fb67492
+  metadata.gz: b3678f4b2e04b9f5a3a45edd3273d8ecfecb8a7a2bc4d92568b9644c6192e8e5fbeb8b902f0bf53d5c42b184f1402359a6daf8ea9f9923c1331b22b914fc0a54
+  data.tar.gz: 19a0f2e47cb585f3a1aaab331c3a97bbec05d3e57ce8ec76e17f5c1dc48f96a5b68cbb0b9d8b7b648490cbfbeed0dd1f2810381574286bd5135bddc9eac2d5bc

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.4, 2.5, 2.6, 2.7, jruby, truffleruby]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,62 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/snmp/open/parser/value_parser.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/snmp/open/parser.rb'
+
+Style/AccessModifierDeclarations: {Enabled: false}
+Style/IfUnlessModifier: {Enabled: false}
+Style/FrozenStringLiteralComment: {Enabled: false}
+
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true

data/Gemfile

@@ -5,4 +5,5 @@ group :guard do
   gem 'guard'
   gem 'guard-rspec'
   gem 'guard-rubocop'
+  gem 'rubocop', '~>1.0'
 end

data/lib/snmp/open/command_reader.rb

@@ -30,8 +30,7 @@ module SNMP
                    else
                      Open3.capture3(cli(cmd, oid, options))
                    end
-        raise CommandTimeoutError, err.chomp if err =~ /^timeout/i
-        raise CommandError, err.chomp unless err.empty?
+        raise_capture_errors(err)
         out
       end
 
@@ -42,6 +41,7 @@ module SNMP
         [
           command,
           *options.map { |k, v| "#{k}#{v}" },
+          *oid_options(id),
           *@host_options.map { |k, v| "#{k}#{v}" },
           *@command_options.fetch(command, {}).map { |k, v| "#{k}#{v}" },
           *id
@@ -50,6 +50,19 @@ module SNMP
 
       private
 
+      def raise_capture_errors(err)
+        case err
+        when /^Cannot find module \(([^)]+)\)/
+          raise UnknownMIBError, "Unknown MIB: #{Regexp.last_match(1)}"
+        when /^(\S+): Unknown Object Identifier$/
+          raise UnknownOIDError, "Unknown OID: #{Regexp.last_match(1)}"
+        when /^timeout/i
+          raise CommandTimeoutError, err.chomp
+        when /./
+          raise CommandError, err.chomp
+        end
+      end
+
       def merge_options(options = {})
         options.each_pair.with_object({}) do |(key, value), opts|
           if Options::MAP.key?(key)
@@ -63,6 +76,15 @@ module SNMP
         end
       end
 
+      # if the request OID is all-numeric, force numeric OID in the output
+      def oid_options(id)
+        if id =~ /[^0-9.]/
+          []
+        else
+          ['-On']
+        end
+      end
+
       def normalize_command(command)
         case command
         when Symbol then "snmp#{command}"
@@ -99,6 +121,11 @@ module SNMP
     end # class CommandReader
 
     class CommandError < RuntimeError; end
+
     class CommandTimeoutError < CommandError; end
+
+    class UnknownMIBError < CommandError; end
+
+    class UnknownOIDError < CommandError; end
   end # class Open
 end # module SNMP

data/lib/snmp/open/file_reader.rb

@@ -32,12 +32,12 @@ module SNMP
         mkdir(@directory, cmd.to_s) if @make_directories
         outfile = File.join(@directory, cmd.to_s, oid)
         File.read(outfile)
-      rescue Errno::ENOENT => err
+      rescue Errno::ENOENT => e
         if @warnings
           warning = @warnings.call(@command_generator, cmd, oid, outfile)
           warn warning
         end
-        raise err
+        raise e
       end
 
       def mkdir(base, cmd)

data/lib/snmp/open/options.rb

@@ -12,8 +12,10 @@ module SNMP
           'snmpbulkwalk' => '-Cc',
           'snmpwalk' => '-Cc'
         },
+        no_mib_name: '-Os',
         no_units: '-OU',
         non_symbolic: '-Oe',
+        non_symbolic_table_indexes: '-Ob',
         numeric: '-On',
         priv_password: '-X', # not recommended, see snmp.conf(5)
         priv_protocol: '-x',
@@ -24,12 +26,12 @@ module SNMP
         host: nil
       }.freeze
 
-      # On some systems, SNMP command outputs will include symbolic OID names,
-      # symbolic values, and/or value units. The parser doesn't support these,
-      # so disable them.
+      # On some systems, SNMP command outputs will include symbolic values,
+      # table indexes, and/or value units. The parser doesn't support these, so
+      # disable them.
       REQUIRED_BY_PARSER = {
+        '-Ob' => nil,
         '-Oe' => nil,
-        '-On' => nil,
         '-OU' => nil
       }.freeze
 

data/lib/snmp/open/parser/value_parser.rb

@@ -23,9 +23,11 @@ module SNMP
         class Bits < ValueParser
           def parse(tokens)
             return @parse if @parse
+
             bytes = []
             loop do
               break unless tokens.peek =~ /\A[0-9A-Za-z]{1,2}\z/
+
               bytes << tokens.next.to_i(16)
             end
             @parse = [@type, bytes]
@@ -50,9 +52,11 @@ module SNMP
         class HexString < ValueParser
           def parse(tokens)
             return @parse if @parse
+
             bytes = []
             loop do
               break unless tokens.peek =~ /\A[0-9A-Za-z]{2}\z/
+
               bytes << tokens.next
             end
             string = bytes.map { |b| b.to_i(16).chr }.join
@@ -72,6 +76,7 @@ module SNMP
         class Timeticks < ValueParser
           def parse(tokens)
             return @parse if @parse
+
             ticks = tokens.next.tr('()', '').to_i
 
             # consume tokens through one like 23:59:59.99
@@ -106,16 +111,16 @@ module SNMP
 
         KNOWN_TOKENS = {
           NOSUCHINSTANCE_STR => NoSuchInstance,
-          NOSUCHOBJECT_STR =>  NoSuchObject,
+          NOSUCHOBJECT_STR => NoSuchObject,
           NOMOREVARIABLES_STR => Stop
         }.freeze
 
         KNOWN_TYPES = {
           nil => Default,
           'BITS' => Bits,
-          'INTEGER'   => ValueParser::Integer,
-          'Gauge32'   => ValueParser::Integer,
-          'Gauge64'   => ValueParser::Integer,
+          'INTEGER' => ValueParser::Integer,
+          'Gauge32' => ValueParser::Integer,
+          'Gauge64' => ValueParser::Integer,
           'Counter32' => ValueParser::Integer,
           'Counter64' => ValueParser::Integer,
           'Hex-STRING' => HexString,

data/lib/snmp/open/parser.rb

@@ -14,6 +14,37 @@ module SNMP
     # convert SNMP command output into arrays
     class Parser
       include SNMP::Open::Parser::Constants
+      OID_RE = Regexp.union(/\S+-MIB::\S+/, /[0-9.]+/)
+
+      EMPTY_STRING_RE =
+        /^(#{OID_RE})     # capture group 1: OID
+          \s+=\s+
+          (Opaque|STRING) # capture group 2: Type
+          :\s*\n          # value is always empty string
+        /x.freeze
+
+      STRING_RE =
+        /^(#{OID_RE})         # capture group 1: OID
+          \s+=\s+
+          (Opaque|STRING):\s+ # capture group 2: Type
+
+          (                   # capture group 3: Value
+
+           (?!")              # this pattern is for finding strings in need of
+                              # quoting, so reject any strings that are already
+                              # quoted
+
+           [^\n]*             # first line of value
+
+           (\n                # newline before each additional line of value
+            (?!
+             #{OID_RE}        # additional lines of value are identified by not
+             \s+=\s+          # starting with "<OID> ="
+            )
+            [^\n]+            # additional lines of value
+           )*
+          )\n
+        /x.freeze
 
       def initialize(oids)
         @oids = oids
@@ -21,12 +52,8 @@ module SNMP
 
       def parse(texts)
         columns = texts.map do |text|
-          tokenized =
-            text
-            .gsub(/^([0-9\.]+) = (Opaque|STRING): ((?!")[^\n]*)\n/,
-                  %(\\1 = \\2: "\\3"\n))
-            .gsub(Static::ANY_MESSAGE, Static::QUOTED_MESSAGES)
-            .shellsplit
+          clean = clean_input_text(text)
+          tokenized = clean.shellsplit
           parse_tokens(tokenized)
         end
 
@@ -47,6 +74,14 @@ module SNMP
         end
       end
 
+      def clean_input_text(text)
+        text
+          .gsub(/\r\n|\n\r|\r/, "\n")
+          .gsub(EMPTY_STRING_RE, %(\\1 = \\2: ""\n))
+          .gsub(STRING_RE, %(\\1 = \\2: "\\3"\n))
+          .gsub(Static::ANY_MESSAGE, Static::QUOTED_MESSAGES)
+      end
+
       def index_using_first_oid(value)
         base = @oids.first
 
@@ -69,14 +104,16 @@ module SNMP
 
         objects
       rescue StopIteration
-        return objects
+        objects
       end
 
       def parse_next_object(tokens)
         oid = tokens.next.sub(/\A\./, '')
-        raise "Parse error at #{oid}" unless oid =~ /\A[0-9.]+\z/
+        raise "Parse error at #{oid}" unless oid =~ OID_RE
+
         equals = tokens.next
         raise "Parse error after #{oid}" unless equals == '='
+
         type, value = parse_type(tokens)
         Value.new(oid, type, value)
       end

data/lib/snmp/open/version.rb

@@ -1,5 +1,5 @@
 module SNMP
   class Open
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

data/lib/snmp/open.rb

@@ -27,16 +27,18 @@ module SNMP
     end
 
     # Perform an SNMP get using the "snmpget" command and parse the output
-    def get(oids)
+    def get(oids, &block)
       return enum_for(:get, oids) unless block_given?
+
       texts = oids.map { |oid| reader.capture(:get, oid) }
-      Parser.new(oids).parse(texts).fetch(0, []).each { |arg| yield(arg) }
+      Parser.new(oids).parse(texts).fetch(0, []).each(&block)
     end
 
     # Perform an SNMP walk using the "snmpwalk" or "snmpbulkwalk" commands and
     # parse the output
     def walk(oids, **kwargs)
       return enum_for(:walk, oids, **kwargs) unless block_given?
+
       bulk = kwargs.fetch(:bulk, true)
       options = walk_options(bulk, **kwargs)
       cmd = bulk ? :bulkwalk : :walk

data/snmp-open.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'snmp/open/version'
 
@@ -18,8 +18,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.required_ruby_version = '~> 2.4'
+
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'snmp'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snmp-open
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ben Miller
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,16 +66,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - bmiller@rackspace.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -98,24 +99,24 @@ files:
 homepage: https://github.com/bjmllr/snmp-open
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Wrapper for command-line SNMP utilities
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-  - 2.3.4
-  - 2.2.7
-before_install: gem install bundler -v 1.13.6