snmp-open 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eb1bfb86bae4239a253fa4528be54e46a30e770d
-  data.tar.gz: 0574b00db365565c87e647314b00f34950ba8280
+SHA256:
+  metadata.gz: 1362f32d8e43b509be4884b392c43689b9cba48c2e2d6f63c4912e645ba6fcc9
+  data.tar.gz: d751cce9e00204ae0b0d131120338ce3b7beaf1bbfb2e71f114c60f8c9bfdfa8
 SHA512:
-  metadata.gz: db49e2407897332554aae593b909bb74db5878a6b2f5f72779bfe6fdd1be116c2579226811bca87814c5f2ae3f55678c4a9ccbfcebd0157ccc918a4b48bea0b4
-  data.tar.gz: 98f0150f390faf0fe8f8cffb8e60c535aae051cda4bfa964900a4e2172449807c3e85fdcaccf9d2090c1a082084885a872d93402b423e6fa2abb94de797b086e
+  metadata.gz: 51603c2ee2b8d5077be2dcc8f26b74ad174d09a31fe6b6879343d98b33bba5f30f6246cf2ac3999f3a3aa46fda3b5cf7f849310016de5725cbdd0574741af99c
+  data.tar.gz: 2670576c9373c22e74e5bc7a118317ffdefb33d685ef654236e1ec5f369f9ac772d619ff7cfba3e8532ba52a5fc3b0d52bc67439cbeb96d84a08d6cc36f40819

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,2 @@
+Style/CommentedKeyword:
+  Enabled: false

data/lib/snmp/open/command_reader.rb

@@ -1,39 +1,13 @@
 require 'open3'
+require 'snmp/open/options'
 
 module SNMP
   class Open
     # Open3-based data source that executes an snmp* command and captures the
     # output
     class CommandReader
-      # see snmpcmd(1) for explanation of options
-      OPTIONS = {
-        version: '-v',
-        auth_password: '-A',
-        auth_protocol: '-a',
-        community: '-c',
-        context: '-n',
-        no_check_increasing: {
-          'snmpbulkwalk' => '-Cc',
-          'snmpwalk' => '-Cc'
-        },
-        numeric: '-On', # needed by parser, should always be enabled
-        priv_password: '-X', # not recommended, see snmp.conf(5)
-        priv_protocol: '-x',
-        sec_level: '-l',
-        sec_user: '-u',
-        retries: '-r',
-        timeout: '-t',
-        host: nil
-      }.freeze
-
-      OPTION_VALUES = {
-        no_check_increasing: {
-          true => ''
-        }.freeze
-      }.freeze
-
       # +options+ accepts options dealing with making connections to the host,
-      # including all of the options listed in the +OPTIONS+ constant hash.
+      # including all of the options listed in the +Options::MAP+ constant hash.
       # Other options can be given as strings (or any object with a suitable
       # +to_s+ method), e.g., these are equivalent:
       #
@@ -44,7 +18,9 @@ module SNMP
         @env = options.delete(:env)
         host = options.delete(:host) ||
                (raise ArgumentError, 'Host expected but not given')
-        opts = merge_options(options).merge('-On' => nil, host => nil)
+        opts = Options::REQUIRED_BY_PARSER
+               .merge(merge_options(options))
+               .merge(host => nil)
         @command_options, @host_options = partition_options(opts)
       end
 
@@ -54,7 +30,7 @@ module SNMP
                    else
                      Open3.capture3(cli(cmd, oid, options))
                    end
-        raise CommandError, err.chomp unless err.empty?
+        raise_capture_errors(err)
         out
       end
 
@@ -65,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
@@ -73,11 +50,24 @@ 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.key?(key)
-            opts[OPTIONS[key]] =
-              (OPTION_VALUES.fetch(key, {}).fetch(value, value) || next)
+          if Options::MAP.key?(key)
+            opts[Options::MAP[key]] =
+              (Options::VALUES.fetch(key, {}).fetch(value, value) || next)
           elsif key.is_a?(String)
             opts[key] = value
           else
@@ -86,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}"
@@ -122,5 +121,8 @@ 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

