BUG19168737: Fix unsupported connection argument error with option files

Some connection arguments like pool_name, pool_size, failover, if given
inside an option file being used by Connector/Python, was causing
unsupported connection argument error. This patch fixes this by moving
the _read_option_files function to optionfiles module.

A unit test has been added for BUG#19168737.

Author: peeyushgupta

lib/mysql/connector/__init__.py

@@ -38,6 +38,7 @@
     TimestampFromTicks, TimeFromTicks,
     STRING, BINARY, NUMBER, DATETIME, ROWID,
     apilevel, threadsafety, paramstyle)
+from .optionfiles import read_option_files
 
 _CONNECTION_POOLS = {}
 
@@ -129,6 +130,10 @@ def connect(*args, **kwargs):
 
     Returns MySQLConnection or PooledMySQLConnection.
     """
+    # Option files
+    if 'option_files' in kwargs:
+        new_config = read_option_files(**kwargs)
+        return connect(**new_config)
 
     if all(['fabric' in kwargs, 'failover' in kwargs]):
         raise InterfaceError("fabric and failover arguments can not be used")

lib/mysql/connector/connection.py

@@ -43,7 +43,6 @@
     MySQLCursorDict, MySQLCursorBufferedDict, MySQLCursorNamedTuple,
     MySQLCursorBufferedNamedTuple)
 from .network import MySQLUnixSocket, MySQLTCPSocket
-from .optionfiles import MySQLOptionsParser
 from .protocol import MySQLProtocol
 from .utils import int4store
 
@@ -239,59 +238,6 @@ def _auth_switch_request(self, username=None, password=None):
         elif packet[4] == 255:
             raise errors.get_exception(packet)
 
-    def _read_option_files(self, config):
-        """
-        Read option files for connection parameters.
-
-        Checks if connection arguments contain option file arguments, and then
-        reads option files accordingly.
-        """
-        if 'option_files' in config:
-            try:
-                if isinstance(config['option_groups'], str):
-                    config['option_groups'] = [config['option_groups']]
-                groups = config['option_groups']
-                del config['option_groups']
-            except KeyError:
-                groups = ['client', 'connector_python']
-
-            if isinstance(config['option_files'], str):
-                config['option_files'] = [config['option_files']]
-            option_parser = MySQLOptionsParser(list(config['option_files']),
-                                               keep_dashes=False)
-            del config['option_files']
-
-            config_from_file = option_parser.get_groups_as_dict_with_priority(
-                *groups)
-            config_options = {}
-            for group in groups:
-                try:
-                    for option, value in config_from_file[group].items():
-                        try:
-                            if option == 'socket':
-                                option = 'unix_socket'
-                            # pylint: disable=W0104
-                            DEFAULT_CONFIGURATION[option]
-                            # pylint: enable=W0104
-
-                            if (option not in config_options or
-                                    config_options[option][1] <= value[1]):
-                                config_options[option] = value
-                        except KeyError:
-                            if group is 'connector_python':
-                                raise AttributeError("Unsupported argument "
-                                                     "'{0}'".format(option))
-                except KeyError:
-                    continue
-
-            for option, value in config_options.items():
-                if option not in config:
-                    try:
-                        config[option] = eval(value[0])  # pylint: disable=W0123
-                    except (NameError, SyntaxError):
-                        config[option] = value[0]
-        return config
-
     def config(self, **kwargs):
         """Configure the MySQL Connection
 
@@ -303,9 +249,6 @@ def config(self, **kwargs):
         if 'dsn' in config:
             raise errors.NotSupportedError("Data source name is not supported")
 
-        # Read option files
-        self._read_option_files(config)
-
         # Configure how we handle MySQL warnings
         try:
             self.get_warnings = config['get_warnings']

lib/mysql/connector/fabric/__init__.py

@@ -39,6 +39,12 @@
      'shard', 'shard_type', 'group', 'global_group']
     )
 
