logstash-integration-jdbc 5.0.1 → 5.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a71840d1b072e13fc4ddcc96cee6a6f68e8c12608167a138858c147c11795509
-  data.tar.gz: e782665b9e41de726ccf59e6110d7f2f77fc49127ce4bfe6c5bf16683ab2ffb2
+  metadata.gz: fd1883c21c6bbe0cdfb87cf641cc106d59cb5e4b43b9a7c7de547d9e1ff263f4
+  data.tar.gz: 749710ce22a5c81ce8bb3b024803a2075052cd21aff5870ade488b7ae4dddef7
 SHA512:
-  metadata.gz: 9166b1b3b4e0d461da084d78e5f69ad12ea07d33d61331520bfe755f920df5c406e414f9c60d2209e2432237c6842b1a627b2a852a91cfc250fa4fee0b934f70
-  data.tar.gz: 906d918fd928c2263ec6f1497d7995e7c0f6d9caa8044e23dcc2f8cb020c44c3c83372ed1cf808f3ee86aea33529d7b4378df778fa908ca2c5a97814e45df817
+  metadata.gz: 0c3b0320dc3dfab3381fb2a62642e37e99445178f8d569e3f63dc0d1c83a4f4959398e4ca87163328380d28d389388bf5741a8dcbffd0a7897c151d518871690
+  data.tar.gz: 77961a244d1fbfd0c9d5cf0049eb868fdd423869828733fc1a8e76cdede5f8d9bc9731ecf7668691aa0fbdbc805a5864a035cacb2c834c43a9eb6b594460f72c

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 5.0.6
+  - DOC:Replaced plugin_header file with plugin_header-integration file. [#40](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/40)
+
+## 5.0.5
+  - Fixed user sequel_opts not being passed down properly [#37](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/37)
+  - Refactored jdbc_streaming to share driver loading, so the fixes from the jdbc plugin also effect jdbc_streaming
+
+## 5.0.4
+  - Fixed issue where JDBC Drivers that don't correctly register with Java's DriverManager fail to load (such as Sybase) [#34](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/34)
+
+## 5.0.3
+  - Fixed issue where a lost connection to the database can cause errors when using prepared statements with the scheduler [#25](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/25)
+
+## 5.0.2
+  - Fixed potential resource leak by ensuring scheduler is shutdown when a pipeline encounter an error during the running [#28](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/28)
+
 ## 5.0.1
   - Fixed tracking_column regression with Postgresql Numeric types [#17](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/17)
   - Fixed driver loading when file not accessible [#15](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/15)

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/docs/filter-jdbc_static.asciidoc

@@ -1,3 +1,4 @@
+:integration: jdbc
 :plugin: jdbc_static
 :type: filter
 
@@ -16,7 +17,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 === Jdbc_static filter plugin
 
-include::{include_path}/plugin_header.asciidoc[]
+include::{include_path}/plugin_header-integration.asciidoc[]
 
 ==== Description
 

data/docs/filter-jdbc_streaming.asciidoc

@@ -1,3 +1,4 @@
+:integration: jdbc
 :plugin: jdbc_streaming
 :type: filter
 
@@ -16,7 +17,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 === Jdbc_streaming filter plugin
 
-include::{include_path}/plugin_header.asciidoc[]
+include::{include_path}/plugin_header-integration.asciidoc[]
 
 ==== Description
 

data/docs/input-jdbc.asciidoc

@@ -1,3 +1,4 @@
+:integration: jdbc
 :plugin: jdbc
 :type: input
 :default_codec: plain
@@ -17,7 +18,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 === Jdbc input plugin
 
-include::{include_path}/plugin_header.asciidoc[]
+include::{include_path}/plugin_header-integration.asciidoc[]
 
 ==== Description
 

data/lib/logstash/filters/jdbc/basic_database.rb

@@ -95,7 +95,7 @@ module LogStash module Filters module Jdbc
       end
       begin
         db = nil
-        ::Sequel::JDBC.load_driver(driver_class)
+        @options_hash[:driver] = ::Sequel::JDBC.load_driver(driver_class)
         @connection_string = connection_string
         if user
           @options_hash[:user] = user

data/lib/logstash/filters/jdbc_streaming.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require "logstash/filters/base"
 require "logstash/namespace"
+require "logstash/plugin_mixins/jdbc/common"
 require "logstash/plugin_mixins/jdbc_streaming"
 require "logstash/plugin_mixins/jdbc_streaming/cache_payload"
 require "logstash/plugin_mixins/jdbc_streaming/statement_handler"
@@ -46,6 +47,7 @@ require "lru_redux"
 # }
 #
 module LogStash module Filters class JdbcStreaming < LogStash::Filters::Base
+  include LogStash::PluginMixins::Jdbc::Common
   include LogStash::PluginMixins::JdbcStreaming
 
   config_name "jdbc_streaming"

data/lib/logstash/inputs/jdbc.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require "logstash/inputs/base"
 require "logstash/namespace"
+require "logstash/plugin_mixins/jdbc/common"
 require "logstash/plugin_mixins/jdbc/jdbc"
 
 # this require_relative returns early unless the JRuby version is between 9.2.0.0 and 9.2.8.0
@@ -126,6 +127,7 @@ require_relative "tzinfo_jruby_patch"
 # ---------------------------------------------------------------------------------------------------
 #
 module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
+  include LogStash::PluginMixins::Jdbc::Common
   include LogStash::PluginMixins::Jdbc::Jdbc
   config_name "jdbc"
 
@@ -283,6 +285,10 @@ module LogStash module Inputs class Jdbc < LogStash::Inputs::Base
     end
   end # def run
 
+  def close
+    @scheduler.shutdown if @scheduler
+  end
+
   def stop
     close_jdbc_connection
     @scheduler.shutdown(:wait) if @scheduler

data/lib/logstash/plugin_mixins/jdbc/common.rb

@@ -0,0 +1,66 @@
+
+module LogStash module PluginMixins module Jdbc
+  module Common
+
+    private
+
+    def complete_sequel_opts(defaults = {})
+      sequel_opts = @sequel_opts.
+          map { |key,val| [key.is_a?(String) ? key.to_sym : key, val] }.
+          map { |key,val| [key, val.eql?('true') ? true : (val.eql?('false') ? false : val)] }
+      sequel_opts = defaults.merge Hash[sequel_opts]
+      sequel_opts[:user] = @jdbc_user unless @jdbc_user.nil? || @jdbc_user.empty?
+      sequel_opts[:password] = @jdbc_password.value unless @jdbc_password.nil?
+      sequel_opts[:driver] = @driver_impl # Sequel uses this as a fallback, if given URI doesn't auto-load the driver correctly
+      sequel_opts
+    end
+
+    def load_driver
+      return @driver_impl if @driver_impl ||= nil
+
+      require "java"
+      require "sequel"
+      require "sequel/adapters/jdbc"
+
+      load_driver_jars
+      begin
+        @driver_impl = Sequel::JDBC.load_driver(@jdbc_driver_class)
+      rescue Sequel::AdapterNotFound => e # Sequel::AdapterNotFound, "#{@jdbc_driver_class} not loaded"
+        # fix this !!!
+        message = if jdbc_driver_library_set?
+                    "Are you sure you've included the correct jdbc driver in :jdbc_driver_library?"
+                  else
+                    ":jdbc_driver_library is not set, are you sure you included " +
+                        "the proper driver client libraries in your classpath?"
+                  end
+        raise LogStash::PluginLoadingError, "#{e}. #{message}"
+      end
+    end
+
+    def load_driver_jars
+      if jdbc_driver_library_set?
+        @jdbc_driver_library.split(",").each do |driver_jar|
+          @logger.debug("loading #{driver_jar}")
+          # load 'driver.jar' is different than load 'some.rb' as it only causes the file to be added to
+          # JRuby's class-loader lookup (class) path - won't raise a LoadError when file is not readable
+          unless FileTest.readable?(driver_jar)
+            raise LogStash::PluginLoadingError, "unable to load #{driver_jar} from :jdbc_driver_library, " +
+                "file not readable (please check user and group permissions for the path)"
+          end
+          begin
+            require driver_jar
+          rescue LoadError => e
+            raise LogStash::PluginLoadingError, "unable to load #{driver_jar} from :jdbc_driver_library, #{e.message}"
+          rescue StandardError => e
+            raise LogStash::PluginLoadingError, "unable to load #{driver_jar} from :jdbc_driver_library, #{e}"
+          end
+        end
+      end
+    end
+
+    def jdbc_driver_library_set?
+      !@jdbc_driver_library.nil? && !@jdbc_driver_library.empty?
+    end
+
+  end
+end end end

data/lib/logstash/plugin_mixins/jdbc/jdbc.rb

@@ -106,17 +106,12 @@ module LogStash  module PluginMixins module Jdbc
 
     private
     def jdbc_connect
-      opts = {
-      :user => @jdbc_user,
-      :password => @jdbc_password.nil? ? nil : @jdbc_password.value,
-      :pool_timeout => @jdbc_pool_timeout,
-      :keep_reference => false
-      }.merge(@sequel_opts)
+      sequel_opts = complete_sequel_opts(:pool_timeout => @jdbc_pool_timeout, :keep_reference => false)
       retry_attempts = @connection_retry_attempts
       loop do
         retry_attempts -= 1
         begin
-          return Sequel.connect(@jdbc_connection_string, opts=opts)
+          return Sequel.connect(@jdbc_connection_string, sequel_opts)
         rescue Sequel::PoolTimeout => e
           if retry_attempts <= 0
             @logger.error("Failed to connect to database. #{@jdbc_pool_timeout} second timeout exceeded. Tried #{@connection_retry_attempts} times.")
@@ -127,7 +122,7 @@ module LogStash  module PluginMixins module Jdbc
         # rescue Java::JavaSql::SQLException, ::Sequel::Error => e
         rescue ::Sequel::Error => e
           if retry_attempts <= 0
-            @logger.error("Unable to connect to database. Tried #{@connection_retry_attempts} times", :error_message => e.message, )
+            @logger.error("Unable to connect to database. Tried #{@connection_retry_attempts} times", :error_message => e.message)
             raise e
           else
             @logger.error("Unable to connect to database. Trying again", :error_message => e.message)
@@ -137,56 +132,6 @@ module LogStash  module PluginMixins module Jdbc
       end
     end
 
-    private
-
-    def load_driver
-      if @drivers_loaded.false?
-        require "java"
-        require "sequel"
-        require "sequel/adapters/jdbc"
-
-        load_driver_jars
-        begin
-          Sequel::JDBC.load_driver(@jdbc_driver_class)
-        rescue Sequel::AdapterNotFound => e # Sequel::AdapterNotFound, "#{@jdbc_driver_class} not loaded"
-          # fix this !!!
-          message = if jdbc_driver_library_set?
-                      "Are you sure you've included the correct jdbc driver in :jdbc_driver_library?"
-                    else
-                      ":jdbc_driver_library is not set, are you sure you included " +
-                          "the proper driver client libraries in your classpath?"
-                    end
-          raise LogStash::PluginLoadingError, "#{e}. #{message}"
-        end
-        @drivers_loaded.make_true
-      end
-    end
-
-    def load_driver_jars
-      if jdbc_driver_library_set?
-        @jdbc_driver_library.split(",").each do |driver_jar|
-          @logger.debug("loading #{driver_jar}")
-          # load 'driver.jar' is different than load 'some.rb' as it only causes the file to be added to
-          # JRuby's class-loader lookup (class) path - won't raise a LoadError when file is not readable
-          unless FileTest.readable?(driver_jar)
-            raise LogStash::PluginLoadingError, "unable to load #{driver_jar} from :jdbc_driver_library, " +
-                "file not readable (please check user and group permissions for the path)"
-          end
-          begin
-            require driver_jar
-          rescue LoadError => e
-            raise LogStash::PluginLoadingError, "unable to load #{driver_jar} from :jdbc_driver_library, #{e.message}"
-          rescue StandardError => e
-            raise LogStash::PluginLoadingError, "unable to load #{driver_jar} from :jdbc_driver_library, #{e}"
-          end
-        end
-      end
-    end
-
-    def jdbc_driver_library_set?
-      !@jdbc_driver_library.nil? && !@jdbc_driver_library.empty?
-    end
-
     def open_jdbc_connection
       # at this point driver is already loaded
       Sequel.application_timezone = @plugin_timezone.to_sym
@@ -229,7 +174,6 @@ module LogStash  module PluginMixins module Jdbc
     public
     def prepare_jdbc_connection
       @connection_lock = ReentrantLock.new
-      @drivers_loaded = Concurrent::AtomicBoolean.new
     end
 
     public
@@ -260,7 +204,9 @@ module LogStash  module PluginMixins module Jdbc
         end
         success = true
       rescue Sequel::DatabaseConnectionError, Sequel::DatabaseError, Java::JavaSql::SQLException => e
-        @logger.warn("Exception when executing JDBC query", :exception => e)
+        details = { :exception => e.message }
+        details[:backtrace] = e.backtrace if @logger.debug?
+        @logger.warn("Exception when executing JDBC query", details)
       else
         @value_tracker.set_value(sql_last_value)
       ensure

data/lib/logstash/plugin_mixins/jdbc/statement_handler.rb

@@ -97,7 +97,14 @@ module LogStash module PluginMixins module Jdbc
       end
       bind_value_sql_last_value(sql_last_value)
       statement_logger.log_statement_parameters(statement, parameters, nil)
-      db.call(name, parameters)
+      begin
+        db.call(name, parameters)
+      rescue => e
+        # clear the statement prepared flag - the statement may be closed by this
+        # time.
+        statement_prepared.make_false
+        raise e
+      end
     end
 
     def post_init(plugin)

data/lib/logstash/plugin_mixins/jdbc_streaming.rb

@@ -55,37 +55,11 @@ module LogStash module PluginMixins module JdbcStreaming
     config :jdbc_validation_timeout, :validate => :number, :default => 3600
   end
 
-  private
-
-  def load_driver_jars
-    unless @jdbc_driver_library.nil? || @jdbc_driver_library.empty?
-      @jdbc_driver_library.split(",").each do |driver_jar|
-        begin
-          @logger.debug("loading #{driver_jar}")
-          # Use https://github.com/jruby/jruby/wiki/CallingJavaFromJRuby#from-jar-files to make classes from jar
-          # available
-          require driver_jar
-        rescue LoadError => e
-          raise LogStash::PluginLoadingError, "unable to load #{driver_jar} from :jdbc_driver_library, #{e.message}"
-        end
-      end
-    end
-  end
-
   public
   def prepare_jdbc_connection
-    require "sequel"
-    require "sequel/adapters/jdbc"
-    require "java"
-
-    load_driver_jars
-
-    @sequel_opts_symbols = @sequel_opts.inject({}) {|hash, (k,v)| hash[k.to_sym] = v; hash}
-    @sequel_opts_symbols[:user] = @jdbc_user unless @jdbc_user.nil? || @jdbc_user.empty?
-    @sequel_opts_symbols[:password] = @jdbc_password.value unless @jdbc_password.nil?
+    load_driver
 
-    Sequel::JDBC.load_driver(@jdbc_driver_class)
-    @database = Sequel.connect(@jdbc_connection_string, @sequel_opts_symbols)
+    @database = Sequel.connect(@jdbc_connection_string, complete_sequel_opts)
     if @jdbc_validate_connection
       @database.extension(:connection_validator)
       @database.pool.connection_validation_timeout = @jdbc_validation_timeout

data/logstash-integration-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-integration-jdbc'
-  s.version         = '5.0.1'
+  s.version         = '5.0.6'
   s.licenses = ['Apache License (2.0)']
   s.summary         = "Integration with JDBC - input and filter 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"

data/spec/filters/integration/jdbc_static_spec.rb

@@ -4,7 +4,6 @@ require "logstash/filters/jdbc_static"
 require "sequel"
 require "sequel/adapters/jdbc"
 require "stud/temporary"
-require "timecop"
 
 module LogStash module Filters
   describe JdbcStatic, :integration => true do
@@ -35,6 +34,7 @@ module LogStash module Filters
     let(:settings) do
       {
         "jdbc_user" => ENV['USER'],
+        "jdbc_password" => ENV["POSTGRES_PASSWORD"],
         "jdbc_driver_class" => "org.postgresql.Driver",
         "jdbc_driver_library" => "/usr/share/logstash/postgresql.jar",
         "staging_directory" => temp_import_path_plugin,
@@ -88,6 +88,7 @@ module LogStash module Filters
         let(:settings) do
           {
             "jdbc_user" => ENV['USER'],
+            "jdbc_password" => ENV["POSTGRES_PASSWORD"],
             "jdbc_driver_class" => "org.postgresql.Driver",
             "jdbc_driver_library" => "/usr/share/logstash/postgresql.jar",
             "staging_directory" => temp_import_path_plugin,
@@ -134,18 +135,16 @@ module LogStash module Filters
     describe "scheduled operation" do
       context "given a loader_schedule" do
         it "should properly schedule" do
-          settings["loader_schedule"] = "*/10 * * * * * UTC"
-          Timecop.travel(Time.now.utc - 3600)
-          Timecop.scale(60)
+          settings["loader_schedule"] = "*/3 * * * * * UTC"
           static_filter = JdbcStatic.new(settings)
           runner = Thread.new(static_filter) do |filter|
             filter.register
           end
-          sleep 3
+          runner.join(4)
+          sleep 4
           static_filter.filter(event)
           expect(static_filter.loader_runner.reload_count).to be > 1
           static_filter.close
-          Timecop.return
           expect(event.get("server")).to eq([{"ip"=>"10.3.1.1", "name"=>"mv-server-1", "location"=>"MV-9-6-4"}])
         end
       end

data/spec/filters/integration/jdbcstreaming_spec.rb

@@ -16,7 +16,10 @@ module LogStash module Filters
       "jdbc:postgresql://postgresql:5432") + "/jdbc_streaming_db?user=postgres"
 
     let(:mixin_settings) do
-      { "jdbc_driver_class" => "org.postgresql.Driver",
+      {
+        "jdbc_user" => ENV['USER'],
+        "jdbc_password" => ENV["POSTGRES_PASSWORD"],
+        "jdbc_driver_class" => "org.postgresql.Driver",
         "jdbc_driver_library" => "/usr/share/logstash/postgresql.jar",
         "jdbc_connection_string" => jdbc_connection_string
       }

data/spec/filters/jdbc/read_only_database_spec.rb

@@ -10,28 +10,37 @@ module LogStash module Filters module Jdbc
     let(:driver_class) { "org.apache.derby.jdbc.EmbeddedDriver" }
     let(:driver_library) { nil }
     subject(:read_only_db) { described_class.create(connection_string, driver_class, driver_library) }
+    let(:stub_driver_class) { double(driver_class).as_null_object }
 
     describe "basic operations" do
       describe "initializing" do
+        before(:each) do
+          allow(Sequel::JDBC).to receive(:load_driver).and_return(stub_driver_class)
+        end
+
         it "tests the connection with defaults" do
           expect(Sequel::JDBC).to receive(:load_driver).once.with(driver_class)
-          expect(Sequel).to receive(:connect).once.with(connection_string, {:test => true})
+          expect(Sequel).to receive(:connect).once.with(connection_string, {:test => true, :driver => stub_driver_class})
           expect(read_only_db.empty_record_set).to eq([])
         end
 
-        it "tests the connection with fully specified arguments" do
-          connection_str = "a connection string"
-          user = "a user"
-          password = Util::Password.new("secret")
-          expect(Sequel::JDBC).to receive(:load_driver).once.with("a driver class")
-          expect(Sequel).to receive(:connect).once.with(connection_str, {:user => user, :password =>  password.value, :test => true}).and_return(db)
-          described_class.create(connection_str, "a driver class", nil, user, password)
+        context 'with fully-specified arguments' do
+          let(:connection_string) { "a connection string" }
+          let(:user) { "a user" }
+          let(:password) { Util::Password.new("secret") }
+          let(:driver_class) { "a driver class" }
+
+          it "tests the connection" do
+            expect(Sequel::JDBC).to receive(:load_driver).once.with(driver_class)
+            expect(Sequel).to receive(:connect).once.with(connection_string, {:user => user, :password =>  password.value, :test => true, :driver => stub_driver_class}).and_return(db)
+            described_class.create(connection_string, driver_class, nil, user, password)
+          end
         end
 
         it "connects with defaults" do
           expect(Sequel::JDBC).to receive(:load_driver).once.with(driver_class)
-          expect(Sequel).to receive(:connect).once.with(connection_string, {:test => true}).and_return(db)
-          expect(Sequel).to receive(:connect).once.with(connection_string, {}).and_return(db)
+          expect(Sequel).to receive(:connect).once.with(connection_string, {:test => true, :driver => stub_driver_class}).and_return(db)
+          expect(Sequel).to receive(:connect).once.with(connection_string, {:driver => stub_driver_class}).and_return(db)
           expect(read_only_db.connected?).to be_falsey
           read_only_db.connect("a caller specific error message")
           expect(read_only_db.connected?).to be_truthy

data/spec/filters/jdbc/read_write_database_spec.rb

@@ -16,10 +16,11 @@ module LogStash module Filters module Jdbc
     describe "basic operations" do
       context "connecting  to a db" do
         it "connects with defaults" do
-          expect(::Sequel::JDBC).to receive(:load_driver).once.with("org.apache.derby.jdbc.EmbeddedDriver")
+          stub_driver_class = double('org.apache.derby.jdbc.EmbeddedDriver').as_null_object
+          expect(::Sequel::JDBC).to receive(:load_driver).once.with("org.apache.derby.jdbc.EmbeddedDriver").and_return(stub_driver_class)
           # two calls to connect because ReadWriteDatabase does verify_connection and connect
-          expect(::Sequel).to receive(:connect).once.with(connection_string_regex, {:test => true}).and_return(db)
-          expect(::Sequel).to receive(:connect).once.with(connection_string_regex, {}).and_return(db)
+          expect(::Sequel).to receive(:connect).once.with(connection_string_regex, {:driver => stub_driver_class, :test => true}).and_return(db)
+          expect(::Sequel).to receive(:connect).once.with(connection_string_regex, {:driver => stub_driver_class}).and_return(db)
           expect(read_write_db.empty_record_set).to eq([])
         end
 
@@ -27,9 +28,10 @@ module LogStash module Filters module Jdbc
           connection_str = "a connection string"
           user = "a user"
           password = Util::Password.new("secret")
-          expect(::Sequel::JDBC).to receive(:load_driver).once.with("a driver class")
-          expect(::Sequel).to receive(:connect).once.with(connection_str, {:user => user, :password => password.value, :test => true}).and_return(db)
-          expect(::Sequel).to receive(:connect).once.with(connection_str, {:user => user, :password => password.value}).and_return(db)
+          stub_driver_class = double('com.example.Driver')
+          expect(::Sequel::JDBC).to receive(:load_driver).once.with("a driver class").and_return(stub_driver_class)
+          expect(::Sequel).to receive(:connect).once.with(connection_str, {:driver => stub_driver_class, :user => user, :password => password.value, :test => true}).and_return(db)
+          expect(::Sequel).to receive(:connect).once.with(connection_str, {:driver => stub_driver_class, :user => user, :password => password.value}).and_return(db)
           described_class.create(connection_str, "a driver class", nil, user, password)
         end
       end

data/spec/filters/jdbc_streaming_spec.rb

@@ -1,4 +1,5 @@
 require "logstash/devutils/rspec/spec_helper"
+require "logstash/devutils/rspec/shared_examples"
 require "logstash/filters/jdbc_streaming"
 require 'jdbc/derby'
 require "sequel"

data/spec/inputs/integration/integ_spec.rb

@@ -3,7 +3,6 @@ require "logstash/inputs/jdbc"
 require "sequel"
 require "sequel/adapters/jdbc"
 
-# This test requires: Firebird installed to Mac OSX, it uses the built-in example database `employee`
 
 describe LogStash::Inputs::Jdbc, :integration => true do
   # This is a necessary change test-wide to guarantee that no local timezone
@@ -19,6 +18,7 @@ describe LogStash::Inputs::Jdbc, :integration => true do
       "jdbc_connection_string" => jdbc_connection_string,
       "jdbc_driver_library" => "/usr/share/logstash/postgresql.jar",
       "jdbc_user" => "postgres",
+      "jdbc_password" => ENV["POSTGRES_PASSWORD"],
       "statement" => 'SELECT FIRST_NAME, LAST_NAME FROM "employee" WHERE EMP_NO = 2'
     }
   end

data/spec/inputs/jdbc_spec.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
+require "logstash/devutils/rspec/shared_examples"
 require "logstash/inputs/jdbc"
 require "jdbc/derby"
 require "sequel"
@@ -12,9 +13,13 @@ require "date"
 # We do not need to set TZ env var anymore because we can have 'Sequel.application_timezone' set to utc by default now.
 
 describe LogStash::Inputs::Jdbc do
+  let(:connection_string) { "jdbc:derby:memory:testdb;create=true" }
   let(:mixin_settings) do
-    { "jdbc_user" => ENV['USER'], "jdbc_driver_class" => "org.apache.derby.jdbc.EmbeddedDriver",
-      "jdbc_connection_string" => "jdbc:derby:memory:testdb;create=true"}
+    {
+        "jdbc_user" => ENV['USER'],
+        "jdbc_driver_class" => "org.apache.derby.jdbc.EmbeddedDriver",
+        "jdbc_connection_string" => connection_string
+    }
   end
   let(:settings) { {} }
   let(:plugin) { LogStash::Inputs::Jdbc.new(mixin_settings.merge(settings)) }
@@ -111,6 +116,57 @@ describe LogStash::Inputs::Jdbc do
     end
   end
 
+  context "when sequel opts has user option" do
+    let(:settings) do
+      {
+          "jdbc_user" => 'system',
+          "statement" => "SELECT * from test_table",
+          "sequel_opts" => { "user" => 'from-opts' }
+      }
+    end
+
+    before do
+      plugin.register
+    end
+
+    after do
+      plugin.stop
+    end
+
+    it "should honor set jdbc-user when connecting" do
+      expect( Sequel ).to receive(:connect).with connection_string, hash_including(:user=>"system")
+      plugin.send(:jdbc_connect)
+    end
+  end
+
+  context "with sequel opts" do
+    let(:settings) do
+      {
+          "jdbc_user" => 'system',
+          "statement" => "SELECT * from test_table",
+          "sequel_opts" => {
+              "truthy" => 'true',
+              "falsey" => 'false',
+              "foo" => 'bar',
+              "jdbc_properties" => { "some" => 'true' }
+          }
+      }
+    end
+
+    before do
+      plugin.register
+    end
+
+    after do
+      plugin.stop
+    end
+
+    it "should symbolize keys" do
+      expect( Sequel ).to receive(:connect).with connection_string,
+          hash_including(:truthy => true, :falsey => false, :foo => 'bar', :jdbc_properties => { 'some' => 'true' })
+      plugin.send(:jdbc_connect)
+    end
+  end
 
   context "when neither statement and statement_filepath arguments are passed" do
     it "should fail to register" do
@@ -190,6 +246,18 @@ describe LogStash::Inputs::Jdbc do
       Timecop.return
     end
 
+    it "cleans up scheduler resources on close" do
+      runner = Thread.new do
+        plugin.run(queue)
+      end
+      sleep 1
+      plugin.do_close
+
+      scheduler = plugin.instance_variable_get(:@scheduler)
+      expect(scheduler).to_not be_nil
+      expect(scheduler.down?).to be_truthy
+    end
+
   end
 
   context "when scheduling and previous runs are to be preserved" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.6
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -210,7 +210,6 @@ files:
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
-- NOTICE.TXT
 - README.md
 - docs/filter-jdbc_static.asciidoc
 - docs/filter-jdbc_streaming.asciidoc
@@ -235,6 +234,7 @@ files:
 - lib/logstash/inputs/jdbc.rb
 - lib/logstash/inputs/tzinfo_jruby_patch.rb
 - lib/logstash/plugin_mixins/jdbc/checked_count_logger.rb
+- lib/logstash/plugin_mixins/jdbc/common.rb
 - lib/logstash/plugin_mixins/jdbc/jdbc.rb
 - lib/logstash/plugin_mixins/jdbc/statement_handler.rb
 - lib/logstash/plugin_mixins/jdbc/value_tracking.rb
@@ -242,7 +242,6 @@ files:
 - lib/logstash/plugin_mixins/jdbc_streaming/cache_payload.rb
 - lib/logstash/plugin_mixins/jdbc_streaming/parameter_handler.rb
 - lib/logstash/plugin_mixins/jdbc_streaming/statement_handler.rb
-- lib/logstash/plugin_mixins/statement_handler.rb
 - logstash-integration-jdbc.gemspec
 - spec/filters/env_helper.rb
 - spec/filters/integration/jdbc_static_spec.rb
@@ -291,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.7.9
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Integration with JDBC - input and filter plugins

data/NOTICE.TXT

@@ -1,5 +0,0 @@
-Elasticsearch
-Copyright 2012-2018 Elasticsearch
-
-This product includes software developed by The Apache Software
-Foundation (http://www.apache.org/).