BUG19481761: Fix option files with !include with trailing newline

peeyushgupta · peeyushgupta · commit d454651b65ee · 2014-08-26T14:56:02.000+05:30
If an option file has a  !include option which has a trailing newline,
mysql.connector.connect() fails with a ValueError. This patch fixes this
by stripping all whitesapce characters in the filenames or directory
names given with !include or !includedir options.

A unit test has been added for BUG#19481761.
diff --git a/lib/mysql/connector/optionfiles.py b/lib/mysql/connector/optionfiles.py
@@ -193,6 +193,7 @@ def _parse_options(self, files):
                     for line in op_file.readlines():
                         if line.startswith('!includedir'):
                             _, dir_path = line.split(None, 1)
+                            dir_path = dir_path.strip()
                             for entry in os.listdir(dir_path):
                                 entry = os.path.join(dir_path, entry)
                                 if entry in files:
@@ -204,6 +205,7 @@ def _parse_options(self, files):
 
                         elif line.startswith('!include'):
                             _, filename = line.split(None, 1)
+                            filename = filename.strip()
                             if filename in files:
                                 raise ValueError(err_msg.format(
                                     filename, file_))
@@ -249,7 +251,6 @@ def read(self, filenames):  # pylint: disable=W0221
                     else:
                         out_file.write(line + '\n')
                 out_file.seek(0)
-                self._read(out_file, filename)
             except IOError:
                 continue
             try:
diff --git a/tests/test_bugs.py b/tests/test_bugs.py
@@ -35,6 +35,7 @@
 to be created first.
 """
 
+import io
 import os
 import gc
 import tempfile
@@ -2833,3 +2834,36 @@ def test_unsupported_arguments(self):
         exp.update(config)
 
         self.assertEqual(exp, new_config)
+
+
+class BugOra19481761(tests.MySQLConnectorTests):
+    """BUG#19481761: OPTION_FILES + !INCLUDE FAILS WITH TRAILING NEWLINE
+    """
+    def test_option_files_with_include(self):
+        temp_cnf_file = os.path.join(os.getcwd(), 'temp.cnf')
+        temp_include_file = os.path.join(os.getcwd(), 'include.cnf')
+
+        cnf_file = open(temp_cnf_file, "w+")
+        include_file = open(temp_include_file, "w+")
+
+        config = tests.get_mysql_config()
+
+        cnf = "[connector_python]\n"
+        cnf += '\n'.join(['{0} = {1}'.format(key, value)
+                         for key, value in config.items()])
+
+        include_file.write(cnf)
+        cnf_file.write("!include {0}\n".format(temp_include_file))
+
+        cnf_file.close()
+        include_file.close()
+
+        try:
+            conn = mysql.connector.connect(option_files=temp_cnf_file)
+        except:
+            self.fail("Connection failed with option_files argument.")
+
+        self.assertEqual(config, read_option_files(option_files=temp_cnf_file))
+
+        os.remove(temp_cnf_file)
+        os.remove(temp_include_file)
