logstash-mixin-rabbitmq_connection 6.0.0-java → 6.2.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd7fc8e31d1c925fe7f8aa9f2fcd35ecf711060d15f3ec6b3bf1587ce6e3e853
-  data.tar.gz: 2bd3d32bd653b36eb943667b43b6fe495f3bf6a448aa4b7a21df2beba82f7386
+  metadata.gz: facc2c0bbb94d9ffe28e084637a8bffdafd34b6b7ac1585bf44a519d4043253c
+  data.tar.gz: d7462fe30d31bd4851210100e0ddf6506a3045f2777dc877a77c06a320f24abd
 SHA512:
-  metadata.gz: f0d7510ed02b889bab83f1837f4f4452d18573323f4fec480333fe9652b77db559a4289895fc858cc96794fd1625bd6a163282b35a99847f2eddd4718f942ac1
-  data.tar.gz: 1b9d536f7e0c4d5a5648696e6cf19d752e482407e765b8c4a2b0a3857ab608b790588ca8e28b27827c5ce5891e6ca17f1341e36fb1bc3fc7d304775e3215505f
+  metadata.gz: bf0e3772d6d7ef7b0c1f9c77aab348a1dd8fe2bba5d7afa78abbdc4cacd72f13397406d6a7edc7aef0493ad17f71e74d0ef5be81517bcbf4a3200773d4a0eda0
+  data.tar.gz: 5b3790fa5d4dc80eed67701bd05712ede0299d0b2569905385758f54c7a9ab17fd87fe4cca9602128176eb1dacc7210f45c1b49202d98a77e42830a60346e961

data/.ci/docker-compose.yml

@@ -0,0 +1,17 @@
+version: '3'
+
+# run tests:  cd ci/unit; docker-compose up --build --force-recreate
+# manual:  cd ci/unit; docker-compose run logstash bash
+services:
+
+  logstash:
+    build:
+      context: ../
+      dockerfile: .ci/Dockerfile
+      args:
+        - ELASTIC_STACK_VERSION=$ELASTIC_STACK_VERSION
+    command: .ci/run.sh
+    environment:
+      LS_JAVA_OPTS: "-Xmx256m -Xms256m"
+      LOGSTASH_SOURCE: 1
+    tty: true

data/.ci/run.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+ # This is intended to be run inside the docker container as the command of the docker-compose.
+set -ex
+
+ #bundle exec rspec -fd --pattern spec/**/*_spec.rb,spec/**/*_specs.rb
+bundle exec rspec -fd

data/.travis.yml

