snmp 0.5.1 → 0.6.0

data/test/test_manager.rb

@@ -2,13 +2,13 @@ require 'test/unit'
 require 'snmp/manager'
 
 class EchoTransport
-    def initialize(host, port)
+    def initialize
     end
     
     def close
     end
     
-    def send(data)
+    def send(data, host, port)
         @data = data
     end
     
@@ -111,9 +111,8 @@ class TestManager < Test::Unit::TestCase
     end
     
     def test_request_id
-        srand(100)
         id = RequestId.new
-        assert_equal(186422792, id.next)
+        fail if id.next < 0 or id.next >= 2**31
         
         id.force_next(1)
         assert_equal(1, id.next)
@@ -124,6 +123,52 @@ class TestManager < Test::Unit::TestCase
         assert_raise(RuntimeError) { id.force_next(RequestId::MAX_REQUEST_ID) }
         assert_raise(RuntimeError) { id.force_next(0) }
     end
+    
+    def test_trap_v1
+        manager = Manager.new(:Transport => EchoTransport, :Version => :SNMPv1)
+        sent_data = manager.trap_v1(
+            "enterprises.9",
+            "10.1.2.3",
+            :enterpriseSpecific,
+            42,
+            12345,
+            [VarBind.new("1.3.6.1.2.3.4", Integer.new(1))]
+        )
+        pdu = Message.decode(sent_data).pdu
+        assert_equal(ObjectId.new("1.3.6.1.4.1.9"), pdu.enterprise)
+        assert_equal(IpAddress.new("10.1.2.3"), pdu.agent_addr)
+        assert_equal(:enterpriseSpecific, pdu.generic_trap)
+        assert_equal(42, pdu.specific_trap)
+        assert_equal(TimeTicks.new(12345), pdu.timestamp)
+        assert_equal(1, pdu.vb_list.length)
+    end
+    
+    def test_trap_v2
+        sent_data = @manager.trap_v2(1234, "1.3.6.1.2.3.4")
+        pdu = Message.decode(sent_data).pdu
+        assert_equal(1234, pdu.sys_up_time)
+        assert_equal("1.3.6.1.2.3.4", pdu.trap_oid.to_s) 
+        assert_equal(2, pdu.vb_list.length)
+
+        sent_data = @manager.trap_v2(1234, "1.3.6.1.2.3.4", ["1.2.3", "1.4.5.6"])
+        pdu = Message.decode(sent_data).pdu
+        assert_equal(1234, pdu.sys_up_time)
+        assert_equal("1.3.6.1.2.3.4", pdu.trap_oid.to_s) 
+        assert_equal(4, pdu.vb_list.length) 
+        assert_equal("1.4.5.6", pdu.vb_list.last.name.to_s)
+    end
+    
+    def test_inform
+        response = @manager.inform(1234, "1.3.6.1.2.3.4")
+        assert_equal(1234, response.vb_list[0].value)
+        assert_equal("1.3.6.1.2.3.4", response.vb_list[1].value.to_s) 
+        assert(2, response.vb_list.length) 
+        
+        response = @manager.inform(1234, "1.3.6.1.2.3.4", ["1.2.3", "1.4.5.6"])
+        assert_equal(1234, response.vb_list[0].value)
+        assert_equal("1.3.6.1.2.3.4", response.vb_list[1].value.to_s) 
+        assert(4, response.vb_list.length) 
+    end 
 end
 
 class TrapTestTransport

data/test/test_retry.rb

