logstash-input-jms 3.1.0-java → 3.2.1-java

data/spec/inputs/integration/jms_spec.rb

@@ -1,11 +1,8 @@
 require_relative '../spec_helper'
 require 'logstash/inputs/jms'
-require 'jms'
-require 'json'
+require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
 require 'securerandom'
 
-
-
 shared_examples_for "a JMS input" do
   context 'when inputting messages' do
     let (:destination) { "#{pub_sub ? 'topic' : 'queue'}://#{queue_name}"}
@@ -15,7 +12,7 @@ shared_examples_for "a JMS input" do
       let(:message) { "Hello There" }
 
       context 'when properties are skipped' do
-        let (:jms_config) { super.merge({'skip_properties' => ['this', 'that']})}
+        let (:config) { super().merge({'skip_properties' => ['this', 'that']})}
 
         it 'should skip the specified property and process other properties, headers and the message' do
           send_message do |session|
@@ -25,17 +22,17 @@ shared_examples_for "a JMS input" do
             msg.set_string_property('the_other', 'the_other_prop')
             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.get('message')).to eql(message)
+          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
 
       context 'when using message selectors' do
-        let (:jms_config) { super.merge({'selector' => selector }) }
+        let (:config) { super().merge({'selector' => selector }) }
 
         context 'with multiple selector query parameter' do
           let (:selector) { "this = 3 OR this = 4" }
@@ -47,9 +44,9 @@ shared_examples_for "a JMS input" do
               msg.set_int_property('this', 4)
               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.get('message')).to eql(message)
+            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
@@ -73,9 +70,9 @@ shared_examples_for "a JMS input" do
               msg.set_int_property('this', 3)
               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.get('message')).to eql(message)
+            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
@@ -100,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
@@ -126,9 +123,9 @@ shared_examples_for "a JMS input" do
               msg.set_string_property('that', 'that_prop')
               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.get('message')).to eql(message)
+            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
@@ -145,7 +142,8 @@ shared_examples_for "a JMS input" do
       end
 
       context 'when headers are skipped' do
-        let (:jms_config) { super.merge({'skip_headers' => ['jms_destination', 'jms_reply_to']})}
+        let (:config) { super().merge('skip_headers' => ['jms_destination', 'jms_reply_to']) }
+
         it 'should skip the specified header and process other headers, properties and the message' do
           send_message do |session|
             msg = session.message(message)
@@ -155,42 +153,133 @@ shared_examples_for "a JMS input" do
             msg.set_string_property('the_other', 'the_other_prop')
             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.get('message')).to eql(message)
+          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
 
-      context 'when neither header nor property is skipped ' do
-        it 'should process properties, headers and the message' do
+      context 'when include_headers => false' do
+        let (:config) { super().merge('include_headers' => 'false') }
+
+        it 'should skip all headers' do
           send_message do |session|
             msg = session.message(message)
-            msg.set_string_property('this', 'this_prop')
-            msg.set_string_property('that', 'that_prop')
-            msg.set_string_property('the_other', 'the_other_prop')
+            msg.reply_to = session.create_destination(:topic_name => SecureRandom.hex(8))
+            msg.set_string_property('some', 'property')
+            msg
+          end
+          event = queue.first.to_hash_with_metadata
+          expect( event.keys.find { |name| name.start_with?('jms_') } ).to be nil
+        end
+      end
+
+      context 'when include_header => false (deprecated)' do
+        let (:config) { super().merge('include_header' => 'false') }
+
+        it 'should skip all headers' do
+          send_message do |session|
+            msg = session.message(message)
+            msg.reply_to = session.create_destination(:topic_name => SecureRandom.hex(8))
+            msg.set_string_property('some', 'property')
             msg
           end
