BUG25349794: Add read_default_file alias for option_files in connect()

nmariz · nmariz · commit 59ee2106adb9 · 2019-08-13T17:10:07.000+01:00
This patch adds an alias read_default_file for option_files, which allows
more compatibility with other MySQL Python drivers.

A test was added for regression.
diff --git a/lib/mysql/connector/__init__.py b/lib/mysql/connector/__init__.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2009, 2018, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2009, 2019, Oracle and/or its affiliates. All rights reserved.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -143,6 +143,10 @@ def connect(*args, **kwargs):
     Returns MySQLConnection or PooledMySQLConnection.
     """
     # Option files
+    if 'read_default_file' in kwargs:
+        kwargs['option_files'] = kwargs['read_default_file']
+        kwargs.pop('read_default_file')
+
     if 'option_files' in kwargs:
         new_config = read_option_files(**kwargs)
         return connect(**new_config)
diff --git a/lib/mysql/connector/abstracts.py b/lib/mysql/connector/abstracts.py
@@ -281,6 +281,7 @@ def config(self, **kwargs):
             ('username', 'user'),
             ('passwd', 'password'),
             ('connect_timeout', 'connection_timeout'),
+            ('read_default_file', 'option_files') ,
         ]
         for compat, translate in compat_map:
             try:
diff --git a/tests/test_bugs.py b/tests/test_bugs.py
@@ -5677,3 +5677,27 @@ def test_connection_collation_utf8mb4_0900_bin(self):
 
         cnx = self.cnx.__class__(**config)
         cnx.close()
+
+
+class BugOra25349794(tests.MySQLConnectorTests):
+    """BUG#25349794: ADD READ_DEFAULT_FILE ARGUMENT FOR CONNECT().
+    """
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    @foreach_cnx()
+    def test_read_default_file_alias(self):
+        opt_file = os.path.join("tests", "data", "option_files", "pool.cnf")
+        config = tests.get_mysql_config()
+
+        if tests.MYSQL_VERSION < (5, 7):
+            config["client_flags"] = [-constants.ClientFlag.CONNECT_ARGS]
+
+        conn = mysql.connector.connect(read_default_file=opt_file,
+                                       option_groups=["pooling"], **config)
+        self.assertEqual("my_pool", conn.pool_name)
+        mysql.connector._CONNECTION_POOLS = {}
+        conn.close()

Original file line number	Diff line number	Diff line change
`@@ -281,6 +281,7 @@ def config(self, **kwargs):`
`281`	`281`	`('username', 'user'),`
`282`	`282`	`('passwd', 'password'),`
`283`	`283`	`('connect_timeout', 'connection_timeout'),`
	`284`	`+ ('read_default_file', 'option_files') ,`
`284`	`285`	`]`
`285`	`286`	`for compat, translate in compat_map:`
`286`	`287`	`try:`