snmp 0.4.1 → 0.5.0

data/data/ruby/snmp/mibs/WWW-MIB.yaml

@@ -88,4 +88,4 @@ wwwRequestInRequests: 1.3.6.1.2.1.65.1.2.2.1.2
 wwwResponseOutLastTime: 1.3.6.1.2.1.65.1.2.5.1.4
 wwwDocumentStatistics: 1.3.6.1.2.1.65.1.3
 wwwDocCtrlTable: 1.3.6.1.2.1.65.1.3.1
-wwwDocBucketIndex: 1.3.6.1.2.1.65.1.3.3.1.1
+wwwDocBucketIndex: 1.3.6.1.2.1.65.1.3.3.1.1

data/examples/dump.rb

@@ -9,7 +9,7 @@ next_oid = start_oid
 while next_oid.subtree_of?(start_oid)
     response = manager.get_next(next_oid)
     varbind = response.varbind_list.first
-    break if varbind.value == EndOfMibView
+    break if EndOfMibView == varbind.value
     next_oid = varbind.name
     puts "#{varbind.name.to_s}  #{varbind.value.to_s}  #{varbind.value.asn1_type}"
 end

data/lib/snmp/manager.rb

@@ -202,6 +202,28 @@ class Manager
         try_request(request)
     end
 
+    ##
+    # Sends a get request for the supplied list of ObjectId or VarBind
+    # objects.
+    #
+    # Returns a list of the varbind values only, not the entire response,
+    # in the same order as the initial object_list.  This method is
+    # useful for retrieving scalar values.
+    #
+    # For example:
+    #
+    #   SNMP::Manager.open(:Host => "localhost") do |manager|
+    #     puts manager.get_value("sysDescr.0")
+    #   end
+    #
+    def get_value(object_list)
+        if object_list.respond_to? :to_ary
+            get(object_list).vb_list.collect { |vb| vb.value }
+        else
+            get(object_list).vb_list.first.value
+        end
+    end
+    
     ##
     # Sends a get-next request for the supplied list of ObjectId or VarBind
     # objects.
@@ -273,17 +295,19 @@ class Manager
         loop do
             varbind_list = get_next(varbind_list).varbind_list
             first_vb = varbind_list.first
+            break if EndOfMibView == first_vb.value 
             stop_oid = first_vb.name
             if stop_oid <= last_oid
                 warn "OIDs are not increasing, #{last_oid} followed by #{stop_oid}"
                 break
             end
             break unless stop_oid.subtree_of?(start_oid)
-            break if stop_oid == EndOfMibView
             last_oid = stop_oid
-            if varbind_list.length == 1
+            if object_list.respond_to?(:to_str) ||
+               object_list.respond_to?(:to_varbind)
+            then
                 yield first_vb
-            else 
+            else
                 yield varbind_list
             end
         end
@@ -318,6 +342,8 @@ class Manager
                 end
             rescue Timeout::Error
                 # no action - try again
+            rescue => e
+                warn e.to_s
             end
         end
         raise RequestTimeout, "host #{@config[:Host]} not responding", caller
@@ -333,7 +359,7 @@ class Manager
         message = Message.decode(data)
         response = message.pdu
         if (request.request_id != response.request_id)
-            raise "Request ID mismatch: expected #{request.request_id}, got #{pdu.request_id}", caller
+            raise RuntimeError, "Request ID mismatch: expected #{request.request_id}, got #{response.request_id}", caller
         end
         response
     end
@@ -418,7 +444,8 @@ class TrapListener
     
     ##
     # Define a trap handler block for a specific trap ObjectId.  This handler
-    # only applies to SNMPv2 traps.
+    # only applies to SNMPv2 traps.  Note that symbolic OIDs are not
+    # supported by this method (like in the SNMP.Manager class).
     #
     def on_trap(object_id, &block)
         raise ArgumentError, "a block must be provided" unless block

data/lib/snmp/mib.rb

@@ -77,8 +77,12 @@ class MIB
                 if mib["nodes"]
                     oid_hash = {}
                     mib["nodes"].each { |key, value| oid_hash[key] = value["oid"] }
+                    if mib["notifications"]
+                        mib["notifications"].each { |key, value| oid_hash[key] = value["oid"] }
+                    end
                     File.open(module_file_name(module_name, mib_dir), 'w') do |file|
                         YAML.dump(oid_hash, file)
