net-snmp2 0.3.0

data/spec/oid_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Net::SNMP::OID do
+  it "should instantiate valid oid with numeric" do
+    oid = Net::SNMP::OID.new("1.3.6.1.2.1.2.1.0")
+    oid.to_s.should eql("1.3.6.1.2.1.2.1.0")
+    oid.label.should eql("ifNumber.0")
+  end
+
+  it "should instantiate valid oid with string" do
+    oid = Net::SNMP::OID.new("ifNumber.0")
+    oid.to_s.should eql("1.3.6.1.2.1.2.1.0")
+    oid.label.should eql("ifNumber.0")
+  end
+
+  it "should to_s correctly" do
+    oid_str = "1.3.6.1.2.1.2.1.0"
+    oid = Net::SNMP::OID.new(oid_str)
+    oid.to_s.should eq(oid_str)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'net-snmp2'
+require 'rspec'
+
+# Trap tests fail randomly due to race conditions,
+# setting thread_safe should fix this
+Net::SNMP::thread_safe = true
+Net::SNMP.init

data/spec/sync_spec.rb

@@ -0,0 +1,132 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "synchronous calls" do
+  context "version 1" do
+    it "get should succeed" 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 "multiple calls within session should succeed" 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")
+        second = sess.get("sysName.0")
+        second.varbinds.first.value.should eql("test.net-snmp.org")
+      end
+    end
+
+    it "get should succeed with 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 "set should succeed" do
+      Net::SNMP::Session.open(:peername => 'localhost', :version => 1, :community => 'private') do |sess|
+        result = sess.set([['sysContact.0', Net::SNMP::Constants::ASN_OCTET_STR, 'newContact']])
+        result.varbinds.first.value.should match(/newContact/)
+      end
+    end
+
+    it "getnext should succeed" 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
+
+    it "getbulk should succeed" 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.name.should eql("1.3.6.1.2.1.1.5.0")
+        result.varbinds.first.value.should eql("test.net-snmp.org")
+      end
+    end
+
+    it "getbulk should succeed with multiple oids" do
+      Net::SNMP::Session.open(:peername => "localhost" , :version => '2c', :community => 'public') do |sess|
+        result = sess.get_bulk(["ifIndex", "ifType"], :max_repetitions =>3)
+        result.varbinds.size.should eql(6)
+      end
+    end
+
+    it "rasises an when a non-existant MIB variable is requested" do
+      Net::SNMP::Session.open(:peername => "test.net-snmp.org", :community => "demopublic" ) do |sess|
+        expect { sess.get(["XXXsysDescr.0"]) }.to raise_error
+      end
+    end
+
+    it "get_table should work" do
+      session = Net::SNMP::Session.open(:peername => "localhost", :version => '1')
+      table = session.table("ifEntry")
+      table['1']['ifIndex'].should eql(1)
+      table['2']['ifIndex'].should eql(2)
+    end
+
+    it "walk should work" do
+      session = Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :version => 1, :community => 'demopublic')
+      results = session.walk("system")
+      results['1.3.6.1.2.1.1.1.0'].should match(/test.net-snmp.org/)
+    end
+
+    it "walk should work with multiple oids" do
+      Net::SNMP::Session.open(:peername => 'localhost', :version => 1) do |sess|
+        sess.walk(['system', 'ifTable']) do |results|
+          # Set earlier. Yes, I know, tests shouldn't depend on eachother...
+          results['1.3.6.1.2.1.1.4.0'].should match(/newContact/)
+          # ifIndex (Should just be returning the same number as the instance requested)
+          results['1.3.6.1.2.1.2.2.1.1.2'].should eql(2)
+        end
+      end
+    end
+
+    it "get_columns should work" do
+      Net::SNMP::Session.open(:peername => 'localhost') do |sess|
+        table = sess.columns(['ifIndex', 'ifDescr', 'ifType'])
+        table['1']['ifIndex'].should eql(1)
+        table['2']['ifDescr'].should match(/[a-zA-Z]{3}[0-9]/)
+      end
+    end
+
+    it "get a value with oid type should work" do
+      Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |sess|
+        res = sess.get("sysObjectID.0")
+        res.varbinds.first.value.to_s.should eql('1.3.6.1.4.1.8072.3.2.10')
+      end
+    end
+  end
+
+  context "version 2" do
+
+  end
+
+  context "version 3" do
+    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 set using snmpv3" do
+      pending
+      Net::SNMP::Session.open(:peername => 'localhost', :version => 3, :username => 'myuser', :auth_protocol => :sha1, :password => '0x1234') 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 using authpriv" do
+      pending
+      Net::SNMP::Session.open(:peername => 'localhost', :version => 3, :username => 'mixtli', :security_level => Net::SNMP::Constants::SNMP_SEC_LEVEL_AUTHPRIV, :auth_protocol => :md5, :priv_protocol => :des, :auth_password => 'testauth', :priv_password => 'testpass') do |sess|
+        result = sess.get("sysDescr.0")
+        result.varbinds.first.value.should match(/xenu/)
+      end
+    end
+  end
+end

