Merge pull request #1952 from dbcli/RW/remove-my-cnf-support

Remove support for reading vendor my.cnf files

Author: rolandwalker

changelog.md

@@ -8,6 +8,7 @@ Breaking Changes
 * Remove support for deprecated environment variable `$MYSQL_UNIX_PORT`.
 * Remove support for `--ssl/--no-ssl` CLI arguments in favor of `--ssl-mode`.
 * Remove support for deprecated SSH jump functionality.
+* Remove support for `my.cnf` vendor MySQL option files.
 
 
 Internal

mycli/app_state.py

@@ -1,12 +1,11 @@
 from __future__ import annotations
 
-from collections import defaultdict
 import re
 from typing import TYPE_CHECKING, Any
 
 from configobj import ConfigObj
 
-from mycli.config import str_to_bool, strip_matching_quotes
+from mycli.config import strip_matching_quotes
 
 if TYPE_CHECKING:
     from mycli.client import MyCli
@@ -19,21 +18,13 @@ def normalize_ssl_mode(config: ConfigObj) -> tuple[str | None, str | None]:
     return ssl_mode, None
 
 
-def ensure_my_cnf_sections(my_cnf: ConfigObj) -> None:
-    if not my_cnf.get('client'):
-        my_cnf['client'] = {}
-    if not my_cnf.get('mysqld'):
-        my_cnf['mysqld'] = {}
-
-
 def configure_prompt_state(
     mycli: MyCli,
     config: ConfigObj,
     prompt: str | None,
-    prompt_cnf: str | None,
     toolbar_format: str | None,
 ) -> None:
-    mycli.prompt_format = prompt or prompt_cnf or config['main']['prompt'] or mycli.default_prompt
+    mycli.prompt_format = prompt or config['main']['prompt'] or mycli.default_prompt
     mycli.prompt_lines = 0
     mycli.multiline_continuation_char = config['main']['prompt_continuation']
     mycli.toolbar_format = toolbar_format or config['main']['toolbar']
@@ -61,47 +52,22 @@ def llm_prompt_truncation(config: ConfigObj) -> tuple[int, int]:
 
 
 class AppStateMixin:
-    defaults_suffix: str | None
     login_path: str | None
 
-    def read_my_cnf(self, cnf: ConfigObj, keys: list[str]) -> dict[str, Any]:
-        sections = ['client', 'mysqld']
-        key_transformations = {
-            'mysqld': {
-                'socket': 'default_socket',
-                'port': 'default_port',
-                'user': 'default_user',
-            },
-        }
-
-        if self.login_path and self.login_path != 'client':
-            sections.append(self.login_path)
-
-        if self.defaults_suffix:
-            sections.extend([sect + self.defaults_suffix for sect in sections])
-
-        configuration: dict[str, Any] = defaultdict(lambda: None)
-        for key in keys:
-            for section in cnf:
-                if section not in sections or key not in cnf[section]:
-                    continue
-                new_key = key_transformations.get(section, {}).get(key) or key
-                configuration[new_key] = strip_matching_quotes(cnf[section][key])
-
-        return configuration
-
-    def merge_ssl_with_cnf(self, ssl: dict[str, Any], cnf: dict[str, Any]) -> dict[str, Any]:
-        merged = {}
-        merged.update(ssl)
-        prefix = 'ssl-'
-        for key, value in cnf.items():
-            if not key.startswith(prefix):
-                continue
-            if value is None:
+    def read_mylogin_cnf(self, cnf: ConfigObj) -> dict[str, Any]:
+        allowed_keys = [
+            'user',
+            'password',
+            'host',
+            'port',
+            'socket',
+        ]
+        configuration: dict[str, Any] = dict.fromkeys(allowed_keys)
+        for section in cnf:
+            if section != self.login_path:
                 continue
-            if key == 'ssl-verify-server-cert':
-                merged['check_hostname'] = str_to_bool(value)
-            else:
-                merged[key[len(prefix) :]] = value
+            for key in allowed_keys:
+                if key in cnf[section]:
+                    configuration[key] = strip_matching_quotes(cnf[section][key])
 
-        return merged
+        return configuration

mycli/cli_runner.py

@@ -3,14 +3,13 @@
 import os
 import re
 import sys
-from textwrap import dedent
 from typing import TYPE_CHECKING, Any, Callable
 from urllib.parse import parse_qs, unquote, urlparse
 
 import click
 
 from mycli.config import str_to_bool
-from mycli.constants import EMPTY_PASSWORD_FLAG_SENTINEL, ISSUES_URL, REPO_URL
+from mycli.constants import EMPTY_PASSWORD_FLAG_SENTINEL, ISSUES_URL
 from mycli.main_modes.batch import main_batch_from_stdin, main_batch_with_progress_bar, main_batch_without_progress_bar
 from mycli.main_modes.checkup import main_checkup
 from mycli.main_modes.execute import main_execute_from_cli
