snmp_table_viewer 0.0.4

data/lib/snmp_table_viewer/converter/if_table.rb

@@ -0,0 +1,296 @@
+module SNMPTableViewer
+
+  # Converter for the interface table.
+  #   Replaces type with "number (meaning)"
+  #   Replaces admin state with "number (meaning)"
+  #   Replaces oper state with "number (meaning)"
+  #   Replaces last change with "Timeticks: (number) D days, H:M:S.ms"
+  class Converter::IfTable < Converter
+    def self.convert(data)
+      admin_states = ['up', 'down', 'testing']
+      oper_states = ['up', 'down', 'testing', 'unknown', 'dormant', 'notPresent', 'lowerLayerDown']
+      types = {
+        1 => 'other',
+        2 => 'regular1822',
+        3 => 'hdh1822',
+        4 => 'ddnX25',
+        5 => 'rfc877x25',
+        6 => 'ethernetCsmacd',
+        7 => 'iso88023Csmacd',
+        8 => 'iso88024TokenBus',
+        9 => 'iso88025TokenRing',
+        10 => 'iso88026Man',
+        11 => 'starLan',
+        12 => 'proteon10Mbit',
+        13 => 'proteon80Mbit',
+        14 => 'hyperchannel',
+        15 => 'fddi',
+        16 => 'lapb',
+        17 => 'sdlc',
+        18 => 'ds1',
+        19 => 'e1',
+        20 => 'basicISDN',
+        21 => 'primaryISDN',
+        22 => 'propPointToPointSerial',
+        23 => 'ppp',
+        24 => 'softwareLoopback',
+        25 => 'eon',
+        26 => 'ethernet3Mbit',
+        27 => 'nsip',
+        28 => 'slip',
+        29 => 'ultra',
+        30 => 'ds3',
+        31 => 'sip',
+        32 => 'frameRelay',
+        33 => 'rs232',
+        34 => 'para',
+        35 => 'arcnet',
+        36 => 'arcnetPlus',
+        37 => 'atm',
+        38 => 'miox25',
+        39 => 'sonet',
+        40 => 'x25ple',
+        41 => 'iso88022llc',
+        42 => 'localTalk',
+        43 => 'smdsDxi',
+        44 => 'frameRelayService',
+        45 => 'v35',
+        46 => 'hssi',
+        47 => 'hippi',
+        48 => 'modem',
+        49 => 'aal5',
+        50 => 'sonetPath',
+        51 => 'sonetVT',
+        52 => 'smdsIcip',
+        53 => 'propVirtual',
+        54 => 'propMultiplexor',
+        55 => 'ieee80212',
+        56 => 'fibreChannel',
+        57 => 'hippiInterface',
+        58 => 'frameRelayInterconnect',
+        59 => 'aflane8023',
+        60 => 'aflane8025',
+        61 => 'cctEmul',
+        62 => 'fastEther',
+        63 => 'isdn',
+        64 => 'v11',
+        65 => 'v36',
+        66 => 'g703at64k',
+        67 => 'g703at2mb',
+        68 => 'qllc',
+        69 => 'fastEtherFX',
+        70 => 'channel',
+        71 => 'ieee80211',
+        72 => 'ibm370parChan',
+        73 => 'escon',
+        74 => 'dlsw',
+        75 => 'isdns',
+        76 => 'isdnu',
+        77 => 'lapd',
+        78 => 'ipSwitch',
+        79 => 'rsrb',
+        80 => 'atmLogical',
+        81 => 'ds0',
+        82 => 'ds0Bundle',
+        83 => 'bsc',
+        84 => 'async',
+        85 => 'cnr',
+        86 => 'iso88025Dtr',
+        87 => 'eplrs',
+        88 => 'arap',
+        89 => 'propCnls',
+        90 => 'hostPad',
+        91 => 'termPad',
+        92 => 'frameRelayMPI',
+        93 => 'x213',
+        94 => 'adsl',
+        95 => 'radsl',
+        96 => 'sdsl',
+        97 => 'vdsl',
+        98 => 'iso88025CRFPInt',
+        99 => 'myrinet',
+        100 => 'voiceEM',
+        101 => 'voiceFXO',
+        102 => 'voiceFXS',
+        103 => 'voiceEncap',
+        104 => 'voiceOverIp',
+        105 => 'atmDxi',
+        106 => 'atmFuni',
+        107 => 'atmIma',
+        108 => 'pppMultilinkBundle',
+        109 => 'ipOverCdlc',
+        110 => 'ipOverClaw',
+        111 => 'stackToStack',
+        112 => 'virtualIpAddress',
+        113 => 'mpc',
+        114 => 'ipOverAtm',
+        115 => 'iso88025Fiber',
+        116 => 'tdlc',
+        117 => 'gigabitEthernet',
+        118 => 'hdlc',
+        119 => 'lapf',
+        120 => 'v37',
+        121 => 'x25mlp',
+        122 => 'x25huntGroup',
+        123 => 'transpHdlc',
+        124 => 'interleave',
+        125 => 'fast',
+        126 => 'ip',
+        127 => 'docsCableMaclayer',
+        128 => 'docsCableDownstream',
+        129 => 'docsCableUpstream',
+        130 => 'a12MppSwitch',
+        131 => 'tunnel',
+        132 => 'coffee',
+        133 => 'ces',
+        134 => 'atmSubInterface',
+        135 => 'l2vlan',
+        136 => 'l3ipvlan',
+        137 => 'l3ipxvlan',
+        138 => 'digitalPowerline',
+        139 => 'mediaMailOverIp',
+        140 => 'dtm',
+        141 => 'dcn',
+        142 => 'ipForward',
+        143 => 'msdsl',
+        144 => 'ieee1394',
+        145 => 'if-gsn',
+        146 => 'dvbRccMacLayer',
+        147 => 'dvbRccDownstream',
+        148 => 'dvbRccUpstream',
+        149 => 'atmVirtual',
+        150 => 'mplsTunnel',
+        151 => 'srp',
+        152 => 'voiceOverAtm',
+        153 => 'voiceOverFrameRelay',
+        154 => 'idsl',
+        155 => 'compositeLink',
+        156 => 'ss7SigLink',
+        157 => 'propWirelessP2P',
+        158 => 'frForward',
+        159 => 'rfc1483',
+        160 => 'usb',
+        161 => 'ieee8023adLag',
+        162 => 'bgppolicyaccounting',
+        163 => 'frf16MfrBundle',
+        164 => 'h323Gatekeeper',
+        165 => 'h323Proxy',
+        166 => 'mpls',
+        167 => 'mfSigLink',
+        168 => 'hdsl2',
+        169 => 'shdsl',
+        170 => 'ds1FDL',
+        171 => 'pos',
+        172 => 'dvbAsiIn',
+        173 => 'dvbAsiOut',
+        174 => 'plc',
+        175 => 'nfas',
+        176 => 'tr008',
+        177 => 'gr303RDT',
+        178 => 'gr303IDT',
+        179 => 'isup',
+        180 => 'propDocsWirelessMaclayer',
+        181 => 'propDocsWirelessDownstream',
+        182 => 'propDocsWirelessUpstream',
+        183 => 'hiperlan2',
+        184 => 'propBWAp2Mp',
+        185 => 'sonetOverheadChannel',
+        186 => 'digitalWrapperOverheadChannel',
+        187 => 'aal2',
+        188 => 'radioMAC',
+        189 => 'atmRadio',
+        190 => 'imt',
+        191 => 'mvl',
+        192 => 'reachDSL',
+        193 => 'frDlciEndPt',
+        194 => 'atmVciEndPt',
+        195 => 'opticalChannel',
+        196 => 'opticalTransport',
+        197 => 'propAtm',
+        198 => 'voiceOverCable',
+        199 => 'infiniband',
+        200 => 'teLink',
+        201 => 'q2931',
+        202 => 'virtualTg',
+        203 => 'sipTg',
+        204 => 'sipSig',
+        205 => 'docsCableUpstreamChannel',
+        206 => 'econet',
+        207 => 'pon155',
+        208 => 'pon622',
+        209 => 'bridge',
+        210 => 'linegroup',
+        211 => 'voiceEMFGD',
+        212 => 'voiceFGDEANA',
+        213 => 'voiceDID',
+        214 => 'mpegTransport',
+        215 => 'sixToFour',
+        216 => 'gtp',
+        217 => 'pdnEtherLoop1',
+        218 => 'pdnEtherLoop2',
+        219 => 'opticalChannelGroup',
+        220 => 'homepna',
+        221 => 'gfp',
+        222 => 'ciscoISLvlan',
+        223 => 'actelisMetaLOOP',
+        224 => 'fcipLink',
+        225 => 'rpr',
+        226 => 'qam',
+        227 => 'lmp',
+        228 => 'cblVectaStar',
+        229 => 'docsCableMCmtsDownstream',
+        230 => 'adsl2',
+        231 => 'macSecControlledIF',
+        232 => 'macSecUncontrolledIF',
+        233 => 'aviciOpticalEther',
+        234 => 'atmbond',
+        235 => 'voiceFGDOS',
+        236 => 'mocaVersion1',
+        237 => 'ieee80216WMAN',
+        238 => 'adsl2plus',
+        239 => 'dvbRcsMacLayer',
+        240 => 'dvbTdm',
+        241 => 'dvbRcsTdma',
+        242 => 'x86Laps',
+        243 => 'wwanPP',
+        244 => 'wwanPP2',
+        245 => 'voiceEBS',
+        246 => 'ifPwType',
+        247 => 'ilan',
+        248 => 'pip',
+        249 => 'aluELP',
+        250 => 'gpon',
+        251 => 'vdsl2',
+        252 => 'capwapDot11Profile',
+        253 => 'capwapDot11Bss',
+        254 => 'capwapWtpVirtualRadio',
+        255 => 'bits',
+        256 => 'docsCableUpstreamRfPort',
+        257 => 'cableDownstreamRfPort',
+        258 => 'vmwareVirtualNic',
+        259 => 'ieee802154',
+        260 => 'otnOdu',
+        261 => 'otnOtu',
+        262 => 'ifVfiType',
+        263 => 'g9981',
+        264 => 'g9982',
+        265 => 'g9983',
+        266 => 'aluEpon',
+        267 => 'aluEponOnu',
+        268 => 'aluEponPhysicalUni',
+        269 => 'aluEponLogicalLink',
+        270 => 'aluGponOnu',
+        271 => 'aluGponPhysicalUni',
+        272 => 'vmwareNicTeam',
+      }
+      data.map do |item|
+        item[2] = "#{item[2]} (#{types[item[2]]})"
+        item[6] = "#{item[6]} (#{admin_states[item[6]-1]})"
+        item[7] = "#{item[7]} (#{oper_states[item[7]-1]})" 
+        item[8] = item[8].to_s # Timeticks for last change
+        item
+      end
+    end
+  end # IfTable Converter
+
+end # module SNMPTableViewer

