Added ClickHouse support (#173)

* Added ClickHouse support

* Improvements for `_configure` method

Author: yakimka

README.rst

@@ -19,6 +19,7 @@ Currently available features:
 * Neo4j container
 * OracleDb container
 * PostgreSQL Db container
+* ClickHouse container
 * Microsoft SQL Server container
 * Generic docker containers
 * LocalStack

docs/database.rst

@@ -1,7 +1,7 @@
 Database containers
 ===================
 
-Allows to spin up database images such as MySQL, PostgreSQL, MariaDB, Oracle XE, MongoDb or Neo4j.
+Allows to spin up database images such as MySQL, PostgreSQL, MariaDB, Oracle XE, MongoDb, ClickHouse or Neo4j.
 
 .. autoclass:: testcontainers.mysql.MySqlContainer
 .. autoclass:: testcontainers.mysql.MariaDbContainer
@@ -10,4 +10,5 @@ Allows to spin up database images such as MySQL, PostgreSQL, MariaDB, Oracle XE,
 .. autoclass:: testcontainers.elasticsearch.ElasticSearchContainer
 .. autoclass:: testcontainers.mongodb.MongoDbContainer
 .. autoclass:: testcontainers.mssql.SqlServerContainer
+.. autoclass:: testcontainers.clickhouse.ClickHouseContainer
 .. autoclass:: testcontainers.neo4j.Neo4jContainer

requirements.in

@@ -1,4 +1,4 @@
--e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,mongo,redis,mssqlserver,neo4j,kafka,rabbitmq]
+-e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,mongo,redis,mssqlserver,neo4j,kafka,rabbitmq,clickhouse]
 codecov>=2.1.0
 flake8<3.8.0  # 3.8.0 adds a dependency on importlib-metadata which conflicts with other packages.
 pytest

requirements/3.6.txt

@@ -16,6 +16,10 @@ attrs==21.4.0
     #   pytest
 babel==2.9.1
     # via sphinx
+backports.zoneinfo==0.2.1
+    # via
+    #   pytz-deprecation-shim
+    #   tzlocal
 bcrypt==3.2.0
     # via paramiko
 cached-property==1.5.2
@@ -31,6 +35,8 @@ cffi==1.15.0
     #   pynacl
 charset-normalizer==2.0.12
     # via requests
+clickhouse-driver==0.2.3
+    # via testcontainers
 codecov==2.1.12
     # via -r requirements.in
 coverage[toml]==6.2
@@ -98,6 +104,8 @@ importlib-metadata==4.8.3
     #   redis
     #   sphinx
     #   sqlalchemy
+importlib-resources==5.4.0
+    # via backports.zoneinfo
 iniconfig==1.1.1
     # via pytest
 jinja2==3.0.3
@@ -170,7 +178,10 @@ python-dotenv==0.20.0
 pytz==2022.1
     # via
     #   babel
+    #   clickhouse-driver
     #   neo4j
+pytz-deprecation-shim==0.1.0.post0
+    # via tzlocal
 pyyaml==5.4.1
     # via docker-compose
 redis==4.2.0
@@ -197,7 +208,7 @@ six==1.16.0
     #   websocket-client
 snowballstemmer==2.2.0
     # via sphinx
-sphinx==4.4.0
+sphinx==4.5.0
     # via -r requirements.in
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
@@ -224,6 +235,10 @@ typing-extensions==4.1.1
     #   async-timeout
     #   importlib-metadata
     #   redis
+tzdata==2022.1
+    # via pytz-deprecation-shim
+tzlocal==4.1
+    # via clickhouse-driver
 urllib3==1.26.9
     # via
     #   requests
@@ -237,7 +252,9 @@ wrapt==1.14.0
     #   deprecated
     #   testcontainers
 zipp==3.6.0
-    # via importlib-metadata
+    # via
+    #   importlib-metadata
+    #   importlib-resources
 
 # The following packages are considered to be unsafe in a requirements file:
 # setuptools

requirements/3.7.txt

@@ -22,6 +22,10 @@ attrs==21.4.0
     #   trio
 babel==2.9.1
     # via sphinx