+                        file.puts
                     end
                     module_name
                 else

data/lib/snmp/pdu.rb

@@ -111,6 +111,8 @@ class PDU
     attr_accessor :error_index
     attr_accessor :varbind_list
     
+    alias vb_list varbind_list
+    
     def self.decode(pdu_class, pdu_data)
         request_id, remainder = decode_integer(pdu_data)
         error_status, remainder = decode_integer(remainder)
@@ -218,7 +220,7 @@ class Response < PDU
     class << self
         def from_pdu(request)
             Response.new(request.request_id, request.varbind_list,
-                request.error_status, request.error_index)
+                :noError, 0)
         end
     end
     

data/test/test_ber.rb

@@ -1,4 +1,5 @@
 require 'test/unit'
+require 'snmp/varbind'
 require 'snmp/ber'
 
 class ASN1_Test < Test::Unit::TestCase
@@ -231,6 +232,9 @@ class ASN1_Test < Test::Unit::TestCase
         assert_equal("\006\003" << 82.chr << "\202\001", encode_object_id([2,2,257]))
         assert_raise(InvalidObjectId) { encode_object_id([3,2,257]) }
         assert_raise(InvalidObjectId) { encode_object_id([]) }
+        
+        assert_equal("\006\a+\203\377\177\203\377\177",
+            encode_object_id(SNMP::ObjectId.new("1.3.65535.65535")))
     end
 end
 

data/test/test_manager.rb

@@ -13,7 +13,7 @@ class EchoTransport
     end
     
     def recv(max_bytes)
-        Message.decode(@data).response.encode[0,max_bytes]
+        SNMP::Message.decode(@data).response.encode[0,max_bytes]
     end
 end
 
@@ -58,6 +58,19 @@ class TestManager < Test::Unit::TestCase
         assert_equal(ObjectId.new("1.2.3.4.5"), response.varbind_list[1].name)
     end
 
+    def test_get_value
+        value = @manager.get_value("1.2.3.4")
+        assert_equal(Null, value)
+
+        value = @manager.get_value(["1.2.3.4"])
+        assert_equal([Null], value)
+
+        values = @manager.get_value(["1.2.3.4", "1.2.3.4.5"])
+        assert_equal(2, values.length)
+        assert_equal(Null, values[0])
+        assert_equal(Null, values[1])
+    end
+    
     def test_get_next
         response = @manager.get_next("1.2.3.4")
         assert_equal("1.2.3.4", response.varbind_list.first.name.to_s)
@@ -82,8 +95,8 @@ class TestManager < Test::Unit::TestCase
 
     def test_get_bulk
         response = @manager.get_bulk(1, 3, ["1.3.6.1.3.1.1.1.0", "1.3.6.1.3.1.1.2.0"])
-        assert_equal(:tooBig, response.error_status)
-        assert_equal(3, response.error_index)
+        assert_equal(:noError, response.error_status)
+        assert_equal(0, response.error_index)
         assert_equal(2, response.varbind_list.length)
         assert_equal("1.3.6.1.3.1.1.1.0", response.varbind_list[0].name.to_s)
         assert_equal("1.3.6.1.3.1.1.2.0", response.varbind_list[1].name.to_s)

data/test/test_mib.rb

@@ -41,6 +41,10 @@ class TestMib < Test::Unit::TestCase
         assert_equal(1, vb_list.length)
         assert_equal("1.2.3.4", vb_list.first.name.to_s)
 
+        vb_list = @mib.varbind_list(["1.2.3.4"])
+        assert_equal(1, vb_list.length)
+        assert_equal("1.2.3.4", vb_list.first.name.to_s)
+
         vb_list = @mib.varbind_list(["IF-MIB::ifTable.1.23", "1.2.3.4"])
         assert_equal(2, vb_list.length)
         assert_equal("1.3.6.1.2.1.2.2.1.23", vb_list.first.name.to_s)
@@ -61,6 +65,11 @@ class TestMib < Test::Unit::TestCase
         assert_equal(4, list.length)
     end
     
+    # def test_import
+    #     module_name = MIB.import_module('SNMPv2-MIB')
+    #     assert_equal('SNMPv2-MIB', module_name)
+    # end
+    
 end
 
 end

