fix discovering .cnf files that are included with !includedirs

Author: gfrlv

mycli/config.py

@@ -1,4 +1,5 @@
 import shutil
+from copy import copy
 from io import BytesIO, TextIOWrapper
 import logging
 import os
@@ -58,12 +59,34 @@ def read_config_file(f, list_values=True):
     return config
 
 
+def get_included_configs(config_path) -> list:
+    """Get a list of configuration files that are included into config_path
+    with !includedir directive."""
+    if not os.path.exists(config_path):
+        return []
+    included_configs = []
+    with open(config_path) as f:
+        include_directives = filter(
+            lambda s: s.startswith('!includedir'),
+            f
+        )
+        dirs = map(lambda s: s.strip().split()[-1], include_directives)
+        dirs = filter(os.path.isdir, dirs)
+        for dir in dirs:
+            for filename in os.listdir(dir):
+                if filename.endswith('.cnf'):
+                    included_configs.append(os.path.join(dir, filename))
+    return included_configs
+
+
 def read_config_files(files, list_values=True):
     """Read and merge a list of config files."""
 
     config = ConfigObj(list_values=list_values)
-
-    for _file in files:
+    _files = copy(files)
+    while _files:
+        _file = _files.pop(0)
+        _files = get_included_configs(_file) + _files
         _config = read_config_file(_file, list_values=list_values)
         if bool(_config) is True:
             config.merge(_config)

mycli/main.py

@@ -386,7 +386,7 @@ def connect(self, database='', user='', passwd='', host='', port='',
         if port or host:
             socket = ''
         else:
-            socket = socket or cnf['socket']
+            socket = socket or cnf['socket'] or guess_socket_location()
         user = user or cnf['user'] or os.getenv('USER')
         host = host or cnf['host']
         port = port or cnf['port']
@@ -430,27 +430,13 @@ def _connect():
                 else:
                     raise e
 
-        def _fallback_to_tcp_ip():
-            self.echo(
-                'Retrying over TCP/IP', err=True)
-
-            # Else fall back to TCP/IP localhost
-            nonlocal socket, host, port
-            socket = ""
-            host = 'localhost'
-            port = 3306
-            _connect()
-
         try:
-            if (host is None) and not WIN:
-                # Try a sensible default socket first (simplifies auth)
-                # If we get a connection error, try tcp/ip localhost
+            if not WIN and socket:
+                socket_owner = getpwuid(os.stat(socket).st_uid).pw_name
+                self.echo(
+                    f"Connecting to socket {socket}, owned by user {socket_owner}")
                 try:
-                    socket = socket or guess_socket_location()
                     _connect()
-                except FileNotFoundError:
-                    self.echo('Failed to find socket file at default locations')
-                    _fallback_to_tcp_ip()
                 except OperationalError as e:
                     # These are "Can't open socket" and 2x "Can't connect"
                     if [code for code in (2001, 2002, 2003) if code == e.args[0]]:
@@ -461,15 +447,16 @@ def _fallback_to_tcp_ip():
                         self.echo(
                             "Failed to connect to local MySQL server through socket '{}':".format(socket))
                         self.echo(str(e), err=True)
-                        _fallback_to_tcp_ip()
+                        self.echo(
+                            'Retrying over TCP/IP', err=True)
+
+                        # Else fall back to TCP/IP localhost
+                        socket = ""
+                        host = 'localhost'
+                        port = 3306
+                        _connect()
                     else:
                         raise e
-                else:
-                    socket_owner = getpwuid(os.stat(socket).st_uid).pw_name
-                    self.echo(
-                        "Using socket {}, owned by user {}".format(
-                            socket, socket_owner)
-                    )
             else:
                 host = host or 'localhost'
                 port = port or 3306
@@ -1009,6 +996,9 @@ def get_last_query(self):
 @click.option('--ssh-port', default=22, help='Port to connect to ssh server.')
 @click.option('--ssh-password', help='Password to connect to ssh server.')
 @click.option('--ssh-key-filename', help='Private key filename (identify file) for the ssh connection.')
+@click.option('--ssh-config-path', help='Path to ssh configuration.',
+              default=os.path.expanduser('~') + '/.ssh/config')
+@click.option('--ssh-config-host', help='Host to connect to ssh server reading from ssh configuration.')
 @click.option('--ssl-ca', help='CA file in PEM format.',
               type=click.Path(exists=True))
 @click.option('--ssl-capath', help='CA directory.')
@@ -1030,6 +1020,8 @@ def get_last_query(self):
               help='Use DSN configured into the [alias_dsn] section of myclirc file.')
 @click.option('--list-dsn', 'list_dsn', is_flag=True,
         help='list of DSN configured into the [alias_dsn] section of myclirc file.')
