net-snmp2 0.3.0

data/net-snmp2.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$:.unshift lib
+require 'net/snmp/version'
+
+Gem::Specification.new do |s|
+  s.name        = "net-snmp2"
+  s.version     = Net::SNMP::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ron McClain", "Jared Breeden"]
+  s.email       = ["jared.breeden@gmail.com"]
+  s.homepage    = "https://github.com/jbreeden/net-snmp2"
+  s.summary     = %q{Object oriented wrapper around C net-snmp libraries}
+  s.description = %q{Cross platform net-snmp wrapper for Ruby, building on the original net-snmp gem}
+
+  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"]
+
+  # Documentation options
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w{ README.md }
+  s.rdoc_options = ["--main=README.md", "--line-numbers", "--inline-source", "--title=#{s.name}-#{s.version} Documentation"]
+
+  s.add_dependency 'nice-ffi'
+  s.add_dependency 'pry'
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "eventmachine"
+end

data/spec/README.md

@@ -0,0 +1,105 @@
+Notes
+-----
+
+- To test sets, you have to have a local snmpd running with write permissions
+- For your local agent, use read community "public" & write community "private"
+- A free simulator can be downloaded from [veraxsystems](http://www.veraxsystems.com/en/products/free-snmp-agent-simulator)
+  + TODO: This simulator could be used to replace the dependency on test.net-snmp.org
+
+Latest Results
+--------------
+
+Generated with `rspec -f d -o spec/spec.txt --no-color`
+
+```
+async
+  version 1
+    get should work
+    get should return an error
+    getnext should work
+  version 2
+    get should work
+    getnext should work
+  version 3
+    should get async using snmpv3
+    get should work
+    getnext should work
+
+em
+  should work in event_machine
+
+snmp errors
+  should rescue a timeout error
+  should rescue timeout error in a fiber
+
+in fiber
+  get should work in a fiber with synchronous calling style
+  getnext
+  should get using snmpv3
+
+Net::SNMP::MIB::Node
+  should get info for sysDescr
+  should get parent
+  should get node children
+  should get siblings
+  should get oid
+  should get by oid
+  should do stuff
+
+Net::SNMP::OID
+  should instantiate valid oid with numeric
+  should instantiate valid oid with string
+  should to_s correctly
+
+synchronous calls
+  version 1
+    get should succeed
+    multiple calls within session should succeed
+    get should succeed with multiple oids
+    set should succeed
+    getnext should succeed
+    getbulk should succeed
+    getbulk should succeed with multiple oids
+    get should return error with invalid oid
+    get_table should work
+    walk should work
+    walk should work with multiple oids
+    get_columns should work
+    get a value with oid type should work
+  version 3
+    should get using snmpv3
+    should set using snmpv3 (PENDING: No reason given)
+    should get using authpriv (PENDING: No reason given)
+
+in a thread
+  should get an oid asynchronously in a thread
+
+snmp traps
+  should send a v1 trap
+  should send a v2 inform (PENDING: still working on it)
+  should send v2 trap (PENDING: still working on it)
+
+Net::SNMP::Utility
+  should compare oids
+
+Net::SNMP::Wrapper
+  wrapper should snmpget synchronously
+  wrapper should snmpget asynchronously
+
+Pending:
+  synchronous calls version 3 should set using snmpv3
+    # No reason given
+    # ./spec/sync_spec.rb:117
+  synchronous calls version 3 should get using authpriv
+    # No reason given
+    # ./spec/sync_spec.rb:125
+  snmp traps should send a v2 inform
+    # still working on it
+    # ./spec/trap_spec.rb:14
+  snmp traps should send v2 trap
+    # still working on it
+    # ./spec/trap_spec.rb:26
+
+Finished in 25.41 seconds (files took 0.38735 seconds to load)
+47 examples, 0 failures, 4 pending
+```

data/spec/async_spec.rb

@@ -0,0 +1,123 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "async" do
+  context "version 1" do
+    it "get should work" do
+      did_callback = false
+      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
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
+        end
+      end
+      Net::SNMP::Dispatcher.select(false)
+      did_callback.should be(true)
+    end
+
+    it "get should return an error" do
+      did_callback = false
+      sess = Net::SNMP::Session.open(:peername => 'www.yahoo.com', :timeout => 1, :retries => 0) do |sess|
+        sess.get("sysDescr.0") do |op, pdu|
+          did_callback = true
+          op.should eql(:timeout)
+        end
+      end
+      sleep 2
+      pdu = sess.select(10)
+
+      pdu.should eql(0)
+      did_callback.should eq(true)
+    end
+
+    it "getnext should work" do
+      did_callback = false
+      Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
+        s.get_next(["sysDescr", "sysContact"]) do |op, pdu|
+          did_callback = true
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
+        end
+      end
+      Net::SNMP::Dispatcher.select(false)
+      did_callback.should be(true)
+    end
+  end
+
+  context "version 2" do
+    it "get should work" do
+      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 |op, pdu|
+          did_callback = true
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
+        end
+      end
+      Net::SNMP::Dispatcher.select(false)
+      did_callback.should be(true)
+    end
+
+    it "getnext should work" do
+      did_callback = false
+      Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic', :version => '2c') do |s|
+        s.get_next(["sysDescr", "sysContact"]) do |op, pdu|
+          did_callback = true
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
+        end
+      end
+      Net::SNMP::Dispatcher.select(false)
+      did_callback.should be(true)
+    end
+
+  end
+
+  context "version 3" do
+    #failing intermittently
+    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"]) do |op, pdu|
+            did_callback = true
+            pdu.varbinds[0].value.should eql('test.net-snmp.org')
+          end
+          sleep(0.5)
+          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
+      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 |op,pdu|
+          did_callback = true
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
+        end
+      end
+      Net::SNMP::Dispatcher.select(false)
+      sess.close
+      did_callback.should be(true)
+    end
+
+    #  XXX  occasionally segfaulting
+    it "getnext should work" do
+      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 |op, pdu|
+          did_callback = true
+          pdu.varbinds[0].value.should eql("test.net-snmp.org")
+          pdu.varbinds[1].value.should match(/Coders/)
+        end
+      end
+      Net::SNMP::Dispatcher.select(false)
+      sess.close
+      did_callback.should be(true)
+    end
+  end
+end

data/spec/em_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'eventmachine'
+
+describe "em" do
+  it "should work in event_machine" do
+    did_callback = false
+    EM.run 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 |op, result|
+          did_callback = true
+          result.varbinds[0].value.should eql("test.net-snmp.org")
+        end
+      end
+
+      EM.add_timer(3) do
+        did_callback.should eq(true)
+        EM.stop
+      end
+    end
+  end
+end

data/spec/error_spec.rb

@@ -0,0 +1,34 @@
+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
+            sess.get("sysDescr.0")
+          rescue Net::SNMP::TimeoutError => e
+            got_error = true
+          end
+        end
+        EM.stop
+      }.resume(nil)
+    }
+    got_error.should eq(true)
+  end
+
+end