data/spec/thread_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "in a thread" do
+  it "should get an oid asynchronously in a thread" do
+    did_callback = false
+    dispatch_thread = Net::SNMP::Dispatcher.thread_loop
+    Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'demopublic') do |s|
+      s.get(["sysDescr.0", "sysContact.0"]) do |op, result|
+        did_callback = true
+        result.varbinds[0].value.should eql("test.net-snmp.org")
+        result.varbinds[1].value.should match(/Coders/)
+      end
+    end
+    sleep 3
+    did_callback.should be(true)
+
+    Thread.kill(dispatch_thread)
+  end
+end

data/spec/trap_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# NOTE: Run a trap receiver on port 163 for these tests to pass.
+# (I'm using MIB Browser's builtin receiver)
+# This is just because I'm using the veraxsystem SNMP simulator for other tests,
+# and it occupies port 162 but doesn't respond to the informs
+
+describe Net::SNMP::TrapSession do
+  it "should send a v1 trap" do
+    Net::SNMP::TrapSession.open(:peername => 'localhost:163', :version => '1', :community => 'public') do |sess|
+      res = sess.trap(
+        enterprise: '1.3.1',
+        trap_type: 6,
+        specific_type: 1,
+        uptime: 1000,
+        agent_addr: '127.0.0.1'
+      )
+      res.should eq(:success)
+    end
+  end
+
+  it "should send v2 trap" do
+    Net::SNMP::TrapSession.open(:peername => 'localhost:163', :version => '2c') do |sess|
+      res = sess.trap_v2(:oid => 'sysContact.0', :uptime => 1000)
+      res.should eq(:success)
+    end
+  end
+
+  it "should send a v2 inform" do
+    did_callback = false
+    Net::SNMP::TrapSession.open(:peername => 'localhost:163', :version => '2c') do |sess|
+      resp = sess.inform(:oid => 'coldStart.0')
+      has_cold_start_oid = false
+      # Got some weird segfaults when using rspec's ".should include {...}"
+      # matcher, so I did this manually.
+      resp.varbinds.each do |vb|
+        if (vb.oid.to_s == Net::SNMP::MIB.translate('snmpTrapOID.0')) &&
+            (vb.value.to_s == Net::SNMP::MIB.translate('coldStart.0'))
+          has_cold_start_oid = true
+        end
+      end
+      has_cold_start_oid.should eq(true)
+    end
+  end
+end

data/spec/utility_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Net::SNMP::Utility do
+  it "should compare oids" do
+    Net::SNMP::Utility.oid_lex_cmp('1.3.5', '1.3.7').should eql(-1)
+    Net::SNMP::Utility.oid_lex_cmp('1.3.7', '1.3.5').should eql(1)
+    Net::SNMP::Utility.oid_lex_cmp('1.3.7', '1.3.7.1').should eql(-1)
+    Net::SNMP::Utility.oid_lex_cmp('1.3.5', '1.3.5').should eql(0)
+  end
+end