@@ -13,20 +13,37 @@ module SNMP
     # be used to generate a needed file, if the file is unavailable. Controlled
     # by the `warnings` option.
     class FileReader
+      DEFAULT_WARNING_FORMATTER = lambda { |gen, cmd, oid, outfile|
+        "#{gen.cli(cmd, oid)} > #{outfile}"
+      }
+
       def initialize(directory, options = {})
         @directory = directory
         @warnings = options.delete(:warnings)
-        @command_generator =
-          SNMP::Open::CommandReader.new(options.merge(host: '$OPTIONS'))
+        @make_directories = options.delete(:make_directories)
+        if @warnings && !@warnings.respond_to?(:call)
+          @warnings = DEFAULT_WARNING_FORMATTER
+        end
+        options[:host] ||= '$OPTIONS'
+        @command_generator = SNMP::Open::CommandReader.new(options)
       end
 
       def capture(cmd, oid, _options = {})
-        outfile = File.join(cmd.to_s, oid)
-        File.read(File.join(@directory, outfile))
+        mkdir(@directory, cmd.to_s) if @make_directories
+        outfile = File.join(@directory, cmd.to_s, oid)
+        File.read(outfile)
       rescue Errno::ENOENT => err
-        warn "#{@command_generator.cli(cmd, oid)} > #{outfile}" if @warnings
+        if @warnings
+          warning = @warnings.call(@command_generator, cmd, oid, outfile)
+          warn warning
+        end
         raise err
       end
+
+      def mkdir(base, cmd)
+        Dir.mkdir(base) unless File.exist?(base)
+        Dir.mkdir(File.join(base, cmd)) unless File.exist?(File.join(base, cmd))
+      end
     end # class FileReader
   end # class Open
 end # module SNMP

data/lib/snmp/open/options.rb

@@ -0,0 +1,41 @@
+module SNMP
+  class Open
+    class Options
+      # see snmpcmd(1) for explanation of options
+      MAP = {
+        version: '-v',
+        auth_password: '-A',
+        auth_protocol: '-a',
+        community: '-c',
+        context: '-n',
+        no_check_increasing: {
+          'snmpbulkwalk' => '-Cc',
+          'snmpwalk' => '-Cc'
+        },
+        no_units: '-OU',
+        non_symbolic: '-Oe',
+        numeric: '-On',
+        priv_password: '-X', # not recommended, see snmp.conf(5)
+        priv_protocol: '-x',
+        sec_level: '-l',
+        sec_user: '-u',
+        retries: '-r',
+        timeout: '-t',
+        host: nil
+      }.freeze
+
+      # On some systems, SNMP command outputs will include symbolic values
+      # and/or value units. The parser doesn't support these, so disable them.
+      REQUIRED_BY_PARSER = {
+        '-Oe' => nil,
+        '-OU' => nil
+      }.freeze
+
+      VALUES = {
+        no_check_increasing: {
+          true => ''
+        }.freeze
+      }.freeze
+    end # class Options
+  end # class Open
+end # module SNMP

data/lib/snmp/open/parser.rb

@@ -1,5 +1,7 @@
 require 'set'
 require 'shellwords'
+require 'snmp/open/parser/constants'
+require 'snmp/open/parser/value_parser'
 
 module SNMP
   class Open
@@ -11,10 +13,8 @@ module SNMP
 
     # convert SNMP command output into arrays
     class Parser
-      NOSUCHOBJECT_STR =
-        'No Such Object available on this agent at this OID'.freeze
-      NOSUCHINSTANCE_STR =
-        'No Such Instance currently exists at this OID'.freeze
+      include SNMP::Open::Parser::Constants
+      OID_RE = Regexp.union(/\S+-MIB::\S+/, /[0-9\.]+/)
 
       def initialize(oids)
         @oids = oids
@@ -22,11 +22,8 @@ module SNMP
 
       def parse(texts)
         columns = texts.map do |text|
-          tokenized =
-            text
-            .gsub(NOSUCHOBJECT_STR, %("#{NOSUCHOBJECT_STR}"))
-            .gsub(NOSUCHINSTANCE_STR, %("#{NOSUCHINSTANCE_STR}"))
-            .shellsplit
+          clean = clean_input_text(text)
+          tokenized = clean.shellsplit
           parse_tokens(tokenized)
         end
 
