initial commit

Author: daimor

.gitignore

@@ -0,0 +1,6 @@
+.idea
+env
+.pytest_cache
+build
+dist
+*.egg-info

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Dmitry Maslennikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,27 @@
+# Testcontainers-python for InterSystems IRIS
+
+[testcontainers-python](https://testcontainers-python.readthedocs.io/en/latest/README.html) facilitates the use of Docker containers for functional and integration testing.
+
+## Other implementations
+
+* [testcontainers-iris-java](https://github.com/caretdev/testcontainers-iris-java)
+
+## Basic usage
+
+```
+>>> from testcontainers.iris import IRISContainer
+>>> import sqlalchemy
+
+>>> iris_container = IRISContainer("intersystemsdc/iris-community:latest")
+>>> with iris_container as iris:
+...     engine = sqlalchemy.create_engine(iris.get_connection_url())
+...     with engine.begin() as connection:
+...         result = connection.execute(sqlalchemy.text("select $zversion"))
+...         version, = result.fetchone()
+>>> version
+'IRIS for UNIX (Ubuntu Server LTS for ARM64 Containers) 2023.2 (Build 227U) Mon Jul 31 2023 17:43:25 EDT'
+```
+
+The snippet above will spin up a InterSystems IRIS database in a container. The get_connection_url() convenience method returns a sqlalchemy compatible url we use to connect to the database and retrieve the database version.
+
+More extensive documentation can be found at [Read The Docs](https://testcontainers-python.readthedocs.io/).

demo.py

@@ -0,0 +1,10 @@
+from testcontainers.iris import IRISContainer
+import sqlalchemy
+
+iris_container = IRISContainer("intersystemsdc/iris-community:latest")
+with iris_container as iris:
+    engine = sqlalchemy.create_engine(iris.get_connection_url())
+    with engine.begin() as connection:
+        result = connection.execute(sqlalchemy.text("select $zversion"))
+        version, = result.fetchone()
+print(version)

requirements.txt

@@ -0,0 +1,3 @@
+pytest
+wheel
+twine

setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_namespace_packages
+
+description = "InterSystems IRIS component of testcontainers-python."
+
+setup(
+    name="testcontainers-iris",
+    version="1.0.1",
+    packages=find_namespace_packages(),
+    description=description,
+    long_description=description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/caretdev/testcontainers-iris-python",
+    install_requires=[
+        "testcontainers-core",
+        "sqlalchemy",
+        "sqlalchemy-iris",
+    ],
+    python_requires=">=3.7",
+)

testcontainers/iris/__init__.py

@@ -0,0 +1,53 @@
+import os
+from typing import Optional
+from testcontainers.core.generic import DbContainer
+# from testcontainers.core.utils import raise_for_deprecated_parameter
+
+
+class IRISContainer(DbContainer):
+    """
+    InterSystems IRIS database container.
+
+    Example:
+
+        The example spins up a IRIS database and connects to it using the :code:`intersystems-iris`
+        driver.
+
+        .. doctest::
+
+            >>> from testcontainers.iris import IRISContainer
+            >>> import sqlalchemy
+
+            >>> iris_container = IRISContainer("intersystemsdc/iris-community:latest")
+            >>> with iris_container as iris:
+            ...     engine = sqlalchemy.create_engine(iris.get_connection_url())
+            ...     with engine.begin() as connection:
+            ...         result = connection.execute(sqlalchemy.text("select $zversion"))
+            ...         version, = result.fetchone()
+            >>> version
+            'IRIS for UNIX (Ubuntu Server LTS for ARM64 Containers) 2023.2 (Build 227U) Mon Jul 31 2023 17:43:25 EDT'
+    """
+    def __init__(self, image: str = "intersystemsdc/iris-community:latest", port: int = 1972,
+                 username: Optional[str] = None, password: Optional[str] = None,
+                 dbname: Optional[str] = None, driver: str = "iris", **kwargs) -> None:
+        # raise_for_deprecated_parameter(kwargs, "user", "username")
+        super(IRISContainer, self).__init__(image=image, **kwargs)
+        self.username = username or os.environ.get("IRIS_USERNAME", "test")
+        self.password = password or os.environ.get("IRIS_PASSWORD", "test")
+        self.dbname = dbname or os.environ.get("IRIS_NAMESPACE", "USER")
+        self.port = port
+        self.driver = driver
+
+        self.with_exposed_ports(self.port)
+
+    def _configure(self) -> None:
+        self.with_env("IRIS_USERNAME", self.username)
+        self.with_env("IRIS_PASSWORD", self.password)
+        self.with_env("IRIS_NAMESPACE", self.dbname)
+
+    def get_connection_url(self, host=None) -> str:
+        return super()._create_connection_url(
+            dialect=f"iris", username=self.username,
+            password=self.password, db_name=self.dbname, host=host,
+            port=self.port,
+        )

tests/test_iris.py

@@ -0,0 +1,12 @@
+import sqlalchemy
+from testcontainers.iris import IRISContainer
+
+
+def test_docker_run_iris():
+    iris_container = IRISContainer("intersystemsdc/iris-community:2023.1.1.380.0-zpm")
+    with iris_container as iris:
+        engine = sqlalchemy.create_engine(iris.get_connection_url())
+        with engine.begin() as connection:
+            result = connection.execute(sqlalchemy.text("select $zversion"))
+            for row in result:
+                assert "2023.1.1 (Build 380U)" in row[0]