[mysql] adjust for Connector/J driver (8.0) changes

and test the whole mysql_connection configuration loading
since we will need to support the old 5.1 at the same time

Author: kares

lib/arjdbc/mysql/connection_methods.rb

@@ -39,7 +39,8 @@ def mysql_connection(config)
 
     properties = ( config[:properties] ||= {} )
     if mysql_driver
-      properties['zeroDateTimeBehavior'] ||= 'convertToNull'
+      properties['zeroDateTimeBehavior'] ||=
+        config[:driver].to_s.start_with?('com.mysql.cj.') ? 'CONVERT_TO_NULL' : 'convertToNull'
       properties['jdbcCompliantTruncation'] ||= false
       # NOTE: this is "better" than passing what users are used to set on MRI
       # e.g. 'utf8mb4' will fail cause the driver will check for a Java charset

test/db/mysql/unit_test.rb

@@ -109,6 +109,117 @@ def initialize; end
       assert config[:adapter_class]
     end
 
+    test 'configuration attempts to load MySQL driver by default' do
+      load_jdbc_mysql
+
+      connection_handler = connection_handler_stub
+
+      config = { database: 'MyDB' }
+      connection_handler.expects(:jdbc_connection)
+      ::Jdbc::MySQL.expects(:load_driver).with(:require)
+      connection_handler.mysql_connection config
+    end
+
+    test 'configuration uses driver_name from Jdbc::MySQL' do
+      load_jdbc_mysql
+
+      connection_handler = connection_handler_stub
+
+      config = { database: 'MyDB' }
+      connection_handler.expects(:jdbc_connection)
+      ::Jdbc::MySQL.expects(:driver_name).returns('com.mysql.CustomDriver')
+      connection_handler.mysql_connection config
+      assert_equal 'com.mysql.CustomDriver', config[:driver]
+    end
+
+    test 'configuration sets up properties according to connector/j driver (>= 8.0)' do
+      load_jdbc_mysql
+
+      connection_handler = connection_handler_stub
+
+      config = { database: 'MyDB' }
+      connection_handler.expects(:jdbc_connection)
+      ::Jdbc::MySQL.expects(:driver_name).returns('com.mysql.cj.jdbc.Driver')
+      connection_handler.mysql_connection config
+      assert_equal 'com.mysql.cj.jdbc.Driver', config[:driver]
+      assert_equal 'CONVERT_TO_NULL', config[:properties]['zeroDateTimeBehavior']
+      assert_equal false, config[:properties]['useLegacyDatetimeCode']
+      assert_equal false, config[:properties]['jdbcCompliantTruncation']
+      assert_equal false, config[:properties]['useSSL']
+    end
+
+    def load_jdbc_mysql
+      require 'jdbc/mysql'
+    end
+
+  end
+
+  context 'connection (Jdbc::MySQL missing)' do
+
+    module ::Jdbc; end
+
+    @@jdbc_mysql = ::Jdbc::MySQL rescue nil
+
+    def setup
+      ::Jdbc.send :remove_const, :MySQL if @@jdbc_mysql
+    end
+
+    def teardown
+      ::Jdbc.const_set :MySQL, @@jdbc_mysql if @@jdbc_mysql
+    end
+
+    test 'configuration sets url and properties assuming mysql driver (<= 5.1)' do
+      connection_handler = connection_handler_stub
+
+      config = { host: '127.0.0.1', database: 'MyDB' }
+      connection_handler.expects(:jdbc_connection)
+      connection_handler.mysql_connection config
+
+      # we do not complete username/database etc :
+      assert_equal 'root', config[:username]
+      assert_equal 'com.mysql.jdbc.Driver', config[:driver]
+      assert_equal 'jdbc:mysql://127.0.0.1/MyDB', config[:url]
+      assert_equal 'UTF-8', config[:properties]['characterEncoding']
+      assert_equal 'convertToNull', config[:properties]['zeroDateTimeBehavior']
+      assert_equal false, config[:properties]['useLegacyDatetimeCode']
+      assert_equal false, config[:properties]['jdbcCompliantTruncation']
+      assert_equal false, config[:properties]['useSSL']
+    end
+
+    test 'configuration attempts to load MySQL driver by default' do
+      connection_handler = connection_handler_stub
+
+      config = { database: 'MyDB' }
+      connection_handler.expects(:jdbc_connection)
+      connection_handler.expects(:require).with('jdbc/mysql')
+      connection_handler.mysql_connection config
+    end
+
+    test 'configuration allows to skip driver loading' do
+      connection_handler = connection_handler_stub
+
+      config = { database: 'MyDB', driver: false }
+      connection_handler.expects(:jdbc_connection)
+      connection_handler.expects(:require).never
+      connection_handler.mysql_connection config
+      assert_not config[:driver] # allow Java's service discovery mechanism (with connector/j 8.0)
+    end
+
+    test 'configuration works with MariaDB driver specified' do
+      connection_handler = connection_handler_stub
+
+      config = { database: 'MyDB', driver: 'org.mariadb.jdbc.Driver' }
+      connection_handler.expects(:jdbc_connection)
+      connection_handler.mysql_connection config
+
+      # we do not complete username/database etc :
+      assert_equal 'root', config[:username]
+      assert_equal 'org.mariadb.jdbc.Driver', config[:driver]
+      assert_equal 'jdbc:mysql://localhost/MyDB', config[:url]
+      assert_equal false, config[:properties]['useLegacyDatetimeCode']
+      assert_equal false, config[:properties]['useSsl']
+    end
+
   end
 
 end if defined? JRUBY_VERSION