net-snmp 0.1.7 → 0.2.0

data/lib/net/snmp/trap_session.rb

@@ -0,0 +1,64 @@
+module Net
+  module SNMP
+    class TrapSession < Session
+      # == Represents a session for sending SNMP traps
+      def initialize(options = {})
+        options[:peername] = "#{options[:peername]}:162"
+        super(options)
+      end
+
+      # Send an SNMPv1 trap
+      # +options+
+      # * :enterprise The Oid of the enterprise
+      # * :trap_type  The generic trap type.
+      # * :specific_type The specific trap type
+      def trap(options = {})
+        pdu = PDU.new(Constants::SNMP_MSG_TRAP)
+        options[:enterprise] ||= '1.3.6.1.4.1.3.1.1'  # uh, just send netsnmp enterprise i guess
+        pdu.enterprise = OID.new(options[:enterprise])
+        pdu.trap_type = options[:trap_type] || 1  # need to check all these defaults
+        pdu.specific_type = options[:specific_type] || 0
+        pdu.time = 1    # put what here?
+        send_pdu(pdu)
+        true
+      end
+
+      # Send an SNMPv2 trap
+      # +options
+      # * :oid The Oid of the trap
+      # * :varbinds A list of Varbind objects to send with the trap
+      def trap_v2(options = {})
+        if options[:oid].kind_of?(String)
+          options[:oid] = Net::SNMP::OID.new(options[:oid])
+        end
+        pdu = PDU.new(Constants::SNMP_MSG_TRAP2)
+        build_trap_pdu(pdu, options)
+        send_pdu(pdu)
+      end
+
+      # Send an SNMPv2 inform.  Can accept a callback to execute on confirmation of the inform
+      # +options
+      # * :oid The OID of the inform
+      # * :varbinds A list of Varbind objects to send with the inform
+      def inform(options = {}, &callback)
+        if options[:oid].kind_of?(String)
+          options[:oid] = Net::SNMP::OID.new(options[:oid])
+        end
+        pdu = PDU.new(Constants::SNMP_MSG_INFORM)
+        build_trap_pdu(pdu, options)
+        send_pdu(pdu, &callback)
+      end
+
+      private
+      def build_trap_pdu(pdu, options = {})
+        pdu.add_varbind(:oid => OID.new('sysUpTime.0'), :type => Constants::ASN_TIMETICKS, :value => 42)
+        pdu.add_varbind(:oid => OID.new('snmpTrapOID.0'), :type => Constants::ASN_OBJECT_ID, :value => options[:oid])
+        if options[:varbinds]
+          options[:varbinds].each do |vb|
+            pdu.add_varbind(vb)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/net/snmp/varbind.rb

@@ -1,34 +1,56 @@
 module Net
   module SNMP
     class Varbind
+      # == Represents an SNMP Variable Binding
+
       attr_accessor :struct
       
-      def initialize(ptr)
+      def initialize(ptr = nil)
         @struct = Net::SNMP::Wrapper::VariableList.new(ptr)
       end
       
       def self.from_pointer(ptr)
         new(ptr)
       end
-      
+
+      # Returns the data type of the varbind
       def object_type
         @struct.type
       end
       
+      # Returns the OID associated with the varbind
       def oid
         @oid ||= Net::SNMP::OID.new(@struct.name.read_array_of_long(@struct.name_length).join("."))
       end
-      
-
 
+      # Returns the value of the varbind
       def value
         case object_type
-        when Constants::ASN_OCTET_STR
+        when Constants::ASN_OCTET_STR, Constants::ASN_OPAQUE
           struct.val[:string].read_string(struct.val_len)
-        when Constants::ASN_INTEGER, Constants::ASN_COUNTER, Constants::ASN_GAUGE
+        when Constants::ASN_INTEGER
           struct.val[:integer].read_long
+        when Constants::ASN_UINTEGER, Constants::ASN_TIMETICKS,  Constants::ASN_COUNTER, Constants::ASN_GAUGE
+          struct.val[:integer].read_ulong
         when Constants::ASN_IPADDRESS
           struct.val[:objid].read_string(struct.val_len).unpack('CCCC').join(".")