data/spec/fiber_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'eventmachine'
+require 'fiber'
+
+describe "in fiber" do
+
+  def wrap_fiber
+    EM.run do
+      Net::SNMP::Dispatcher.fiber_loop
+      Fiber.new { yield; EM.stop }.resume(nil)
+    end
+  end
+
+  it "get should work in a fiber with synchronous calling style" do
+    wrap_fiber do
+        session = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic')
+        result = session.get("sysDescr.0")
+        result.varbinds[0].value.should eql("test.net-snmp.org")
+    end
+  end
+
+  it "getnext" do
+    wrap_fiber do
+      Net::SNMP::Session.open(:peername => "test.net-snmp.org", :community => "demopublic" ) do |sess|
+        result = sess.get_next(["sysUpTimeInstance.0"])
+        result.varbinds.first.oid.oid.should eql("1.3.6.1.2.1.1.4.0")
+        result.varbinds.first.value.should match(/Net-SNMP Coders/)
+      end
+    end
+  end
+
+  it "should get using snmpv3" do
+    wrap_fiber 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
+  end
+
+end

data/spec/mib_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Net::SNMP::MIB do
+  describe '::translate' do
+    it "translates OIDs to variable names including instance indexes" do
+      expect(Net::SNMP::MIB.translate('sysContact.0')).to eql '1.3.6.1.2.1.1.4.0'
+    end
+
+    it "translates variable names to OIDs including instance indexes" do
+      expect(Net::SNMP::MIB.translate('1.3.6.1.2.1.1.4.0')).to eql 'sysContact.0'
+    end
+  end
+
+  describe '::[]' do
+    it "can retrieve MIB nodes by variable name" do
+      node = Net::SNMP::MIB["sysDescr"]
+      node.label.should eq("sysDescr")
+    end
+
+    it "can retrieve MIB nodes by numeric oid" do
+      node = Net::SNMP::MIB["1.3.6.1.2.1.1.1"]
+      node.label.should eq("sysDescr")
+    end
+  end
+end
+
+describe Net::SNMP::MIB::Node do
+  describe "::get_node" do
+    it "retrieves MIB nodes by variable name" do
+      node = Net::SNMP::MIB::Node.get_node("sysDescr")
+      node.label.should eq("sysDescr")
+    end
+
+    it "retrieves MIB nodes by numeric oid" do
+      node = Net::SNMP::MIB::Node.get_node("1.3.6.1.2.1.1.1")
+      node.label.should eq("sysDescr")
+    end
+  end
+
+  describe "#parent" do
+    it "links to the parent node" do
+      node = Net::SNMP::MIB::Node.get_node("sysDescr")
+      node.parent.label.should eq("system")
+    end
+  end
+
+  describe "#children" do
+    it "contains Node objects for all child nodes" do
+      node = Net::SNMP::MIB::Node.get_node("ifTable")
+      if_entry = node.children.first
+      if_entry.children.should include { |n| n.label == "ifIndex" }
+    end
+  end
+
+  describe "#siblings" do
+    it "contains an array of sibling nodes" do
+      node = Net::SNMP::MIB::Node.get_node("sysDescr")
+      node.siblings.should include { |n| n.label == "sysName" }
+    end
+  end
+
+  describe "#oid" do
+    it "is an OID object for the node" do
+      node = Net::SNMP::MIB::Node.get_node("sysDescr")
+      node.oid.to_s.should eq("1.3.6.1.2.1.1.1")
+    end
+  end
+end

data/spec/net-snmp_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "NetSnmp" do
+
+
+
+#  it "should get columns" do
+#    Net::SNMP::Session.open(:peername => 'localhost', :version => '2c', :community => 'public') do |sess|
+#      result = sess.get_columns(['ifIndex', 'ifInOctets', 'ifOutOctets'])
+#      result.size.should eql(7)
+#      result['1']['ifIndex'].should eql('1')
+#      result['2']['ifInOctets'].should be > 10
+#    end
+#  end
+
+
+
+end