data/lib/snmp_table_viewer/converter.rb

@@ -0,0 +1,8 @@
+module SNMPTableViewer
+
+  # Parent class for converters. Which take data and perform sometranslations/conversions to it..
+  # @abstract
+  class Converter
+  end # Converter base class
+
+end # module SNMPTableViewer

data/lib/snmp_table_viewer/fetcher.rb

@@ -0,0 +1,24 @@
+module SNMPTableViewer
+
+  # Class to fetch the information from an SNMP host.
+  class Fetcher
+
+    # Fetch the data using SNMP.
+    # @param base_oid [String] The OID to start the SNMP walk from
+    # @param **snmp_options [Hash] The options to pass to NETSNMP::Client.new
+    # @return [Array<Array<#to_s>>] A two dimensional array containing objects in each cell (at 'address' data[row][col])
+    def self.from_snmp(base_oid:, **snmp_options)
+      data = Array.new
+      NETSNMP::Client.new(snmp_options) do |manager|
+        manager.walk(oid: base_oid).each do |oid, value|
+          col, row = oid.split('.')[-2..-1].map{ |i| i.to_i - 1}
+          data[row] ||= []
+          data[row][col] = value
+        end
+      end
+      data
+    end
+
+  end # class Fetcher
+
+end # module SNMPTableViewer