+        when Constants::ASN_NULL
+          nil
+        when Constants::ASN_OBJECT_ID
+          Net::SNMP::OID.new(struct.val[:objid].read_array_of_long(struct.val_len).join("."))
+        when Constants::ASN_COUNTER64
+          counter = Wrapper::Counter64.new(struct.val[:counter64])
+          counter.high * 2^32 + counter.low
+        when Constants::ASN_BIT_STR
+          # XXX not sure what to do here.  Is this obsolete?
+        when Constants::SNMP_ENDOFMIBVIEW
+          :endofmibview
+        when Constants::SNMP_NOSUCHOBJECT
+          :nosuchobject
+        when Constants::SNMP_NOSUCHINSTANCE
+          :nosuchinstance
+        else
+          raise Net::SNMP::Error.new, "Unknown value type #{object_type}"
         end
       end
     end

data/lib/net/snmp/version.rb

@@ -1,5 +1,5 @@
 module Net
   module SNMP
-    VERSION = "0.1.7"
+    VERSION = "0.2.0"
   end
 end

data/lib/net/snmp/wrapper.rb

@@ -12,7 +12,7 @@ module Wrapper
            :low, :u_long
     )
   end
-  
+
   class TimeVal < NiceFFI::Struct
     layout(:tv_sec, :long, :tv_usec, :long)
   end
@@ -20,7 +20,7 @@ module Wrapper
     puts "tv_sec = #{tv.tv_sec}, tv_usec = #{tv.tv_usec} "
   end
 
-  
+
   class NetsnmpVardata < FFI::Union
     layout(
            :integer, :pointer,
@@ -288,7 +288,7 @@ module Wrapper
   attach_function :snmp_add, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :int ], :int) ], :pointer
   attach_function :snmp_add_full, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :uint ], :int), callback([ :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :uint ], :int), callback([ :pointer, :pointer, :uint ], :pointer) ], :pointer
   attach_function :snmp_sess_send, [ :pointer, :pointer ], :int
-  attach_function :snmp_sess_async_send, [ :pointer, :pointer, :netsnmp_callback, :pointer ], :int
+  attach_function :snmp_sess_async_send, [ :pointer, :pointer, :snmp_callback, :pointer ], :int
   attach_function :snmp_sess_select_info, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :int
   attach_function :snmp_sess_read, [ :pointer, :pointer ], :int
   attach_function :snmp_sess_timeout, [ :pointer ], :void
@@ -344,8 +344,7 @@ module Wrapper
   attach_function :generate_Ku, [:pointer, :int, :string, :int, :pointer, :pointer], :int
 
 
-  # Standard IO functions
-  attach_function :select, [:int, :pointer, :pointer, :pointer, :pointer], :int
+
   # MIB functions
   attach_function :init_mib, [], :void
   attach_function :read_all_mibs, [], :void
@@ -369,9 +368,35 @@ end
 end
 end
 
+
 #module RubyWrapper
-#  extend NiceFFI::Library
-#  #ffi_lib "libruby"
-#  ffi_lib "/Users/rmcclain/.rvm/rubies/ruby-1.9.2-preview3/lib/libruby.dylib"
+#  extend FFI::Library
+#  ffi_lib FFI::CURRENT_PROCESS
 #  attach_function :rb_thread_select, [:int, :pointer, :pointer, :pointer, :pointer], :int
 #end
+
+
+
+module FFI
+  module LibC
+    extend FFI::Library
+    ffi_lib [FFI::CURRENT_PROCESS, 'c']
+
+    typedef :pointer, :FILE
+    typedef :uint32, :in_addr_t
+    typedef :uint16, :in_port_t
+
+    class Timeval < FFI::Struct
+      layout :tv_sec, :time_t,
+             :tv_usec, :suseconds_t
+    end
+
+    # Standard IO functions
+    #@blocking = true  # some undocumented voodoo that tells the next attach_function to release the GIL
+    attach_function :select, [:int, :pointer, :pointer, :pointer, :pointer], :int
+    attach_variable :errno, :int
+    attach_function :malloc, [:size_t], :pointer
+    attach_function :free, [:pointer], :void
+  end
+end
+

