net-snmp 0.1.0

data/net-snmp.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "net/snmp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "net-snmp"
+  s.version     = Net::Snmp::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ron McClain"]
+  s.email       = ["mixtli@github.com"]
+  s.homepage    = ""
+  s.summary     = %q{Object oriented wrapper around C net-snmp libraries}
+  s.description = %q{Uses ffi to create an object oriented wrapper around C net-snmp libraries}
+
+  s.rubyforge_project = "net-snmp"
+
+  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_development_dependency "rspec"
+  s.add_development_dependency "eventmachine"
+  s.add_dependency "nice-ffi"
+end

data/spec/mib_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Net::SNMP::MIB::Node do
+  it "should get info for sysDescr" do
+    node = Net::SNMP::MIB::Node.get_node("sysDescr")
+    node.label.should eq("sysDescr")
+  end
+  
+  it "should get parent" do
+    node = Net::SNMP::MIB::Node.get_node("sysDescr")
+    node.parent.label.should eq("system")
+   #   puts node.parent.inspect
+  end
+  
+  it "should get children" do
+    node = Net::SNMP::MIB::Node.get_node("system")
+    node.children.each do |c|
+    #  puts c.inspect
+    end
+  end
+  
+  it "should get siblings" do
+    node = Net::SNMP::MIB::Node.get_node("sysDescr")
+    node.siblings.should include{|n| n.label == "sysName"}
+    puts node.siblings.map(&:label)
+  end
+
+  it "should get oid" do
+    node = Net::SNMP::MIB::Node.get_node("sysDescr")
+    puts node.struct.inspect
+    node.oid.should eq("1.3.6.1.2.1.1.1")
+  end
+  
+  it "should get by oid" do
+    node = Net::SNMP::MIB::Node.get_node("1.3.6.1.2.1.1.1")
+    node.label.should eq("sysDescr")
+  end
+  
+  it "should do stuff" do
+    node = Net::SNMP::MIB::Node.get_node("ipAdEntIfIndex")
+    puts node.inspect
+    puts node.struct.inspect
+  end
+  
+end

data/spec/net-snmp_spec.rb