-          expect(queue.first.get('message')).to eql (message)
-          expect(queue.first.get('jms_timestamp')).to_not be_nil
-          expect(queue.first.get('jms_destination')).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')
+          event = queue.first.to_hash_with_metadata
+          expect( event.keys.find { |name| name.start_with?('jms_') } ).to be nil
+        end
+      end
+
+      context 'when neither header nor property is skipped', :ecs_compatibility_support do
+        ecs_compatibility_matrix(:disabled, :v1, :v8) do |ecs_select|
+
+          let(:ecs_compatibility?) { ecs_select.active_mode != :disabled }
+
+          let (:config) { super().merge('ecs_compatibility' => ecs_select.active_mode) }
+
+          it 'should process properties, headers and the message' do
+            send_message do |session|
+              msg = session.message(message)
+              msg.set_string_property('this', 'this_prop')
+              msg.set_int_property('camelCase', 42)
+              msg.set_boolean_property('JMSFlag', true)
+              msg
+            end
+
+            event = queue.first
+
+            expect(event.get('message')).to eql(message)
+
+            # headers
+            if ecs_compatibility?
+              expect(event.include?('jms_timestamp')).to be false
+              expect(event.include?('jms_destination')).to be false
+              expect(event.get('[@metadata][input][jms][headers][jms_timestamp]')).to be_a Integer
+              expect(event.get('[@metadata][input][jms][headers][jms_destination]')).to_not be nil
+              expect(event.include?("[@metadata][input][jms][headers][jms_delivery_mode_sym]")).to be false
+              expect(event.include?("[@metadata][input][jms][headers][jms_delivery_mode]")).to be true
+            else
+              expect(event.get('jms_timestamp')).to be_a Integer
+              expect(event.get('jms_destination')).to_not be nil
+              expect(event.include?("jms_delivery_mode_sym")).to be true
+            end
+
+            # properties
+            if ecs_compatibility?
+              expect(event.include?('this')).to be false
+              expect(event.get('[@metadata][input][jms][properties][this]')).to eq 'this_prop'
+              expect(event.get('[@metadata][input][jms][properties][camelCase]')).to eq 42
+              expect(event.get('[@metadata][input][jms][properties][JMSFlag]')).to be true
+            else
+              expect(event.get('this')).to eq 'this_prop'
+              expect(event.get('camelCase')).to eq 42
+              expect(event.get('JMSFlag')).to be true
+            end
+          end
+
         end
       end
     end
 
-    context 'when the message is map message' do
-      let(:message) { {:one => 1} }
-      it 'should read the message' do
-        send_message
-        expect(queue.size).to eql 1
-        expect(queue.first.get('one')).to eql (1)
-        expect(queue.first.get("jms_destination")).to eql(destination)
+    context 'when the message is map message', :ecs_compatibility_support do
+
+      ecs_compatibility_matrix(:disabled, :v1, :v8) do |ecs_select|
+
+        let(:ecs_compatibility?) { ecs_select.active_mode != :disabled }
+
+        let (:config) { super().merge('ecs_compatibility' => ecs_select.active_mode) }
+
+        let(:message) { {:one => 1} }
+
+        before do
+          if ecs_compatibility?
+            expect(subject.logger).to receive(:info).once.with /ECS compatibility is enabled but `target` option was not specified/i
+          end
+        end
+
+        it 'should read the message' do
+          send_message
+
+          expect(queue.size).to eql 1
+          event = queue.first
+          expect(event.get('one')).to eql 1
+
+          if ecs_compatibility?
+            expect(event.get('[@metadata][input][jms][headers][jms_destination]')).to eql(destination)
+            expect(event.get('[@metadata][input][jms][headers][jms_delivery_mode]')).to eql 'persistent'
+            expect(event.include?('[@metadata][input][jms][headers][jms_delivery_mode_sym]')).to be false
+          else
+            expect(event.get("jms_destination")).to eql(destination)
+            expect(event.get("jms_delivery_mode_sym")).to eql :persistent
+          end
+
+          send_message # should not log the ECS warning again
+        end
+
       end
+
     end
 
     context 'when the message is a bytes message' do
