feat: add valkey module and keydb and dragonfly redis services (#83)

- Consolidate AlloyDB into the existing postgres module.
- Updated tags for AlloyDB Omni and pgvector
- Add `postgres_user` and `postgres_password`  fixtures.
- Add dedicated `keydb` and `dragonfly` fixtures
- Add `valkey` service that uses `valkey` python client instead of `redis`

Author: cofin

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
 
   # Ruff replaces black, flake8, autoflake and isort
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.11.8" # make sure this is always consistent with hatch configs
+    rev: "v0.11.11" # make sure this is always consistent with hatch configs
     hooks:
       - id: ruff
         args: [--config, ./pyproject.toml]

docs/supported-databases/alloydb.rst

@@ -11,11 +11,11 @@ This section provides detailed information on the supported databases, including
    mariadb
    oracle
    sqlserver
-   alloydb
    spanner
    bigquery
    cockroachdb
    redis
+   valkey
    elasticsearch
    azure_blob_storage
    minio

docs/supported-databases/index.rst

@@ -1,7 +1,7 @@
 PostgreSQL
 ==========
 
-Integration with `PostgreSQL <https://www.postgresql.org/>`_ using the `PostgreSQL Docker Image <https://hub.docker.com/_/postgres>`_ or `pgvector Docker Image <https://hub.docker.com/r/ankane/pgvector>`_
+Integration with `PostgreSQL <https://www.postgresql.org/>`_ using the `PostgreSQL Docker Image <https://hub.docker.com/_/postgres>`_, Google's `AlloyDB Omni <https://cloud.google.com/alloydb/omni?hl=en>`_ or `pgvector Docker Image <https://hub.docker.com/r/ankane/pgvector>`_
 
 Installation
 ------------
@@ -36,22 +36,25 @@ Usage Example
 Available Fixtures
 ------------------
 
+* ``postgres_user``: The PostgreSQL user.
+* ``postgres_password``: The PostgreSQL password.
+* ``postgres_database``: The PostgreSQL database name to use.
 * ``postgres_image``: The Docker image to use for PostgreSQL.
 * ``postgres_service``: A fixture that provides a PostgreSQL service.
 * ``postgres_connection``: A fixture that provides a PostgreSQL connection.
 
 The following version-specific fixtures are also available:
 
+* ``alloydb_omni_image``, ``alloydb_omni_service``, ``alloydb_omni_connection``: Latest Available AlloyDB Omni 16 Docker image.
 * ``postgres_11_image``, ``postgres_11_service``, ``postgres_11_connection``: PostgreSQL 11.x
 * ``postgres_12_image``, ``postgres_12_service``, ``postgres_12_connection``: PostgreSQL 12.x
 * ``postgres_13_image``, ``postgres_13_service``, ``postgres_13_connection``: PostgreSQL 13.x
 * ``postgres_14_image``, ``postgres_14_service``, ``postgres_14_connection``: PostgreSQL 14.x
 * ``postgres_15_image``, ``postgres_15_service``, ``postgres_15_connection``: PostgreSQL 15.x
 * ``postgres_16_image``, ``postgres_16_service``, ``postgres_16_connection``: PostgreSQL 16.x
 * ``postgres_17_image``, ``postgres_17_service``, ``postgres_17_connection``: PostgreSQL 17.x
-* ``pgvector_image``: The Docker image to use for pgvector.
-* ``pgvector_service``: A fixture that provides a pgvector service.
-* ``pgvector_connection``: A fixture that provides a pgvector connection.
+* ``pgvector_image``, ``pgvector_service``. ``pgvector_connection``: Latest Available pgvector Docker image.
+
 
 Service API
 -----------

docs/supported-databases/postgres.rst

@@ -1,7 +1,7 @@
 Redis
 =====
 
-Integration with `Redis <https://redis.io/>`_
+Integration with `Redis <https://redis.io/>`_ using the `Redis Docker Image <https://hub.docker.com/_/redis>`_, Snap's `Key DB<https://docs.keydb.dev/>` or `Dragonfly <https://www.dragonflydb.io/>`_.
 
 Installation
 ------------
@@ -43,6 +43,11 @@ Available Fixtures
 * ``redis_service``: A fixture that provides a Redis service.
 * ``redis_connection``: A fixture that provides a Redis connection.
 
+The following version-specific fixtures are also available:
+
+* ``dragonflydb_port``, ``dragonflydb_host``, ``dragonflydb_image``, ``dragonflydb_service``, ``dragonflydb_connection``: Latest Available DragonflyDB Docker image.
+* ``keydb_port``, ``keydb_host``, ``keydb_image``, ``keydb_service``, ``keydb_connection``: Latest Available KeyDB Docker image.
+
 Service API
 -----------
 

docs/supported-databases/redis.rst

@@ -0,0 +1,52 @@
+Valkey
+======
+
+Integration with `Valkey <https://valkey.io//>`_ using the `Valkey Docker Image <https://hub.docker.com/_/valkey>`_
+
+Installation
+------------
+
+.. code-block:: bash
+
+   pip install pytest-databases[valkey]
+
+Usage Example
+-------------
+
+.. code-block:: python
+
+    import pytest
+    from valkey import Valkey
+    from pytest_databases.docker.valkey import ValkeyService
+
+    pytest_plugins = ["pytest_databases.docker.valkey"]
+
+    def test(valkey_service: ValkeyService) -> None:
+        client = Valkey(
+            host=valkey_service.host,
+            port=valkey_service.port,
+            db=valkey_service.db
+        )
+        client.set("test_key", "test_value")
+        assert client.get("test_key") == b"test_value"
+
+    def test(valkey_connection: Valkey) -> None:
+        valkey_connection.set("test_key", "test_value")
+        assert valkey_connection.get("test_key") == b"test_value"
+
+Available Fixtures
+------------------
+
+* ``valkey_port``: The port number for the Valkey service.
+* ``valkey_host``: The host name for the Valkey service.
+* ``valkey_image``: The Docker image to use for Valkey.
+* ``valkey_service``: A fixture that provides a Valkey service.
+* ``valkey_connection``: A fixture that provides a Valkey connection.
+
+Service API
+-----------
+
+.. automodule:: pytest_databases.docker.valkey
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/supported-databases/valkey.rst

@@ -31,6 +31,8 @@ keywords = [
   "redis",
   "elasticsearch",
   "azure",
+  "valkey",
+  "dragonflydb",
 ]
 # options under https://pypi.org/classifiers/
 classifiers = [
@@ -68,12 +70,13 @@ oracle = ["oracledb"]
 postgres = ["psycopg>=3"]
 redis = ["redis"]
 spanner = ["google-cloud-spanner"]
+valkey = ["valkey"]
 
 [dependency-groups]
 dev = [
   # tests
   "bump-my-version",
-  "pytest-databases[azure-storage,bigquery,cockroachdb,dragonfly,elasticsearch7,elasticsearch8,keydb,mssql,mysql,mariadb,oracle,postgres,redis,spanner,minio]",
+  "pytest-databases[azure-storage,bigquery,cockroachdb,dragonfly,elasticsearch7,elasticsearch8,keydb,mssql,mysql,mariadb,oracle,postgres,redis,spanner,minio,valkey]",
   "coverage[toml]>=6.2",
   "pytest",
   "pytest-cov",
@@ -83,7 +86,7 @@ dev = [
   "pytest-xdist",
   "pytest-sugar",
   "slotscheck",
-  "psycopg-binary", # This fixes tests failing on M series CPUs.
+  "psycopg-binary",                                                                                                                                                    # This fixes tests failing on M series CPUs.
   # lint
   "mypy",
   "ruff",

pyproject.toml

@@ -8,12 +8,12 @@
 from contextlib import AbstractContextManager, contextmanager
 from typing import TYPE_CHECKING, Any, Callable
 
-import docker
 import filelock
 import pytest
-from docker.errors import ImageNotFound
+from docker.errors import APIError, ImageNotFound
 from typing_extensions import Self
 
+from docker import DockerClient
 from pytest_databases.helpers import get_xdist_worker_id
 from pytest_databases.types import ServiceContainer
 
@@ -48,14 +48,14 @@ def get_docker_host() -> str:
     return next(context["DockerEndpoint"] for context in contexts if context["Current"] is True)
 
 
-def get_docker_client() -> docker.DockerClient:
+def get_docker_client() -> DockerClient:
     env = {**os.environ}
     if "DOCKER_HOST" not in env:
         env["DOCKER_HOST"] = get_docker_host()
-    return docker.DockerClient.from_env(environment=env)
+    return DockerClient.from_env(environment=env)
 
 
-def _stop_all_containers(client: docker.DockerClient) -> None:
+def _stop_all_containers(client: DockerClient) -> None:
     containers: list[Container] = client.containers.list(
         all=True,
         filters={"label": "pytest_databases"},
@@ -76,7 +76,7 @@ def _stop_all_containers(client: docker.DockerClient) -> None:
 class DockerService(AbstractContextManager):
     def __init__(
         self,
-        client: docker.DockerClient,
+        client: DockerClient,
         tmp_path: pathlib.Path,
         session: pytest.Session,
     ) -> None:
@@ -221,16 +221,16 @@ def run(
             try:
                 container.stop()
                 container.remove(force=True)
-            except docker.errors.APIError as exc:  # pyright: ignore[reportAttributeAccessIssue]
+            except APIError as exc:  # pyright: ignore[reportAttributeAccessIssue]
                 # '409 - Conflict' means removal is already in progress. this is the
-                # safest way of delaiyng with it, since the API is a bit borked when it
+                # safest way of delaying with it, since the API is a bit borked when it
                 # comes to concurrent requests
                 if exc.status_code not in {409, 404}:
                     raise
 
 
 @pytest.fixture(scope="session")
-def docker_client() -> Generator[docker.DockerClient, None, None]:
+def docker_client() -> Generator[DockerClient, None, None]:
     client = get_docker_client()
     try:
         yield client
@@ -240,7 +240,7 @@ def docker_client() -> Generator[docker.DockerClient, None, None]:
 
 @pytest.fixture(scope="session")
 def docker_service(
-    docker_client: docker.DockerClient,
+    docker_client: DockerClient,
     tmp_path_factory: pytest.TempPathFactory,
     request: pytest.FixtureRequest,
 ) -> Generator[DockerService, None, None]: