logstash-input-jms 3.2.0-java → 3.2.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a40f29ee0db67e912d547f5fa74a74bcd08466c3f2594dd9edd5f82669ea494
-  data.tar.gz: c8fa0a986cea0a588b8b68fbd8618f24122ee42abb21ad3cf7f5e7cbb0f3484c
+  metadata.gz: 5dca4ef438036be47078b2db808c88cfd09206a952c793a235cb46ef655067c8
+  data.tar.gz: 1f8e6bd65539c095a4d78488121a08eaee5d5bd24c6eb1f67e35b070550638ff
 SHA512:
-  metadata.gz: a121b9359ff97942888218bb1f2553f469940574e7f8421f7e910980bf37b973fd73cb2e0739a7525c0b71c5e8b4891765f70e505a798d1d9263f0bedbb13eee
-  data.tar.gz: d10f028310928b17f41f48cc50e8393022171d2c2fa4d25502f428f3d2bfbfc6172eee75d527d0ebb9b66f5a3790b6fe9c50fc3de5355dd71a907be33d5f9c5c
+  metadata.gz: 49c794f7452a575a8ce57e168f862e945bb2d57193daca9ff5ac4767b2f9eed39045d5fbed3a8b735fb3c050848d48a8fe2b57febf7a34c19baf9820664c71f3
+  data.tar.gz: 707f05788271a99e6e4eff3555285fa4120e3f6e2b1251ed63ddfbce1e38a2e1a821e59df549f3ac912bc4e221fa6776a320f286e6f8ef8b4f070aa4fed59669

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.2.1
+ - Fix: improve compatibility with MessageConsumer implementations [#51](https://github.com/logstash-plugins/logstash-input-jms/pull/51),
+   such as IBM MQ.
+ - Test: Fix test failures due to ECS compatibility default changes in `8.x` of logstash [#53](https://github.com/logstash-plugins/logstash-input-jms/pull/53)
+
 ## 3.2.0
  - Feat: event_factory support + targets to aid ECS [#49](https://github.com/logstash-plugins/logstash-input-jms/pull/49)
  - Fix: when configured to add JMS headers to the event, headers whose value is not set no longer result in nil entries on the event

data/lib/logstash/inputs/jms.rb

@@ -84,7 +84,7 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
   # If pub-sub (topic) style should be used.
   config :pub_sub, :validate => :boolean, :default => false
 
-  # Durable subscriber settings.
+  # Durable message_consumer settings.
   # By default the `durable_subscriber_name` will be set to the topic, and `durable_subscriber_client_id` will be set
   # to 'Logstash'
   config :durable_subscriber, :validate => :boolean, :default => false
@@ -273,9 +273,9 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
       params = {:timeout => @timeout * 1000, :selector => @selector}
       subscriber = subscriber(session, params)
       until stop?
-        # This will read from the queue/topic until :timeout is breached, or messages are available whichever comes
-        # first.
-        subscriber.each({:timeout => @interval * 1000}) do |message|
+        # read from the queue/topic until :timeout is reached, or a message is available
+        # (whichever comes first)
+        do_receive_message(subscriber, timeout: @interval * 1000) do |message|
           queue_event(message, output_queue)
           break if stop?
         end
@@ -336,6 +336,28 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
     end
   end
 
+  # Loop through messages received and yield them.
+  #
+  # NOTE: a simplified replacement for JMS::MessageConsumer#each and #get (extensions).
+  #
+  # @param message_consumer [javax.jms.MessageConsumer]
+  # @param timeout in milliseconds
+  def do_receive_message(message_consumer, timeout: 0)
+    # Receive messages according to timeout
+    while true
+      case timeout
+      when  0 # Return immediately if no message is available
+        message = message_consumer.receiveNoWait()
+      when -1 # Wait forever
+        message = message_consumer.receive()
+      else # Wait for x milli-seconds for a message to be received from the broker
+        message = message_consumer.receive(timeout)
+      end
+      break unless message
+      yield message
+    end
+  end
+
   def to_string_keyed_hash(hash)
     hash.inject({}) { |h, (key, val)| h[key.to_s] = val; h }
   end

data/logstash-input-jms.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-jms'
-  s.version         = '3.2.0'
+  s.version         = '3.2.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads events from a Jms Broker"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/inputs/integration/jms_spec.rb

@@ -23,11 +23,11 @@ shared_examples_for "a JMS input" do
             msg
           end
           expect(queue.first.get('message')).to eql(message)
-          expect(queue.first.get('jms_destination')).to_not be_nil
-          expect(queue.first.get('jms_timestamp')).to_not be_nil
-          expect(queue.first.get('this')).to be_nil
-          expect(queue.first.get('that')).to be_nil
-          expect(queue.first.get('the_other')).to eql('the_other_prop')
+          expect(queue.first).to have_header('jms_destination')
+          expect(queue.first).to have_header('jms_timestamp')
+          expect(queue.first).not_to have_property('this')
+          expect(queue.first).not_to have_property('this')
+          expect(queue.first).to have_property_value('the_other', 'the_other_prop')
         end
       end
 
@@ -45,8 +45,8 @@ shared_examples_for "a JMS input" do
               msg
             end
             expect(queue.first.get('message')).to eql(message)
-            expect(queue.first.get('this')).to eql(4)
-            expect(queue.first.get('that')).to eql('that_prop')
+            expect(queue.first).to have_property_value('this', 4)
+            expect(queue.first).to have_property_value('that', 'that_prop')
           end
 
           it 'does not process messages that do not conform to the message selector' do
@@ -71,8 +71,8 @@ shared_examples_for "a JMS input" do
               msg
             end
             expect(queue.first.get('message')).to eql(message)
-            expect(queue.first.get('this')).to eql(3)
-            expect(queue.first.get('that')).to eql('that_prop')
+            expect(queue.first).to have_property_value('this', 3)
+            expect(queue.first).to have_property_value('that', 'that_prop')
           end
 
           it 'does not process messages that do not conform to the message selector' do
@@ -97,8 +97,8 @@ shared_examples_for "a JMS input" do
               msg
             end
             expect(queue.first.get('message')).to eql(message)
-            expect(queue.first.get('this')).to be_within(0.001).of(3.1)
-            expect(queue.first.get('that')).to eql('that_prop')
+            expect(get_property_value(queue.first, 'this')).to be_within(0.001).of(3.1)
+            expect(queue.first).to have_property_value('that', 'that_prop')
           end
 
           it 'does not process messages that do not conform to the message selector' do
@@ -124,8 +124,8 @@ shared_examples_for "a JMS input" do
               msg
             end
             expect(queue.first.get('message')).to eql(message)
-            expect(queue.first.get('this')).to eql('this_prop')
-            expect(queue.first.get('that')).to eql('that_prop')
+            expect(queue.first).to have_property_value('this', 'this_prop')
+            expect(queue.first).to have_property_value('that', 'that_prop')
           end
 
           it 'does not process messages that do not conform to the message selector' do
@@ -154,11 +154,11 @@ shared_examples_for "a JMS input" do
             msg
           end
           expect(queue.first.get('message')).to eql(message)
-          expect(queue.first.get('jms_destination')).to be_nil
-          expect(queue.first.get('jms_timestamp')).to_not be_nil
-          expect(queue.first.get('this')).to eq('this_prop')
-          expect(queue.first.get('that')).to eq('that_prop')
-          expect(queue.first.get('the_other')).to eq('the_other_prop')
+          expect(queue.first).not_to have_header('jms_destination')
+          expect(queue.first).to have_header('jms_timestamp')
+          expect(queue.first).to have_property_value('this', 'this_prop')
+          expect(queue.first).to have_property_value('that', 'that_prop')
+          expect(queue.first).to have_property_value('the_other', 'the_other_prop')
         end
       end
 
@@ -293,7 +293,7 @@ shared_examples_for "a JMS input" do
         end
         expect(queue.size).to eql 1
         expect(queue.first.get('message')).to eql 'hello world'
-        expect(queue.first.get("jms_destination")).to eql(destination)
+        expect(queue.first).to have_header_value("jms_destination", destination)
       end
     end
   end

data/spec/inputs/spec_helper.rb

@@ -32,6 +32,42 @@ def send_message(&block)
   end
   input.run(queue)
 
-  destination = "#{pub_sub ? 'topic' : 'queue'}://#{queue_name}"
   tt.join(3)
 end
+
+
+def get_value(type, actual, name)
+  actual.get(name) || actual.get("[@metadata][input][jms][#{type}][#{name}]")
+end
+
+def get_header_value(actual, name)
+  get_value('headers', actual, name)
+end
+
+def get_property_value(actual, name)
+  get_value('properties', actual, name)
+end
+
+RSpec::Matchers.define :have_header do |expected|
+  match do |actual|
+    get_header_value(actual, expected)
+  end
+end
+
+RSpec::Matchers.define :have_property do |expected|
+  match do |actual|
+    get_property_value(actual, expected)
+  end
+end
+
+RSpec::Matchers.define :have_header_value do |header, expected|
+  match do |actual|
+    expected == get_header_value(actual, header)
+  end
+end
+
+RSpec::Matchers.define :have_property_value do |property, expected|
+  match do |actual|
+    expected == get_property_value(actual, property)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jms
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: java
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement