logstash-input-jms 3.0.6-java → 3.1.0-java

data/spec/inputs/spec_helper.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+
+def fixture_path(file)
+  File.join(File.dirname(__FILE__),"fixtures/#{file}")
+end
+
+def send_message(&block)
+  input.register
+
+  tt = Thread.new do
+    sleep 1
+    properties_before_send = java.lang.System.getProperties
+
+    begin
+      input.load_ssl_properties
+      config = input.jms_config_from_yaml(fixture_path('jms.yml'), yaml_section)
+      raise "JMS Provider option:#{jms_provider} not found in jms.yml file" unless config
+      destination_key = pub_sub ? :topic_name : :queue_name
+      JMS::Connection.session(config) do |session|
+        session.producer(destination_key => queue_name) do |producer|
+          msg = yield session unless block.nil?
+          msg ||= session.message(message)
+          producer.send(msg)
+        end
+        session.close
+      end
+      input.do_stop
+    ensure
+      java.lang.System.setProperties(properties_before_send)
+    end
+  end
+  input.run(queue)
+
+  destination = "#{pub_sub ? 'topic' : 'queue'}://#{queue_name}"
+  tt.join(3)
+end

data/spec/inputs/unit/jms_spec.rb

@@ -0,0 +1,256 @@
+require_relative '../spec_helper'
+require 'logstash/inputs/jms'
+require 'jms'
+require 'json'
+
+describe "inputs/jms" do
+  let (:queue_name) {SecureRandom.hex(8)}
+  let (:jms_config) {{'destination' => queue_name}}
+
+  subject(:plugin) { LogStash::Inputs::Jms.new(jms_config) }
+
+  describe 'initialization' do
+
+    context 'with System properties' do
+      let (:jms_config) {{ 'system_properties' => system_properties, 'destination' => 'ExampleQueue'}}
+      let (:system_properties) { { 'JNDI_Connection_Retries_Per_Host' => 7,
+                                   'JNDI_Connect_Retries' => 5 }}
+
+      before :each do
+        subject.register
+      end
+
+      after :each do
+        system_properties.each do |k, v|
+          java.lang.System.clear_property(k)
+        end
+      end
+
+      it 'should populate the system properties' do
+        system_properties.each do |k,v|
+          expect(java.lang.System.get_property(k)).to_not be_nil
+          expect(java.lang.System.get_property(k)).to eq(v.to_s)
+        end
+      end
+    end
+
+    context 'configuration check' do
+      context 'if threads is > 1' do
+          let(:thread_count) { 2 }
+          let(:jms_config) { super.merge({'threads' => thread_count})}
+
+          context 'with pub_sub set to true' do
+            let(:jms_config) { super.merge({'pub_sub' => true})}
+
+            it 'should raise a configuration error' do
+              expect { plugin.register }.to raise_error(LogStash::ConfigurationError)
+            end
+          end
+
+          context 'with pub_sub set to false' do
+            let(:jms_config) { super.merge({'pub_sub' => false})}
+
+            it 'should not raise a configuration error' do
+              plugin.register
+              expect(plugin.threads).to eq(thread_count)
+            end
+        end
+      end
+
+      context 'with durable_subscriber set' do
+        let(:jms_config) { super.merge({ 'pub_sub' => true,
+                                         'durable_subscriber' => true,
+                                         'durable_subscriber_name' => SecureRandom.hex(8),
+                                         'durable_subscriber_client_id' => SecureRandom.hex(8)})}
+
+        context 'if durable_subscriber_client_id is not set' do
+          let(:jms_config) { super.tap { |h| h.delete('durable_subscriber_client_id') } }
+
+          it 'should set client_id to Logstash' do
+            plugin.register
+            expect(plugin.durable_subscriber_client_id).to eq('Logstash')
+          end
+        end
+
+        context 'if durable_subscriber_name is not set' do
+          let(:jms_config) { super.tap { |h| h.delete('durable_subscriber_name') } }
+
+          it 'should set name to the topic name' do
+            plugin.register
+            expect(plugin.durable_subscriber_name).to eq(queue_name)
+          end
+        end
+
+
+        context 'if pub_sub is set to false' do
+          let(:jms_config) { super.merge({'pub_sub' => false})}
+          it 'should raise a configuration error' do
+            expect { plugin.register }.to raise_error(LogStash::ConfigurationError)
+          end
+        end
+      end
+    end
+
+
+    context 'via yaml file' do
+      let (:yaml_section) { 'activemq' }
+      let (:jms_config) {{'yaml_file' => fixture_path(file), 'yaml_section' => yaml_section, 'destination' => SecureRandom.hex(8)}}
+
+      context 'simple yaml configuration' do
+        let (:file) { "jms.yml" }
+        let (:password) { 'the_password' }
+
+        it 'should populate jms config from the yaml file' do
+          expect(plugin.jms_config).to include({:broker_url => "tcp://localhost:61616",
+                                             :password => password,
+                                             :factory=>"org.apache.activemq.ActiveMQConnectionFactory",
+                                             :require_jars=>["activemq-all.jar"]})
+        end
+        it 'should not log the password in plaintext' do
+          expect(plugin.logger).to receive(:debug) do |_, params|
+            expect(params[:context]).to include(:password)
+            expect(params[:context][:password]).not_to eq(password)
+          end
+
+          plugin.register
+        end
+
+      end
+
+      context 'jndi yaml configuration' do
+        let (:file) { "jndijms.yml" }
+        let (:yaml_section) { 'solace' }
+
+        it 'should populate jms config from the yaml file' do
+          expect(plugin.jms_config).to include({:jndi_context=>{
+              "java.naming.factory.initial"=>"com.solacesystems.jndi.SolJNDIInitialContextFactory",
+              "java.naming.security.principal"=>"username",
+              "java.naming.provider.url"=>"tcp://localhost:20608",
+              "java.naming.security.credentials"=>"password"},
+                                             :jndi_name => "/jms/cf/default",
+                                             :require_jars => ["commons-lang-2.6.jar",
+                                                               "sol-jms-10.5.0.jar",
+                                                               "geronimo-jms_1.1_spec-1.1.1.jar",
+                                                               "commons-lang-2.6.jar"]})
+        end
+        it 'should not log the password in plaintext' do
+          expect(plugin.logger).to receive(:debug) do |_, params|
+            expect(params[:context]).not_to include(:password)
+          end
+          plugin.register
+        end
+      end
+    end
+
+    context 'simple configuration' do
+      let (:password) { 'the_password' }
+      let (:jms_config) {{
+          'destination' => 'ExampleQueue',
+          'username' => 'user',
+          'password' => password,
+          'broker_url' => 'tcp://localhost:61616',
+          'pub_sub' => true,
+          'factory' => 'org.apache.activemq.ActiveMQConnectionFactory',
+          'require_jars' => ['activemq-all-5.15.8.jar']
+      }}
+      it 'should populate jms config from the configuration' do
+        expect(plugin.jms_config).to include({:broker_url => "tcp://localhost:61616",
+                                           :factory=>"org.apache.activemq.ActiveMQConnectionFactory",
+                                           :require_jars=>["activemq-all-5.15.8.jar"]})
+      end
+      it 'should not log the password in plaintext' do
+        expect(plugin.logger).to receive(:debug) do |_, params|
+          expect(params[:context]).to include(:password)
+          expect(params[:context][:password]).not_to eq(password)
+        end
+
+        plugin.register
+      end
+    end
+
+    context 'simple configuration with jndi' do
+      let (:jms_config) {{
+          'destination' => 'ExampleQueue',
+          'jndi_name' => "/jms/cf/default",
+          "jndi_context" => {
+              "java.naming.factory.initial"=>"com.solacesystems.jndi.SolJNDIInitialContextFactory",
+              "java.naming.security.principal"=>"username",
+              "java.naming.provider.url"=>"tcp://localhost:20608",
+              "java.naming.security.credentials"=>"password"},
+          'pub_sub' => true,
+          "require_jars" => ["commons-lang-2.6.jar",
+                             "sol-jms-10.5.0.jar",
+                             "geronimo-jms_1.1_spec-1.1.1.jar",
+                             "commons-lang-2.6.jar"]}}
+
+
+      it 'should populate jms config from the configuration' do
+        expect(plugin.jms_config).to include({:jndi_context=>{
+            "java.naming.factory.initial"=>"com.solacesystems.jndi.SolJNDIInitialContextFactory",
+            "java.naming.security.principal"=>"username",
+            "java.naming.provider.url"=>"tcp://localhost:20608",
+            "java.naming.security.credentials"=>"password"},
+                                           :jndi_name => "/jms/cf/default",
+                                           :require_jars => ["commons-lang-2.6.jar",
+                                                             "sol-jms-10.5.0.jar",
+                                                             "geronimo-jms_1.1_spec-1.1.1.jar",
+                                                             "commons-lang-2.6.jar"]})
+      end
+    end
+  end
+
+  describe '#error_hash' do
+    context 'should handle Java exceptions with a chain of causes' do
+      let (:raised) { java.lang.Exception.new("Outer", java.lang.RuntimeException.new("middle", java.io.IOException.new("Inner")))}
+
+      it 'should find contain the root cause of a java exception cause chain' do
+        expect(plugin.error_hash(raised)[:exception].to_s).to eql("Java::JavaLang::Exception")
+        expect(plugin.error_hash(raised)[:exception_message].to_s).to eql("Outer")
+        expect(plugin.error_hash(raised)[:root_cause][:exception]).to eql("Java::JavaIo::IOException")
+        expect(plugin.error_hash(raised)[:root_cause][:exception_message]).to eql("Inner")
+        expect(plugin.error_hash(raised)[:root_cause][:exception_loop]).to be_falsey
+      end
+    end
+
+    context 'should handle Java Exceptions with a cause chain loop' do
+      let (:inner)  { java.io.IOException.new("Inner") }
+      let (:middle) { java.lang.RuntimeException.new("Middle", inner) }
+      let (:raised) { java.lang.Exception.new("Outer", middle)}
+
+      before :each do
+        inner.init_cause(middle)
+      end
+
+      it 'should not go into an infinite loop' do
+        expect(plugin.error_hash(raised)[:exception].to_s).to eql("Java::JavaLang::Exception")
+        expect(plugin.error_hash(raised)[:exception_message].to_s).to eql("Outer")
+        expect(plugin.error_hash(raised)[:root_cause][:exception]).to eql("Java::JavaLang::RuntimeException")
+        expect(plugin.error_hash(raised)[:root_cause][:exception_message]).to eql("Middle")
+      end
+
+      it 'should report that an exception loop was detected' do
+        expect(plugin.error_hash(raised)[:root_cause][:exception_loop]).to be_truthy
+      end
+    end
+
+    context 'should handle Java Exceptions with no cause' do
+      let (:raised) { java.lang.Exception.new("Only")}
+
+      it 'should populate exception, exception_message but not root_cause' do
+        expect(plugin.error_hash(raised)[:exception].to_s).to eql("Java::JavaLang::Exception")
+        expect(plugin.error_hash(raised)[:exception_message].to_s).to eql("Only")
+        expect(plugin.error_hash(raised)[:root_cause]).to be_nil
+      end
+    end
+
+    context 'should handle Ruby Errors' do
+      let (:raised) { StandardError.new("Ruby") }
+
+      it 'should populate exception, exception_message but not root_cause' do
+        expect(plugin.error_hash(raised)[:exception].to_s).to eql("StandardError")
+        expect(plugin.error_hash(raised)[:exception_message].to_s).to eql("Ruby")
+        expect(plugin.error_hash(raised)[:root_cause]).to be_nil
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jms
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.1.0
 platform: java
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -115,8 +115,14 @@ files:
 - docs/index.asciidoc
 - lib/logstash/inputs/jms.rb
 - logstash-input-jms.gemspec