+CNX_FABRIC_ARGS = ['fabric_host', 'fabric_username', 'fabric_password',
+                   'fabric_port', 'fabric_connect_attempts',
+                   'fabric_connect_delay', 'fabric_report_errors',
+                   'fabric_ssl_ca', 'fabric_ssl_key', 'fabric_ssl_cert',
+                   'fabric_user']
+
 from .connection import (
     MODE_READONLY, MODE_READWRITE,
     STATUS_PRIMARY, STATUS_SECONDARY,

lib/mysql/connector/optionfiles.py

@@ -30,6 +30,9 @@
 import re
 
 from .catch23 import PY2
+from .connection import DEFAULT_CONFIGURATION
+from .pooling import CNX_POOL_ARGS
+from .fabric import CNX_FABRIC_ARGS
 
 # pylint: disable=F0401
 if PY2:
@@ -45,6 +48,80 @@
 }
 
 
+def read_option_files(**config):
+    """
+    Read option files for connection parameters.
+
+    Checks if connection arguments contain option file arguments, and then
+    reads option files accordingly.
+    """
+    if 'option_files' in config:
+        try:
+            if isinstance(config['option_groups'], str):
+                config['option_groups'] = [config['option_groups']]
+            groups = config['option_groups']
+            del config['option_groups']
+        except KeyError:
+            groups = ['client', 'connector_python']
+
+        if isinstance(config['option_files'], str):
+            config['option_files'] = [config['option_files']]
+        option_parser = MySQLOptionsParser(list(config['option_files']),
+                                           keep_dashes=False)
+        del config['option_files']
+
+        config_from_file = option_parser.get_groups_as_dict_with_priority(
+            *groups)
+        config_options = {}
+        fabric_options = {}
+        for group in groups:
+            try:
+                for option, value in config_from_file[group].items():
+                    try:
+                        if option == 'socket':
+                            option = 'unix_socket'
+
+                        if option in CNX_FABRIC_ARGS:
+                            if (option not in fabric_options or
+                                    fabric_options[option][1] <= value[1]):
+                                fabric_options[option] = value
+                            continue
+
+                        if (option not in CNX_POOL_ARGS and
+                                option not in ['fabric', 'failover']):
+                            # pylint: disable=W0104
+                            DEFAULT_CONFIGURATION[option]
+                            # pylint: enable=W0104
+
+                        if (option not in config_options or
+                                config_options[option][1] <= value[1]):
+                            config_options[option] = value
+                    except KeyError:
+                        if group is 'connector_python':
+                            raise AttributeError("Unsupported argument "
+                                                 "'{0}'".format(option))
+            except KeyError:
+                continue
+
+        for option, value in config_options.items():
+            if option not in config:
+                try:
+                    config[option] = eval(value[0])  # pylint: disable=W0123
+                except (NameError, SyntaxError):
+                    config[option] = value[0]
+
+        if fabric_options:
+            config['fabric'] = {}
+            for option, value in fabric_options.items():
+                try:
+                     # pylint: disable=W0123
+                    config['fabric'][option.split('_', 1)[1]] = eval(value[0])
+                     # pylint: enable=W0123
+                except (NameError, SyntaxError):
+                    config['fabric'][option.split('_', 1)[1]] = value[0]
+    return config
+
+
 class MySQLOptionsParser(SafeConfigParser):  # pylint: disable=R0901
     """This class implements methods to parse MySQL option files"""
 

lib/mysql/connector/pooling.py

@@ -39,7 +39,7 @@
 from .connection import MySQLConnection
 
 CONNECTION_POOL_LOCK = threading.RLock()
-CNX_POOL_ARGS = ('pool_name', 'pool_size', 'pool_cnx')
+CNX_POOL_ARGS = ('pool_name', 'pool_size', 'pool_reset_session')
 CNX_POOL_MAXSIZE = 32
 CNX_POOL_MAXNAMESIZE = 64
 CNX_POOL_NAMEREGEX = re.compile(r'[^a-zA-Z0-9._:\-*$#]')

