BUG32838010: Fix option files parsing with include directive

nmariz · nmariz · commit 9e2881d52647 · 2021-05-31T18:42:21.000+01:00
This patch fixes the option files parsing when using the include
directive in config files with override sections.

Example:

    !include D:\test\base.cnf

    [mysql]
    port = 1002

The mysql.port should be 1002.

A test was added for regression.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -16,6 +16,7 @@ v8.0.26
 - WL#14440: Support for authentication_kerberos_client authentication plugin
 - WL#14237: Support query attributes
 - BUG#32947160: Remove MySQLdb module dependency from Django backend
+- BUG#32838010: Fix option files parsing with include directive
 - BUG#32789076: MSI is missing required libraries to use auth_ldap_client plugin
 - BUG#32778827: Raise an error if the _id is different when replacing a document
 - BUG#32740486: Fix typo in docstring
diff --git a/lib/mysql/connector/optionfiles.py b/lib/mysql/connector/optionfiles.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2020, Oracle and/or its affiliates.
+# Copyright (c) 2014, 2021, Oracle and/or its affiliates.
 #
 # 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
@@ -166,12 +166,14 @@ def _parse_options(self, files):
         Raises ValueError if any of the included or file given in arguments
         is not readable.
         """
+        initial_files = files[:]
+        files = []
         index = 0
         err_msg = "Option file '{0}' being included again in file '{1}'"
 
-        for file_ in files:
+        for file_ in initial_files:
             try:
-                if file_ in files[index+1:]:
+                if file_ in initial_files[index+1:]:
                     raise ValueError("Same option file '{0}' occurring more "
                                      "than once in the list".format(file_))
                 with open(file_, 'r') as op_file:
@@ -186,18 +188,18 @@ def _parse_options(self, files):
                                         entry, file_))
                                 if (os.path.isfile(entry) and
                                         entry.endswith(self.default_extension)):
-                                    files.insert(index+1, entry)
+                                    files.append(entry)
 
                         elif line.startswith('!include'):
                             _, filename = line.split(None, 1)
                             filename = filename.strip()
                             if filename in files:
                                 raise ValueError(err_msg.format(
                                     filename, file_))
-                            files.insert(index+1, filename)
+                            files.append(filename)
 
                     index += 1
-
+                    files.append(file_)
             except (IOError, OSError) as exc:
                 raise ValueError("Failed reading file '{0}': {1}".format(
                     file_, str(exc)))
@@ -224,6 +226,10 @@ def read(self, filenames):  # pylint: disable=W0221
                 out_file = io.StringIO()
                 for line in codecs.open(filename, encoding='utf-8'):
                     line = line.strip()
+                    # Skip lines that begin with "!includedir" or "!include"
+                    if line.startswith('!include'):
+                        continue
+
                     match_obj = self.OPTCRE.match(line)
                     if not self.SECTCRE.match(line) and match_obj:
                         optname, delimiter, optval = match_obj.group('option',
diff --git a/tests/data/option_files/my_include_override.cnf b/tests/data/option_files/my_include_override.cnf
@@ -0,0 +1,4 @@
+!include tests/data/option_files/my.cnf
+
+[mysqld]
+port=1002
diff --git a/tests/test_optionfiles.py b/tests/test_optionfiles.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2014, 2021, 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
@@ -214,3 +214,27 @@ def test_read_option_files(self):
         self.assertEqual(exp, result)
 
         self.assertRaises(ValueError, connect, option_files='dummy_file.cnf')
+
+    def test_read_option_files_with_include(self):
+        top_dir = os.path.dirname(os.path.realpath(__file__))
+        my_cnf_name = 'my.cnf'
+        my_cnf = os.path.join(self.option_file_dir, my_cnf_name)
+        my_overwrite = os.path.join(
+            top_dir,
+            "..",
+            self.option_file_dir,
+            'my_include_override.cnf'
+        )
+
+        result = read_option_files(
+            option_files=my_overwrite,
+            option_groups='mysqld'
+        )
+
+        # option in the overwrite file
+        port_exp = 1002
+        self.assertEqual(port_exp, result['port'])
+
+        # option in the include file
+        user_exp = 'mysql'
+        self.assertEqual(user_exp, result['user'])
