logstash-integration-snmp 4.0.0-java

data/spec/integration/inputs/snmptrap_spec.rb

@@ -0,0 +1,383 @@
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/inputs/snmptrap'
+require 'logstash-integration-snmp_jars'
+require 'timeout'
+require 'socket'
+
+describe LogStash::Inputs::Snmptrap, :integration => true do
+
+  java_import 'org.logstash.snmp.SnmpTestTrapSender'
+  java_import 'org.snmp4j.smi.OID'
+
+  PDU_METADATA = '[@metadata][input][snmptrap][pdu]'
+
+  let(:port) { rand(5000) + 1025 }
+  let(:target_address) { "udp:localhost/#{port}" }
+  let(:config) { { 'port' => port } }
+  let(:plugin) { LogStash::Inputs::Snmptrap.new(config) }
+
+  before(:all) do
+    @trap_sender = org.logstash.snmp.SnmpTestTrapSender.new(0)
+  end
+
+  after(:all) do
+    @trap_sender.close
+  end
+
+  describe 'traps receiver' do
+    shared_examples 'a plugin receiving a v1 trap message' do
+      it 'should process the message' do
+        queue = run_plugin_and_get_queue(plugin) do
+          @trap_sender.send_trap_v1(target_address, community, { '1.3.6.1.2.1.1.1.0' => 'It is a trap' })
+        end
+
+        expect(queue.size).to be(1)
+
+        trap_event = queue.pop
+
+        # fields
+        expect(trap_event.get('iso.org.dod.internet.mgmt.mib-2.system.sysDescr.0')).to eq('It is a trap')
+
+        # metadata
+        expect(trap_event.get("#{PDU_METADATA}[version]")).to eq('1')
+        expect(trap_event.get("#{PDU_METADATA}[type]")).to eq('V1TRAP')
+        expect(trap_event.get("#{PDU_METADATA}[enterprise]")).to eq('0.0')
+        expect(trap_event.get("#{PDU_METADATA}[agent_addr]")).to eq('0.0.0.0')
+        expect(trap_event.get("#{PDU_METADATA}[generic_trap]")).to eq(0)
+        expect(trap_event.get("#{PDU_METADATA}[specific_trap]")).to eq(0)
+        expect(trap_event.get("#{PDU_METADATA}[timestamp]")).to be(0)
+        expect(trap_event.get("#{PDU_METADATA}[community]")).to eq(community)
+        expect(trap_event.get("#{PDU_METADATA}[variable_bindings]")).to match hash_including('1.3.6.1.2.1.1.1.0' => 'It is a trap')
+        expect(LogStash::Json.load(trap_event.get('message'))).to eq(trap_event.get("#{PDU_METADATA}"))
+      end
+    end
+
+    shared_examples 'a plugin receiving a v2c or v3 trap message' do |version|
+      it 'should process the message' do
+        queue = run_plugin_and_get_queue(plugin) do
+          bindings = { '1.3.6.1.2.1.1.1.0' => "It is a #{version} trap" }
+
+          if version == '2c'
+            @trap_sender.send_trap_v2c(target_address, 'public', bindings)
+          else
+            @trap_sender.send_trap_v3(target_address, security_name, auth_protocol, auth_pass, priv_protocol, priv_pass, security_level, bindings)
+          end
+        end
+
+        expect(queue.size).to be(1)
+
+        trap_event = queue.pop
+
+        # fields
+        expect(trap_event.get('iso.org.dod.internet.mgmt.mib-2.system.sysDescr.0')).to eq("It is a #{version} trap" )
+
+        # metadata
+        expect(trap_event.get("#{PDU_METADATA}[version]")).to eq(version)
+        expect(trap_event.get("#{PDU_METADATA}[type]")).to eq('TRAP')
+        expect(trap_event.get("#{PDU_METADATA}[request_id]")).to be_a(Integer)
+        expect(trap_event.get("#{PDU_METADATA}[error_status]")).to eq(0)
+        expect(trap_event.get("#{PDU_METADATA}[error_status_text]")).to eq('Success')
+        expect(trap_event.get("#{PDU_METADATA}[error_index]")).to eq(0)
+        expect(trap_event.get("#{PDU_METADATA}[community]")).to eq('public') if version == '2c'
+        expect(trap_event.get("#{PDU_METADATA}[variable_bindings]")).to match hash_including('1.3.6.1.2.1.1.1.0' => "It is a #{version} trap")
+        expect(LogStash::Json.load(trap_event.get('message'))).to eq(trap_event.get("#{PDU_METADATA}"))
+      end
+    end
+
+    context 'SNMP v1' do
+      let(:config) { super().merge('supported_versions' => ['1']) }
+      let(:community) { 'public' }
+
+      context 'when receiving a message over TCP' do
+        let(:target_address) { "tcp:127.0.0.1/#{port}" }
+        let(:config) { super().merge('supported_transports' => ['tcp']) }
+
+        it_behaves_like 'a plugin receiving a v1 trap message'
+      end
+
+      context 'when receiving a message over UDP' do
+        let(:config) { super().merge('supported_transports' => ['udp']) }
+
+        it_behaves_like 'a plugin receiving a v1 trap message'
+      end
+
+      context 'when receiving a message with unknown community' do
+        let(:config) { super().merge('community' => "not-#{community}") }
+
+        it 'should not receive a message' do
+          queue = run_plugin_and_get_queue(plugin, timeout: 3) do
+            @trap_sender.send_trap_v1(target_address, community, { '1.3.6.1.2.1.1.1.0' => 'It is a trap' })
+          end
+
+          expect(queue.size).to eq(0)
+        end
+      end
+    end
+
+    context 'SNMP v2c' do
+      let(:community) { 'public' }
+
+      context 'when receiving a message over UDP' do
+        let(:config) { super().merge('supported_transports' => ['udp']) }
+
+        it_behaves_like 'a plugin receiving a v2c or v3 trap message', '2c'
+      end
+
+      context 'when receiving a message over TCP' do
+        let(:target_address) { "tcp:127.0.0.1/#{port}" }
+        let(:config) { super().merge('supported_transports' => ['tcp']) }
+
+        it_behaves_like 'a plugin receiving a v2c or v3 trap message', '2c'
+      end
+
+      context 'when receiving a message with unknown community' do
+        let(:config) { super().merge('community' => "not-#{community}") }
+
+        it 'should not process the message' do
+          queue = run_plugin_and_get_queue(plugin, timeout: 3) do
+            @trap_sender.send_trap_v2c(target_address, community, { '1.3.6.1.2.1.1.1.0' => 'It is a trap' })
+          end
+
+          expect(queue.size).to eq(0)
+        end
+      end
+    end
+
+    context 'SNMP v3' do
+      let(:security_name) { 'user' }
+      let(:auth_protocol) { 'md5' }
+      let(:auth_pass) { 'foo@@Bar' }
+      let(:priv_protocol) { 'aes' }
+      let(:priv_pass) { 'bar@@Foo' }
+      let(:security_level) { 'authPriv' }
+
+      let(:config) do
+        super().merge({
+          'supported_versions' => ['3'],
+          'security_name' => security_name,
+          'auth_protocol' => auth_protocol,
+          'auth_pass' => auth_pass,
+          'priv_protocol' => priv_protocol,
+          'priv_pass' => priv_pass,
+          'security_level' => security_level
+        })
+      end
+
+      context 'when receiving a message over UDP' do
+        let(:config) { super().merge('supported_transports' => ['udp']) }
+
+        it_behaves_like 'a plugin receiving a v2c or v3 trap message', '3'
+      end
+
+      context 'when receiving a message over TCP' do
+        let(:target_address) { "tcp:127.0.0.1/#{port}" }
+        let(:config) { super().merge('supported_transports' => ['tcp']) }
+
+        it_behaves_like 'a plugin receiving a v2c or v3 trap message', '3'
+      end
+
+      context 'when receiving a request with invalid credentials' do
+        it 'should not process the message' do
+          queue = run_plugin_and_get_queue(plugin, timeout: 3) do
+            @trap_sender.send_trap_v3(target_address, security_name, auth_protocol, 'wrong@password', priv_protocol, priv_pass, security_level, {'1.1' => 'foo'})
+          end
+
+          expect(queue.size).to eq(0)
+        end
+      end
+    end
+
+    context 'with supported_versions' do
+      context 'with multiple versions enabled' do
+        let(:security_name) { 'user' }
+        let(:auth_protocol) { 'md5' }
+        let(:auth_pass) { 'foo@@Bar' }
+        let(:priv_protocol) { 'aes' }
+        let(:priv_pass) { 'bar@@Foo' }
+        let(:security_level) { 'authPriv' }
+        let(:config) do
+          super().merge({
+            'supported_versions' => %w[1 2c 3],
+            'security_name' => security_name,
+            'auth_protocol' => auth_protocol,
+            'auth_pass' => auth_pass,
+            'priv_protocol' => priv_protocol,
+            'priv_pass' => priv_pass,
+            'security_level' => security_level
+          })
+        end
+
+        it 'should receive all messages' do
+          queue = run_plugin_and_get_queue(plugin, messages: 4) do
+            oid = '1.3.6.1.2.1.1.1.0'
+            @trap_sender.send_trap_v1(target_address, 'public', { "#{oid}" => '1' })
+            @trap_sender.send_trap_v1(target_address, 'public', { "#{oid}" => '1' })
+            @trap_sender.send_trap_v2c(target_address, 'public', { "#{oid}" => '2c' })
+            @trap_sender.send_trap_v3(target_address, security_name, auth_protocol, auth_pass, priv_protocol, priv_pass, security_level, { "#{oid}" => '3' })
+          end
+
+          expect(queue.size).to eq(4)
+
+          events_per_version = queue.group_by { |event| event.get("#{PDU_METADATA}[version]") }
+          expect(events_per_version['1'].size).to eq(2)
+          expect(events_per_version['2c'].size).to eq(1)
+          expect(events_per_version['3'].size).to eq(1)
+        end
+      end
+
+      context 'with specific version enabled' do
+        let(:config) { super().merge({ 'supported_versions' => ['1'] }) }
+
+        it 'should not process unsupported message versions' do
+          queue = run_plugin_and_get_queue(plugin, timeout: 3) do
+            @trap_sender.send_trap_v2c(target_address, 'public', { '1' => 'foo' })
+          end
+
+          expect(queue.size).to eq(0)
+        end
+      end
+    end
+
+    context 'with oid_mapping_format => dotted_string' do
+      let(:config) { super().merge({ 'oid_mapping_format' => 'dotted_string' }) }
+
+      it 'should have OID fields mapped as dotted string' do
+        event = run_plugin_and_get_queue(plugin) do
+          @trap_sender.send_trap_v1(target_address, 'public', { '1.3.6.1.2.1.1.1.0' => '1.0' })
+        end.pop
+
+        expect(event.get('1.3.6.1.2.1.1.1.0')).to eq('1.0')
+      end
+    end
+
+    context 'with oid_mapping_format => ruby_snmp' do
+      let(:config) { super().merge({ 'oid_mapping_format' => 'ruby_snmp', 'use_provided_mibs' => false }) }
+
+      it 'should have OID fields mapped as dotted string' do
+        event = run_plugin_and_get_queue(plugin) do
+          @trap_sender.send_trap_v1(target_address, 'public', { '1.3.6.1.2.1.1.1.0' => '1.0' })
+        end.pop
+
+        expect(event.get('SNMPv2-MIB::sysDescr.0')).to eq('1.0')
+      end
+    end
+
+    context 'with oid_map_field_values' do
+      context 'set to false' do
+        let(:config) { super().merge('oid_map_field_values' => false) }
+
+        it 'should not map OID field values' do
+          event = run_plugin_and_get_queue(plugin) do
+            @trap_sender.send_trap_v2c(target_address, 'public', { '1.3.6.1.2.1.1.2.0' => org.snmp4j.smi.OID.new('1.3.6.1.4.1.8072.3.2.10') })
+          end.pop
+
+          expect(event).to be_a(LogStash::Event)
+          expect(event.get('iso.org.dod.internet.mgmt.mib-2.system.sysObjectID.0')).to eq('1.3.6.1.4.1.8072.3.2.10')
+        end
+      end
+
+      context 'set to true' do
+        let(:config) { super().merge('oid_map_field_values' => true) }
+
+        it 'should map OID field values' do
+          event = run_plugin_and_get_queue(plugin) do
+            @trap_sender.send_trap_v2c(target_address, 'public', { '1.3.6.1.2.1.1.2.0' => org.snmp4j.smi.OID.new('1.3.6.1.4.1.8072.3.2.10') })
+          end.pop
+
+          expect(event).to be_a(LogStash::Event)
+          expect(event.get('iso.org.dod.internet.mgmt.mib-2.system.sysObjectID.0')).to eq('iso.org.dod.internet.private.enterprises.8072.3.2.10')
+        end
+      end
+    end
+
+    context 'with no MIBs provided' do
+      let(:config) { super().reject { |key, _| key == 'mib_paths' }.merge('use_provided_mibs' => false, 'oid_mapping_format' => 'ruby_snmp') }
+
+      it 'should load default ruby-snmp MIBs' do
+        event = run_plugin_and_get_queue(plugin) do
+          bindings = {
+            '1.3.6.1.2.1.1.2.0' => 'SNMPv2-SMI.dic',
+            '1.3' => 'SNMPv2-MIB.dic',
+            '1.3.6.1.2.1.2.1' => 'IF-MIB.dic',
+            '1.3.6.1.2.1.4' => 'IP-MIB.dic',
+            '1.3.6.1.2.1.6' => 'TCP-MIB.dic',
+            '1.3.6.1.2.1.7.1' => 'UDP-MIB.dic',
+            # non-default ACCOUNTING-CONTROL-MIB::accountingControlMIB
+            '1.3.6.1.2.1.60' => 'ACCOUNTING-CONTROL-MIB.dic'
+          }
+
+          @trap_sender.send_trap_v2c(target_address, 'public', bindings)
+        end.pop
+
+        expect(event).to be_a(LogStash::Event)
+        expect(event.get('SNMPv2-SMI::org')).to_not be_nil
+        expect(event.get('SNMPv2-MIB::sysObjectID.0')).to_not be_nil
+        expect(event.get('IF-MIB::ifNumber')).to_not be_nil
+        expect(event.get('IP-MIB::ip')).to_not be_nil
+        expect(event.get('TCP-MIB::tcp')).to_not be_nil
+        expect(event.get('UDP-MIB::udpInDatagrams')).to_not be_nil
+        expect(event.get('SNMPv2-SMI::mib-2.60')).to_not be_nil
+      end
+    end
+
+    context 'with host' do
+      context 'set to IP address' do
+        let(:ip_address) { IPSocket.getaddress(Socket.gethostname) }
+        let(:config) { super().merge('host' => ip_address, 'oid_mapping_format' => 'dotted_string')}
+
+        it "should only received message through configured host" do
+          queue = run_plugin_and_get_queue(plugin, messages: 2, timeout: 5) do
+            @trap_sender.send_trap_v2c("udp:#{ip_address}/#{port}", 'public', { '1.3.6.1.2.1.1.2.0' => ip_address })
+            @trap_sender.send_trap_v2c("udp:127.0.0.1/#{port}", 'public', { '1.3.6.1.2.1.1.2.0' => 'INVALID' })
+          end
+
+          expect(queue.size).to eq(1)
+          expect(queue.pop.get('1.3.6.1.2.1.1.2.0')).to eq(ip_address)
+        end
+      end
+
+      context 'set to any IPV6 address' do
+        let(:config) { super().merge('host' => '::', 'oid_mapping_format' => 'dotted_string') }
+
+        it "should received message through localhost" do
+          queue = run_plugin_and_get_queue(plugin, messages: 2, timeout: 5) do
+            @trap_sender.send_trap_v2c("udp:localhost/#{port}", 'public', { '1.3.6.1.2.1.1.2.0' => 'IPV6' })
+          end
+
+          expect(queue.size).to eq(1)
+          expect(queue.pop.get('1.3.6.1.2.1.1.2.0')).to eq('IPV6')
+        end
+      end
+    end
+  end
+
+  def run_plugin_and_get_queue(plugin, timeout: 30, register: true, messages: 1, &actions)
+    plugin.register if register
+
+    message_latch = Concurrent::CountDownLatch.new(messages)
+    allow(plugin).to receive(:consume_trap_message).and_wrap_original do |original_method, *args, &block|
+      original_method.call(*args, &block)
+      message_latch.count_down
+    end
+
+    Thread.new do
+      Timeout::timeout(5) do
+        until plugin.client_listening?
+          sleep 0.2
+        end
+      end
+
+      begin
+        actions.call
+        message_latch.wait(timeout)
+      ensure
+        plugin.do_close
+        plugin.do_stop
+      end
+    end
+
+    queue = Concurrent::Array.new
+    plugin.run(queue)
+    queue
+  end
+end