@@ -35,7 +32,7 @@ module SNMP
 
       private
 
-      def table(columns)
+      def align(columns)
         indexes = columns.first.map { |value| index_using_first_oid(value) }
         hash = columns.flat_map { |row| row.map { |v| [v.oid, v] } }.to_h
 
@@ -47,6 +44,16 @@ module SNMP
         end
       end
 
+      def clean_input_text(text)
+        text
+          .gsub(/\r\n|\n\r|\r/, "\n")
+          .gsub(/^(#{OID_RE})\s*=\s*(Opaque|STRING):\s*\n/,
+                %(\\1 = \\2: ""\n))
+          .gsub(/^(#{OID_RE}) = (Opaque|STRING): ((?!")[^\n]*)\n/,
+                %(\\1 = \\2: "\\3"\n))
+          .gsub(Static::ANY_MESSAGE, Static::QUOTED_MESSAGES)
+      end
+
       def index_using_first_oid(value)
         base = @oids.first
 
@@ -69,12 +76,12 @@ 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)
@@ -82,21 +89,16 @@ module SNMP
       end
 
       def parse_type(tokens)
-        next_token = tokens.next
-        type = next_token.match(/\A([A-Z]+):\z/) { |md| md[1] }
-        type, value = parse_value(tokens, next_token, type)
-        [type, Conversions.convert_value(type, value)]
+        token = tokens.next
+        type = token.match(/\A([-A-Za-z]+[0-9]*):\z/) { |md| md[1] }
+        ValueParser.find(type, token).parse(tokens)
       end
 
-      def parse_value(tokens, token, type)
-        if token == NOSUCHOBJECT_STR
-          ['No Such Object', nil]
-        elsif token == NOSUCHINSTANCE_STR
-          ['No Such Instance', nil]
-        elsif !type
-          ['STRING', token]
+      def table(columns)
+        if columns.size == 1 && columns.all? { |column| column.size == 1 }
+          columns
         else
-          [type, tokens.next]
+          align(columns)
         end
       end
 
@@ -116,25 +118,24 @@ module SNMP
         @oids.zip(columns).map do |oid, column|
           indexes.map do |index|
             id = (oid == index ? index : "#{oid}.#{index}")
-            column.find { |o| o.oid == id } || Conversions.absent_value(id)
+            column.find { |o| o.oid == id } || Value.new(id, 'absent', nil)
           end
         end
       end
 
-      # functions to generate value objects
-      module Conversions
-        module_function def convert_value(type, value)
-          case type
-          when 'INTEGER'
-            value.to_i
-          else
-            value
-          end
-        end
+      # static messages from net-snmp commands
+      module Static
+        include SNMP::Open::Parser::Constants
 
-        module_function def absent_value(id)
-          Value.new(id, 'absent', nil)
-        end
+        MESSAGES = [
+          NOSUCHOBJECT_STR,
+          NOSUCHINSTANCE_STR,
+          NOMOREVARIABLES_STR
+        ].freeze
+
+        ANY_MESSAGE = Regexp.union(*MESSAGES)
+
+        QUOTED_MESSAGES = MESSAGES.map { |v| [v, %("#{v}")] }.to_h.freeze
       end
     end # class Parser
   end # class Open

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

@@ -0,0 +1,15 @@
+module SNMP
+  class Open
+    class Parser
+      module Constants
+        NOSUCHOBJECT_STR =
+          'No Such Object available on this agent at this OID'.freeze
+        NOSUCHINSTANCE_STR =
+          'No Such Instance currently exists at this OID'.freeze
+        NOMOREVARIABLES_STR =
+          'No more variables left in this MIB View '\
+          '(It is past the end of the MIB tree)'.freeze
+      end # module Constants
+    end # class Parser
+  end # class Open
+end # module SNMP

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

@@ -0,0 +1,127 @@
+module SNMP
+  class Open
+    class Parser
+      # base class for value parsers
+      class ValueParser
+        include SNMP::Open::Parser::Constants
+
+        def self.find(type, token)
+          cls = KNOWN_TOKENS[token] || KNOWN_TYPES[type] || Other
+          cls.new(type, token)
+        end
+
+        def initialize(type, token)
+          @type = type
+          @token = token
+        end
+
+        def parse(*)
+          @parse
+        end
+
+        # parses BITS
+        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]
+          end
+        end # class Bits < ValueParser
+
+        # parses objects with no explicit type
+        class Default < ValueParser
+          def initialize(_type, token)
+            @parse = ['STRING', token]
+          end
+        end # class Default
+
+        # parses integer-like objects
+        class Integer < ValueParser
+          def parse(tokens)
+            @parse ||= [@type, Integer(tokens.next)]
+          end
+        end
+
+        # parses objects identified like '= Hex-STRING:'
+        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
+            @parse = [@type, string]
+          end
+        end # class HexString
+
+        # handles messages indicating the end of the response
+        class Stop < ValueParser
+          def parse(*)
+            raise StopIteration, @token
+          end
+        end
+
+        # parses objects identified like '= Timeticks:'
+        # note that 1 second = 100 ticks
+        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
+            loop do
+              break if tokens.next =~ /\A\d\d:\d\d:\d\d.\d\d\z/
+            end
+
+            @parse = [@type, ticks]
+          end
+        end # class Timeticks
+
+        # handles objects not handled by any other parser
+        class Other < ValueParser
+          def parse(tokens)
+            @parse ||= [@type, tokens.next]
+          end
+        end # class Other
+
+        # handles NoSuchInstance
+        class NoSuchInstance < ValueParser
+          def initialize(*)
+            @parse = ['No Such Instance', nil]
+          end
+        end # class NoSuchInstance < ValueParser
+
+        # handles NoSuchObject
+        class NoSuchObject < ValueParser
+          def initialize(*)
+            @parse = ['No Such Object', nil]
+          end
+        end # class NoSuchObject < ValueParser
+
+        KNOWN_TOKENS = {
+          NOSUCHINSTANCE_STR => NoSuchInstance,
+          NOSUCHOBJECT_STR =>  NoSuchObject,
+          NOMOREVARIABLES_STR => Stop
+        }.freeze
+
+        KNOWN_TYPES = {
+          nil => Default,
+          'BITS' => Bits,
+          'INTEGER'   => ValueParser::Integer,
+          'Gauge32'   => ValueParser::Integer,
+          'Gauge64'   => ValueParser::Integer,
+          'Counter32' => ValueParser::Integer,
+          'Counter64' => ValueParser::Integer,
+          'Hex-STRING' => HexString,
+          'Timeticks' => Timeticks
+        }.freeze
+      end # class ValueParser
+    end # class Parser
+  end # class Open
+end # module SNMP