data/spec/async_spec.rb

@@ -3,106 +3,154 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe "async" do
   context "version 1" do
     it "get should work" do
+      #pending
       did_callback = false
-      Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
-        s.get(["sysDescr.0", "sysContact.0"]) do |result|
+      puts "started test #{Time.now}"
+      sess = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
+        s.get(["sysDescr.0", "sysContact.0"]) do |op, pdu|
           did_callback = true
-          result.varbinds[0].value.should eql("test.net-snmp.org")
-          result.varbinds[1].value.should match(/Coders/)
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
         end
       end
-      Net::SNMP::Dispatcher.poll(false)
+      Net::SNMP::Dispatcher.select(false)
       did_callback.should be(true)
+      puts "ended test #{Time.now}"
+    end
+
+    it "get should return an error" do
+      Net::SNMP.thread_safe = true
+      puts "started test #{Time.now}"
+
+      did_callback = false
+      sess = Net::SNMP::Session.open(:peername => 'www.yahoo.com', :timeout => 5, :retries => 0) do |sess|
+        sess.get("sysDescr.0") do |op, pdu|
+          puts "IN GET CALLBACK"
+          puts pdu.inspect
+          did_callback = true
+          op.should eql(:timeout)
+        end
+      end
+      puts"selecting #{Time.now}"
+      sleep 2
+      pdu = sess.select(10)
+      puts "and now #{Time.now}"
+      puts "sess err = #{sess.s_snmp_errno}"
+
+      pdu.should eql(0)
+      did_callback.should be(true)
+      puts "ended test #{Time.now}"
+      Net::SNMP.thread_safe = false
     end
 
     it "getnext should work" do
+      puts "started test #{Time.now}"
+
+      #pending
       puts "testing getnext"
       did_callback = false
       Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
-        s.get_next(["sysDescr", "sysContact"]) do |result|
+        s.get_next(["sysDescr", "sysContact"]) do |op, pdu|
           did_callback = true
-          #result.varbinds[0].value.should eql("test.net-snmp.org")
-          #result.varbinds[1].value.should match(/Coders/)
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
         end
       end
-      Net::SNMP::Dispatcher.poll(false)
+      Net::SNMP::Dispatcher.select(false)
       puts "done getnext"
       did_callback.should be(true)
+      puts "ended test #{Time.now}"
+
     end
 
   end
 
   context "version 2" do
     it "get should work" do
+      puts "started test #{Time.now}"
+
+      #pending
       did_callback = false
       Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic', :version => '2c') do |s|
-        s.get(["sysDescr.0", "sysContact.0"]) do |result|
+        s.get(["sysDescr.0", "sysContact.0"]) do |op, pdu|
           did_callback = true
-          result.varbinds[0].value.should eql("test.net-snmp.org")
-          result.varbinds[1].value.should match(/Coders/)
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
         end
       end
-      Net::SNMP::Dispatcher.poll(false)
+      Net::SNMP::Dispatcher.select(false)
       did_callback.should be(true)
+      puts "ended test #{Time.now}"
+
     end
 
     it "getnext should work" do
+      #pending
+      puts "started test #{Time.now}"
+
       did_callback = false
       Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic', :version => '2c') do |s|
-        s.get_next(["sysDescr", "sysContact"]) do |result|
+        s.get_next(["sysDescr", "sysContact"]) do |op, pdu|
           did_callback = true
-          result.varbinds[0].value.should eql("test.net-snmp.org")
-          result.varbinds[1].value.should match(/Coders/)
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
         end
       end
-      Net::SNMP::Dispatcher.poll(false)
+      Net::SNMP::Dispatcher.select(false)
       did_callback.should be(true)
+      puts "ended test #{Time.now}"
+
     end
+
   end
 
   context "version 3" do
     #failing intermittently
     it "should get async using snmpv3" do