data/spec/wrapper_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Net::SNMP::Wrapper" do
+  def init_session
+    community = "demopublic"
+    peername = "test.net-snmp.org"
+
+    @session = Net::SNMP::Wrapper::SnmpSession.new(nil)
+    Net::SNMP::Wrapper.snmp_sess_init(@session.pointer)
+    @session.community = FFI::MemoryPointer.from_string(community)
+    @session.community_len = community.length
+    @session.peername = FFI::MemoryPointer.from_string(peername)
+    @session.version = Net::SNMP::Constants::SNMP_VERSION_1
+
+    @handle = Net::SNMP::Wrapper.snmp_sess_open(@session.pointer)
+    @session_struct = Net::SNMP::Wrapper.snmp_sess_session(@handle)
+  end
+
+  def make_pdu
+    @pdu = Net::SNMP::Wrapper.snmp_pdu_create(Net::SNMP::Constants::SNMP_MSG_GET)
+    @oid_ptr = FFI::MemoryPointer.new(:ulong, Net::SNMP::Constants::MAX_OID_LEN)
+    @oid_len_ptr = FFI::MemoryPointer.new(:size_t)
+    @oid_len_ptr.write_int(Net::SNMP::Constants::MAX_OID_LEN)
+
+    Net::SNMP::Wrapper.get_node("sysDescr.0", @oid_ptr, @oid_len_ptr)
+    Net::SNMP::Wrapper.snmp_pdu_add_variable(@pdu.pointer, @oid_ptr, @oid_len_ptr.read_int, Net::SNMP::Constants::ASN_NULL, nil, 0)
+  end
+
+  it "wrapper should snmpget synchronously" do
+    init_session
+
+    make_pdu
+
+    response_ptr = FFI::MemoryPointer.new(:pointer)
+    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(response.variables.val_len)
+    value.should eql('test.net-snmp.org')
+  end
+
+  it "wrapper should snmpget asynchronously" do
+      init_session
+      make_pdu
+      did_callback = 0
+      result = nil
+      @session.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(variables.val_len)
+        0
+      end
+      sess = Net::SNMP::Wrapper.snmp_open(@session.pointer)
+      Net::SNMP::Wrapper.snmp_send(sess.pointer, @pdu)
+      sleep 1
+      fdset = FFI::MemoryPointer.new(1024 * 8)
+      fds = FFI::MemoryPointer.new(:int)
+      tval = Net::SNMP::Wrapper::TimeVal.new
+      block = FFI::MemoryPointer.new(:int)
+      block.write_int(1)
+      Net::SNMP::Wrapper.snmp_select_info(fds, fdset, tval.pointer, block )
+      FFI::LibC.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,166 @@
+--- !ruby/object:Gem::Specification
+name: net-snmp2
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Ron McClain
+- Jared Breeden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nice-ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cross platform net-snmp wrapper for Ruby, building on the original net-snmp
+  gem
+email:
+- jared.breeden@gmail.com
+executables:
+- mib2rb
+- net-snmp2
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- bin/mib2rb
+- bin/net-snmp2
+- examples/agent.rb
+- examples/manager.rb
+- examples/trap_handler.rb
+- examples/v1_trap_session.rb
+- examples/v2_trap_session.rb
+- lib/net-snmp2.rb
+- lib/net/snmp.rb
+- lib/net/snmp/agent/agent.rb
+- lib/net/snmp/agent/provider.rb
+- lib/net/snmp/agent/provider_dsl.rb
+- lib/net/snmp/agent/request_dispatcher.rb
+- lib/net/snmp/constants.rb
+- lib/net/snmp/debug.rb
+- lib/net/snmp/dispatcher.rb
+- lib/net/snmp/error.rb
+- lib/net/snmp/listener.rb
+- lib/net/snmp/message.rb
+- lib/net/snmp/mib/mib.rb
+- lib/net/snmp/mib/module.rb
+- lib/net/snmp/mib/node.rb
+- lib/net/snmp/mib/templates.rb
+- lib/net/snmp/oid.rb
+- lib/net/snmp/pdu.rb
+- lib/net/snmp/repl/manager_repl.rb
+- lib/net/snmp/session.rb
+- lib/net/snmp/trap_handler/trap_handler.rb
+- lib/net/snmp/trap_handler/v1_trap_dsl.rb
+- lib/net/snmp/trap_handler/v2_trap_dsl.rb
+- lib/net/snmp/trap_session.rb
+- lib/net/snmp/utility.rb
+- lib/net/snmp/varbind.rb
+- lib/net/snmp/version.rb
+- lib/net/snmp/wrapper.rb
+- net-snmp2.gemspec
+- spec/README.md
+- spec/async_spec.rb
+- spec/em_spec.rb
+- spec/error_spec.rb
+- spec/fiber_spec.rb
+- spec/mib_spec.rb
+- spec/net-snmp_spec.rb
+- spec/oid_spec.rb
+- spec/spec_helper.rb
+- spec/sync_spec.rb
+- spec/thread_spec.rb
+- spec/trap_spec.rb
+- spec/utility_spec.rb
+- spec/wrapper_spec.rb
+homepage: https://github.com/jbreeden/net-snmp2
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --main=README.md
+- --line-numbers
+- --inline-source
+- --title=net-snmp2-0.3.0 Documentation
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Object oriented wrapper around C net-snmp libraries
+test_files: []
+has_rdoc: true