@@ -203,17 +292,26 @@ shared_examples_for "a JMS input" do
           jms_message
         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.get('message')).to eql 'hello world'
+        expect(queue.first).to have_header_value("jms_destination", destination)
       end
     end
   end
 end
 
-describe "input/jms", :integration => true do
+describe LogStash::Inputs::Jms, :integration => true do
   let (:message) { "hello World" }
   let (:queue_name) { SecureRandom.hex(8)}
 
+  let (:yaml_section) { 'activemq' }
+  let (:config) {{'yaml_file' => fixture_path("jms.yml"),
+                      'yaml_section' => yaml_section,
+                      'destination' => queue_name,
+                      'pub_sub' => pub_sub,
+                      'interval' => 2}}
+
+  subject(:input) { described_class.new(config) }
+
   before :each do
     allow(input).to receive(:jms_config_from_yaml) do |yaml_file, section|
       settings = YAML.load_file(yaml_file)[section]
@@ -222,14 +320,6 @@ describe "input/jms", :integration => true do
     end
   end
 
-  let (:yaml_section) { 'activemq' }
-  let (:jms_config) {{'yaml_file' => fixture_path("jms.yml"),
-                      'yaml_section' => yaml_section,
-                      'destination' => queue_name,
-                      'pub_sub' => pub_sub,
-                      'interval' => 2}}
-  let(:input) { LogStash::Plugin.lookup("input", "jms").new(jms_config) }
-
   after :each do
     input.close unless input.nil?
   end
@@ -241,7 +331,7 @@ describe "input/jms", :integration => true do
     end
 
     context 'with pub_sub true and durable subscriber' do
