netsnmp 0.0.0

data/lib/netsnmp/version.rb

@@ -0,0 +1,3 @@
+module NETSNMP
+  VERSION = '0.0.0'.freeze
+end

data/netsnmp.gemspec

@@ -0,0 +1,36 @@
+require File.expand_path('../lib/netsnmp/version',__FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "netsnmp"
+  gem.summary     = "SNMP Client library"
+  gem.description = <<DESC
+Wraps the net-snmp core usage into idiomatic ruby.
+It is designed to support as many environments and concurrency frameworks as possible.
+DESC
+  gem.requirements = ['net-snmp']
+  gem.version     = NETSNMP::VERSION
+  gem.license     = "Apache-2.0"
+  gem.authors     = ["Tiago Cardoso"]
+  gem.email       = "cardoso_tiago@hotmail.com"
+  gem.homepage    = ""
+  gem.platform    = Gem::Platform::RUBY
+  gem.required_ruby_version = '>=2.0.0'
+
+  # Manifest
+  gem.files         = `git ls-files`.split("\n") - Dir['tmp/**/*']
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.executables = Dir["bin/*"].map { |e| File.basename e }
+  gem.add_runtime_dependency "ffi", ["~> 1.9"]
+  unless RUBY_PLATFORM == "java"
+    gem.add_runtime_dependency "RubyInline", ["~> 3.12"]
+  end
+
+  gem.add_development_dependency "rake", ["~> 10.4.2"]
+  gem.add_development_dependency "rspec", ["~> 3.3.0"]
+
+  gem.add_development_dependency "em-synchrony", ["~> 1.0.4"]
+  gem.add_development_dependency "celluloid-io", ["~> 0.17.2"]
+end

data/spec/client_spec.rb

@@ -0,0 +1,90 @@
+RSpec.describe NETSNMP::Client do
+  let(:host) { "localhost" }
+  let(:host_options) { {
+    peername: "localhost",
+    port: SNMPPORT,
+    username: "simulator",
+    auth_password: "auctoritas",
+    auth_protocol: :md5,
+    priv_password: "privatus",
+    priv_protocol: :des
+  } }
+
+  subject { described_class.new(host, options) }
+
+  describe "#get" do
+    let(:oid) { "1.3.6.1.2.1.1.5.0" } # sysName.0
+    let(:value) { subject.get(oid) }
+    let(:options) { host_options.merge(context: "a172334d7d97871b72241397f713fa12") }
+    it "fetches the varbinds for a given oid" do
+      expect(value).to eq("tt")
+    end
+  end
+
+  describe "#get_next" do
+    let(:oid) { "1.3.6.1.2.1.1.5.0" } # sysName.0
+    let(:value) { subject.get_next(oid) }
+    let(:options) { host_options.merge(context: "a172334d7d97871b72241397f713fa12") }
+    it "fetches the varbinds for the next oid" do
+      expect(value).to start_with("KK12")
+    end
+  end
+
+  describe "#walk" do
+    let(:oid) { "1.3.6.1.2.1.1.9.1.3" } # sysORDescr
+    let(:value) { subject.walk(oid) }
+    let(:options) { host_options.merge(context: "a172334d7d97871b72241397f713fa12") }
+    it "fetches the varbinds for the next oid" do
+      expect(value.next).to eq(["#{oid}.1","The SNMP Management Architecture MIB."])
+      expect(value.next).to eq(["#{oid}.2","The MIB for Message Processing and Dispatching."])
+      expect(value.next).to eq(["#{oid}.3","The management information definitions for the SNMP User-based Security Model."])
+      expect(value.next).to eq(["#{oid}.4","The MIB module for SNMPv2 entities"])
+      expect(value.next).to eq(["#{oid}.5","The MIB module for managing TCP implementations"])
+      expect(value.next).to eq(["#{oid}.6","The MIB module for managing IP and ICMP implementations"])
+      expect(value.next).to eq(["#{oid}.7","The MIB module for managing UDP implementations"])
+      expect(value.next).to eq(["#{oid}.8","View-based Access Control Model for SNMP."])
+      expect{ value.next }.to raise_error(StopIteration)
+    end
+  end
+
+  describe "#get_bulk" do
+    let(:oid) { "1.3.6.1.2.1.1.9.1.3" }
+    let(:value) { subject.get_bulk(oid) }
+    let(:options) { host_options.merge(context: "a172334d7d97871b72241397f713fa12") }
+    it "fetches the varbinds for the next oid" do
+      expect(value.next).to eq(["#{oid}.1","The SNMP Management Architecture MIB."])
+      expect(value.next).to eq(["#{oid}.2","The MIB for Message Processing and Dispatching."])
+      expect(value.next).to eq(["#{oid}.3","The management information definitions for the SNMP User-based Security Model."])
+      expect(value.next).to eq(["#{oid}.4","The MIB module for SNMPv2 entities"])
+      expect(value.next).to eq(["#{oid}.5","The MIB module for managing TCP implementations"])
+      expect(value.next).to eq(["#{oid}.6","The MIB module for managing IP and ICMP implementations"])
+      expect(value.next).to eq(["#{oid}.7","The MIB module for managing UDP implementations"])
+      expect(value.next).to eq(["#{oid}.8","View-based Access Control Model for SNMP."])
+      expect(value.next).to eq(["1.3.6.1.2.1.1.9.1.4.1",2])
+      expect(value.next).to eq(["1.3.6.1.2.1.1.9.1.4.2",2])
+      expect{ value.next }.to raise_error(StopIteration)
+    end
+  end
+
+ 
+  # TODO: use this oid to test error calls
+  #  let(:oid) { "SNMPv2-MIB::sysORDescr.1" }
+
+  describe "#set" do
+    let(:options) { host_options.merge(context: "0886e1397d572377c17c15036a1e6c66") } # write cache
+    let(:oid) { "1.3.6.1.2.1.1.3.0" } # sysUpTimeInstance
+    let(:new_value) { 43 }
+    after { subject.set(oid, value: 42) }
+    it "updates the value of the oid" do
+      expect(subject.get(oid)).to be(42)
+  
+      # without type
+      subject.set(oid, value: 43)
+      expect(subject.get(oid)).to be(43)
+
+      subject.set(oid, value: 44, type: :integer)
+      expect(subject.get(oid)).to be(44)
+
+    end
+  end
+end

data/spec/core/libc_spec.rb

@@ -0,0 +1,2 @@
+RSpec.describe NETSNMP::Core::C do
+end

data/spec/core/libsnmp_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe NETSNMP::Core::LibSNMP do
+  subject { described_class }
+  it "exposes initialization and shutdown methods" do
+    [:init_snmp, :snmp_perror].each do |meth| 
+      is_expected.to respond_to(meth)
+    end
+  end
+
+  it "exposes netsnmp session handling methods" do
+    [:snmp_sess_init, :snmp_sess_open, :snmp_sess_close, :generate_Ku].each do |meth|
+      is_expected.to respond_to(meth)
+    end
+  end
+
+  it "exposes netsnmp read API" do
+    [:snmp_sess_synch_response, :snmp_sess_send].each do |meth|
+      is_expected.to respond_to(meth)
+    end
+  end
+
+  it "exposes netsnmp session async send/read" do
+    [:snmp_sess_async_send, :snmp_sess_select_info, :snmp_sess_read].each do |meth|
+      is_expected.to respond_to(meth)
+    end
+  end
+
+  it "exposes the pdu API" do
+    [:snmp_pdu_create, :snmp_free_pdu, :snmp_pdu_add_variable].each do |meth|
+      is_expected.to respond_to(meth)
+    end
+  end
+end

data/spec/core/structures_spec.rb

@@ -0,0 +1,54 @@
+RSpec.describe NETSNMP::Core::Structures do
+  describe NETSNMP::Core::Structures::Session do
+    [:version, :retries, :timeout, :flags, :subsession, :next, :peername, :remote_port, :localname, :local_port, :authenticator, 
+     :callback, :callback_magic, :community, :community_len, :rcvMsgMaxSize, :sndMsgMaxSize, :isAuthoritative, :contextEngineID,
+     :contextEngineIDLen, :engineBoots, :engineTime, :contextName, :contextNameLen, :securityEngineID, :securityEngineIDLen, 
+     :securityName, :securityNameLen, :securityAuthProto, :securityAuthProtoLen, :securityAuthKey, :securityAuthKeyLen, 
+     :securityAuthLocalKey, :securityAuthLocalKeyLen, :securityPrivProto, :securityPrivProtoLen, :securityPrivKey, :securityPrivKeyLen,
+     :securityPrivLocalKey, :securityPrivLocalKeyLen, :securityModel, :securityLevel, :paramName, :securityInfo, :myvoid].each do |attr| 
+      it { expect(subject[attr]).not_to be_nil } 
+    end
+  end
+
+  describe NETSNMP::Core::Structures::Vardata do
+    [:integer, :string, :objid, :bitstring, :counter64, :float, :double].each do |attr|
+      it { expect(subject[attr]).not_to be_nil }
+    end
+  end
+
+  describe NETSNMP::Core::Structures::VariableList do
+    [:next_variable, :name, :name_length, :type, :val, :val_len, :name_loc, :buf, :data, :dataFreeHook, :index].each do |attr|
+      it { expect(subject[attr]).not_to be_nil }
+    end
+  end 
+
+  describe NETSNMP::Core::Structures::PDU do
+    [:version, :command, :reqid, :msgid, :transid, :sessid, :errstat, :errindex, :time, :flags, :securityModel, 
+     :securityLevel, :msgParseModel, :transport_data, :transport_data_length, :tDomain, :tDomainLen, :variables, 
+     :community, :community_len, :enterprise, :enterprise_length, :trap_type, :specific_type, :agent_addr, 
+     :contextEngineID, :contextEngineIDLen, :contextName, :contextNameLen, :securityEngineID, :securityEngineIDLen, 
+     :securityName, :securityNameLen, :priority, :range_subid, :securityStateRef].each do |attr|
+      it { expect(subject[attr]).not_to be_nil }
+    end 
+  end
+
+  describe NETSNMP::Core::Structures::SessionList do 
+    [:next, :session, :transport, :internal].each do |attr|
+      it { expect(subject[attr]).not_to be_nil }
+    end
+  end
+
+  describe NETSNMP::Core::Structures::Transport do
+    [:domain, :domain_length, :local, :local_length, :remote, :remote_length, 
+     :sock, :flags, :data, :data_length, :msgMaxSize, :base_transport].each do |attr|
+      it { expect(subject[attr]).not_to be_nil } 
+    end
+  end
+
+  describe NETSNMP::Core::Structures::Counter64 do
+    [:high, :low].each do |attr|
+      it { expect(subject[attr]).not_to be_nil } 
+    end
+  end
+
+end

data/spec/handlers/celluloid_spec.rb

@@ -0,0 +1,29 @@
+require 'celluloid/io'
+require 'netsnmp/handlers/celluloid'
+require_relative '../support/celluloid'
+
+RSpec.describe NETSNMP::Celluloid::Client, type: :celluloid do
+  include CelluloidHelpers
+  let(:host) { "localhost" }
+  let(:host_options) { {
+    peername: "localhost",
+    port: SNMPPORT,
+    username: "simulator",
+    auth_password: "auctoritas",
+    auth_protocol: :md5,
+    priv_password: "privatus",
+    priv_protocol: :des
+  } }
+
+  subject { described_class.new(host, options) }
+
+  describe "#get" do
+    let(:oid) { "1.3.6.1.2.1.1.5.0" } # sysName.0
+    let(:options) { host_options.merge(context: "a172334d7d97871b72241397f713fa12") }
+    it "fetches the varbinds for a given oid" do
+      value = within_io_actor { value = subject.get(oid) }
+      expect(value).to eq("tt")
+    end
+  end
+  
+end

data/spec/handlers/em_client_spec.rb

@@ -0,0 +1,34 @@
+require 'em-synchrony'
+require 'netsnmp/handlers/em'
+
+RSpec.describe NETSNMP::EM::Client do
+  let(:host) { "localhost" }
+  let(:host_options) { {
+    peername: "localhost",
+    port: SNMPPORT,
+    username: "simulator",
+    auth_password: "auctoritas",
+    auth_protocol: :md5,
+    priv_password: "privatus",
+    priv_protocol: :des
+  } }
+
+  subject { described_class.new(host, options) }
+
+  describe "#get" do
+    let(:oid) { "1.3.6.1.2.1.1.5.0" } # sysName.0
+    let(:options) { host_options.merge(context: "a172334d7d97871b72241397f713fa12") }
+    it "fetches the varbinds for a given oid" do
+      value = nil
+      EM.synchrony do
+        begin
+          value = subject.get(oid)
+        ensure
+          EM.stop_event_loop
+        end
+      end
+      expect(value).to eq("tt")
+    end
+  end
+  
+end

data/spec/oid_spec.rb

@@ -0,0 +1,9 @@
+RSpec.describe NETSNMP::OID do
+  let(:code) { "SNMPv2-MIB::sysDescr.0" }
+  let(:oid_code) { "1.3.6.1.2.1.1.1.0" }
+  subject { described_class.new(code) }
+
+  it "translates always to numerical oid code" do
+    expect(subject.to_s).to eq(oid_code)
+  end
+end

data/spec/pdu_spec.rb

@@ -0,0 +1,29 @@
+RSpec.describe NETSNMP::PDU do
+  let(:struct) { double(:structure) }
+  let(:pointer) { double(:pointer) }
+  subject {  NETSNMP::PDU.new(pointer) }
+  before do
+    allow(NETSNMP::Core::Structures::PDU).to receive(:new).with(pointer).and_return(struct)
+  end
+
+  it { is_expected.to respond_to(:struct) }
+  it { expect(subject.varbinds).to be_empty }
+
+  describe NETSNMP::RequestPDU do
+    before { allow(NETSNMP::Core::LibSNMP).to receive(:snmp_pdu_create).and_return(pointer) }
+    subject { NETSNMP::PDU.build(:get) }
+
+    describe "#add_varbind" do
+      let(:oid) { double(:oid) }
+      let(:value) { double(:value) }
+      let(:varbind) { double(:varbind) }
+      before { allow(NETSNMP::RequestVarbind).to receive(:new).with(subject, oid, value, instance_of(Hash)).and_return(varbind) }
+      it "creates a new varbind and adds it to the structure" do
+        subject.add_varbind(oid, { value: value }) 
+        expect(subject.varbinds).not_to be_empty
+        expect(subject.varbinds).to include(varbind) 
+      end
+    end
+  end
+
+end

data/spec/session_spec.rb

@@ -0,0 +1,34 @@
+RSpec.describe NETSNMP::Session do
+  let(:host) { "localhost" }
+  let(:options) { {
+    version: '2c', 
+    context: "public",
+    port: SNMPPORT
+  } }
+  subject { described_class.new(host, options) }
+  after { subject.close }
+
+
+  describe "#send" do
+    let(:pointer) { double(:pointer) }
+    let(:pdu) { double(:pdu, pointer: pointer) }
+    let(:response) { double(:response) }
+    let(:reqid) { double(:requestid) }
+    let(:requests) { {} }
+
+    before do
+      allow(pdu).to receive(:[]).with(:reqid).and_return(reqid) 
+      allow(requests).to receive(:[]).with(reqid).and_return([:success, response])
+    end
+
+    it "sends and receives a pdu" do
+      expect(IO).to receive(:select).twice.and_return([[], []])
+      expect(NETSNMP::Core::LibSNMP).to receive(:snmp_sess_async_send).with(subject.signature, pointer, instance_of(FFI::Function), nil)
+      expect(subject).to receive(:handle_response).and_return(response)
+      expect(subject.send(pdu)).to be(response)
+    end
+    
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,114 @@
+require 'simplecov' if ENV["COVERAGE"]
+require 'coveralls'
+Coveralls.wear!
+
+SimpleCov.start do   
+  minimum_coverage 85
+  add_filter ".bundle"
+  add_filter "/spec/"
+end if defined?(SimpleCov)
+
+require 'bundler/setup'
+Bundler.require(:default, :test)
+
+require 'netsnmp'
+
+
+SNMPPORT = `sudo docker port test-snmp-emulator 1161/udp`[/.*:(\d+)/, 1].to_i
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end