@@ -0,0 +1,81 @@
+require 'snmp/manager'
+
+class TimeoutManager  < SNMP::Manager
+  attr_accessor :response_count
+  
+  def initialize(config)
+    super(config)
+    @response_count = 0
+    @raise_on_send = false
+    @raise_on_get = false
+  end
+  
+  def raise_send_error
+      @raise_on_send = true
+  end
+
+  def raise_get_error
+      @raise_on_get = true
+  end
+  
+  def send_request(request, community, host, port) 
+      raise RuntimeError if @raise_on_send
+  end
+
+  def get_response(request) 
+      @response_count += 1
+      raise RuntimeError if @raise_on_get
+      raise Timeout::Error, "testing retry count"
+  end
+end
+
+class MismatchIdTransport
+    def initialize
+        @data = []
+    end
+    
+    def close
+    end
+    
+    def send(data, host, port)
+        bad_id_data = data.dup
+        bad_msg = Message.decode(data)
+        bad_msg.pdu.request_id -= 3  # corrupt request_id  
+        @data << bad_msg.encode # insert corrupted PDU before real data
+        @data << data
+    end
+    
+    def recv(max_bytes)
+        raise "receive queue is empty" unless @data.first
+        SNMP::Message.decode(@data.shift).response.encode[0,max_bytes]
+    end
+end
+
+
+class TestRetry < Test::Unit::TestCase 
+    def test_retry_count
+        assert_response_count(0, 1, SNMP::RequestTimeout)
+        assert_response_count(1, 2, SNMP::RequestTimeout)
+        assert_response_count(5, 6, SNMP::RequestTimeout)
+    end
+
+    def test_retry_on_error
+        assert_response_count(5, 0, RuntimeError) { |m| m.raise_send_error }  
+        old_verbose = $VERBOSE
+        $VERBOSE = nil
+        assert_response_count(5, 6, SNMP::RequestTimeout) { |m| m.raise_get_error }
+        $VERBOSE = old_verbose
+    end
+
+    def assert_response_count(retry_count, response_count, exception) 
+        m = TimeoutManager.new( :Retries => retry_count )
+        yield m if block_given?
+        assert_raise(exception) { m.get("1.2.3.4") }
+        assert_equal(response_count, m.response_count)
+    end
+    
+    def test_drop_mismatched_id
+        m = SNMP::Manager.new(:Transport => MismatchIdTransport)
+        m.get("1.2.3.4")
+    end
+end

data/test/test_varbind.rb

@@ -22,6 +22,12 @@ class TestVarBind < Test::Unit::TestCase
         assert_equal("0\f\006\010+\006\001\002\001\001\002\000\005\000", remainder)
     end
 
+    def test_varbind_name_alias_oid
+        vb = VarBind.new("1.2.3.4", OctetString.new("blah"))
+        assert(ObjectId.new("1.2.3.4"), vb.name)
+        assert(ObjectId.new("1.2.3.4"), vb.oid)
+    end
+    
     def test_varbind_list_create
         list = VarBindList.new
         assert_equal(0, list.length)
@@ -99,6 +105,11 @@ class TestVarBind < Test::Unit::TestCase
         assert_equal(s1, s3)
     end
     
+    def test_octet_string_to_oid
+        s = OctetString.new("test")
+        assert_equal(ObjectId.new([116, 101, 115, 116]), s.to_oid)
+    end
+    
     def test_object_id
         id = ObjectId.new([1,3,6,1])
         assert_equal("1.3.6.1", id.to_s)
@@ -154,6 +165,17 @@ class TestVarBind < Test::Unit::TestCase
         assert(id1.subtree_of?("1.3.3.4"))
         assert(!id4.subtree_of?("1.3.3.4"))
     end
+
+    def test_object_id_index
+        id1 = ObjectId.new("1.3.3.4")
+        id2 = ObjectId.new("1.3.3.4.1")
+        id3 = ObjectId.new("1.3.3.4.1.2")
+        assert(ObjectId.new("1"), id2.index(id1))
+        assert(ObjectId.new("1.2"), id3.index(id1))
+        assert(ObjectId.new("1.2"), id3.index("1.3.3.4"))
+        assert_raise(ArgumentError) { id1.index(id3) }
+        assert_raise(ArgumentError) { id1.index(id1) } 
+    end
     
     def test_object_name_from_string
         id = ObjectName.new("1.3.4.5.6")
@@ -196,6 +218,14 @@ class TestVarBind < Test::Unit::TestCase
         assert(i2 > 54000)
     end
     
+    def test_integer_to_oid
+        assert(ObjectId.new("123"), Integer.new(123).to_oid)
+        assert(ObjectId.new("0"), Integer.new(0).to_oid)
+        
+        i = Integer.new(-1)
+        assert_raise(RangeError) { i.to_oid }
+    end
+    
     def test_ip_address_from_string
         ip = IpAddress.new("10.0.255.1")
         assert_equal("10.0.255.1", ip.to_s)
@@ -203,6 +233,12 @@ class TestVarBind < Test::Unit::TestCase
         assert_raise(InvalidIpAddress) { IpAddress.new("1.2.3.-1") }
         assert_raise(InvalidIpAddress) { IpAddress.new("1.2.3") }
     end