-      let (:jms_config) { super.merge({'durable_subscriber' => true,
+      let (:config) { super().merge({'durable_subscriber' => true,
                            'durable_subscriber_client_id' => SecureRandom.hex(8),
                            'durable_subscriber_name' => SecureRandom.hex(8) } ) }
 
@@ -258,8 +348,8 @@ describe "input/jms", :integration => true do
 
   context 'with tls', :tls => true do
     let (:yaml_section) { 'activemq_tls' }
-    let (:jms_config) { super.merge({"keystore" => fixture_path("keystore.jks"), "keystore_password" => "changeit",
-                                     "truststore" => fixture_path("keystore.jks"), "truststore_password" => "changeit"})}
+    let (:config) { super().merge({"keystore" => fixture_path("keystore.jks"), "keystore_password" => "changeit",
+                                   "truststore" => fixture_path("keystore.jks"), "truststore_password" => "changeit"})}
 
     context 'with pub_sub true' do
       let (:pub_sub) { true }
@@ -267,7 +357,7 @@ describe "input/jms", :integration => true do
     end
 
     context 'with pub_sub true and durable subscriber' do
-      let (:jms_config) { super.merge({'durable_subscriber' => true,
+      let (:config) { super().merge({'durable_subscriber' => true,
                            'durable_subscriber_client_id' => SecureRandom.hex(8),
                            'durable_subscriber_name' => SecureRandom.hex(8) } ) }
 

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

data/spec/inputs/unit/jms_spec.rb

@@ -1,9 +1,9 @@
 require_relative '../spec_helper'
 require 'logstash/inputs/jms'
-require 'jms'
-require 'json'
+require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
+require 'securerandom'
 
-describe "inputs/jms" do
+describe LogStash::Inputs::Jms do
   let (:queue_name) {SecureRandom.hex(8)}
   let (:jms_config) {{'destination' => queue_name}}
 
@@ -37,10 +37,10 @@ describe "inputs/jms" do
     context 'configuration check' do
       context 'if threads is > 1' do
           let(:thread_count) { 2 }
-          let(:jms_config) { super.merge({'threads' => thread_count})}
+          let(:jms_config) { super().merge({'threads' => thread_count})}
 
           context 'with pub_sub set to true' do
-            let(:jms_config) { super.merge({'pub_sub' => true})}
+            let(:jms_config) { super().merge({'pub_sub' => true})}
 
             it 'should raise a configuration error' do
               expect { plugin.register }.to raise_error(LogStash::ConfigurationError)
@@ -48,7 +48,7 @@ describe "inputs/jms" do
           end
 
           context 'with pub_sub set to false' do
-            let(:jms_config) { super.merge({'pub_sub' => false})}
+            let(:jms_config) { super().merge({'pub_sub' => false})}
 
             it 'should not raise a configuration error' do
               plugin.register
@@ -58,13 +58,13 @@ describe "inputs/jms" do
       end
 
       context 'with durable_subscriber set' do
-        let(:jms_config) { super.merge({ 'pub_sub' => true,
+        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') } }
+          let(:jms_config) { super().tap { |h| h.delete('durable_subscriber_client_id') } }
 
           it 'should set client_id to Logstash' do
             plugin.register
@@ -73,7 +73,7 @@ describe "inputs/jms" do
         end
 
         context 'if durable_subscriber_name is not set' do
-          let(:jms_config) { super.tap { |h| h.delete('durable_subscriber_name') } }
+          let(:jms_config) { super().tap { |h| h.delete('durable_subscriber_name') } }
 
           it 'should set name to the topic name' do
             plugin.register
@@ -83,7 +83,7 @@ describe "inputs/jms" do
 
 
         context 'if pub_sub is set to false' do
-          let(:jms_config) { super.merge({'pub_sub' => false})}
+          let(:jms_config) { super().merge({'pub_sub' => false})}
           it 'should raise a configuration error' do
             expect { plugin.register }.to raise_error(LogStash::ConfigurationError)
           end
@@ -253,4 +253,60 @@ describe "inputs/jms" do
       end
     end
   end
+
+  context 'invalid configuration' do
+    let (:jms_config) { super().merge('include_headers' => true, 'include_header' => false) }
+
+    it 'should raise a configuration error' do
+      expect { subject.register }.to raise_error LogStash::ConfigurationError,
+                                                 /Both `include_headers => true` and `include_header => false` options are specified/i
+    end
+  end
+
+  context 'targets', :ecs_compatibility_support do
+
+    ecs_compatibility_matrix(:disabled, :v1, :v8) do |ecs_select|
+
+      let (:jms_config) do
+        super().merge(
+            'include_body' => false,
+            'include_headers' => true, 'headers_target' => '@metadata',
+            'include_properties' => true, 'properties_target' => '[@metadata]'
+        )
+      end
+
+      let(:jms_timestamp) { 1 }
+
+      let(:jms_message_double) do
+        message = double('jms-message-stub')
+        allow(message).to receive(:jms_timestamp).and_return(jms_timestamp)
+        allow_any_instance_of(described_class).to receive(:map_headers).and_return(
+            'jms_message_id' => 'id1', 'jms_timestamp' => jms_timestamp, 'jms_expiration' => nil
+        )
+        allow(message).to receive(:properties).and_return(:foo => 'bar', 'the-baz' => 42)
+        message
+      end
+
+      before(:each) do
+        allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
+
+        plugin.register
+        plugin.queue_event(jms_message_double, queue = [])
+        expect(queue.size).to eql 1
+        @event = queue.first
+      end
+
+      it 'sets headers into meta-data' do
+        expect( @event.get('[@metadata][jms_timestamp]') ).to eql jms_timestamp
+        expect( @event.get('[@metadata][jms_message_id]') ).to_not be nil
+      end
+
+      it 'sets properties as meta-data' do
+        expect( @event.get('[@metadata][foo]') ).to eql 'bar'
+        expect( @event.get('[@metadata][the-baz]') ).to eql 42
+      end
+
+    end
+
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jms
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.1
 platform: java
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -61,17 +61,45 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
-  name: semantic_logger
+        version: '1.3'
+  name: logstash-mixin-ecs_compatibility_support
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-mixin-event_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-mixin-validator_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -86,6 +114,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  name: semantic_logger
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -144,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Reads events from a Jms Broker