-- spec/inputs/jms.yml
-- spec/inputs/jms_spec.rb
+- spec/inputs/fixtures/activemq_plaintext.xml
+- spec/inputs/fixtures/activemq_ssl.xml
+- spec/inputs/fixtures/jms.yml
+- spec/inputs/fixtures/jndijms.yml
+- spec/inputs/fixtures/keystore.jks
+- spec/inputs/integration/jms_spec.rb
+- spec/inputs/spec_helper.rb
+- spec/inputs/unit/jms_spec.rb
 homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -144,5 +150,11 @@ signing_key:
 specification_version: 4
 summary: Reads events from a Jms Broker
 test_files:
-- spec/inputs/jms.yml
-- spec/inputs/jms_spec.rb
+- spec/inputs/fixtures/activemq_plaintext.xml
+- spec/inputs/fixtures/activemq_ssl.xml
+- spec/inputs/fixtures/jms.yml
+- spec/inputs/fixtures/jndijms.yml
+- spec/inputs/fixtures/keystore.jks
+- spec/inputs/integration/jms_spec.rb
+- spec/inputs/spec_helper.rb
+- spec/inputs/unit/jms_spec.rb

data/spec/inputs/jms.yml

@@ -1,18 +0,0 @@
----
-# HornetQ Broker
-hornetq:
-  # Connect to a local HornetQ Broker using JNDI
-  :jndi_name: /ConnectionFactory
-  :jndi_context:
-    java.naming.factory.initial: org.jnp.interfaces.NamingContextFactory
-    java.naming.provider.url: jnp://localhost:1099
-    java.naming.factory.url.pkgs: org.jboss.naming:org.jnp.interfaces
-    java.naming.security.principal: guest
-    java.naming.security.credentials: guest
-  :require_jars:
-    - /Applications/hornetq-2.4.0.Final/lib/hornetq-commons.jar
-    - /Applications/hornetq-2.4.0.Final/lib/hornetq-core-client.jar
-    - /Applications/hornetq-2.4.0.Final/lib/hornetq-jms-client.jar
-    - /Applications/hornetq-2.4.0.Final/lib/jboss-jms-api.jar
-    - /Applications/hornetq-2.4.0.Final/lib/jnp-client.jar
-    - /Applications/hornetq-2.4.0.Final/lib/netty.jar

data/spec/inputs/jms_spec.rb

@@ -1,30 +0,0 @@
-require "logstash/devutils/rspec/spec_helper"
-require "logstash/inputs/jms"
-require "jms"
-
-describe LogStash::Inputs::Jms do
-  let(:queue) { Queue.new }
-  let(:jms_config) {{:require_jars => ["some.jar"],  :jndi_name => "", :jndi_context => {}}}
-  let(:config) do
-    config = { "destination" => "ExampleQueue" }
-    jms_config.each {|k, v| config[k.to_s] = v }
-    config
-  end
-  subject { LogStash::Inputs::Jms.new(config.dup) }
-
-  context "using default runner (consumer)" do
-    before :each do
-      subject.register
-    end
-
-    it "should call the consumer runner" do
-      expect(subject).to receive(:run_consumer).with(queue)
-      subject.run(queue)
-    end
-
-    it "should create a JMS session based on JMS config" do
-      expect(JMS::Connection).to receive(:session).with(jms_config)
-      subject.run(queue)
-    end
-  end
-end