data/spec/unit/inputs/common_spec.rb

@@ -0,0 +1,264 @@
+require 'logstash/devutils/rspec/spec_helper'
+require_relative '../../../lib/logstash/inputs/snmp'
+require_relative '../../../lib/logstash/inputs/snmptrap'
+
+shared_examples 'a common SNMP plugin' do
+  let(:mock_client) { double('org.logstash.snmp.SnmpClient') }
+
+  context 'oid_root_skip and oid_path_length validation' do
+    before(:each) do
+      allow(plugin).to receive(:build_client!).and_return(mock_client)
+    end
+
+    context 'with only `oid_root_skip` set' do
+      let(:config) { super().merge('oid_mapping_format' => 'default', 'oid_root_skip' => 1) }
+      it 'should not raise' do
+        expect { plugin.register }.to_not raise_error
+      end
+    end
+
+    context 'with only `oid_path_length` set' do
+      let(:config) { super().merge('oid_mapping_format' => 'default', 'oid_path_length' => 1) }
+      it 'should not raise' do
+        expect { plugin.register }.to_not raise_error
+      end
+    end
+
+    context 'with `oid_root_skip` and `oid_path_length` set' do
+      let(:config) { super().merge({ 'oid_mapping_format' => 'default', 'oid_root_skip' => 1, 'oid_path_length' => 1 }) }
+      it 'should raise' do
+        expect { plugin.register }.to raise_error(LogStash::ConfigurationError, 'Use either `oid_root_skip` or `oid_path_length`')
+      end
+    end
+  end
+
+  context 'oid_mapping_format validation' do
+    before(:each) do
+      allow(plugin).to receive(:build_client!).and_return(mock_client)
+    end
+
+    context 'with value set to `default`' do
+      let(:config) { super().merge('oid_mapping_format' => 'default') }
+      context 'and oid_root_skip set' do
+        let(:config) { super().merge('oid_root_skip' => 1) }
+        it 'should not raise' do
+          expect { plugin.register }.to_not raise_error
+        end
+      end
+
+      context 'and oid_path_length set' do
+        let(:config) { super().merge('oid_path_length' => 1) }
+        it 'should not raise' do
+          expect { plugin.register }.to_not raise_error
+        end
+      end
+    end
+
+    %w[ruby_snmp dotted_string].each do |format|
+      context "with value set to `#{format}`" do
+        let(:config) { super().merge('oid_mapping_format' => format) }
+
+        context 'and oid_root_skip set' do
+          let(:config) { super().merge('oid_root_skip' => 1) }
+          it 'should raise' do
+            expect { plugin.register }.to raise_error(LogStash::ConfigurationError, 'The `oid_root_skip` and `oid_path_length` requires setting `oid_mapping_format` to `default`')
+          end
+        end
+
+        context 'and oid_path_length set' do
+          let(:config) { super().merge('oid_path_length' => 1) }
+          it 'should raise' do
+            expect { plugin.register }.to raise_error(LogStash::ConfigurationError, 'The `oid_root_skip` and `oid_path_length` requires setting `oid_mapping_format` to `default`')
+          end
+        end
+      end
+    end
+
+    context 'build_mib_manager!' do
+      context 'with mib_paths set' do
+        let(:config) { super().merge('mib_paths' => %w[/foo /bar]) }
+        let(:mock_mib_manager) { double('org.logstash.snmp.mib.MibManager') }
+
+        it 'should add paths to MIB manager' do
+          allow(plugin).to receive(:new_mib_manager).and_return(mock_mib_manager)
+          allow(mock_mib_manager).to receive(:add)
+
+          mib_manager = plugin.build_mib_manager!
+
+          expect(mib_manager).to have_received(:add).with('/foo')
+          expect(mib_manager).to have_received(:add).with('/bar')
+        end
+      end
+
+      context 'with `use_provided_mibs` set to `true`' do
+        let(:config) { super().merge('use_provided_mibs' => true) }
+        let(:mock_mib_manager) { double('org.logstash.snmp.mib.MibManager') }
+
+        it 'should add provided paths to MIB manager' do
+          allow(plugin).to receive(:new_mib_manager).and_return(mock_mib_manager)
+          allow(mock_mib_manager).to receive(:add)
+
+          mib_manager = plugin.build_mib_manager!
+
+          LogStash::PluginMixins::Snmp::Common::MIB_PROVIDED_PATHS.each do |path|
+            expect(mib_manager).to have_received(:add).with(path)
+          end
+        end
+      end
+
+      context 'with `use_provided_mibs` set to `false`' do
+        let(:config) { super().merge('use_provided_mibs' => false) }
+        let(:mock_mib_manager) { double('org.logstash.snmp.mib.MibManager') }
+
+        it 'should not add provided paths to MIB manager' do
+          allow(plugin).to receive(:new_mib_manager).and_return(mock_mib_manager)
+          allow(mock_mib_manager).to receive(:add)
+
+          mib_manager = plugin.build_mib_manager!
+
+          expect(mib_manager).to_not have_received(:add)
+        end
+      end
+
+      { 'default' => org.logstash.snmp.DefaultOidFieldMapper,
+        'ruby_snmp' => org.logstash.snmp.RubySnmpOidFieldMapper,
+        'dotted_string' => org.logstash.snmp.DottedStringOidFieldMapper }.each do |format, expected_kind|
+        context "with `oid_mapping_format` set to `#{format}`" do
+          let(:config) { super().merge('oid_mapping_format' => format) }
+
+          it "should use `#{expected_kind}` field mapper" do
+            mib_manager = plugin.build_mib_manager!
+            expect(mib_manager.getFieldMapper).to be_a expected_kind
+          end
+        end
+      end
+    end
+  end
+
+  context '#build_snmp_client!' do
+    let(:client_builder) { double('org.logstash.snmp.SnmpClientBuilder') }
+
+    context 'with USM user validation' do
+      let(:config) { super().merge('security_name' => 'public') }
+
+      context 'with `security_name` not set' do
+        let(:config) { super().reject! { |k| k == 'security_name'} }
+
+        it 'should raise' do
+          error_message = '`security_name` is required when SNMP v3 is enabled'
+          expect { plugin.build_snmp_client!(client_builder, validate_usm_user: true) }.to raise_error(LogStash::ConfigurationError, error_message)
+        end
+      end
+
+      context 'with `security_level` set to `noAuthNoPriv`' do
+        let(:config) do
+          {
+            'security_name' => 'foobar',
+            'security_level' => 'noAuthNoPriv'
+          }
+        end
+
+        it 'should not raise' do
+          expect(client_builder).to receive(:addUsmUser)
+          expect(client_builder).to receive(:setMapOidVariableValues)
+          expect(client_builder).to receive(:build)
+          expect { plugin.build_snmp_client!(client_builder, validate_usm_user: true) }.to_not raise_error
+        end
+      end
+
+      [{ protocol: 'auth_protocol', pass: 'auth_pass', protocol_value: 'md5', security_levels: %w[authPriv authNoPriv]},
+       { protocol: 'priv_protocol', pass: 'priv_pass', protocol_value: 'des', security_levels: %w[authPriv] }].each do |config|
+        context "with only `#{config[:protocol]}` set" do
+          let(:config) { super().merge((config[:protocol]).to_s => (config[:protocol_value]).to_s ) }
+
+          it 'should raise' do
+            error_message = /Using `#{config[:protocol]}` requires the `#{config[:pass]}`/
+            expect { plugin.build_snmp_client!(client_builder, validate_usm_user: true) }.to raise_error(LogStash::ConfigurationError, error_message)
+          end
+        end
+
+        context "with only `#{config[:pass]}` set" do
+          let(:config) { super().merge((config[:pass]).to_s => 'foobar') }
+
+          it 'should raise' do
+            error_message = /`#{config[:protocol]}` is required when using `#{config[:pass]}`/
+            expect { plugin.build_snmp_client!(client_builder, validate_usm_user: true) }.to raise_error(LogStash::ConfigurationError, error_message)
+          end
+        end
+
+        context "with both `#{config[:protocol]}` and `#{config[:pass]}` set" do
+          let(:config) { super().merge({ "#{config[:protocol]}" => config[:protocol_value], "#{config[:pass]}" => '*' * 10 }) }
+
+          it 'should not raise' do
+            expect(client_builder).to receive(:addUsmUser)
+            expect(client_builder).to receive(:setMapOidVariableValues)
+            expect(client_builder).to receive(:build)
+            expect { plugin.build_snmp_client!(client_builder, validate_usm_user: true) }.to_not raise_error
+          end
+        end
+
+        context "with valid `#{config[:pass]}` length" do
+          let(:config) { super().merge({ "#{config[:protocol]}" => config[:protocol_value], "#{config[:pass]}" => '*' * 8 }) }
+
+          it 'should not raise' do
+            expect(client_builder).to receive(:addUsmUser)
+            expect(client_builder).to receive(:setMapOidVariableValues)
+            expect(client_builder).to receive(:build)
+            expect { plugin.build_snmp_client!(client_builder, validate_usm_user: true) }.to_not raise_error
+          end
+        end
+
+        context "with invalid `#{config[:pass]}` length" do
+          let(:config) { super().merge("#{config[:pass]}" => '**') }
+
+          it 'should raise' do
+            error_message = /`#{config[:pass]}` passphrase must be at least 8 bytes long/
+            expect { plugin.build_snmp_client!(client_builder, validate_usm_user: true) }.to raise_error(LogStash::ConfigurationError, error_message)
+          end
+        end
+
+        config[:security_levels].each do |security_level|
+          context "with `security_level` set to `#{security_level}`" do
+            let(:config) { super().merge('security_level' => security_level) }
+
+            context "and no `#{config[:protocol]}` set" do
+              let(:config) { super().reject { |k| k == config[:protocol] } }
+
+              it 'should raise' do
+                error_message = /Using `security_level` set to `#{security_level}` requires the configuration of `#{config[:protocol]}`/
+                expect { plugin.build_snmp_client!(client_builder, validate_usm_user: true) }.to raise_error(LogStash::ConfigurationError, error_message)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  it 'should default `use_provided_mibs` to `true`' do
+    expect(plugin.config['use_provided_mibs']).to eql(true)
+  end
+
+  it 'should default `oid_mapping_format` to `default`' do
+    expect(plugin.config['oid_mapping_format']).to eql('default')
+  end
+
+  it 'should default `oid_map_field_values` to `false`' do
+    expect(plugin.config['oid_map_field_values']).to  eql(false)
+  end
+end
+
+describe 'SNMP input plugins' do
+  let(:config) { {} }
+  subject(:plugin) { described_class.new(config) }
+
+  describe LogStash::Inputs::Snmp do
+    let(:config) { { 'get' => ['1.3.6.1.2.1.1.1.0'], 'hosts' => [{'host' => 'udp:127.0.0.1/161'}] } }
+
+    it_behaves_like 'a common SNMP plugin'
+  end
+
+  describe LogStash::Inputs::Snmptrap do
+    it_behaves_like 'a common SNMP plugin'
+  end
+end