+backports-zoneinfo==0.2.1
+    # via
+    #   pytz-deprecation-shim
+    #   tzlocal
 bcrypt==3.2.0
     # via paramiko
 cached-property==1.5.2
@@ -39,6 +43,8 @@ cffi==1.15.0
     #   pynacl
 charset-normalizer==2.0.12
     # via requests
+clickhouse-driver==0.2.3
+    # via testcontainers
 codecov==2.1.12
     # via -r requirements.in
 coverage[toml]==6.3.2
@@ -192,7 +198,10 @@ python-dotenv==0.20.0
 pytz==2022.1
     # via
     #   babel
+    #   clickhouse-driver
     #   neo4j
+pytz-deprecation-shim==0.1.0.post0
+    # via tzlocal
 pyyaml==5.4.1
     # via docker-compose
 redis==4.2.0
@@ -223,7 +232,7 @@ snowballstemmer==2.2.0
     # via sphinx
 sortedcontainers==2.4.0
     # via trio
-sphinx==4.4.0
+sphinx==4.5.0
     # via -r requirements.in
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
@@ -257,6 +266,10 @@ typing-extensions==4.1.1
     #   h11
     #   importlib-metadata
     #   redis
+tzdata==2022.1
+    # via pytz-deprecation-shim
+tzlocal==4.1
+    # via clickhouse-driver
 urllib3[secure,socks]==1.26.9
     # via
     #   requests

requirements/3.8.txt

@@ -22,6 +22,10 @@ attrs==21.4.0
     #   trio
 babel==2.9.1
     # via sphinx
+backports-zoneinfo==0.2.1
+    # via
+    #   pytz-deprecation-shim
+    #   tzlocal
 bcrypt==3.2.0
     # via paramiko
 cachetools==5.0.0
@@ -37,6 +41,8 @@ cffi==1.15.0
     #   pynacl
 charset-normalizer==2.0.12
     # via requests
+clickhouse-driver==0.2.3
+    # via testcontainers
 codecov==2.1.12
     # via -r requirements.in
 coverage[toml]==6.3.2
@@ -184,7 +190,10 @@ python-dotenv==0.20.0
 pytz==2022.1
     # via
     #   babel
+    #   clickhouse-driver
     #   neo4j
+pytz-deprecation-shim==0.1.0.post0
+    # via tzlocal
 pyyaml==5.4.1
     # via docker-compose
 redis==4.2.0
@@ -215,7 +224,7 @@ snowballstemmer==2.2.0
     # via sphinx
 sortedcontainers==2.4.0
     # via trio
-sphinx==4.4.0
+sphinx==4.5.0
     # via -r requirements.in
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
@@ -245,6 +254,10 @@ trio-websocket==0.9.2
     # via selenium
 typing-extensions==4.1.1
     # via redis
+tzdata==2022.1
+    # via pytz-deprecation-shim
+tzlocal==4.1
+    # via clickhouse-driver
 urllib3[secure,socks]==1.26.9
     # via
     #   requests

requirements/3.9.txt

@@ -37,6 +37,8 @@ cffi==1.15.0
     #   pynacl
 charset-normalizer==2.0.12
     # via requests
+clickhouse-driver==0.2.3
+    # via testcontainers
 codecov==2.1.12
     # via -r requirements.in
 coverage[toml]==6.3.2
@@ -184,7 +186,10 @@ python-dotenv==0.20.0
 pytz==2022.1
     # via
     #   babel
+    #   clickhouse-driver
     #   neo4j
+pytz-deprecation-shim==0.1.0.post0
+    # via tzlocal
 pyyaml==5.4.1
     # via docker-compose
 redis==4.2.0
@@ -215,7 +220,7 @@ snowballstemmer==2.2.0
     # via sphinx
 sortedcontainers==2.4.0
     # via trio
-sphinx==4.4.0
+sphinx==4.5.0
     # via -r requirements.in
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
@@ -245,6 +250,10 @@ trio-websocket==0.9.2
     # via selenium
 typing-extensions==4.1.1
     # via redis
