Merge remote-tracking branch 'origin' into default-socket-location

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/packages/tabular_output/sql_format.py

@@ -9,6 +9,13 @@
 preprocessors = ()
 
 
+def escape_for_sql_statement(value):
+    if isinstance(value, bytes):
+        return f"X'{value.hex()}'"
+    else:
+        return formatter.mycli.sqlexecute.conn.escape(value)
+
+
 def adapter(data, headers, table_format=None, **kwargs):
     tables = extract_tables(formatter.query)
     if len(tables) > 0:
@@ -19,13 +26,13 @@ def adapter(data, headers, table_format=None, **kwargs):
             table_name = table[1]
     else:
         table_name = "`DUAL`"
-    escape = formatter.mycli.sqlexecute.conn.escape
     if table_format == 'sql-insert':
         h = "`, `".join(headers)
         yield "INSERT INTO {} (`{}`) VALUES".format(table_name, h)
         prefix = "  "
         for d in data:
-            values = ", ".join(escape(v) for i, v in enumerate(d))
+            values = ", ".join(escape_for_sql_statement(v)
+                               for i, v in enumerate(d))
             yield "{}({})".format(prefix, values)
             if prefix == "  ":
                 prefix = ", "
@@ -39,11 +46,12 @@ def adapter(data, headers, table_format=None, **kwargs):
             yield "UPDATE {} SET".format(table_name)
             prefix = "  "
             for i, v in enumerate(d[keys:], keys):
-                yield "{}`{}` = {}".format(prefix, headers[i], escape(v))
+                yield "{}`{}` = {}".format(prefix, headers[i], escape_for_sql_statement(v))
                 if prefix == "  ":
                     prefix = ", "
             f = "`{}` = {}"
-            where = (f.format(headers[i], escape(d[i])) for i in range(keys))
+            where = (f.format(headers[i], escape_for_sql_statement(
+                d[i])) for i in range(keys))
             yield "WHERE {};".format(" AND ".join(where))
 
 

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

setup.py