@@ -1,19 +1,2 @@
----
-sudo: false
-language: ruby
-cache: bundler
-matrix:
-  include:
-  - rvm: jruby-9.1.13.0
-    env: LOGSTASH_BRANCH=master
-  - rvm: jruby-9.1.13.0
-    env: LOGSTASH_BRANCH=6.x
-  - rvm: jruby-9.1.13.0
-    env: LOGSTASH_BRANCH=6.5
-  - rvm: jruby-1.7.27
-    env: LOGSTASH_BRANCH=5.6
-  fast_finish: true
-install: true
-script: ci/build.sh
-jdk: oraclejdk8
-before_install: gem install bundler -v '< 2'
+import:
+  - logstash-plugins/.ci:travis/travis.yml@1.x

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 6.2.0
+  - Remove ruby pipeline dependency. Starting from Logstash 8, Ruby execution engine is not available. All pipelines should use Java pipeline [#64](https://github.com/logstash-plugins/logstash-mixin-rabbitmq_connection/pull/64)
+  - Updated ci setting to use the share ci repository
+## 6.1.1
+   - Fixed issue with custom port assignment when multiple hosts are specified. [#54](https://github.com/logstash-plugins/logstash-mixin-rabbitmq_connection/pull/54)
+
+## 6.1.0
+   - Updated `march_hare` dependency to `4.x`, which enables consumers to reliably manage a connection blocked/unblocked state machine that survives connection recovery.
+   - Removed support for Logstash 5.x since `march_hare` >= 3.x is not compatible.
+
 ## 6.0.0
    - Removed obsolete options `verify_ssl`, `debug`, `tls_certificate_path` and `tls_certificate_password`
 

data/lib/logstash/plugin_mixins/rabbitmq_connection.rb

@@ -3,6 +3,7 @@ require "logstash/outputs/base"
 require "logstash/namespace"
 require "march_hare"
 require "java"
+require "stud/interval"
 
 # Common functionality for the rabbitmq input/output
 module LogStash
@@ -95,8 +96,7 @@ module LogStash
 
         s = {
           :vhost => @vhost,
-          :hosts => @host,
-          :port  => @port,
+          :addresses => addresses_from_hosts_and_port(@host, @port),
           :user  => @user,
           :automatic_recovery => @automatic_recovery,
           :pass => @password ? @password.value : "guest",
@@ -122,6 +122,42 @@ module LogStash
         @rabbitmq_settings = s
       end
 
+
+      # Adds port to the value of host if it is not already supplied
+      def format_address(host, port)
+        case host.count(':')
+        when 0
+          "#{host}:#{port}"
+        when 1
+          host
+        else
+          format_ipv6(host, port)
+        end
+      end
+
+      # Formats an IPv6 to include the port, if it is not already given, conforming to the format used for
+      # literal IPv6 addresses in URIs,
+      # eg [2406:da00:ff00::6b15:edbc]:80
+      def format_ipv6(host, port)
+        last_bracket = host.rindex(']')
+        if last_bracket
+          if last_bracket < host.rindex(':')
+            host
+          else
+            "#{host}:#{port}"
+          end
+        else
+          "[#{host}]:#{port}"
+        end
+      end
+
+      def addresses_from_hosts_and_port(hosts, port)
+        # Expand host to include port, unless port is already present
+        # (Allowing hosts with port was a previously undocumented feature)
+        hosts.map{|host|format_address(host, port)}
+      end
+
+
       def connect!
         @hare_info = connect() unless @hare_info # Don't duplicate the conn!
       rescue MarchHare::Exception, java.io.IOException => e

data/logstash-mixin-rabbitmq_connection.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |s|
   s.name            = 'logstash-mixin-rabbitmq_connection'
-  s.version         = '6.0.0'
+  s.version         = '6.2.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Common functionality for RabbitMQ plugins"
   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"
@@ -17,7 +17,12 @@ Gem::Specification.new do |s|
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 
   s.platform = RUBY_PLATFORM
-  s.add_runtime_dependency 'march_hare', ['~> 3.0'] #(MIT license)
+
+  # MarchHare 3.x+ includes ruby syntax from 2.x
+  # This effectively requires Logstash >= 6.x
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_runtime_dependency 'march_hare', ['~> 4.0'] #(MIT license)
   s.add_runtime_dependency 'stud', '~> 0.0.22'
 
   s.add_development_dependency 'logstash-devutils'

data/spec/plugin_mixins/rabbitmq_connection_spec.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
-require "logstash/pipeline"
 require "logstash/plugin_mixins/rabbitmq_connection"
 require "stud/temporary"
 
@@ -14,12 +13,12 @@ end
 
 describe LogStash::PluginMixins::RabbitMQConnection do
   let(:klass) { TestPlugin }
+  let(:default_port) { 5672 }
   let(:host) { "localhost" }
-  let(:port) { 5672 }
+  let(:port) { default_port }
   let(:rabbitmq_settings) {
     {
-      "host" => host,
-      "port" => port,
+      "host" => host
     }
   }
   let(:instance) {
@@ -27,6 +26,24 @@ describe LogStash::PluginMixins::RabbitMQConnection do
   }
   let(:hare_info) { instance.instance_variable_get(:@hare_info) }
 
+
+
+  shared_examples_for 'it sets the addresses correctly' do
+    let(:file) { Stud::Temporary.file }
+    let(:path) { file.path }
+
+    it "should set addresses to the expected value" do
+      host.each_with_index do |_, index|
+        puts(expected_values[index])
+        expect(instance.rabbitmq_settings[:addresses][index]).to eql(expected_values[index])
+      end
+    end
+
+    it "should insert the correct number of address entries" do
+      expect(instance.rabbitmq_settings[:addresses].length).to eql(host.count)
+    end
+  end
+
   describe "rabbitmq_settings" do
     let(:file) { Stud::Temporary.file }
     let(:path) { file.path }
@@ -59,12 +76,70 @@ describe LogStash::PluginMixins::RabbitMQConnection do
       expect(instance.rabbitmq_settings[:tls_certificate_password]).to eql(rabbitmq_settings["ssl_certificate_password"])
     end
 
-    it "should set hosts to the expected value " do
-      expect(instance.rabbitmq_settings[:hosts][0]).to eql(host)
+    context 'with host names' do
+      let (:host) {%w(localhost rmq.elastic.co rmq.local)}
+      let (:expected_values) {%w(localhost:5672 rmq.elastic.co:5672 rmq.local:5672)}
+
+      it_behaves_like 'it sets the addresses correctly'
+    end
+
+    context 'with host names including ports' do
+      let (:host) {%w(localhost:123 rmq.elastic.co:234 rmq.local:345)}
+      let (:expected_values) {%w(localhost:123 rmq.elastic.co:234 rmq.local:345)}
+
+      it_behaves_like 'it sets the addresses correctly'
     end
 
-    it "should only insert a single host entry" do
-      expect(instance.rabbitmq_settings[:hosts].length).to eql(1)
+    context 'with ipv4 ip addresses' do
+      let (:host) {%w(127.0.0.1 192.168.1.1 192.168.1.2)}
+      let (:expected_values) {%w(127.0.0.1:5672 192.168.1.1:5672 192.168.1.2:5672)}
+
+      it_behaves_like 'it sets the addresses correctly'
+    end
+
+    context 'with ipv4 ip addresses including ports' do
+      let (:host) {%w(127.0.0.1:123 192.168.1.1:234 192.168.1.2:345)}
+      let (:expected_values) {host}
+
+      it_behaves_like 'it sets the addresses correctly'
+    end
+
+    context 'with ipv6 addresses' do
+      let (:host) {%w(::1 fe80::1c86:a2e:4bec:4a9f%en0 2406:da00:ff00::36e1:f792 [::1] [fe80::1c86:a2e:4bec:4a9f%en0] [2406:da00:ff00::36e1:f792])}
+      let (:expected_values) {%w([::1]:5672 [fe80::1c86:a2e:4bec:4a9f%en0]:5672 [2406:da00:ff00::36e1:f792]:5672 [::1]:5672 [fe80::1c86:a2e:4bec:4a9f%en0]:5672 [2406:da00:ff00::36e1:f792]:5672)}
+      it_behaves_like 'it sets the addresses correctly'
+    end
+
+    context 'with ipv6 addresses including ports' do
+      let (:host) {%w([::1]:456 [fe80::1c86:a2e:4bec:4a9f%en0]:457 [2406:da00:ff00::36e1:f792]:458)}
+      let (:expected_values) {%w([::1]:456 [fe80::1c86:a2e:4bec:4a9f%en0]:457 [2406:da00:ff00::36e1:f792]:458)}
+      it_behaves_like 'it sets the addresses correctly'
+    end
+
+    context 'with a custom port' do
+      let(:port) { 123 }
+      let(:rabbitmq_settings) { super.merge({"port" => port})}
+
+      context 'with hostnames' do
+        let (:host) {%w(localhost rmq.elastic.co rmq.local)}
+        let (:expected_values) {%w(localhost:123 rmq.elastic.co:123 rmq.local:123)}
+
+        it_behaves_like 'it sets the addresses correctly'
+      end
+
+
+      context 'with ipv4 ip addresses' do
+        let (:host) {%w(127.0.0.1 192.168.1.1 192.168.1.2)}
+        let (:expected_values) {%w(127.0.0.1:123 192.168.1.1:123 192.168.1.2:123)}
+
+        it_behaves_like 'it sets the addresses correctly'
+      end
+
+      context 'with ipv6 addresses' do
+        let (:host) {%w(::1 fe80::1c86:a2e:4bec:4a9f%en0 2406:da00:ff00::36e1:f792 [::1] [fe80::1c86:a2e:4bec:4a9f%en0] [2406:da00:ff00::36e1:f792])}
+        let (:expected_values) {%w([::1]:123 [fe80::1c86:a2e:4bec:4a9f%en0]:123 [2406:da00:ff00::36e1:f792]:123 [::1]:123 [fe80::1c86:a2e:4bec:4a9f%en0]:123 [2406:da00:ff00::36e1:f792]:123)}
+        it_behaves_like 'it sets the addresses correctly'
+      end
     end
   end
 
@@ -79,23 +154,6 @@ describe LogStash::PluginMixins::RabbitMQConnection do
     end
 
   end
-  describe "rabbitmq_settings multiple hosts" do
-    let(:file) { Stud::Temporary.file }
-    let(:path) { file.path }
-    after { File.unlink(path)}
-
-    let(:rabbitmq_settings) { super.merge({"host" => ["host01", "host02", "host03"]}) }
-
-    it "should set hosts to the expected value" do
-      expect(instance.rabbitmq_settings[:hosts][0]).to eql("host01")
-      expect(instance.rabbitmq_settings[:hosts][1]).to eql("host02")
-      expect(instance.rabbitmq_settings[:hosts][2]).to eql("host03")
-    end
-
-    it "should insert 3 host entries" do
-      expect(instance.rabbitmq_settings[:hosts].length).to eql(3)
-    end
-  end
 
   context "when connected" do
     let(:connection) { double("MarchHare Connection") }

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: logstash-mixin-rabbitmq_connection
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.2.0
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   name: march_hare
   prerelease: false
   type: :runtime
@@ -23,7 +23,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -88,6 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ci/docker-compose.yml"
+- ".ci/run.sh"
 - ".github/CONTRIBUTING.md"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
@@ -97,8 +99,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- ci/build.sh
-- ci/setup.sh
 - lib/logstash/plugin_mixins/rabbitmq_connection.rb
 - logstash-mixin-rabbitmq_connection.gemspec
 - spec/fixtures/README.md
@@ -142,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/ci/build.sh

@@ -1,21 +0,0 @@
-#!/bin/bash
-# version: 1
-########################################################
-#
-# AUTOMATICALLY GENERATED! DO NOT EDIT
-#
-########################################################
-set -e
-
-echo "Starting build process in: `pwd`"
-source ./ci/setup.sh
-
-if [[ -f "ci/run.sh" ]]; then
-    echo "Running custom build script in: `pwd`/ci/run.sh"
-    source ./ci/run.sh
-else
-    echo "Running default build scripts in: `pwd`/ci/build.sh"
-    bundle install
-    bundle exec rake vendor
-    bundle exec rspec spec
-fi

data/ci/setup.sh

@@ -1,26 +0,0 @@
-#!/bin/bash
-# version: 1
-########################################################
-#
-# AUTOMATICALLY GENERATED! DO NOT EDIT
-#
-########################################################
-set -e
-if [ "$LOGSTASH_BRANCH" ]; then
-    echo "Building plugin using Logstash source"
-    BASE_DIR=`pwd`
-    echo "Checking out branch: $LOGSTASH_BRANCH"
-    git clone -b $LOGSTASH_BRANCH https://github.com/elastic/logstash.git ../../logstash --depth 1
-    printf "Checked out Logstash revision: %s\n" "$(git -C ../../logstash rev-parse HEAD)"
-    cd ../../logstash
-    echo "Building plugins with Logstash version:"
-    cat versions.yml
-    echo "---"
-    # We need to build the jars for that specific version
-    echo "Running gradle assemble in: `pwd`"
-    ./gradlew assemble
-    cd $BASE_DIR
-    export LOGSTASH_SOURCE=1
-else
-    echo "Building plugin using released gems on rubygems"
-fi