@@ -101,8 +100,6 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
         prompt=cli_args.prompt,
         toolbar_format=cli_args.toolbar,
         logfile=cli_args.logfile,
-        defaults_suffix=cli_args.defaults_group_suffix,
-        defaults_file=cli_args.defaults_file,
         login_path=cli_args.login_path,
         auto_vertical_output=cli_args.auto_vertical_output,
         warn=cli_args.warn,
@@ -314,82 +311,6 @@ def run_from_cli_args(cli_args: 'CliArgs', client_factory: ClientFactory) -> Non
         use_keyring = str_to_bool(cli_args.use_keyring)
         reset_keyring = False
 
-    # todo: removeme after a period of transition
-    for tup in [
-        ('client', 'prompt', 'prompt', 'main', 'prompt'),
-        ('client', 'pager', 'pager', 'main', 'pager'),
-        ('client', 'skip-pager', 'skip-pager', 'main', 'enable_pager'),
-        # this is a white lie, because default_character_set can actually be read from the package config
-        ('client', 'default-character-set', 'default-character-set', 'connection', 'default_character_set'),
-        # local-infile can be read from both sections
-        ('mysqld', 'local-infile', 'local-infile', 'connection', 'default_local_infile'),
-        ('client', 'local-infile', 'local-infile', 'connection', 'default_local_infile'),
-        ('mysqld', 'loose-local-infile', 'loose-local-infile', 'connection', 'default_local_infile'),
-        ('client', 'loose-local-infile', 'loose-local-infile', 'connection', 'default_local_infile'),
-        # todo: in the future we should add default_port, etc, but only in .myclirc
-        # they are currently ignored in my.cnf
-        ('mysqld', 'default_socket', 'socket', 'connection', 'default_socket'),
-        ('client', 'ssl-ca', 'ssl-ca', 'connection', 'default_ssl_ca'),
-        ('client', 'ssl-cert', 'ssl-cert', 'connection', 'default_ssl_cert'),
-        ('client', 'ssl-key', 'ssl-key', 'connection', 'default_ssl_key'),
-        ('client', 'ssl-cipher', 'ssl-cipher', 'connection', 'default_ssl_cipher'),
-        ('client', 'ssl-verify-server-cert', 'ssl-verify-server-cert', 'connection', 'default_ssl_verify_server_cert'),
-    ]:
-        (
-            mycnf_section_name,
-            mycnf_item_name,
-            printable_mycnf_item_name,
-            myclirc_section_name,
-            myclirc_item_name,
-        ) = tup
-        if str_to_bool(mycli.config['main'].get('my_cnf_transition_done', 'False')):
-            break
-        if (
-            mycli.my_cnf[mycnf_section_name].get(mycnf_item_name) is None
-            and mycli.my_cnf[mycnf_section_name].get(mycnf_item_name.replace('-', '_')) is None
-        ):
-            continue
-        user_section = mycli.config_without_package_defaults.get(myclirc_section_name, {})
-        if user_section.get(myclirc_item_name) is None:
-            cnf_value = mycli.my_cnf[mycnf_section_name].get(mycnf_item_name)
-            if cnf_value is None:
-                cnf_value = mycli.my_cnf[mycnf_section_name].get(mycnf_item_name.replace('-', '_'))
-            click.secho(
-                dedent(
-                    f"""
-                    Reading configuration from my.cnf files is deprecated.
-                    See {ISSUES_URL}/1490 .
-                    The cause of this message is the following in a my.cnf file without a corresponding
-                    ~/.myclirc entry:
-
-                        [{mycnf_section_name}]
-                        {printable_mycnf_item_name} = {cnf_value}
-
-                    To suppress this message, remove the my.cnf item add or the following to ~/.myclirc:
-
-                        [{myclirc_section_name}]
-                        {myclirc_item_name} = <value>
-
-                    The ~/.myclirc setting will take precedence.  In the future, the my.cnf will be ignored.
-
-                    Values are documented at {REPO_URL}/blob/main/mycli/myclirc .  An
-                    empty <value> is generally accepted.
-
-                    To ignore all of this, set
-
-                        [main]
-                        my_cnf_transition_done = True
-
-                    in ~/.myclirc.
-
-                    --------
-
-                    """
-                ),
-                err=True,
-                fg='yellow',
-            )
-
     mycli.connect(
         database=database,
         user=cli_args.user,

mycli/client.py

@@ -7,6 +7,7 @@
 from typing import IO, Literal
 
 from cli_helpers.tabular_output import TabularOutputFormatter
+from configobj import ConfigObj
 from prompt_toolkit.formatted_text import to_formatted_text
 from prompt_toolkit.shortcuts import PromptSession
 import sqlparse
@@ -15,7 +16,6 @@
     AppStateMixin,
     configure_prompt_state,
     destructive_keywords_from_config,
-    ensure_my_cnf_sections,
     llm_prompt_truncation,
     normalize_ssl_mode,
 )