@@ -0,0 +1,202 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "NetSnmp" do
+  it "should get single oid" do
+    Net::SNMP::Session.open(:peername => "test.net-snmp.org", :community => "demopublic" ) do |sess|
+      result = sess.get("sysDescr.0")
+      result.varbinds.first.value.should eql("test.net-snmp.org")
+    end
+  end
+
+  it "should get multiple oids" do
+    Net::SNMP::Session.open(:peername => "test.net-snmp.org", :community => 'demopublic' ) do |sess|
+      result = sess.get(["sysDescr.0", "sysName.0"])
+      result.varbinds[0].value.should eql("test.net-snmp.org")
+      result.varbinds[1].value.should eql("test.net-snmp.org")
+    end
+  end
+  
+  it "should get multiple requests asynchronously" do
+    did_callback = false
+    session = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
+      s.get(["sysDescr.0", "sysContact.0"]) do |result|
+        puts "in callback"
+        did_callback = true
+        result.varbinds[0].value.should eql("test.net-snmp.org")
+        result.varbinds[1].value.should match(/Coders/)
+      end
+    end
+    Net::SNMP.dispatcher(false)
+    did_callback.should be(true)
+  end
+
+
+
+
+  it "should get an oid asynchronously in a thread" do
+    did_callback = false
+    session = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
+      s.get(["sysDescr.0", "sysContact.0"]) do |result|
+        puts "in callback"
+        did_callback = true
+        result.varbinds[0].value.should eql("test.net-snmp.org")
+        result.varbinds[1].value.should match(/Coders/)
+      end
+    end
+    Thread.new do
+      while Net::SNMP.dispatcher == 0
+        sleep 1
+      end
+    end.join
+    did_callback.should be(true)
+  end
+
+
+  it "invalid oid should return error" do
+    Net::SNMP::Session.open(:peername => "test.net-snmp.org", :community => "demopublic" ) do |sess|
+      result = sess.get(["XXXsysDescr.0"])  #misspelled
+      result.should be_error
+    end
+  end
+
+  it "should get using snmpv3" do
+    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|
+      result = sess.get("sysDescr.0")
+      result.varbinds.first.value.should eql('test.net-snmp.org')
+    end
+  end
+
+  it "should get async using snmpv3" do
+    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", "sysName.0"]) do |result|
+          did_callback = true
+          result.varbinds[0].value.should eql('test.net-snmp.org')
+          result.varbinds[1].value.should eql('test.net-snmp.org')
+          0
+        end
+        sleep(1)
+        Net::SNMP.dispatcher()
+        did_callback.should be(true)
+    end
+  end
+  
+  
+  # To test sets, you have to have a local snmpd running with write permissions
+  it "should set a value" do
+    Net::SNMP::Session.open(:peername => '127.0.0.1', :version => 1) do |sess|
+      result = sess.set([['sysContact.0', Net::SNMP::Constants::ASN_OCTET_STR, 'yomama']])
+      result.varbinds.first.value.should match(/yomama/)
+      result.should_not be_error
+    end
+  end
+     
+  #it "should set using snmpv3" do
+  #  pending
+  #  Net::SNMP::Session.open(:peername => '127.0.0.1', :version => 3, :username => 'myuser', :authprotocol => :sha1, :authkey => '0x1234', :privprotocol => :des, :privkey => '0x25252') do |sess|
+  #    result = sess.set([["sysDescr.0", Net::SNMP::Constants::ASN_OCTET_STR, 'yomama']])
+  #    result.varbinds.first.value.should match(/Darwin/)
+  #  end
+  #end
+  
+  it "should get next an array of oids" do
+    Net::SNMP::Session.open(:peername => "test.net-snmp.org", :community => "demopublic" ) do |sess|
+      result = sess.get_next(["sysUpTimeInstance.0"])
+      result.varbinds.first.name.should eql("1.3.6.1.2.1.1.4.0")
+      result.varbinds.first.value.should match(/Net-SNMP Coders/)
+    end
+  end
+  
+
+  it "should get_bulk_request" do
+    Net::SNMP::Session.open(:peername => "test.net-snmp.org" , :version => '2c', :community => 'demopublic') do |sess|
+      result = sess.get_bulk(["sysContact.0"], :max_repetitions => 10)
+      result.varbinds.first.oid.should eql("1.3.6.1.2.1.1.5.0")
+      result.varbinds.first.value.should eql("test.net-snmp.org")
+    end
+  end
+  
+  it "should get a table of values"
+  
+  it "should work in event_machine" do
+    require 'eventmachine'
+    did_callback = false
+    EM.run do
+      tickloop = EM.tick_loop do
+        Net::SNMP.dispatcher
+      end
+
+      session = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
+        s.get("sysDescr.0") do |result|
+          did_callback = true
+          result.varbinds[0].value.should eql("test.net-snmp.org")
+        end
+        
+      end
+
+      EM.add_timer(2) do
+        puts "in timer"
+        did_callback.should be_true
+        EM.stop
+      end
+    end
+  end
+
+  it "should work in a fiber" do
+    require 'eventmachine'
+    did_callback = false
+    EM.run do
+      tickloop = EM.tick_loop do
+        Net::SNMP.dispatcher
+      end
+
+      Fiber.new {
+        session = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
+          s.get("sysDescr.0") do |result|
+            did_callback = true
+            puts "INHERERERERERERE"
+            puts result.inspect
+            result.varbinds[0].value.should eql("test.net-snmp.org")
+          end
+
+        end
+
+        EM.add_timer(2) do
+          puts "in timer"
+          did_callback.should eql(true)
+          EM.stop
+        end
+      }.resume
+    end
+  end
+
+
+
+  it "get should work in a fiber with synchronous calling style" do
+    require 'eventmachine'
+    did_callback = false
+    EM.run do
+      puts "em fiber = #{Fiber.current.inspect}"
+      Fiber.new {
+        puts "inner fiber = #{Fiber.current.inspect}"
+
+        EM.tick_loop do
+          #puts "tick_fiber = #{Fiber.current.inspect}"
+
+          Net::SNMP.dispatcher
+        end
+        sleep 1
+        session = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic')
+        puts "calling aget"
+        result = session.get("sysDescr.0")
+        result.varbinds[0].value.should eql("test.net-snmp.org")
+
+
+      }.resume
+      EM.stop
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'net-snmp'
+require 'rspec'
+require 'rspec/autorun'
+
+#Spec::Runner.configure do |config|
+  
+#end

