ry-testkit 0.1.0__tar.gz

ry_testkit-0.1.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: ry-testkit
+Version: 0.1.0
+Summary: Shared integration test base classes for Redis and Postgres containers
+Author: Ross Yeager
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: psycopg2-binary
+Requires-Dist: redis
+Requires-Dist: testcontainers
+
+# ry-testkit
+
+Shared Redis/Postgres integration test base classes.
+
+## Install
+
+```bash
+pip install ry-testkit
+```

ry_testkit-0.1.0/README.md

@@ -0,0 +1,9 @@
+# ry-testkit
+
+Shared Redis/Postgres integration test base classes.
+
+## Install
+
+```bash
+pip install ry-testkit
+```

ry_testkit-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ry-testkit"
+version = "0.1.0"
+description = "Shared integration test base classes for Redis and Postgres containers"
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [{ name = "Ross Yeager" }]
+dependencies = [
+  "psycopg2-binary",
+  "redis",
+  "testcontainers",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

ry_testkit-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ry_testkit-0.1.0/src/ry_testkit/__init__.py

@@ -0,0 +1,6 @@
+"""Shared test helpers for containerized integration tests."""
+
+from .postgres import PostgresOnlyTestBase
+from .redis import RedisOnlyTestBase
+
+__all__ = ["PostgresOnlyTestBase", "RedisOnlyTestBase"]

ry_testkit-0.1.0/src/ry_testkit/postgres.py

@@ -0,0 +1,83 @@
+import os
+import time
+import typing as T
+import unittest
+
+import psycopg2
+from psycopg2 import OperationalError
+from testcontainers.core.container import DockerContainer  # type: ignore[import-untyped]
+from testcontainers.core.waiting_utils import wait_for_logs  # type: ignore[import-untyped]
+
+
+class PostgresOnlyTestBase(unittest.TestCase):
+    container: T.Optional[DockerContainer] = None
+    _started = False
+
+    IMAGE = os.getenv("TEST_POSTGRES_IMAGE", "postgres:latest")
+    USER = os.getenv("TEST_POSTGRES_USER", "test")
+    PASSWORD = os.getenv("TEST_POSTGRES_PASSWORD", "test")
+    DB = os.getenv("TEST_POSTGRES_DB", "testdb")
+    READY_TIMEOUT_S = int(os.getenv("TEST_POSTGRES_READY_TIMEOUT_S", "60"))
+    READY_SLEEP_S = float(os.getenv("TEST_POSTGRES_READY_SLEEP_S", "0.5"))
+
+    @classmethod
+    def _dsn(cls) -> str:
+        assert cls.container is not None
+        return (
+            f"dbname={cls.DB} user={cls.USER} password={cls.PASSWORD} "
+            f"host={cls.container.get_container_host_ip()} "
+            f"port={cls.container.get_exposed_port(5432)}"
+        )
+
+    @classmethod
+    def _wait_ready(cls) -> None:
+        deadline = time.time() + cls.READY_TIMEOUT_S
+        while time.time() < deadline:
+            try:
+                conn = psycopg2.connect(cls._dsn())
+                conn.close()
+                return
+            except OperationalError:
+                time.sleep(cls.READY_SLEEP_S)
+        raise RuntimeError("Postgres test container did not become ready")
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        super().setUpClass()
+        if cls._started:
+            return
+
+        c = DockerContainer(cls.IMAGE)
+        c.with_env("POSTGRES_USER", cls.USER)
+        c.with_env("POSTGRES_PASSWORD", cls.PASSWORD)
+        c.with_env("POSTGRES_DB", cls.DB)
+        c.with_exposed_ports(5432)
+        c.start()
+
+        try:
+            wait_for_logs(c, "database system is ready to accept connections", timeout=cls.READY_TIMEOUT_S)
+        except Exception:
+            pass
+
+        cls.container = c
+        cls._wait_ready()
+        cls._started = True
+
+    @classmethod
+    def tearDownClass(cls) -> None:
+        if cls.container is not None:
+            cls.container.stop()
+            cls.container = None
+        cls._started = False
+        super().tearDownClass()
+
+    @classmethod
+    def postgres_connection_info(cls) -> T.Dict[str, T.Any]:
+        assert cls.container is not None
+        return {
+            "host": cls.container.get_container_host_ip(),
+            "port": int(cls.container.get_exposed_port(5432)),
+            "user": cls.USER,
+            "password": cls.PASSWORD,
+            "db": cls.DB,
+        }

ry_testkit-0.1.0/src/ry_testkit/redis.py

@@ -0,0 +1,75 @@
+import os
+import time
+import typing as T
+import unittest
+
+import redis
+from redis import RedisError
+from testcontainers.core.container import DockerContainer  # type: ignore[import-untyped]
+from testcontainers.core.waiting_utils import wait_for_logs  # type: ignore[import-untyped]
+
+
+class RedisOnlyTestBase(unittest.TestCase):
+    container: T.Optional[DockerContainer] = None
+    _started = False
+
+    IMAGE = os.getenv("TEST_REDIS_IMAGE", "redis:latest")
+    READY_TIMEOUT_S = int(os.getenv("TEST_REDIS_READY_TIMEOUT_S", "60"))
+    READY_SLEEP_S = float(os.getenv("TEST_REDIS_READY_SLEEP_S", "0.5"))
+
+    @classmethod
+    def _client(cls) -> redis.Redis:
+        assert cls.container is not None
+        return redis.Redis(
+            host=cls.container.get_container_host_ip(),
+            port=int(cls.container.get_exposed_port(6379)),
+            db=0,
+            decode_responses=True,
+        )
+
+    @classmethod
+    def _wait_ready(cls) -> None:
+        deadline = time.time() + cls.READY_TIMEOUT_S
+        while time.time() < deadline:
+            try:
+                if cls._client().ping():
+                    return
+            except RedisError:
+                time.sleep(cls.READY_SLEEP_S)
+        raise RuntimeError("Redis test container did not become ready")
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        super().setUpClass()
+        if cls._started:
+            return
+
+        c = DockerContainer(cls.IMAGE)
+        c.with_exposed_ports(6379)
+        c.start()
+
+        try:
+            wait_for_logs(c, "Ready to accept connections", timeout=cls.READY_TIMEOUT_S)
+        except Exception:
+            pass
+
+        cls.container = c
+        cls._wait_ready()
+        cls._started = True
+
+    @classmethod
+    def tearDownClass(cls) -> None:
+        if cls.container is not None:
+            cls.container.stop()
+            cls.container = None
+        cls._started = False
+        super().tearDownClass()
+
+    @classmethod
+    def redis_connection_info(cls) -> T.Dict[str, T.Any]:
+        assert cls.container is not None
+        return {
+            "host": cls.container.get_container_host_ip(),
+            "port": int(cls.container.get_exposed_port(6379)),
+            "db": 0,
+        }

ry_testkit-0.1.0/src/ry_testkit.egg-info/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: ry-testkit
+Version: 0.1.0
+Summary: Shared integration test base classes for Redis and Postgres containers
+Author: Ross Yeager
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: psycopg2-binary
+Requires-Dist: redis
+Requires-Dist: testcontainers
+
+# ry-testkit
+
+Shared Redis/Postgres integration test base classes.
+
+## Install
+
+```bash
+pip install ry-testkit
+```

ry_testkit-0.1.0/src/ry_testkit.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+src/ry_testkit/__init__.py
+src/ry_testkit/postgres.py
+src/ry_testkit/redis.py
+src/ry_testkit.egg-info/PKG-INFO
+src/ry_testkit.egg-info/SOURCES.txt
+src/ry_testkit.egg-info/dependency_links.txt
+src/ry_testkit.egg-info/requires.txt
+src/ry_testkit.egg-info/top_level.txt

ry_testkit-0.1.0/src/ry_testkit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ry_testkit-0.1.0/src/ry_testkit.egg-info/requires.txt

@@ -0,0 +1,3 @@
+psycopg2-binary
+redis
+testcontainers

ry_testkit-0.1.0/src/ry_testkit.egg-info/top_level.txt

@@ -0,0 +1 @@
+ry_testkit