Improved connect arguments to support credentials and SSL mode with SA

- Accept credentials within the HTTP URI
- Enable SSL mode using the SQLAlchemy dialect's DB URI

Author: amotl

.gitignore

@@ -1,3 +1,4 @@
+.venv*
 .coverage/
 .idea/
 .installed.cfg

CHANGES.txt

@@ -11,6 +11,11 @@ Unreleased
   HTTP by default. Previously, this setting defaulted to false. This setting
   can be changed via the ``verify_ssl_cert`` connection parameter.
 
+- Adjusted connect arguments to accept credentials within the HTTP URI.
+
+- Adjusted connect arguments to enable SSL mode using the SQLAlchemy dialect's
+  DB URI.
+
 2020/09/28 0.26.0
 =================
 

src/crate/client/doctests/client.txt

@@ -54,6 +54,19 @@ also need to provide ``password`` as argument for the ``connect()`` call::
     >>> connection = client.connect([crate_host],
     ...                             username='me',
     ...                             password='my_secret_pw')
+    >>> connection.client.username
+    'me'
+    >>> connection.client.password
+    'my_secret_pw'
+
+The authentication credentials can also be provided in the URL::
+
+    >>> connection = client.connect(['http://me:[email protected]:4200'])
+    >>> connection.client.username
+    'me'
+    >>> connection.client.password
+    'my_secret_pw'
+
 
 Default Schema
 --------------

src/crate/client/http.py

@@ -346,6 +346,19 @@ def __init__(self,
             servers = [self.default_server]
         else:
             servers = _to_server_list(servers)
+
+        # Try to derive credentials from first server argument if not
+        # explicitly given.
+        if not username and not password:
+            try:
+                url = urlparse(servers[0])
+                if url.username is not None:
+                    username = url.username
+                if url.password is not None:
+                    password = url.password
+            except Exception:
+                pass
+
         self._active_servers = servers
         self._inactive_servers = []
         pool_kw = _pool_kw_args(

src/crate/client/sqlalchemy/dialect.py

@@ -25,6 +25,7 @@
 from sqlalchemy import types as sqltypes
 from sqlalchemy.engine import default, reflection
 from sqlalchemy.sql import functions
+from sqlalchemy.util import asbool
 
 from .compiler import (
     CrateCompiler,
@@ -195,6 +196,13 @@ def connect(self, host=None, port=None, *args, **kwargs):
         if 'servers' in kwargs:
             server = kwargs.pop('servers')
         if server:
+            # Evaluate "ssl" connection URI query parameter.
+            # TODO: Evaluate more parameters like `ssl_ca`, `ssl_key`, `ssl_cert`,
+            #       `ssl_capath` and `ssl_cipher`.
+            if "ssl" in kwargs:
+                use_ssl = asbool(kwargs.pop("ssl"))
+                if use_ssl:
+                    server = "https://" + server
             return self.dbapi.connect(servers=server, **kwargs)
         return self.dbapi.connect(**kwargs)
 

src/crate/client/sqlalchemy/tests/connection_test.py

@@ -35,14 +35,21 @@ def test_default_connection(self):
         self.assertEqual("<Connection <Client ['http://127.0.0.1:4200']>>",
                          repr(conn.connection))
 
-    def test_connection_server(self):
+    def test_connection_server_uri_http(self):
         engine = sa.create_engine(
             "crate://otherhost:19201")
         conn = engine.raw_connection()
         self.assertEqual("<Connection <Client ['http://otherhost:19201']>>",
                          repr(conn.connection))
 
-    def test_connection_multiple_server(self):
+    def test_connection_server_uri_https(self):
+        engine = sa.create_engine(
+            "crate://otherhost:19201/?ssl=true")
+        conn = engine.raw_connection()
+        self.assertEqual("<Connection <Client ['https://otherhost:19201']>>",
+                         repr(conn.connection))
+
+    def test_connection_multiple_server_http(self):
         engine = sa.create_engine(
             "crate://", connect_args={
                 'servers': ['localhost:4201', 'localhost:4202']
@@ -53,3 +60,16 @@ def test_connection_multiple_server(self):
             "<Connection <Client ['http://localhost:4201', " +
             "'http://localhost:4202']>>",
             repr(conn.connection))
+
+    def test_connection_multiple_server_https(self):
+        engine = sa.create_engine(
+            "crate://", connect_args={
+                'servers': ['https://localhost:4201', 'https://localhost:4202'],
+                'ssl': True,
+            }
+        )
+        conn = engine.raw_connection()
+        self.assertEqual(
+            "<Connection <Client ['https://localhost:4201', " +
+            "'https://localhost:4202']>>",
+            repr(conn.connection))