+
+    def test_ip_address_from_self
+        ip1 = IpAddress.new("1.2.3.4")
+        ip2 = IpAddress.new(ip1)
+        assert_equal(ip1, ip2)
+    end
     
     def test_ip_address_create
         ip = IpAddress.new("\001\002\003\004")
@@ -230,6 +266,11 @@ class TestVarBind < Test::Unit::TestCase
         assert(!ip1.eql?(12))
     end
         
+    def test_ip_address_to_oid
+        ip = IpAddress.new("1.2.3.4")
+        assert_equal(ObjectId.new("1.2.3.4"), ip.to_oid)
+    end
+    
     def test_counter32_create
         i = Counter32.new(12345)
         assert_equal("12345", i.to_s)

data/test/test_walk.rb

@@ -1,104 +1,191 @@
 require 'snmp'
 require 'test/unit'
+require 'yaml'
 
 include SNMP 
 
-class GetNextTransport
-    
-    attr_accessor :count
-    
-    def initialize(host, port)
+##
+# Accept get and get-next requests, returning the data from the
+# provided YAML data file.  The file contains a list of OID, value, and
+# value type.
+#
+class YamlDataTransport
+    def self.load_data(yaml_file)
+        values = YAML.load(File.new(yaml_file))
+        @@get_map = {}
+        @@get_next_map = {}
+        values.each_index do |i|
+            name, value, klass = values[i]
+            if i < values.length - 1
+                next_name, next_value, next_klass = values[i + 1]
+            else
+                next_value = SNMP::EndOfMibView
+                next_klass = SNMP::EndOfMibView
+            end
+            @@get_map[name] = [name, value, klass]
+            @@get_next_map[name] = [next_name, next_value, next_klass]
+        end
     end
-    
-    def close
+
+    def initialize
+        @responses = []
     end
     
-    def send(data)
-        @data = data
+    def close
     end
     
-    def recv(max_bytes)
-        response = Message.decode(@data).response
-        if $transport_pdu_count > 0
-            response.pdu.each_varbind do |vb|
-                vb.name << 1    
-            end
-            $transport_pdu_count -= 1
+    def send(data, host, port)
+        msg = Message.decode(data) 
+        req_class = msg.pdu.class
+        if req_class == SNMP::GetRequest
+            oid_map = @@get_map
+        elsif req_class == SNMP::GetNextRequest
+            oid_map = @@get_next_map
         else
-            response.pdu.each_varbind do |vb|
-                vb.name = ObjectId.new("1.3.6.9999")    
+            raise "request not supported: " + req_class
+        end
+
+        resp = msg.response
+        resp.pdu.vb_list.each do |vb|
+            name, value, klass = oid_map[vb.name.to_s]
+            vb.name = ObjectId.new(name)
+            if klass == "SNMP::NoSuchObject" or klass == "SNMP::NoSuchInstance"
+                vb.value = eval(klass) 
+            elsif value
+                vb.value = eval("#{klass}.new(value)")
+            else
+                vb.value = SNMP::NoSuchInstance
             end
-        end     
-        response.encode[0,max_bytes]
+        end
+        @responses << resp.encode
+    end
+    
+    def recv(max_bytes) 
+        @responses.shift
     end
 end
 
+class TestTransport < Test::Unit::TestCase
+    
+    def test_get
+        YamlDataTransport.load_data(File.dirname(__FILE__) + "/if_table6.yaml")
+        SNMP::Manager.open(:Transport => YamlDataTransport) do |snmp|
+            value = snmp.get_value("ifDescr.1")
+            assert_equal("lo0", value)
+        end
+    end
+   
+    def test_get_next
+        YamlDataTransport.load_data(File.dirname(__FILE__) + "/if_table6.yaml")
+        SNMP::Manager.open(:Transport => YamlDataTransport) do |snmp|
+            vb = snmp.get_next("ifDescr.1")
+            assert_equal("gif0", vb.vb_list.first.value)
+        end
+    end
+    
+end
 
 class TestWalk < Test::Unit::TestCase
 
+    ##
+    # A single string or single ObjectId can be passed to walk()
+    #
     def test_single_object
-        $transport_pdu_count = 3
         list = []
-        manager.walk("ifTable") do |vb|
+        ifTable6_manager.walk("ifDescr") do |vb|
             assert(vb.kind_of?(VarBind), "Expected a VarBind")
             list << vb
         end