data/lib/snmp_table_viewer/formatter/csv.rb

@@ -0,0 +1,12 @@
+module SNMPTableViewer
+
+  # Formatting class for CSV output.
+  class Formatter::CSV < Formatter
+    # Output the data (and headings if provided).
+    # @return [String] the CSV data
+    def output()
+      data_with_headings.map(&:to_csv).join
+    end
+  end # CSV Formatter
+
+end # module SNMPTableViewer

data/lib/snmp_table_viewer/formatter/json.rb

@@ -0,0 +1,17 @@
+module SNMPTableViewer
+
+  # Formatting class for JSON output
+  class Formatter::JSON < Formatter
+    # Output the data. If no headings are provided you'll get an Array or Arrays. If headings are provided you'll get an Array of Hashes.
+    # @return [String] the JSON data
+    def output()
+      data = @data
+      if @headings.size > 0
+        # Convert inner arrays to hashes
+        data = data.map{ |row| Hash[row.map.with_index{ |value, index| [@headings[index] || '', value] }] }
+      end
+      ::JSON.generate(data)
+    end
+  end # JSON Formatter
+
+end # module SNMPTableViewer

data/lib/snmp_table_viewer/formatter/raw.rb

@@ -0,0 +1,12 @@
+module SNMPTableViewer
+
+  # Formatting class for raw output.
+  class Formatter::Raw < Formatter
+    # Output the data (and headings if provided).
+    # @return [String] the raw data
+    def output()
+      data_with_headings.inspect
+    end
+  end # Raw Fromatter
+
+end # module SNMPTableViewer

