crate 0.29.0__py2.py3-none-any.whl → 0.30.1__py2.py3-none-any.whl

crate/client/sqlalchemy/tests/match_test.py

@@ -25,7 +25,10 @@ from unittest.mock import MagicMock
 
 import sqlalchemy as sa
 from sqlalchemy.orm import Session
-from sqlalchemy.ext.declarative import declarative_base
+try:
+    from sqlalchemy.orm import declarative_base
+except ImportError:
+    from sqlalchemy.ext.declarative import declarative_base
 
 from crate.client.sqlalchemy.types import Craty
 from crate.client.sqlalchemy.predicates import match
@@ -52,14 +55,14 @@ class SqlAlchemyMatchTest(TestCase):
         self.assertEqual(expected_str, str(actual_expr).replace('\n', ''))
 
     def set_up_character_and_session(self):
-        Base = declarative_base(bind=self.engine)
+        Base = declarative_base()
 
         class Character(Base):
             __tablename__ = 'characters'
             name = sa.Column(sa.String, primary_key=True)
             info = sa.Column(Craty)
 
-        session = Session()
+        session = Session(bind=self.engine)
         return session, Character
 
     def test_simple_match(self):

crate/client/sqlalchemy/tests/update_test.py

@@ -27,7 +27,10 @@ from crate.client.sqlalchemy.types import Object
 
 import sqlalchemy as sa
 from sqlalchemy.orm import Session
-from sqlalchemy.ext.declarative import declarative_base
+try:
+    from sqlalchemy.orm import declarative_base
+except ImportError:
+    from sqlalchemy.ext.declarative import declarative_base
 
 from crate.client.cursor import Cursor
 
@@ -42,7 +45,7 @@ class SqlAlchemyUpdateTest(TestCase):
 
     def setUp(self):
         self.engine = sa.create_engine('crate://')
-        self.base = declarative_base(bind=self.engine)
+        self.base = declarative_base()
 
         class Character(self.base):
             __tablename__ = 'characters'
@@ -53,7 +56,7 @@ class SqlAlchemyUpdateTest(TestCase):
             ts = sa.Column(sa.DateTime, onupdate=datetime.utcnow)
 
         self.character = Character
-        self.session = Session()
+        self.session = Session(bind=self.engine)
 
     @patch('crate.client.connection.Cursor', FakeCursor)
     def test_onupdate_is_triggered(self):

crate/client/sqlalchemy/tests/warnings_test.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8; -*-
+import sys
+import warnings
+from unittest import TestCase, skipIf
+
+from crate.client.sqlalchemy import SA_1_4, SA_VERSION
+from crate.testing.util import ExtraAssertions
+
+
+class SqlAlchemyWarningsTest(TestCase, ExtraAssertions):
+
+    @skipIf(SA_VERSION >= SA_1_4, "There is no deprecation warning for "
+                                  "SQLAlchemy 1.3 on higher versions")
+    def test_sa13_deprecation_warning(self):
+        """
+        Verify that a `DeprecationWarning` is issued when running SQLAlchemy 1.3.
+
+        https://docs.python.org/3/library/warnings.html#testing-warnings
+        """
+        with warnings.catch_warnings(record=True) as w:
+
+            # Cause all warnings to always be triggered.
+            warnings.simplefilter("always")
+
+            # Trigger a warning by importing the SQLAlchemy dialect module.
+            # Because it already has been loaded, unload it beforehand.
+            del sys.modules["crate.client.sqlalchemy"]
+            import crate.client.sqlalchemy  # noqa: F401
+
+            # Verify details of the SA13 EOL/deprecation warning.
+            self.assertEqual(len(w), 1)
+            self.assertIsSubclass(w[-1].category, DeprecationWarning)
+            self.assertIn("SQLAlchemy 1.3 is effectively EOL.", str(w[-1].message))

crate/client/test_connection.py

@@ -1,12 +1,37 @@
 import datetime
 
+from .connection import Connection
 from .http import Client
 from crate.client import connect
 from unittest import TestCase
 
+from ..testing.settings import crate_host
+
 
 class ConnectionTest(TestCase):
 