data/lib/snmp/open/version.rb

@@ -1,5 +1,5 @@
-module Snmp
-  module Open
-    VERSION = '0.2.0'.freeze
+module SNMP
+  class Open
+    VERSION = '0.6.0'.freeze
   end
 end

data/snmp-open.gemspec

@@ -1,10 +1,10 @@
-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'
 
 Gem::Specification.new do |spec|
   spec.name          = 'snmp-open'
-  spec.version       = Snmp::Open::VERSION
+  spec.version       = SNMP::Open::VERSION
   spec.authors       = ['Ben Miller']
   spec.email         = ['bmiller@rackspace.com']
 
@@ -18,8 +18,8 @@ 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.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.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ben Miller
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-05-06 00:00:00.000000000 Z
+date: 2020-12-16 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
@@ -89,13 +90,16 @@ files:
 - lib/snmp/open.rb
 - lib/snmp/open/command_reader.rb
 - lib/snmp/open/file_reader.rb
+- lib/snmp/open/options.rb
 - lib/snmp/open/parser.rb
+- lib/snmp/open/parser/constants.rb
+- lib/snmp/open/parser/value_parser.rb
 - lib/snmp/open/version.rb
 - snmp-open.gemspec
 homepage: https://github.com/bjmllr/snmp-open
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,9 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.1.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