add SingleStore container

Author: Vitalii Heria

.github/workflows/main.yml

@@ -44,6 +44,7 @@ jobs:
         - rabbitmq
         - redis
         - selenium
+        - singlestore
     runs-on: ${{ matrix.runtime.machine }}
     steps:
       - uses: actions/checkout@v3

README.rst

@@ -34,6 +34,7 @@ testcontainers-python facilitates the use of Docker containers for functional an
     rabbitmq/README
     redis/README
     selenium/README
+    singlestore/README
 
 Getting Started
 ---------------

requirements.in

@@ -21,6 +21,7 @@
 -e file:rabbitmq
 -e file:redis
 -e file:selenium
+-e file:singlestore
 cryptography<37
 flake8<3.8.0  # 3.8.0 adds a dependency on importlib-metadata which conflicts with other packages.
 pg8000

singlestore/README.rst

@@ -0,0 +1 @@
+.. autoclass:: testcontainers.singlestore.SingleStoreContainer

singlestore/setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_namespace_packages
+
+description = "SingleStore component of testcontainers-python."
+
+setup(
+    name="testcontainers-singlestore",
+    version="0.0.1rc1",
+    packages=find_namespace_packages(),
+    description=description,
+    long_description=description,
+    long_description_content_type="text/x-rst",
+    url="https://github.com/testcontainers/testcontainers-python",
+    install_requires=[
+        "testcontainers-core",
+        "sqlalchemy",
+        "pymysql",
+    ],
+    python_requires=">=3.7",
+)

singlestore/testcontainers/singlestore/__init__.py

@@ -0,0 +1,95 @@
+from os import environ
+from tempfile import NamedTemporaryFile
+from testcontainers.core.generic import DbContainer
+
+SINGLESTORE_INIT_SCRIPT_FILE = '/init.sql'
+
+
+class SingleStoreContainer(DbContainer):
+    """
+    SingleStore database container.
+
+    Example:
+
+        .. doctest::
+
+            >>> import sqlalchemy
+            >>> from singlestore.testcontainers.singlestore import SingleStoreContainer
+            >>> with SingleStoreContainer() as singlestore:
+            ...    engine = sqlalchemy.create_engine(singlestore.get_connection_url())
+            ...    with engine.begin() as connection:
+            ...        result = connection.execute(sqlalchemy.text(f'use {singlestore.get_database_name()}; select 1;'))
+            >>> result
+    """
+
+    def __init__(
+            self,
+            image: str = "ghcr.io/singlestore-labs/singlestoredb-dev:latest",
+            port_to_expose: int = 3306,
+            password: str = 'password',
+            license_key: str = None,
+            dbname: str = 'test_db',
+            singlestore_version: str = None,
+            dialect: str = 'mysql+pymysql',
+            **kwargs
+    ):
+        super(SingleStoreContainer, self).__init__(image, **kwargs)
+
+        self.port_to_expose = port_to_expose
+        self.with_exposed_ports(self.port_to_expose)
+
+        self.SINGLESTORE_USER = 'root'
+        self.SINGLESTORE_ROOT_PASSWORD = password or environ.get(
+            'SINGLESTORE_ROOT_PASSWORD',
+            'password'
+        )
+        self.SINGLESTORE_LICENSE = license_key or environ.get('SINGLESTORE_LICENSE')
+        self.SINGLESTORE_DATABASE = dbname or environ.get('SINGLESTORE_DATABASE', 'test_db')
+        self.SINGLESTORE_VERSION = singlestore_version or environ.get('SINGLESTORE_VERSION')
+
+        self.dialect = dialect
+
+        self.init_script = NamedTemporaryFile(prefix='singlestore-init-script')
+
+    def _configure(self):
+        self.with_env("ROOT_PASSWORD", self.SINGLESTORE_ROOT_PASSWORD)
+        self.with_env("SINGLESTORE_LICENSE", self.SINGLESTORE_LICENSE)
+        self.with_env("LICENSE_KEY", self.SINGLESTORE_LICENSE)
+        self.with_env("START_AFTER_INIT", 'Y')
+
+        if self.SINGLESTORE_VERSION:
+            self.with_env("SINGLESTORE_VERSION", self.SINGLESTORE_VERSION)
+
+        self.maybe_emulate_amd64()
+
+        self.map_init_script()
+
+    def get_connection_url(self) -> str:
+        return super()._create_connection_url(
+            dialect=self.dialect,
+            username=self.SQLSERVER_USER,
+            password=self.SQLSERVER_PASSWORD,
+            db_name=self.SQLSERVER_DBNAME,
+            port=self.port_to_expose
+        )
+
+    def map_init_script(self):
+        self.init_script.write('CREATE DATABASE IF NOT EXISTS {};'.format(self.SINGLESTORE_DATABASE).encode('utf-8'))
+        self.init_script.flush()
+        self.with_volume_mapping(self.init_script.name, SINGLESTORE_INIT_SCRIPT_FILE)
+
+    def stop(self, force=True, delete_volume=True):
+        self.init_script.close()
+        super().stop(force, delete_volume)
+
+    def get_user(self):
+        return self.SINGLESTORE_USER
+
+    def get_password(self):
+        return self.SINGLESTORE_ROOT_PASSWORD
+
+    def get_database_name(self):
+        return self.SINGLESTORE_DATABASE
+
+    def get_port(self):
+        return self.port_to_expose

singlestore/tests/test_singlestore.py

@@ -0,0 +1,17 @@
+import sqlalchemy
+
+from singlestore.testcontainers.singlestore import SingleStoreContainer
+
+
+def test_docker_run_singlestore():
+    dialect = 'mysql+pymysql'
+    with SingleStoreContainer(
+            dialect=dialect,
+            license_key=('BGE5YzE5NTdmN2I1NDQ4MjhhNTQ0MTM4YWQ4Y2Q5ZWNiAAAAAAA'
+                         'AAAAEAAAAAAAAAAwwNQIYKbH2LOLeT189H+nBdRagLdLboVuJTs'
+                         'gJAhkAtSepSZkq0Zn4FDVtvZyASWzovR2OeeyiAA==')
+    ) as singlestore:
+        engine = sqlalchemy.create_engine(singlestore.get_connection_url())
+        with engine.begin() as connection:
+            result = connection.execute(sqlalchemy.text(f'use {singlestore.get_database_name()}; select 1;'))
+            assert result == 1