+    def test_connection_mock(self):
+        """
+        For testing purposes it is often useful to replace the client used for
+        communication with the CrateDB server with a stub or mock.
+
+        This can be done by passing an object of the Client class when calling the
+        ``connect`` method.
+        """
+
+        class MyConnectionClient:
+            active_servers = ["localhost:4200"]
+
+            def __init__(self):
+                pass
+
+            def server_infos(self, server):
+                return ("localhost:4200", "my server", "0.42.0")
+
+        connection = connect([crate_host], client=MyConnectionClient())
+        self.assertIsInstance(connection, Connection)
+        self.assertEqual(connection.client.server_infos("foo"), ('localhost:4200', 'my server', '0.42.0'))
+
     def test_lowest_server_version(self):
         infos = [(None, None, '0.42.3'),
                  (None, None, '0.41.8'),

crate/client/tests.py

@@ -27,7 +27,6 @@ import socket
 import unittest
 import doctest
 from pprint import pprint
-from datetime import datetime
 from http.server import HTTPServer, BaseHTTPRequestHandler
 import ssl
 import time
@@ -37,12 +36,11 @@ import logging
 import stopit
 
 from crate.testing.layer import CrateLayer
-from crate.testing.tests import crate_path, docs_path
+from crate.testing.settings import \
+    crate_host, crate_path, crate_port, \
+    crate_transport_port, docs_path, localhost
 from crate.client import connect
-from crate.client.sqlalchemy.dialect import CrateDialect
-from crate.client.test_util import ClientMocked
 
-from . import http
 from .test_cursor import CursorTest
 from .test_connection import ConnectionTest
 from .test_http import (
@@ -56,7 +54,6 @@ from .test_http import (
     TestDefaultSchemaHeader,
 )
 from .sqlalchemy.tests import test_suite as sqlalchemy_test_suite
-from .sqlalchemy.types import ObjectArray
 
 log = logging.getLogger('crate.testing.layer')
 ch = logging.StreamHandler()
@@ -70,10 +67,6 @@ def cprint(s):
     print(s)
 
 
-def setUpMocked(test):
-    test.globs['connection_client_mocked'] = ClientMocked()
-
-
 settings = {
     'udc.enabled': 'false',
     'lang.js.enabled': 'true',
@@ -85,11 +78,6 @@ settings = {
     'auth.host_based.config.99.user': 'me',
     'auth.host_based.config.99.method': 'password',
 }
-crate_port = 44209
-crate_transport_port = 44309
-local = '127.0.0.1'
-crate_host = "{host}:{port}".format(host=local, port=crate_port)
-crate_uri = "http://%s" % crate_host
 crate_layer = None
 
 
@@ -113,24 +101,16 @@ def ensure_cratedb_layer():
         crate_layer = CrateLayer('crate',
                                  crate_home=crate_path(),
                                  port=crate_port,
-                                 host=local,
+                                 host=localhost,
                                  transport_port=crate_transport_port,
                                  settings=settings)
     return crate_layer
 
 
-def refresh(table):
-    with connect(crate_host) as conn:
-        cursor = conn.cursor()
-        cursor.execute("refresh table %s" % table)
-
-
-def setUpWithCrateLayer(test):
-    test.globs['HttpClient'] = http.Client
+def setUpCrateLayerBaseline(test):
     test.globs['crate_host'] = crate_host
     test.globs['pprint'] = pprint
     test.globs['print'] = cprint
-    test.globs["refresh"] = refresh
 
     with connect(crate_host) as conn:
         cursor = conn.cursor()
@@ -151,62 +131,69 @@ def setUpWithCrateLayer(test):
         # create blob table
         cursor.execute("create blob table myfiles clustered into 1 shards " +
                        "with (number_of_replicas=0)")
+
         # create users
         cursor.execute("CREATE USER me WITH (password = 'my_secret_pw')")
         cursor.execute("CREATE USER trusted_me")
 
+        cursor.close()
 
-def setUpCrateLayerAndSqlAlchemy(test):
-    setUpWithCrateLayer(test)
-    import sqlalchemy as sa
-    from sqlalchemy.ext.declarative import declarative_base
-    from sqlalchemy.orm import sessionmaker
 
-    with connect(crate_host) as conn:
-        cursor = conn.cursor()
-        cursor.execute("""create table characters (
-          id string primary key,
-          name string,
-          quote string,
-          details object,
-          more_details array(object),
-          INDEX name_ft using fulltext(name) with (analyzer = 'english'),
-          INDEX quote_ft using fulltext(quote) with (analyzer = 'english')
-          )""")
-        cursor.execute("CREATE VIEW characters_view AS SELECT * FROM characters")
+def setUpCrateLayerSqlAlchemy(test):
+    """
+    Setup tables and views needed for SQLAlchemy tests.
+    """
+    setUpCrateLayerBaseline(test)
 
-    with connect(crate_host) as conn:
-        cursor = conn.cursor()
-        cursor.execute("""create table cities (
-          name string primary key,
-          coordinate geo_point,
-          area geo_shape
-    ) """)
-
-    engine = sa.create_engine('crate://{0}'.format(crate_host))
-    Base = declarative_base()
-
-    class Location(Base):
-        __tablename__ = 'locations'
-        name = sa.Column(sa.String, primary_key=True)
-        kind = sa.Column(sa.String)
-        date = sa.Column(sa.Date, default=lambda: datetime.utcnow().date())
-        datetime_tz = sa.Column(sa.DateTime, default=datetime.utcnow)
-        datetime_notz = sa.Column(sa.DateTime, default=datetime.utcnow)
-        nullable_datetime = sa.Column(sa.DateTime)
-        nullable_date = sa.Column(sa.Date)
-        flag = sa.Column(sa.Boolean)
-        details = sa.Column(ObjectArray)
-
-    Session = sessionmaker(engine)
-    session = Session()
-    test.globs['sa'] = sa
-    test.globs['engine'] = engine
-    test.globs['Location'] = Location
-    test.globs['Base'] = Base
-    test.globs['session'] = session
-    test.globs['Session'] = Session
-    test.globs['CrateDialect'] = CrateDialect
+    ddl_statements = [
+        """
+        CREATE TABLE characters (
+            id STRING PRIMARY KEY,
+            name STRING,
+            quote STRING,
+            details OBJECT,
+            more_details ARRAY(OBJECT),
+            INDEX name_ft USING fulltext(name) WITH (analyzer = 'english'),
+            INDEX quote_ft USING fulltext(quote) WITH (analyzer = 'english')
+            )""",
+        """
+        CREATE VIEW characters_view
+            AS SELECT * FROM characters
+        """,
+        """
+        CREATE TABLE cities (
+            name STRING PRIMARY KEY,
+            coordinate GEO_POINT,
+            area GEO_SHAPE
+        )"""
+    ]
+    _execute_statements(ddl_statements, on_error="raise")
+
+
+def tearDownDropEntitiesBaseline(test):
+    """
+    Drop all tables, views, and users created by `setUpWithCrateLayer*`.
+    """
+    ddl_statements = [
+        "DROP TABLE locations",
+        "DROP BLOB TABLE myfiles",
+        "DROP USER me",
+        "DROP USER trusted_me",
+    ]
+    _execute_statements(ddl_statements)
+
+
+def tearDownDropEntitiesSqlAlchemy(test):
+    """
+    Drop all tables, views, and users created by `setUpWithCrateLayer*`.
+    """
+    tearDownDropEntitiesBaseline(test)
+    ddl_statements = [
+        "DROP TABLE characters",
+        "DROP VIEW characters_view",
+        "DROP TABLE cities",
+    ]
+    _execute_statements(ddl_statements)
 
 
 class HttpsTestServerLayer:
@@ -298,7 +285,6 @@ class HttpsTestServerLayer:
 
 
 def setUpWithHttps(test):
-    test.globs['HttpClient'] = http.Client
     test.globs['crate_host'] = "https://{0}:{1}".format(
         HttpsTestServerLayer.HOST, HttpsTestServerLayer.PORT
     )
@@ -319,43 +305,33 @@ def setUpWithHttps(test):
     )
 
 
-def _try_execute(cursor, stmt):
+def _execute_statements(statements, on_error="ignore"):
+    with connect(crate_host) as conn:
+        cursor = conn.cursor()
+        for stmt in statements:
+            _execute_statement(cursor, stmt, on_error=on_error)
+        cursor.close()
+
+
+def _execute_statement(cursor, stmt, on_error="ignore"):
     try:
         cursor.execute(stmt)
-    except Exception:
+    except Exception:  # pragma: no cover
         # FIXME: Why does this croak on statements like ``DROP TABLE cities``?
         # Note: When needing to debug the test environment, you may want to
         #       enable this logger statement.
         # log.exception("Executing SQL statement failed")
-        pass
-
-
-def tearDownWithCrateLayer(test):
-    # clear testing data
-    with connect(crate_host) as conn:
-        for stmt in ["DROP TABLE locations",
-                     "DROP BLOB TABLE myfiles",
-                     "DROP TABLE characters",
-                     "DROP VIEW characters_view",
-                     "DROP TABLE cities",
-                     "DROP USER me",
-                     "DROP USER trusted_me",
-                     ]:
-            _try_execute(conn.cursor(), stmt)
+        if on_error == "ignore":
+            pass
+        elif on_error == "raise":
+            raise
 
 
 def test_suite():
     suite = unittest.TestSuite()
     flags = (doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS)
 
-    s = doctest.DocFileSuite(
-        'doctests/cursor.txt',
-        'doctests/connection.txt',
-        setUp=setUpMocked,
-        optionflags=flags,
-        encoding='utf-8'
-    )
-    suite.addTest(s)
+    # Unit tests.
     suite.addTest(unittest.makeSuite(CursorTest))
     suite.addTest(unittest.makeSuite(HttpClientTest))
     suite.addTest(unittest.makeSuite(KeepAliveClientTest))
@@ -371,34 +347,32 @@ def test_suite():
     suite.addTest(doctest.DocTestSuite('crate.client.http'))
 
     s = doctest.DocFileSuite(
-        'doctests/https.txt',
-        setUp=setUpWithHttps,
+        'docs/by-example/connection.rst',
+        'docs/by-example/cursor.rst',
+        module_relative=False,
         optionflags=flags,
         encoding='utf-8'
     )
-    s.layer = HttpsTestServerLayer()
     suite.addTest(s)
 
     s = doctest.DocFileSuite(
-        'sqlalchemy/doctests/itests.txt',
-        'sqlalchemy/doctests/dialect.txt',
-        'sqlalchemy/doctests/reflection.txt',
-        setUp=setUpCrateLayerAndSqlAlchemy,
-        tearDown=tearDownWithCrateLayer,
+        'docs/by-example/https.rst',
+        module_relative=False,
+        setUp=setUpWithHttps,
         optionflags=flags,
         encoding='utf-8'
     )
-    s.layer = ensure_cratedb_layer()
+    s.layer = HttpsTestServerLayer()
     suite.addTest(s)
 
+    # Integration tests.
     s = doctest.DocFileSuite(
-        'doctests/http.txt',
-        'doctests/blob.txt',
-        'doctests/client.txt',
-        'doctests/mocking.txt',
-        'doctests/blob.txt',
-        setUp=setUpWithCrateLayer,
-        tearDown=tearDownWithCrateLayer,
+        'docs/by-example/http.rst',
+        'docs/by-example/client.rst',
+        'docs/by-example/blob.rst',
+        module_relative=False,
+        setUp=setUpCrateLayerBaseline,
+        tearDown=tearDownDropEntitiesBaseline,
         optionflags=flags,
         encoding='utf-8'
     )
@@ -406,9 +380,14 @@ def test_suite():
     suite.addTest(s)
 
     s = doctest.DocFileSuite(
-        'doctests/sqlalchemy.txt',
-        setUp=setUpCrateLayerAndSqlAlchemy,
-        tearDown=tearDownWithCrateLayer,
+        'docs/by-example/sqlalchemy/getting-started.rst',
+        'docs/by-example/sqlalchemy/crud.rst',
+        'docs/by-example/sqlalchemy/working-with-types.rst',
+        'docs/by-example/sqlalchemy/advanced-querying.rst',
+        'docs/by-example/sqlalchemy/inspection-reflection.rst',
+        module_relative=False,
+        setUp=setUpCrateLayerSqlAlchemy,
+        tearDown=tearDownDropEntitiesSqlAlchemy,
         optionflags=flags,
         encoding='utf-8'
     )

crate/testing/layer.py

@@ -321,12 +321,12 @@ class CrateLayer(object):
             sys.stderr.write('\nCrate instance ready.\n')
 
     def stop(self):
+        self.conn_pool.clear()
         if self.process:
             self.process.terminate()
             self.process.communicate(timeout=10)
             self.process.stdout.close()
             self.process = None
-        self.conn_pool.clear()
         self.monitor.stop()
         self._clean()
 

crate/testing/settings.py

@@ -0,0 +1,51 @@
+# vi: set encoding=utf-8
+# -*- coding: utf-8; -*-
+#
+# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+# license agreements.  See the NOTICE file distributed with this work for
+# additional information regarding copyright ownership.  Crate licenses
+# this file to you under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# However, if you have executed another commercial license agreement
+# with Crate these terms will supersede the license and you may use the
+# software solely pursuant to the terms of the relevant commercial agreement.
+from __future__ import absolute_import
+
+import os
+
+
+def docs_path(*parts):
+    return os.path.abspath(
+        os.path.join(
+            os.path.dirname(os.path.dirname(__file__)), *parts
+        )
+    )
+
+
+def project_root(*parts):
+    return os.path.abspath(
+        os.path.join(docs_path("..", ".."), *parts)
+    )
+
+
+def crate_path(*parts):
+    return os.path.abspath(
+        project_root("parts", "crate", *parts)
+    )
+
+
+crate_port = 44209
+crate_transport_port = 44309
+localhost = '127.0.0.1'
+crate_host = "{host}:{port}".format(host=localhost, port=crate_port)
+crate_uri = "http://%s" % crate_host