feat: Remove volumes when stopping services (#52)

Author: provinzkraut

src/pytest_databases/docker/__init__.py

@@ -5,13 +5,15 @@
 import subprocess  # noqa: S404
 import time
 import timeit
+from contextlib import AbstractContextManager
 from typing import TYPE_CHECKING, Any, Callable, Iterable
 
 from pytest_databases.helpers import simple_string_hash
 
 if TYPE_CHECKING:
     from collections.abc import Awaitable, Generator
     from pathlib import Path
+    from types import TracebackType
 
 TRUE_VALUES = {"True", "true", "1", "yes", "Y", "T"}
 
@@ -47,7 +49,7 @@ def wait_until_responsive(
 COMPOSE_PROJECT_NAME: str = f"pytest-databases-{simple_string_hash(__file__)}"
 
 
-class DockerServiceRegistry:
+class DockerServiceRegistry(AbstractContextManager):
     def __init__(
         self,
         worker_id: str,
@@ -65,6 +67,15 @@ def __init__(
         )
         self._before_start = list(before_start) if before_start else []
 
+    def __exit__(
+        self,
+        /,
+        __exc_type: type[BaseException] | None,
+        __exc_value: BaseException | None,
+        __traceback: TracebackType | None,
+    ) -> None:
+        self.down()
+
     @staticmethod
     def _get_docker_ip() -> str:
         docker_host = os.environ.get("DOCKER_HOST", "").strip()
@@ -114,4 +125,4 @@ def stop(self, name: str) -> None:
 
     def down(self) -> None:
         if not SKIP_DOCKER_COMPOSE:
-            self.run_command("down", "-t", "10")
+            self.run_command("down", "-t", "10", "--volumes")

src/pytest_databases/docker/alloydb_omni.py

@@ -49,11 +49,8 @@ def alloydb_docker_services(
     if os.getenv("GITHUB_ACTIONS") == "true" and sys.platform != "linux":
         pytest.skip("Docker not available on this platform")
 
-    registry = DockerServiceRegistry(worker_id, compose_project_name=alloydb_compose_project_name)
-    try:
+    with DockerServiceRegistry(worker_id, compose_project_name=alloydb_compose_project_name) as registry:
         yield registry
-    finally:
-        registry.down()
 
 
 @pytest.fixture(scope="session")

src/pytest_databases/docker/azure_blob.py

@@ -62,14 +62,11 @@ def azure_blob_docker_services(
     azure_blob_service_startup_delay: int,
     worker_id: str = "main",
 ) -> Generator[DockerServiceRegistry, None, None]:
-    registry = DockerServiceRegistry(
+    with DockerServiceRegistry(
         worker_id,
         compose_project_name=azure_blob_compose_project_name,
-    )
-    try:
+    ) as registry:
         yield registry
-    finally:
-        registry.down()
 
 
 @pytest.fixture(scope="session")

src/pytest_databases/docker/bigquery.py

@@ -53,11 +53,8 @@ def bigquery_docker_services(
     if os.getenv("GITHUB_ACTIONS") == "true" and sys.platform != "linux":
         pytest.skip("Docker not available on this platform")
 
-    registry = DockerServiceRegistry(worker_id, compose_project_name=bigquery_compose_project_name)
-    try:
+    with DockerServiceRegistry(worker_id, compose_project_name=bigquery_compose_project_name) as registry:
         yield registry
-    finally:
-        registry.down()
 
 
 @pytest.fixture(scope="session")

src/pytest_databases/docker/cockroachdb.py

@@ -44,11 +44,8 @@ def cockroachdb_docker_services(
     if os.getenv("GITHUB_ACTIONS") == "true" and sys.platform != "linux":
         pytest.skip("Docker not available on this platform")
 
-    registry = DockerServiceRegistry(worker_id, compose_project_name=cockroachdb_compose_project_name)
-    try:
+    with DockerServiceRegistry(worker_id, compose_project_name=cockroachdb_compose_project_name) as registry:
         yield registry
-    finally:
-        registry.down()
 
 
 @pytest.fixture(scope="session")

src/pytest_databases/docker/dragonfly.py

@@ -29,11 +29,8 @@ def dragonfly_docker_services(
     if os.getenv("GITHUB_ACTIONS") == "true" and sys.platform != "linux":
         pytest.skip("Docker not available on this platform")
 
-    registry = DockerServiceRegistry(worker_id, compose_project_name=dragonfly_compose_project_name)
-    try:
+    with DockerServiceRegistry(worker_id, compose_project_name=dragonfly_compose_project_name) as registry:
         yield registry
-    finally:
-        registry.down()
 
 
 @pytest.fixture(scope="session")

src/pytest_databases/docker/elastic_search.py

@@ -51,11 +51,8 @@ def elasticsearch_docker_services(
     if os.getenv("GITHUB_ACTIONS") == "true" and sys.platform != "linux":
         pytest.skip("Docker not available on this platform")
 
-    registry = DockerServiceRegistry(worker_id, compose_project_name=elasticsearch_compose_project_name)
-    try:
+    with DockerServiceRegistry(worker_id, compose_project_name=elasticsearch_compose_project_name) as registry:
         yield registry
-    finally:
-        registry.down()
 
 
 @pytest.fixture(scope="session")

src/pytest_databases/docker/keydb.py

@@ -30,11 +30,8 @@ def keydb_docker_services(
     if os.getenv("GITHUB_ACTIONS") == "true" and sys.platform != "linux":
         pytest.skip("Docker not available on this platform")
 
-    registry = DockerServiceRegistry(worker_id, compose_project_name=keydb_compose_project_name)
-    try:
+    with DockerServiceRegistry(worker_id, compose_project_name=keydb_compose_project_name) as registry:
         yield registry
-    finally:
-        registry.down()
 
 
 @pytest.fixture(scope="session")

src/pytest_databases/docker/mariadb.py

@@ -31,11 +31,8 @@ def mariadb_docker_services(
     if os.getenv("GITHUB_ACTIONS") == "true" and sys.platform != "linux":
         pytest.skip("Docker not available on this platform")
 
-    registry = DockerServiceRegistry(worker_id, compose_project_name=mariadb_compose_project_name)
-    try:
+    with DockerServiceRegistry(worker_id, compose_project_name=mariadb_compose_project_name) as registry:
         yield registry
-    finally:
-        registry.down()
 
 
 @pytest.fixture(scope="session")

src/pytest_databases/docker/mssql.py

@@ -48,11 +48,8 @@ def mssql_docker_services(
     if os.getenv("GITHUB_ACTIONS") == "true" and sys.platform != "linux":
         pytest.skip("Docker not available on this platform")
 
-    registry = DockerServiceRegistry(worker_id, compose_project_name=mssql_compose_project_name)
-    try:
+    with DockerServiceRegistry(worker_id, compose_project_name=mssql_compose_project_name) as registry:
         yield registry
-    finally:
-        registry.down()
 
 
 @pytest.fixture(scope="session")