@@ -24,7 +24,13 @@
 from mycli.client_query import ClientQueryMixin
 from mycli.clistyle import style_factory_helpers, style_factory_ptoolkit
 from mycli.completion_refresher import CompletionRefresher
-from mycli.config import get_mylogin_cnf_path, open_mylogin_cnf, read_config_files, write_default_config
+from mycli.config import (
+    get_mylogin_cnf_path,
+    open_mylogin_cnf,
+    read_config_file,
+    read_config_files,
+    write_default_config,
+)
 from mycli.constants import DEFAULT_PROMPT
 from mycli.main_modes import repl as repl_package
 from mycli.output import OutputMixin
@@ -44,19 +50,10 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
     default_prompt = DEFAULT_PROMPT
     default_prompt_splitln = "\\u@\\h\\n(\\t):\\d>"
     max_len_prompt = 45
-    defaults_suffix = None
     prompt_lines: int
     sqlexecute: SQLExecute | None
     numeric_alignment: str
 
-    # In order of being loaded. Files lower in list override earlier ones.
-    cnf_files: list[str | IO[str]] = [
-        "/etc/my.cnf",
-        "/etc/mysql/my.cnf",
-        "/usr/local/etc/my.cnf",
-        os.path.expanduser("~/.my.cnf"),
-    ]
-
     # check XDG_CONFIG_HOME exists and not an empty string
     xdg_config_home = os.environ.get("XDG_CONFIG_HOME", "~/.config")
     system_config_files: list[str | IO[str]] = [
@@ -72,8 +69,6 @@ def __init__(
         prompt: str | None = None,
         toolbar_format: str | None = None,
         logfile: TextIOWrapper | Literal[False] | None = None,
-        defaults_suffix: str | None = None,
-        defaults_file: str | None = None,
         login_path: str | None = None,
         auto_vertical_output: bool = False,
         warn: bool | None = None,
@@ -83,7 +78,6 @@ def __init__(
     ) -> None:
         self.sqlexecute = sqlexecute
         self.logfile = logfile
-        self.defaults_suffix = defaults_suffix
         self.login_path = login_path
         self.toolbar_error_message: str | None = None
         self.prompt_session: PromptSession | None = None
@@ -92,23 +86,13 @@ def __init__(
         self.sandbox_mode: bool = False
         self.checkpoint: IO | None = None
 
-        # self.cnf_files is a class variable that stores the list of mysql
-        # config files to read in at launch.
-        # If defaults_file is specified then override the class variable with
-        # defaults_file.
-        if defaults_file:
-            self.cnf_files = [defaults_file]
-
         # Load config.
         config_files: list[str | IO[str]] = self.system_config_files + [myclirc] + [self.pwd_config_file]
 
         c = self.config = read_config_files(config_files)
-        # this parallel config exists to
-        #  * compare with my.cnf
-        #  * support the --checkup feature
-        # todo: after removing my.cnf, create the parallel configs only when --checkup is set
+        # only needed in --checkup mode. todo: only load when needed
         self.config_without_package_defaults = read_config_files(config_files, ignore_package_defaults=True)
-        # this parallel config exists to compare with my.cnf support the --checkup feature
+        # only needed in --checkup mode. todo: only load when needed
         self.config_without_user_options = read_config_files(config_files, ignore_user_options=True)
         self.multi_line = c["main"].as_bool("multi_line")
         self.key_bindings = c["main"]["key_bindings"]
@@ -201,20 +185,16 @@ def __init__(
         self.register_special_commands()
 
         # Load .mylogin.cnf if it exists.
-        mylogin_cnf_path = get_mylogin_cnf_path()
-        if mylogin_cnf_path:
-            mylogin_cnf = open_mylogin_cnf(mylogin_cnf_path)
-            if mylogin_cnf_path and mylogin_cnf:
-                # .mylogin.cnf gets read last, even if defaults_file is specified.
-                self.cnf_files.append(mylogin_cnf)
-            elif mylogin_cnf_path and not mylogin_cnf:
-                # There was an error reading the login path file.
+        self.mylogin_cnf = ConfigObj()
+        mylogin_cnf_h = None
+        if mylogin_cnf_path := get_mylogin_cnf_path():
+            mylogin_cnf_h = open_mylogin_cnf(mylogin_cnf_path)
+            if mylogin_cnf_h:
+                self.mylogin_cnf = read_config_file(mylogin_cnf_h, list_values=False) or ConfigObj()
+            else:
                 print("Error: Unable to read login path file.")
 
-        self.my_cnf = read_config_files(self.cnf_files, list_values=False)
-        ensure_my_cnf_sections(self.my_cnf)
-        prompt_cnf = self.read_my_cnf(self.my_cnf, ["prompt"])["prompt"]
-        configure_prompt_state(self, c, prompt, prompt_cnf, toolbar_format)
+        configure_prompt_state(self, c, prompt, toolbar_format)
         self.prompt_session = None
         self.destructive_keywords = destructive_keywords_from_config(c)
         special.set_destructive_keywords(self.destructive_keywords)