+tzdata==2022.1
+    # via pytz-deprecation-shim
+tzlocal==4.1
+    # via clickhouse-driver
 urllib3[secure,socks]==1.26.9
     # via
     #   requests

setup.py

@@ -65,6 +65,7 @@
         'neo4j': ['neo4j'],
         'kafka': ['kafka-python'],
         'rabbitmq': ['pika'],
+        'clickhouse': ['clickhouse-driver'],
     },
     long_description_content_type="text/x-rst",
     long_description=long_description,

testcontainers/clickhouse.py

@@ -0,0 +1,75 @@
+#
+#    Licensed 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.
+import os
+
+import clickhouse_driver
+from clickhouse_driver.errors import Error
+
+from testcontainers.core.generic import DbContainer
+from testcontainers.core.waiting_utils import wait_container_is_ready
+
+
+class ClickHouseContainer(DbContainer):
+    """
+    ClickHouse database container.
+
+    Example
+    -------
+    The example spins up a ClickHouse database and connects to it
+    using the :code:`clickhouse-driver`.
+    ::
+
+        with ClickHouseContainer("clickhouse/clickhouse-server:21.8") as clickhouse:
+            with clickhouse_driver.Client.from_url(self.get_connection_url()) as client:
+                result = client.execute("SELECT version()")
+    """
+
+    CLICKHOUSE_USER = os.environ.get("CLICKHOUSE_USER", "test")
+    CLICKHOUSE_PASSWORD = os.environ.get("CLICKHOUSE_PASSWORD", "test")
+    CLICKHOUSE_DB = os.environ.get("CLICKHOUSE_DB", "test")
+
+    def __init__(
+            self,
+            image="clickhouse/clickhouse-server:latest",
+            port=9000,
+            user=None,
+            password=None,
+            dbname=None
+    ):
+        super().__init__(image=image)
+
+        self.CLICKHOUSE_USER = user or self.CLICKHOUSE_USER
+        self.CLICKHOUSE_PASSWORD = password or self.CLICKHOUSE_PASSWORD
+        self.CLICKHOUSE_DB = dbname or self.CLICKHOUSE_DB
+        self.port_to_expose = port
+
+    @wait_container_is_ready(Error, EOFError)
+    def _connect(self):
+        with clickhouse_driver.Client.from_url(self.get_connection_url()) as client:
+            client.execute("SELECT version()")
+
+    def _configure(self):
+        self.with_exposed_ports(self.port_to_expose)
+        self.with_env("CLICKHOUSE_USER", self.CLICKHOUSE_USER)
+        self.with_env("CLICKHOUSE_PASSWORD", self.CLICKHOUSE_PASSWORD)
+        self.with_env("CLICKHOUSE_DB", self.CLICKHOUSE_DB)
+
+    def get_connection_url(self, host=None):
+        return self._create_connection_url(
+            dialect="clickhouse",
+            username=self.CLICKHOUSE_USER,
+            password=self.CLICKHOUSE_PASSWORD,
+            db_name=self.CLICKHOUSE_DB,
+            host=host,
+            port=self.port_to_expose,
+        )

tests/test_db_containers.py

@@ -1,9 +1,11 @@
 import sqlalchemy
+import clickhouse_driver
 from pymongo import MongoClient
 from pymongo.errors import OperationFailure
 import pytest
 
 from testcontainers.core.utils import is_arm
+from testcontainers.clickhouse import ClickHouseContainer
 from testcontainers.core.container import DockerContainer
 from testcontainers.core.waiting_utils import wait_for
 from testcontainers.mongodb import MongoDbContainer
@@ -151,3 +153,12 @@ def test_docker_run_mssql():
         result = e.execute('select @@servicename')
         for row in result:
             assert row[0] == 'MSSQLSERVER'
+
+
+def test_docker_run_clickhouse():
+    clickhouse_container = ClickHouseContainer()
+    with clickhouse_container as clickhouse:
+        client = clickhouse_driver.Client.from_url(clickhouse.get_connection_url())
+        result = client.execute("select 'working'")
+
+        assert result == [('working',)]