Merge pull request #844 from hxueh/feature/ssh_config

Feature/ssh config

Author: gfrlv

README.md

@@ -6,7 +6,7 @@
 
 A command line client for MySQL that can do auto-completion and syntax highlighting.
 
-HomePage: [http://mycli.net](http://mycli.net)  
+HomePage: [http://mycli.net](http://mycli.net)
 Documentation: [http://mycli.net/docs](http://mycli.net/docs)
 
 ![Completion](screenshots/tables.png)
@@ -63,6 +63,8 @@ $ sudo apt-get install mycli # Only on debian or ubuntu
       --ssh-password TEXT           Password to connect to ssh server.
       --ssh-key-filename TEXT       Private key filename (identify file) for the
                                     ssh connection.
+      --ssh-config-path TEXT        Path to ssh configuation.
+      --ssh-config-host TEXT        Host for ssh server in ssh configuations (requires paramiko).
       --ssl-ca PATH                 CA file in PEM format.
       --ssl-capath TEXT             CA directory.
       --ssl-cert PATH               X509 cert in PEM format.
@@ -78,6 +80,7 @@ $ sudo apt-get install mycli # Only on debian or ubuntu
                                     section of myclirc file.
       --list-dsn                    list of DSN configured into the [alias_dsn]
                                     section of myclirc file.
+      --list-ssh-config             list ssh configurations in the ssh config (requires paramiko).
       -R, --prompt TEXT             Prompt format (Default: "\t \u@\h:\d> ").
       -l, --logfile FILENAME        Log every query and its results to a file.
       --defaults-group-suffix TEXT  Read MySQL config groups with the specified

changelog.md

@@ -1,6 +1,17 @@
+TBD
+===
+
+Features:
+---------
+* Add an option `--ssh-config-host` to read ssh configuration from OpenSSH configuration file.
+* Add an option `--list-ssh-config` to list ssh configurations.
+* Add an option `--ssh-config-path` to choose ssh configuration path.
+
+
 1.21.1
 ======
 
+
 Bug Fixes:
 ----------
 

mycli/AUTHORS

@@ -68,6 +68,7 @@ Contributors:
   * Mike Palandra
   * Georgy Frolov
   * Jonathan Lloyd
+  * Nathan Huang
   * Jakub Boukal
   * Takeshi D. Itoh
   * laixintao

mycli/main.py

@@ -995,6 +995,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.')
@@ -1016,6 +1019,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))
@@ -1048,7 +1053,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
@@ -1085,6 +1090,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
 
@@ -1135,6 +1165,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, "

requirements-dev.txt

@@ -11,3 +11,4 @@ autopep8==1.3.3
 colorama==0.4.1
 git+https://github.com/hayd/pep8radius.git  # --error-status option not released
 click>=7.0
+paramiko==2.7.1

test/test_main.py

@@ -283,6 +283,24 @@ def test_list_dsn():
         assert result.output == "test : mysql://test/test\n"
 
 
+def test_list_ssh_config():
+    runner = CliRunner()
+    with NamedTemporaryFile(mode="w") as ssh_config:
+        ssh_config.write(dedent("""\
+            Host test
+                Hostname test.example.com
+                User joe
+                Port 22222
+                IdentityFile ~/.ssh/gateway
+        """))
+        ssh_config.flush()
+        args = ['--list-ssh-config', '--ssh-config-path', ssh_config.name]
+        result = runner.invoke(cli, args=args)
+        assert "test\n" in result.output
+        result = runner.invoke(cli, args=args + ['--verbose'])
+        assert "test : test.example.com\n" in result.output
+
+
 def test_dsn(monkeypatch):
     # Setup classes to mock mycli.main.MyCli
     class Formatter:
@@ -395,3 +413,82 @@ def run_query(self, query, new_line=True):
         MockMyCli.connect_args["host"] == "dsn_host" and \
         MockMyCli.connect_args["port"] == 6 and \
         MockMyCli.connect_args["database"] == "dsn_database"
+
+
+def test_ssh_config(monkeypatch):
+    # Setup classes to mock mycli.main.MyCli
+    class Formatter:
+        format_name = None
+
+    class Logger:
+        def debug(self, *args, **args_dict):
+            pass
+
+        def warning(self, *args, **args_dict):
+            pass
+
+    class MockMyCli:
+        config = {'alias_dsn': {}}
+
+        def __init__(self, **args):
+            self.logger = Logger()
+            self.destructive_warning = False
+            self.formatter = Formatter()
+
+        def connect(self, **args):
+            MockMyCli.connect_args = args
+
+        def run_query(self, query, new_line=True):
+            pass
+
+    import mycli.main
+    monkeypatch.setattr(mycli.main, 'MyCli', MockMyCli)
+    runner = CliRunner()
+
+    # Setup temporary configuration
+    with NamedTemporaryFile(mode="w") as ssh_config:
+        ssh_config.write(dedent("""\
+            Host test
+                Hostname test.example.com
+                User joe
+                Port 22222
+                IdentityFile ~/.ssh/gateway
+        """))
+        ssh_config.flush()
+
+        # When a user supplies a ssh config.
+        result = runner.invoke(mycli.main.cli, args=[
+            "--ssh-config-path",
+            ssh_config.name,
+            "--ssh-config-host",
+            "test"
+        ])
+        assert result.exit_code == 0, result.output + \
+            " " + str(result.exception)
+        assert \
+            MockMyCli.connect_args["ssh_user"] == "joe" and \
+            MockMyCli.connect_args["ssh_host"] == "test.example.com" and \
+            MockMyCli.connect_args["ssh_port"] == 22222 and \
+            MockMyCli.connect_args["ssh_key_filename"] == os.getenv(
+                "HOME") + "/.ssh/gateway"
+
+        # When a user supplies a ssh config host as argument to mycli,
+        # and used command line arguments, use the command line
+        # arguments.
+        result = runner.invoke(mycli.main.cli, args=[
+            "--ssh-config-path",
+            ssh_config.name,
+            "--ssh-config-host",
+            "test",
+            "--ssh-user", "arg_user",
+            "--ssh-host", "arg_host",
+            "--ssh-port", "3",
+            "--ssh-key-filename", "/path/to/key"
+        ])
+        assert result.exit_code == 0, result.output + \
+            " " + str(result.exception)
+        assert \
+            MockMyCli.connect_args["ssh_user"] == "arg_user" and \
+            MockMyCli.connect_args["ssh_host"] == "arg_host" and \
+            MockMyCli.connect_args["ssh_port"] == 3 and \
+            MockMyCli.connect_args["ssh_key_filename"] == "/path/to/key"