@@ -19,7 +19,7 @@
 install_requirements = [
     'click >= 7.0',
     'Pygments >= 1.6',
-    'prompt_toolkit>=2.0.6,<3.0.0',
+    'prompt_toolkit>=3.0.0,<4.0.0',
     'PyMySQL >= 0.9.2',
     'sqlparse>=0.3.0,<0.4.0',
     'configobj >= 5.0.5',

test/features/environment.py

@@ -17,6 +17,7 @@ def before_all(context):
     os.environ['COLUMNS'] = "100"
     os.environ['EDITOR'] = 'ex'
     os.environ['LC_ALL'] = 'en_US.utf8'
+    os.environ['PROMPT_TOOLKIT_NO_CPR'] = '1'
 
     test_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
     login_path_file = os.path.join(test_dir, 'mylogin.cnf')

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"

test/test_tabular_output.py

@@ -23,13 +23,21 @@ def mycli():
 @dbtest
 def test_sql_output(mycli):
     """Test the sql output adapter."""
-    headers = ['letters', 'number', 'optional', 'float']
+    headers = ['letters', 'number', 'optional', 'float', 'binary']
 
     class FakeCursor(object):
         def __init__(self):
-            self.data = [('abc', 1, None, 10.0), ('d', 456, '1', 0.5)]
-            self.description = [(None, FIELD_TYPE.VARCHAR), (None, FIELD_TYPE.LONG),
-                                (None, FIELD_TYPE.LONG), (None, FIELD_TYPE.FLOAT)]
+            self.data = [
+                ('abc', 1, None, 10.0, b'\xAA'),
+                ('d', 456, '1', 0.5, b'\xAA\xBB')
+            ]
+            self.description = [
+                (None, FIELD_TYPE.VARCHAR),
+                (None, FIELD_TYPE.LONG),
+                (None, FIELD_TYPE.LONG),
+                (None, FIELD_TYPE.FLOAT),
+                (None, FIELD_TYPE.BLOB)
+            ]
 
         def __iter__(self):
             return self
@@ -40,8 +48,6 @@ def __next__(self):
             else:
                 raise StopIteration()
 
-        next = __next__  # Python 2
-
         def description(self):
             return self.description
 
@@ -55,11 +61,13 @@ def description(self):
               `number` = 1
             , `optional` = NULL
             , `float` = 10
+            , `binary` = X'aa'
             WHERE `letters` = 'abc';
             UPDATE `DUAL` SET
               `number` = 456
             , `optional` = '1'
             , `float` = 0.5
+            , `binary` = X'aabb'
             WHERE `letters` = 'd';''')
     # Test sql-update-2 output format
     assert list(mycli.change_table_format("sql-update-2")) == \
@@ -70,38 +78,40 @@ def description(self):
             UPDATE `DUAL` SET
               `optional` = NULL
             , `float` = 10
+            , `binary` = X'aa'
             WHERE `letters` = 'abc' AND `number` = 1;
             UPDATE `DUAL` SET
               `optional` = '1'
             , `float` = 0.5
+            , `binary` = X'aabb'
             WHERE `letters` = 'd' AND `number` = 456;''')
     # Test sql-insert output format (without table name)
     assert list(mycli.change_table_format("sql-insert")) == \
         [(None, None, None, 'Changed table format to sql-insert')]
     mycli.formatter.query = ""
     output = mycli.format_output(None, FakeCursor(), headers)
     assert "\n".join(output) == dedent('''\
-            INSERT INTO `DUAL` (`letters`, `number`, `optional`, `float`) VALUES
-              ('abc', 1, NULL, 10)
-            , ('d', 456, '1', 0.5)
+            INSERT INTO `DUAL` (`letters`, `number`, `optional`, `float`, `binary`) VALUES
+              ('abc', 1, NULL, 10, X'aa')
+            , ('d', 456, '1', 0.5, X'aabb')
             ;''')
     # Test sql-insert output format (with table name)
     assert list(mycli.change_table_format("sql-insert")) == \
         [(None, None, None, 'Changed table format to sql-insert')]
     mycli.formatter.query = "SELECT * FROM `table`"
     output = mycli.format_output(None, FakeCursor(), headers)
     assert "\n".join(output) == dedent('''\
-            INSERT INTO `table` (`letters`, `number`, `optional`, `float`) VALUES
-              ('abc', 1, NULL, 10)
-            , ('d', 456, '1', 0.5)
+            INSERT INTO `table` (`letters`, `number`, `optional`, `float`, `binary`) VALUES
+              ('abc', 1, NULL, 10, X'aa')
+            , ('d', 456, '1', 0.5, X'aabb')
             ;''')
     # Test sql-insert output format (with database + table name)
     assert list(mycli.change_table_format("sql-insert")) == \
         [(None, None, None, 'Changed table format to sql-insert')]
     mycli.formatter.query = "SELECT * FROM `database`.`table`"
     output = mycli.format_output(None, FakeCursor(), headers)
     assert "\n".join(output) == dedent('''\
-            INSERT INTO `database`.`table` (`letters`, `number`, `optional`, `float`) VALUES
-              ('abc', 1, NULL, 10)
-            , ('d', 456, '1', 0.5)
+            INSERT INTO `database`.`table` (`letters`, `number`, `optional`, `float`, `binary`) VALUES
+              ('abc', 1, NULL, 10, X'aa')
+            , ('d', 456, '1', 0.5, X'aabb')
             ;''')

test/utils.py

@@ -12,7 +12,7 @@
 PASSWORD = os.getenv('PYTEST_PASSWORD')
 USER = os.getenv('PYTEST_USER', 'root')
 HOST = os.getenv('PYTEST_HOST', 'localhost')
-PORT = os.getenv('PYTEST_PORT', 3306)
+PORT = int(os.getenv('PYTEST_PORT', 3306))
 CHARSET = os.getenv('PYTEST_CHARSET', 'utf8')
 SSH_USER = os.getenv('PYTEST_SSH_USER', None)
 SSH_HOST = os.getenv('PYTEST_SSH_HOST', None)