data/spec/wrapper_spec.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Net::SNMP::Wrapper" do
+  def init_session
+    community = "demopublic"
+    peername = "test.net-snmp.org"
+    
+    sess = Net::SNMP::Wrapper::SnmpSession.new
+    Net::SNMP::Wrapper.snmp_sess_init(sess.pointer)
+    sess.community = FFI::MemoryPointer.new(:pointer, community.length + 1)
+    #sess.community.autorelease = false
+    sess.community.write_string(community)
+    sess.community_len = community.length
+    sess.peername = FFI::MemoryPointer.new(:pointer, peername.length + 1)
+    #sess.peername.autorelease = false
+    sess.peername.write_string(peername)
+    sess.version = Net::SNMP::SNMP_VERSION_1
+
+    @handle = Net::SNMP::Wrapper.snmp_sess_open(sess.pointer)
+    Net::SNMP::Wrapper.snmp_sess_session(@handle)
+
+    sess
+  end
+
+  def make_pdu
+    pdu_ptr = Net::SNMP::Wrapper.snmp_pdu_create(Net::SNMP::SNMP_MSG_GET)
+    pdu = Net::SNMP::Wrapper::SnmpPdu.new(pdu_ptr)
+    anOID = FFI::MemoryPointer.new(:ulong, Net::SNMP::MAX_OID_LEN)
+    anOIDLen = FFI::MemoryPointer.new(:size_t)
+    anOIDLen.write_int(Net::SNMP::MAX_OID_LEN)
+    Net::SNMP::Wrapper.snmp_parse_oid("sysDescr.0", anOID, anOIDLen)
+    Net::SNMP::Wrapper.snmp_add_null_var(pdu.pointer, anOID, anOIDLen.read_int)
+    pdu
+  end
+
+  it "wrapper should snmpget synchronously" do
+    #pending
+    sess = init_session
+    sess = Net::SNMP::Wrapper.snmp_open(sess.pointer)
+
+    pdu = make_pdu
+
+    response_ptr = FFI::MemoryPointer.new(:pointer)
+    #response_ptr.autorelease = false
+    status = Net::SNMP::Wrapper.snmp_sess_synch_response(@handle, pdu.pointer, response_ptr)
+    status.should eql(0)
+     
+    response = Net::SNMP::Wrapper::SnmpPdu.new(response_ptr.read_pointer)
+    value = response.variables.val[:string].read_string
+    puts "val_len = #{response.variables.val_len}"
+    value.should eql('test.net-snmp.org')
+  end
+
+  it "wrapper should snmpget asynchronously" do
+      pending
+      sess = init_session
+      pdu = make_pdu
+      did_callback = 0
+      result = nil
+      sess.callback = lambda do |operation, session, reqid, pdu_ptr, magic|
+        did_callback = 1
+        pdu = Net::SNMP::Wrapper::SnmpPdu.new(pdu_ptr)
+        variables = Net::SNMP::Wrapper::VariableList.new(pdu.variables)
+        result = variables.val[:string].read_string
+        0
+      end
+      sess = Net::SNMP::Wrapper.snmp_open(sess.pointer)
+      Net::SNMP::Wrapper.snmp_send(sess.pointer, pdu)
+
+      fdset = Net::SNMP::Wrapper.get_fd_set
+      fds = FFI::MemoryPointer.new(:int)
+      #fds.autorelease = false
+      tval = Net::SNMP::Wrapper::TimeVal.new
+      block = FFI::MemoryPointer.new(:int)
+      #block.autorelease = false
+      block.write_int(1)
+      Net::SNMP::Wrapper.snmp_select_info(fds, fdset, tval.pointer, block )
+      Net::SNMP::Wrapper.select(fds.read_int, fdset, nil, nil, nil)
+      Net::SNMP::Wrapper.snmp_read(fdset)
+      did_callback.should be(1)
+      result.should eql('test.net-snmp.org')
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: net-snmp
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ron McClain
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-24 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: nice-ffi
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Uses ffi to create an object oriented wrapper around C net-snmp libraries
+email: 
+- mixtli@github.com
+executables: 
+- snmpget.rb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/snmpget.rb
+- c/Makefile
+- c/test
+- c/test.c
+- interface/snmp_api.h
+- interface/snmp_api.i
+- interface/snmp_api_wrap.xml
+- lib/net-snmp.rb
+- lib/net/snmp.rb
+- lib/net/snmp/constants.rb
+- lib/net/snmp/error.rb
+- lib/net/snmp/inline.rb
+- lib/net/snmp/mib.rb
+- lib/net/snmp/mib/node.rb
+- lib/net/snmp/oid.rb
+- lib/net/snmp/pdu.rb
+- lib/net/snmp/session.rb
+- lib/net/snmp/varbind.rb
+- lib/net/snmp/version.rb
+- lib/net/snmp/wrapper.rb
+- net-snmp.gemspec
+- spec/mib_spec.rb
+- spec/net-snmp_spec.rb
+- spec/spec_helper.rb
+- spec/wrapper_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: net-snmp
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Object oriented wrapper around C net-snmp libraries
+test_files: 
+- spec/mib_spec.rb
+- spec/net-snmp_spec.rb
+- spec/spec_helper.rb
+- spec/wrapper_spec.rb