data/test/test_pdu.rb

@@ -10,7 +10,7 @@ class TestProtocol < Test::Unit::TestCase
         assert_equal(:SNMPv1, message.version)
         assert_equal("public", message.community)
         assert_equal(SNMP::GetRequest, message.pdu.class)
-        varbind_list = message.pdu.varbind_list;
+        varbind_list = message.pdu.vb_list;
         assert_equal(1, varbind_list.length)
         assert_equal([1,3,6,1,2,1,1,1,0], varbind_list.first.name)
         assert_equal(SNMP::Null, varbind_list.first.value)
@@ -20,7 +20,7 @@ class TestProtocol < Test::Unit::TestCase
         message = SNMP::Message.decode("0)\002\001\001\004\006public\240\034\002\0040\265\020\202\002\001\000\002\001\0000\0160\f\006\010+\006\001\002\001\001\001\000\005\000")
         assert_equal(:SNMPv2c, message.version)
         assert_equal("public", message.community)
-        varbind_list = message.pdu.varbind_list;
+        varbind_list = message.pdu.vb_list;
         assert_equal(1, varbind_list.length)
         assert_equal([1,3,6,1,2,1,1,1,0], varbind_list.first.name)
         assert_equal(SNMP::Null, varbind_list.first.value)

data/test/test_smi.rb

@@ -0,0 +1,19 @@
+require 'test/unit'
+
+begin
+    require 'smi'
+
+    class TestSmi < Test::Unit::TestCase
+    
+        include SNMP::SMI
+
+        def test_load
+            name, oid_hash = load_smi_module('test/mibs/IF-MIB')
+            assert_equal("IF-MIB", name)
+            assert_equal("1.3.6.1.2.1.2.2", oid_hash["ifTable"])
+        end
+
+    end
+rescue LoadError
+    # snmp/smi may not always be available because it is a C extention
+end

data/test/test_walk.rb

@@ -40,11 +40,31 @@ class TestWalk < Test::Unit::TestCase
         $transport_pdu_count = 3
         list = []
         manager.walk("ifTable") do |vb|
+            assert(vb.kind_of?(VarBind), "Expected a VarBind")
+            list << vb
+        end
+        assert_equal(3, list.length)    
+
+        $transport_pdu_count = 3
+        list = []
+        manager.walk(ObjectId.new("1.3.4.5")) do |vb|
+            assert(vb.kind_of?(VarBind), "Expected a VarBind")
             list << vb
         end
         assert_equal(3, list.length)    
     end
     
+    def test_single_object_list
+        $transport_pdu_count = 1
+        executed_block = false
+        manager.walk(["1.3.6.1"]) do |vb_list|
+            executed_block = true
+            assert_equal(1, vb_list.length)
+            assert_equal("1.3.6.1.1", vb_list.first.name.to_s)
+        end
+        assert(executed_block, "Did not execute block")
+    end
+        
     def test_object_list
         $transport_pdu_count = 3
         list1 = []
@@ -60,7 +80,7 @@ class TestWalk < Test::Unit::TestCase
     def test_empty
         $transport_pdu_count = 0
         manager.walk("1.2.3.4") do |vb|
-            fail { "Expected block to not be executed"}
+            fail("Expected block to not be executed")
         end
     end
     

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.3
+rubygems_version: 0.8.10
 specification_version: 1
 name: snmp
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
-date: 2004-12-20
+  version: 0.5.0
+date: 2005-06-15
 summary: A Ruby implementation of SNMP (the Simple Network Management Protocol).
 require_paths: 
   - lib
@@ -41,6 +41,7 @@ files:
   - test/test_manager.rb
   - test/test_mib.rb
   - test/test_pdu.rb
+  - test/test_smi.rb
   - test/test_varbind.rb
   - test/test_walk.rb
   - examples/dump.rb
@@ -242,11 +243,14 @@ files:
   - data/ruby/snmp/mibs/VRRP-MIB.yaml
   - data/ruby/snmp/mibs/WWW-MIB.yaml
 test_files: []
-rdoc_options: []
+rdoc_options: 
+  - "--main"
+  - README
+  - "--title"
+  - SNMP Library for Ruby
 extra_rdoc_files: 
   - README
 executables: []
 extensions: []
-requirements: 
-  - none
+requirements: []
 dependencies: []