data/lib/snmp_table_viewer/formatter/table.rb

@@ -0,0 +1,30 @@
+module SNMPTableViewer
+
+  # Formatting class for Table output.
+  class Formatter::Table < Formatter
+    # Output the data (and headings if provided) as a table which can be displayed in the terminal.
+    # @param transpose [Boolean] Whether to swap rows and columns - useful for displaying a wide and short table
+    # @return [String] the text to display in order to draw the table
+    def output(transpose: false)
+      use_headings = @headings.size > 0
+      data = @data
+
+      if transpose
+        # transpose the data
+        if use_headings
+          data = [@headings, *data].transpose
+          use_headings = false # Don't add headings twice
+        else
+          data = data.transpose
+        end
+      end
+
+      if use_headings
+        Terminal::Table.new(rows: data, headings: @headings).to_s
+      else
+        Terminal::Table.new(rows: data).to_s
+      end
+    end
+  end # Table Formatter
+
+end # module SNMPTableViewer

data/lib/snmp_table_viewer/formatter.rb

@@ -0,0 +1,30 @@
+module SNMPTableViewer
+
+  # Parent class for formatters. Which take data and headings and output it in a given format.
+  # @abstract
+  class Formatter
+
+    # Create a new instance of Formatter.
+    # @param data [Array<Array<#to_s>>] A two dimensional array containing objects in each cell (at 'address' data[row][col])
+    # @param headings [Array<String, #to_s>] An array of headings for each column
+    # @return [Formatter]
+    def initialize(data:, headings: [])
+        @headings = headings
+        @data = data
+    end
+
+    private
+    # Get a two dimensioan array of headings prepended to the data or just the data (if no headings were provided).
+    # @return Array<Array<#to_s>>
+    def data_with_headings
+      has_headings? ? [@headings, *@data] : @data
+    end
+    # Determine if headings were passed.
+    # @return [Boolean]
+    def has_headings?
+      @headings.is_a?(Array) && @headings.size > 0
+    end
+
+  end # Formatter base class
+
+end # module SNMPTableViewer

