snmp-open 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db7e18f61349f692d1543dcfe02ae4e2bc9bab34
-  data.tar.gz: 37598b9ab5c8797bd2227eac71da7e8e945ddca7
+  metadata.gz: ed0ba9db497fbb007a69e702a2ed6321cfde3583
+  data.tar.gz: 9cbd977f12ae09f800fc0b27aa29fbad04bd0cd9
 SHA512:
-  metadata.gz: f7dc1bf3650a77fcce40e30ed2c9d6a7ac4f248e91adfac6e1358f5455e06cb045f44be5d9167287a9de4aef13843147a14f41e6b5cf962840deef5f8ae57a09
-  data.tar.gz: cf03e2bb2dc6509afe2991e8f0aaf02a4a262cefd0bc1ca733da93024d8006272177126e223aa861aaffda6ba750596bac90bb96a721fbde6d3467c919b173fe
+  metadata.gz: 74fb9d39823597e02d95f2029e14391d16851e29f0b20006ab595550e56207dc2f20a1bb3404aa118d25cf9e0a8016542c60be327bf43e45683bad890571aa7a
+  data.tar.gz: 6b29974a7a28fa197acb75647674f036f7ef5fad733de2f0ae7a5c780005717e17d8cb87fb4855f398768665ccf987432906d6ed6131f69546798725ac98f6f0

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
 
@@ -76,9 +52,9 @@ module SNMP
 
       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

data/lib/snmp/open/options.rb

@@ -0,0 +1,43 @@
+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 OID names,
+      # symbolic values, and/or value units. The parser doesn't support these,
+      # so disable them.
+      REQUIRED_BY_PARSER = {
+        '-Oe' => nil,
+        '-On' => 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,7 @@ 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
 
       def initialize(oids)
         @oids = oids
@@ -24,8 +23,9 @@ module SNMP
         columns = texts.map do |text|
           tokenized =
             text
-            .gsub(NOSUCHOBJECT_STR, %("#{NOSUCHOBJECT_STR}"))
-            .gsub(NOSUCHINSTANCE_STR, %("#{NOSUCHINSTANCE_STR}"))
+            .gsub(/^([0-9\.]+) = (Opaque|STRING): ((?!")[^\n]*)\n/,
+                  %(\\1 = \\2: "\\3"\n))
+            .gsub(Static::ANY_MESSAGE, Static::QUOTED_MESSAGES)
             .shellsplit
           parse_tokens(tokenized)
         end
@@ -82,22 +82,9 @@ 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)]
-      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]
-        else
-          [type, tokens.next]
-        end
+        token = tokens.next
+        type = token.match(/\A([-A-Za-z]+[0-9]*):\z/) { |md| md[1] }
+        ValueParser.find(type, token).parse(tokens)
       end
 
       def table(columns)
@@ -124,25 +111,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 SNMP
   module Open
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/snmp-open.gemspec

@@ -4,7 +4,7 @@ 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']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snmp-open
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,7 +89,10 @@ 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