tests/data/option_files/pool.cnf

@@ -0,0 +1,14 @@
+[pooling]
+pool_size = 1
+pool_name = my_pool
+pool_reset_session = True
+
+[fabric]
+fabric_host = fabric.example.com
+fabric_connect_delay = 3
+fabric_ssl_ca = /path/to/ssl
+fabric_password = foo
+
+[failover]
+failover = ({'port': 3306, 'pool_name': 'failA' }, {'port': 3307, 'pool_name': 'failB' },)
+

tests/test_bugs.py

@@ -48,6 +48,7 @@
 from . import PY2
 from mysql.connector import (connection, cursor, conversion, protocol,
                              errors, constants, pooling)
+from mysql.connector.optionfiles import read_option_files
 import mysql.connector
 
 
@@ -2730,17 +2731,14 @@ class BugOra19170287(tests.MySQLConnectorTests):
     def test_duplicate_groups(self):
         option_file_dir = os.path.join('tests', 'data', 'option_files')
         opt_file = os.path.join(option_file_dir, 'dup_groups.cnf')
-        config = tests.get_mysql_config()
 
-        cnx = mysql.connector.connect(**config)
         exp = {
             u'password': u'mypass',
             u'user': u'mysql',
             u'database': u'duplicate_data',
             u'port': 10000
         }
-        self.assertEqual(exp, cnx._read_option_files(
-            {'option_files': opt_file}))
+        self.assertEqual(exp, read_option_files(option_files=opt_file))
 
 
 class BugOra19169143(tests.MySQLConnectorTests):
@@ -2750,7 +2748,7 @@ def test_duplicate_optionfiles(self):
         option_file_dir = os.path.join('tests', 'data', 'option_files')
         files = [
             os.path.join(option_file_dir, 'include_files', '1.cnf'),
-           os.path.join(option_file_dir, 'include_files', '2.cnf'),
+            os.path.join(option_file_dir, 'include_files', '2.cnf'),
             os.path.join(option_file_dir, 'include_files', '1.cnf'),
         ]
         self.assertRaises(ValueError, mysql.connector.connect,
@@ -2794,3 +2792,44 @@ def test_null(self):
         cur.execute(sql)
         self.assertEqual(exp, cur.fetchone())
         cur.close()
+
+
+class BugOra19168737(tests.MySQLConnectorTests):
+    """BUG#19168737: UNSUPPORTED CONNECTION ARGUMENTS WHILE USING OPTION_FILES
+    """
+    def test_unsupported_arguments(self):
+        option_file_dir = os.path.join('tests', 'data', 'option_files')
+        opt_file = os.path.join(option_file_dir, 'pool.cnf')
+        config = tests.get_mysql_config()
+
+        conn = mysql.connector.connect(option_files=opt_file,
+                                       option_groups=['pooling'], **config)
+        self.assertEqual('my_pool', conn.pool_name)
+        mysql.connector._CONNECTION_POOLS = {}
+        conn.close()
+
+        new_config = read_option_files(option_files=opt_file,
+                                       option_groups=['fabric'], **config)
+
+        exp = {
+            'fabric': {
+                'connect_delay': 3,
+                'host': 'fabric.example.com',
+                'password': 'foo',
+                'ssl_ca': '/path/to/ssl'
+           }
+        }
+        exp.update(config)
+
+        self.assertEqual(exp, new_config)
+
+        new_config = read_option_files(option_files=opt_file,
+                                       option_groups=['failover'], **config)
+
+        exp = {
+            'failover': ({'pool_name': 'failA', 'port': 3306},
+                         {'pool_name': 'failB', 'port': 3307})
+        }
+        exp.update(config)
+
+        self.assertEqual(exp, new_config)