+      #pending
       did_callback = false
       Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :version => 3, :username => 'MD5User',:security_level => Net::SNMP::Constants::SNMP_SEC_LEVEL_AUTHNOPRIV, :auth_protocol => :md5, :password => 'The Net-SNMP Demo Password') do |sess|
-          sess.get(["sysDescr.0"]) do |result|
+          sess.get(["sysDescr.0"]) do |op, pdu|
             did_callback = true
-            result.varbinds[0].value.should eql('test.net-snmp.org')
+            pdu.varbinds[0].value.should eql('test.net-snmp.org')
           end
           sleep(0.5)
-          Net::SNMP::Dispatcher.poll(false)
-          #Net::SNMP::Dispatcher.poll(false)
-          puts "done poll"
+          Net::SNMP::Dispatcher.select(false)
+          #Net::SNMP::Dispatcher.select(false)
+          puts "done select"
           did_callback.should be(true)
       end
     end
 #
 #
     it "get should work" do
+      #pending
       did_callback = false
       sess = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :version => 3, :username => 'MD5User',:security_level => Net::SNMP::Constants::SNMP_SEC_LEVEL_AUTHNOPRIV, :auth_protocol => :md5, :password => 'The Net-SNMP Demo Password') do |sess|
-        sess.get(["sysDescr.0", "sysContact.0"]) do |result|
+        sess.get(["sysDescr.0", "sysContact.0"]) do |op,pdu|
           did_callback = true
-          result.varbinds[0].value.should eql("test.net-snmp.org")
-          result.varbinds[1].value.should match(/Coders/)
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
         end
       end
-      Net::SNMP::Dispatcher.poll(false)
+      Net::SNMP::Dispatcher.select(false)
       sess.close
       did_callback.should be(true)
     end
 
+    #  XXX  occasionally segfaulting
     it "getnext should work" do
+      #pending
       did_callback = false
 
       sess = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :version => 3, :username => 'MD5User',:security_level => Net::SNMP::Constants::SNMP_SEC_LEVEL_AUTHNOPRIV, :auth_protocol => :md5, :password => 'The Net-SNMP Demo Password') do |sess|
-        sess.get_next(["sysDescr", "sysContact"]) do |result|
+        sess.get_next(["sysDescr", "sysContact"]) do |op, pdu|
           did_callback = true
-          result.varbinds[0].value.should eql("test.net-snmp.org")
-          result.varbinds[1].value.should match(/Coders/)
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
         end
       end
-      Net::SNMP::Dispatcher.poll(false)
+      Net::SNMP::Dispatcher.select(false)
       sess.close
       did_callback.should be(true)
     end

data/spec/em_spec.rb

@@ -9,7 +9,7 @@ describe "em" do
       Net::SNMP::Dispatcher.em_loop
 
       session = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
-        s.get("sysDescr.0") do |result|
+        s.get("sysDescr.0") do |op, result|
           did_callback = true
           result.varbinds[0].value.should eql("test.net-snmp.org")
         end

data/spec/error_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'eventmachine'
+
+describe "snmp errors" do
+  it "should rescue a timeout error" do
+    Net::SNMP::Session.open(:peername => 'www.yahoo.com') do |sess|
+      begin
+        sess.get("sysDescr.0")
+      rescue Net::SNMP::Error => e
+        e.print
+        e.status.should eql(Net::SNMP::Constants::STAT_TIMEOUT)
+      end
+    end
+  end
+
+  it "should rescue timeout error in a fiber" do
+    got_error = false
+    EM.run {
+      Fiber.new {
+        Net::SNMP::Dispatcher.fiber_loop
+        Net::SNMP::Session.open(:peername => 'www.yahoo.com') do |sess|
+          begin
+            puts "sending get pdu"
+            sess.get("sysDescr.0")
+            puts "done sess.get"
+          rescue Net::SNMP::TimeoutError => e
+            got_error = true
+          end
+        end
+        EM.stop
+      }.resume(nil)
+    }
+    got_error.should be_true        
+  end
+
+end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'net-snmp'
 require 'rspec'
 require 'rspec/autorun'
 
+Net::SNMP::Debug.debug = true
 #Spec::Runner.configure do |config|
   
 #end