BUG27528819: Support special characters in the user and password using URI

nmariz · nmariz · commit c41171b1a8f4 · 2018-08-13T14:54:01.000+01:00
Special characters are not allowed in the user and password for connection
strings, used in the mysqlx.get_session() function.
This patch fixes this issue by allowing to quote the user and password in
the connection string.

A URI test was added for regression.
diff --git a/docs/mysqlx/tutorials/getting_started.rst b/docs/mysqlx/tutorials/getting_started.rst
@@ -80,7 +80,15 @@ Connector/Python has a C extension for `Protobuf <https://developers.google.com/
        'use-pure': True
    })
 
-The :func:`mysqlx.Schema.get_schema()` method returns a :class:`mysqlx.Schema` object. We can use this :class:`mysqlx.Schema` object to access collections and tables. X DevAPI's ability to chain all object constructions, enables you to get to the schema object in one line. For example:
+.. note:: The `urllib.parse.quote <https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote>`_ function should be used to quote special characters for user and password when using a connection string in the :func:`mysqlx.get_session()` function.
+
+.. code-block:: python
+
+   from urllib.parse import quote
+   session = mysqlx.get_session('mysqlx://root:{0}@localhost:33060?use-pure=true'
+                                ''.format(quote('pass?!#%@/')))
+
+The :func:`mysqlx.Session.get_schema()` method returns a :class:`mysqlx.Schema` object. We can use this :class:`mysqlx.Schema` object to access collections and tables. X DevAPI's ability to chain all object constructions, enables you to get to the schema object in one line. For example:
 
 .. code-block:: python
 
diff --git a/lib/mysqlx/__init__.py b/lib/mysqlx/__init__.py
@@ -115,7 +115,8 @@ def _parse_connection_uri(uri):
 
     if not host or not userinfo or ":" not in userinfo:
         raise InterfaceError("Malformed URI '{0}'".format(uri))
-    settings["user"], settings["password"] = userinfo.split(":", 1)
+    user, password = userinfo.split(":", 1)
+    settings["user"], settings["password"] = unquote(user), unquote(password)
 
     if host.startswith(("/", "..", ".")):
         settings["socket"] = unquote(host)
diff --git a/tests/test_mysqlx_connection.py b/tests/test_mysqlx_connection.py
@@ -44,9 +44,10 @@
 from mysqlx.protobuf import HAVE_MYSQLXPB_CEXT
 
 if mysqlx.compat.PY3:
-    from urllib.parse import quote_plus
+    from urllib.parse import quote_plus, quote
 else:
     from urllib import quote_plus
+    from urlparse import quote
 
 from .test_mysqlx_crud import drop_table
 
@@ -73,6 +74,11 @@
                                               "password": "", "port": 33060,
                                               "user": "user",
                                               "use-pure": True}),
+    ("user{0}:password{0}@127.0.0.1/schema?use_pure=true"
+     "".format(quote("?!@#$%/:")), {"schema": "schema", "host": "127.0.0.1",
+                                    "port": 33060, "user": "user?!@#$%/:",
+                                    "password": "password?!@#$%/:",
+                                    "use-pure": True}),
     ("mysqlx://user:@127.0.0.1", {"schema": "", "host": "127.0.0.1",
                                   "password": "", "port": 33060,
                                   "user": "user"}),