-        assert_equal(3, list.length)    
+        assert_equal(6, list.length)    
 
-        $transport_pdu_count = 3
         list = []
-        manager.walk(ObjectId.new("1.3.4.5")) do |vb|
+        ifTable6_manager.walk(ObjectId.new("1.3.6.1.2.1.2.2.1.2")) do |vb|
             assert(vb.kind_of?(VarBind), "Expected a VarBind")
             list << vb
         end
-        assert_equal(3, list.length)    
+        assert_equal(6, list.length)    
     end
-    
+
+      
+    ##
+    # If a list of one element is passed to walk() then a list of
+    # one element is passed as the block parameter.
+    #
     def test_single_object_list
-        $transport_pdu_count = 1
         executed_block = false
-        manager.walk(["1.3.6.1"]) do |vb_list|
+        ifTable6_manager.walk(["1.3.6.1.2.1.2.2.1.2"]) 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)
+            assert_equal("1.3.6.1.2.1.2.2.1.2.1", vb_list.first.name.to_s)
+            break
         end
         assert(executed_block, "Did not execute block")
     end
-        
+
+    ##
+    # If a list of multiple items are passed to walk() then
+    # multiple items are passed to the block.
+    #
     def test_object_list
-        $transport_pdu_count = 3
         list1 = []
         list2 = []
-        manager.walk(["ifIndex", "ifDescr"]) do |vb1, vb2|
+        ifTable6_manager.walk(["ifIndex", "ifDescr"]) do |vb1, vb2|
             list1 << vb1
             list2 << vb2
         end
-        assert_equal(3, list1.length)    
-        assert_equal(3, list2.length)    
+        assert_equal(6, list1.length)    
+        assert_equal(6, list2.length)    
+
+        list1 = []
+        list2 = []
+        ifTable6_manager.walk(["ifIndex", "ifDescr"], 1) do |vb1, vb2|
+            list1 << vb1
+            list2 << vb2
+        end
+        assert_equal(6, list1.length)    
+        assert_equal(6, list2.length)    
     end
-    
+
     def test_empty
-        $transport_pdu_count = 0
-        manager.walk("1.2.3.4") do |vb|
+        ifTable6_manager.walk("1.3.6.1.2.1.2.2.1.2.1") do |vb|
             fail("Expected block to not be executed")
         end
     end
-    
+
     def test_one
-        $transport_pdu_count = 1
         list = []
-        manager.walk(["1.3.6.1", "1.3.6.2"]) do |vb|
-            assert_equal("1.3.6.1.1", vb[0].name.to_s)
-            assert_equal("1.3.6.2.1", vb[1].name.to_s)
+        ifTable1_manager.walk(["1.3.6.1.2.1.2.2.1.1", "1.3.6.1.2.1.2.2.1.2"]) do |vb|
+            assert_equal("1.3.6.1.2.1.2.2.1.1.1", vb[0].name.to_s)
+            assert_equal("1.3.6.1.2.1.2.2.1.2.1", vb[1].name.to_s)
+            list << vb
+        end
+        assert_equal(1, list.length)    
+    end
+
+    def test_hole_in_one
+        list = []
+        ifTable1_manager.walk(["ifIndex", "ifDescr", "ifType"]) do |vb|
+            assert_equal("1.3.6.1.2.1.2.2.1.1.1", vb[0].name.to_s) 
+            assert_equal(1, vb[0].value)
+            assert_equal("1.3.6.1.2.1.2.2.1.2.1", vb[1].name.to_s)
+            assert_equal("lo0", vb[1].value)
+            assert_equal("1.3.6.1.2.1.2.2.1.3.1", vb[2].name.to_s)
+            assert_equal(NoSuchInstance, vb[2].value)
             list << vb
+            break
         end
         assert_equal(1, list.length)    
     end
     
     private
     
-    def manager
-        Manager.new(:Transport => GetNextTransport)
+    def ifTable1_manager
+        YamlDataTransport.load_data(File.dirname(__FILE__) + "/if_table1.yaml")
+        Manager.new(:Transport => YamlDataTransport)
+    end
+
+    def ifTable6_manager
+        YamlDataTransport.load_data(File.dirname(__FILE__) + "/if_table6.yaml")
+        Manager.new(:Transport => YamlDataTransport)
     end
-    
 end