+@click.option('--list-ssh-config', 'list_ssh_config', is_flag=True,
+              help='list ssh configurations in the ssh config (requires paramiko).')
 @click.option('-R', '--prompt', 'prompt',
               help='Prompt format (Default: "{0}").'.format(
                   MyCli.default_prompt))
@@ -1062,7 +1054,7 @@ def cli(database, user, host, port, socket, password, dbname,
         ssl_ca, ssl_capath, ssl_cert, ssl_key, ssl_cipher,
         ssl_verify_server_cert, table, csv, warn, execute, myclirc, dsn,
         list_dsn, ssh_user, ssh_host, ssh_port, ssh_password,
-        ssh_key_filename):
+        ssh_key_filename, list_ssh_config, ssh_config_path, ssh_config_host):
     """A MySQL terminal client with auto-completion and syntax highlighting.
 
     \b
@@ -1099,6 +1091,31 @@ def cli(database, user, host, port, socket, password, dbname,
             else:
                 click.secho(alias)
         sys.exit(0)
+    if list_ssh_config:
+        if not paramiko:
+            click.secho(
+                "This features requires paramiko. Please install paramiko and try again.",
+                err=True, fg='red'
+            )
+            exit(1)
+        try:
+            ssh_config = paramiko.config.SSHConfig().from_path(ssh_config_path)
+        except paramiko.ssh_exception.ConfigParseError as err:
+            click.secho('Invalid SSH configuration file. '
+                        'Please check the SSH configuration file.',
+                        err=True, fg='red')
+            exit(1)
+        except FileNotFoundError as e:
+            click.secho(str(e), err=True, fg='red')
+            exit(1)
+        for host in ssh_config.get_hostnames():
+            if verbose:
+                host_config = ssh_config.lookup(host)
+                click.secho("{} : {}".format(
+                    host, host_config.get('hostname')))
+            else:
+                click.secho(host)
+        sys.exit(0)
     # Choose which ever one has a valid value.
     database = dbname or database
 
@@ -1149,6 +1166,32 @@ def cli(database, user, host, port, socket, password, dbname,
         if not port:
             port = uri.port
 
+    if ssh_config_host:
+        if not paramiko:
+            click.secho(
+                "This features requires paramiko. Please install paramiko and try again.",
+                err=True, fg='red'
+            )
+            exit(1)
+        try:
+            ssh_config = paramiko.config.SSHConfig().from_path(ssh_config_path)
+        except paramiko.ssh_exception.ConfigParseError as err:
+            click.secho('Invalid SSH configuration file. '
+                        'Please check the SSH configuration file.',
+                        err=True, fg='red')
+            exit(1)
+        except FileNotFoundError as e:
+            click.secho(str(e), err=True, fg='red')
+            exit(1)
+        ssh_config = ssh_config.lookup(ssh_config_host)
+        ssh_host = ssh_host if ssh_host else ssh_config.get('hostname')
+        ssh_user = ssh_user if ssh_user else ssh_config.get('user')
+        if ssh_config.get('port') and ssh_port == 22:
+            # port has a default value, overwrite it if it's in the config
+            ssh_port = int(ssh_config.get('port'))
+        ssh_key_filename = ssh_key_filename if ssh_key_filename else ssh_config.get(
+            'identityfile', [''])[0]
+
     if not paramiko and ssh_host:
         click.secho(
             "Cannot use SSH transport because paramiko isn't installed, "

mycli/packages/filepaths.py

@@ -103,4 +103,4 @@ def guess_socket_location():
                 if name.startswith("mysql") and ext in ('.socket', '.sock'):
                     return os.path.join(r, filename)
             dirs[:] = [d for d in dirs if d.startswith("mysql")]
-    raise FileNotFoundError
+    return None

mycli/sqlexecute.py

@@ -191,7 +191,6 @@ def run(self, statement):
                     if not cur.nextset() or (not cur.rowcount and cur.description is None):
                         break
 
-
     def get_result(self, cursor):
         """Get the current result's data from the cursor."""
         title = headers = None