data/lib/snmp_table_viewer.rb

@@ -0,0 +1,14 @@
+# Require gems
+require 'netsnmp'
+require 'terminal-table'
+
+# Require from standard ruby libraries
+require 'csv'
+require 'json'
+
+# Load the other files in the lib directory
+require_relative '../version'
+Dir["#{File.dirname(__FILE__)}/**/*.rb"].select{ |f| f != __FILE__}.sort.each { |f| load(f) }
+
+module SNMPTableViewer
+end # module SNMPTableViewer

data/snmp_table_viewer.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require File.join(File.dirname(__FILE__), 'version')
+
+Gem::Specification.new do |s|
+  s.name        = "snmp_table_viewer"
+  s.license     = 'BSD 3 clause'
+  s.version     = SNMPTableViewer::VERSION
+  s.authors     = ['Robert Gauld']
+  s.email       = ['robert@robertgauld.co.uk']
+  s.homepage    = 'https://github.com/robertgauld/snmp-table-viewer'
+  s.summary     = %q{Easily view SNMP tables.}
+  s.description = %q{Easily view SNMP tables in a variety of different formats including as a table in the terminal, json or csv.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'netsnmp', '~> 0.1.3'
+  s.add_runtime_dependency 'terminal-table', '~> 1.8.0'
+
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '>= 2.14.1', '< 4'
+  s.add_development_dependency 'guard-rspec', '~> 4.2', '>= 4.2.5'
+  s.add_development_dependency 'rb-inotify', '~> 0.9'
+  s.add_development_dependency 'coveralls', '~> 0.7'
+  s.add_development_dependency 'simplecov', '~> 0.7'
+
+end

data/spec/snmp_table_viewer/converter/if_table_spec.rb

@@ -0,0 +1,36 @@
+describe SNMPTableViewer::Converter::IfTable do
+
+  describe '#convert' do
+
+    before :each do
+      @input = [[1, "lo", 24, 65536, nil, "", 1, 2, NETSNMP::Timetick.new(100), 18985, 220, 0, 0, 0, 0, 18985, 220, 0, 0, 0, nil, "0.0"]]
+    end
+
+    it 'Converts type' do
+      output = described_class.convert(@input)[0]
+      expect(output[2]).to eq '24 (softwareLoopback)'
+    end
+
+    it 'Converts admin state' do
+      output = described_class.convert(@input)[0]
+      expect(output[6]).to eq '1 (up)'
+    end
+
+    it 'Converts oper state' do
+      output = described_class.convert(@input)[0]
+      expect(output[7]).to eq '2 (down)'
+    end
+
+    it 'Converts last change' do
+      output = described_class.convert(@input)[0]
+      expect(output[8]).to eq 'Timeticks: (100) 0 days, 0:0:1.0'
+    end
+
+  end # describe #convert
+
+end
+
+
+
+
+# [1, "lo", 24, 65536, nil, "", 1, 1, NETSNMP::Timetick.new(100), 18985, 220, 0, 0, 0, 0, 18985, 220, 0, 0, 0, nil, "0.0"]

data/spec/snmp_table_viewer/converter_spec.rb

@@ -0,0 +1,2 @@
+describe SNMPTableViewer::Converter do
+end

data/spec/snmp_table_viewer/fetcher_spec.rb

@@ -0,0 +1,23 @@
+describe SNMPTableViewer::Fetcher do
+
+  it 'Fetches' do
+    snmp_options = {opt_a: :a}
+    manager = double("manager")
+    expect(manager).to receive(:walk).with(oid: '1.2.3.4.5').once.and_return([
+      ['1.2.3.4.5.0.1.1', 1],
+      ['1.2.3.4.5.0.1.2', 2],
+      ['1.2.3.4.5.0.2.1', 'a'],
+      ['1.2.3.4.5.0.2.2', 'b'],
+      ['1.2.3.4.5.0.3.1', 'A'],
+      ['1.2.3.4.5.0.3.2', 'B'],
+    ]) # Array returned by manager doing the SNMP walk
+    expect(NETSNMP::Client).to receive(:new).with(snmp_options).once do |&block|
+      block.call(manager)
+    end # expect block
+    expect(described_class.from_snmp(base_oid: '1.2.3.4.5', **snmp_options)).to eq [
+      [1, 'a', 'A'],
+      [2, 'b', 'B']
+    ]
+  end
+
+end

data/spec/snmp_table_viewer/formatter/csv_spec.rb

@@ -0,0 +1,26 @@
+describe SNMPTableViewer::Formatter::CSV do
+
+  describe '#output' do
+
+    it 'With headings' do
+      headings = ['heading1', 'heading2', 'heading3']
+      data = [
+        ['row1col1', 'row1col2', 'a,b'],
+        ['row2col1', 'row2col2', 'b,c']
+      ]
+      formatter = described_class.new(data: data, headings: headings)
+      expect(formatter.output).to eq "heading1,heading2,heading3\nrow1col1,row1col2,\"a,b\"\nrow2col1,row2col2,\"b,c\"\n"
+    end
+
+    it 'Without headings' do
+      data = [
+        ['row1col1', 'row1col2', 'a,b'],
+        ['row2col1', 'row2col2', 'b,c']
+      ]
+      formatter = described_class.new(data: data)
+      expect(formatter.output).to eq "row1col1,row1col2,\"a,b\"\nrow2col1,row2col2,\"b,c\"\n"
+    end
+    
+  end # describe #output
+
+end

data/spec/snmp_table_viewer/formatter/json_spec.rb

@@ -0,0 +1,26 @@
+describe SNMPTableViewer::Formatter::JSON do
+
+  describe '#output' do
+
+    it 'With headings' do
+      headings = ['heading1', 'heading2', 'heading3']
+      data = [
+        ['row1col1', 'row1col2', 'a,b'],
+        ['row2col1', 'row2col2', 'b,c']
+      ]
+      formatter = described_class.new(data: data, headings: headings)
+      expect(formatter.output).to eq '[{"heading1":"row1col1","heading2":"row1col2","heading3":"a,b"},{"heading1":"row2col1","heading2":"row2col2","heading3":"b,c"}]'
+    end
+
+    it 'Without headings' do
+      data = [
+        ['row1col1', 'row1col2', 'a,b'],
+        ['row2col1', 'row2col2', 'b,c']
+      ]
+      formatter = described_class.new(data: data)
+      expect(formatter.output).to eq '[["row1col1","row1col2","a,b"],["row2col1","row2col2","b,c"]]'
+    end
+
+  end # describe #output
+
+end

data/spec/snmp_table_viewer/formatter/raw_spec.rb

@@ -0,0 +1,26 @@
+describe SNMPTableViewer::Formatter::Raw do
+
+  describe '#output' do
+
+    it 'With headings' do
+      headings = ['heading1', 'heading2', 'heading3']
+      data = [
+        ['row1col1', 'row1col2', 'a,b'],
+        ['row2col1', 'row2col2', 'b,c']
+      ]
+      formatter = described_class.new(data: data, headings: headings)
+      expect(formatter.output).to eq '[["heading1", "heading2", "heading3"], ["row1col1", "row1col2", "a,b"], ["row2col1", "row2col2", "b,c"]]'
+    end
+
+    it 'Without headings' do
+      data = [
+        ['row1col1', 'row1col2', 'a,b'],
+        ['row2col1', 'row2col2', 'b,c']
+      ]
+      formatter = described_class.new(data: data)
+      expect(formatter.output).to eq '[["row1col1", "row1col2", "a,b"], ["row2col1", "row2col2", "b,c"]]'
+    end
+
+  end # describe #output
+
+end