cleanup

Author: provinzkraut

pyproject.toml

@@ -647,7 +647,7 @@ line-length = 120
 ## Testing Tools
 
 [tool.pytest.ini_options]
-addopts = " --doctest-glob='*.md'"
+addopts = " --doctest-glob='*.md' --dist=loadgroup"
 filterwarnings = [
   "ignore::DeprecationWarning:pkg_resources",
   "ignore::DeprecationWarning:xdist.*",

src/pytest_databases/_service.py

@@ -2,34 +2,36 @@
 
 import contextlib
 import json
-import multiprocessing
 import os
-import pathlib
-import secrets
-import subprocess
+import subprocess  # noqa: S404
 import time
 from contextlib import AbstractContextManager, contextmanager
-from functools import partial
-from typing import Callable, Generator, Any
+from typing import TYPE_CHECKING, Any, Callable, Generator, Self
 
-import docker
 import filelock
 import pytest
-from docker.models.containers import Container
-from docker.errors import ImageNotFound
 
+import docker
+from docker.errors import ImageNotFound
 from pytest_databases.helpers import get_xdist_worker_id
 from pytest_databases.types import ServiceContainer
 
+if TYPE_CHECKING:
+    import multiprocessing
+    import pathlib
+    from types import TracebackType
+
+    from docker.models.containers import Container
+
 
 def get_docker_host() -> str:
     result = subprocess.run(
-        ["docker", "context", "ls", "--format=json"],
+        ["docker", "context", "ls", "--format=json"],  # noqa: S607
         text=True,
         capture_output=True,
         check=True,
     )
-    contexts = (json.loads(l) for l in result.stdout.splitlines())
+    contexts = (json.loads(line) for line in result.stdout.splitlines())
     return next(context["DockerEndpoint"] for context in contexts if context["Current"] is True)
 
 
@@ -40,12 +42,6 @@ def get_docker_client() -> docker.DockerClient:
     return docker.DockerClient.from_env(environment=env)
 
 
-def log(msg):
-    log_file = pathlib.Path("out.log")
-    with log_file.open("a") as f:
-        f.write(msg + "\n")
-
-
 def _stop_all_containers(client: docker.DockerClient) -> None:
     containers: list[Container] = client.containers.list(all=True, filters={"label": "pytest_databases"})
     for container in containers:
@@ -56,7 +52,8 @@ def _stop_all_containers(client: docker.DockerClient) -> None:
         elif container.status == "removing":
             continue
         else:
-            raise ValueError(f"Cannot handle container in state {container.status}")
+            msg = f"Cannot handle container in state {container.status}"
+            raise ValueError(msg)
 
 
 class DockerService(AbstractContextManager):
@@ -72,13 +69,13 @@ def __init__(
         self._session = session
         self._is_xdist = get_xdist_worker_id() is not None
 
-    def _daemon(self):
+    def _daemon(self) -> None:
         while (self._tmp_path / "ctrl").exists():
             time.sleep(0.1)
         self._stop_all_containers()
 
-    def __enter__(self) -> DockerService:
-        if self._is_xdist or True:
+    def __enter__(self) -> Self:
+        if self._is_xdist:
             ctrl_file = _get_ctrl_file(self._session)
             with filelock.FileLock(ctrl_file.with_suffix(".lock")):
                 if not ctrl_file.exists():
@@ -88,7 +85,13 @@ def __enter__(self) -> DockerService:
             self._stop_all_containers()
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+    def __exit__(
+        self,
+        /,
+        __exc_type: type[BaseException] | None,
+        __exc_value: BaseException | None,
+        __traceback: TracebackType | None,
+    ) -> None:
         if not self._is_xdist:
             self._stop_all_containers()
 
@@ -97,7 +100,8 @@ def _get_container(self, name: str) -> Container | None:
             filters={"name": name},
         )
         if len(containers) > 1:
-            raise ValueError(f"More than one running container found")
+            msg = "More than one running container found"
+            raise ValueError(msg)
         if containers:
             return containers[0]
         return None
@@ -115,12 +119,13 @@ def run(
         env: dict[str, Any] | None = None,
         exec_after_start: str | list[str] | None = None,
         check: Callable[[ServiceContainer], bool] | None = None,
-        wait_for_log: str | None = None,
+        wait_for_log: str | bytes | None = None,
         timeout: int = 10,
-        pause: int = 0.1,
+        pause: float = 0.1,
     ) -> Generator[ServiceContainer, None, None]:
         if check is None and wait_for_log is None:
-            raise ValueError(f"Must set at least check or wait_for_log")
+            msg = "Must set at least check or wait_for_log"
+            raise ValueError(msg)
 
         name = f"pytest_databases_{name}"
         lock = filelock.FileLock(self._tmp_path / name) if self._is_xdist else contextlib.nullcontext()
@@ -154,21 +159,24 @@ def run(
 
         started = time.time()
         if wait_for_log:
-            wait_for_log = wait_for_log.encode()
+            if isinstance(wait_for_log, str):
+                wait_for_log = wait_for_log.encode()
             while time.time() - started < timeout:
                 if wait_for_log in container.logs():
                     break
                 time.sleep(pause)
             else:
-                raise ValueError(f"Service {name!r} failed to come online")
+                msg = f"Service {name!r} failed to come online"
+                raise ValueError(msg)
 
         if check:
             while time.time() - started < timeout:
                 if check(service) is True:
                     break
                 time.sleep(pause)
             else:
-                raise ValueError(f"Service {name!r} failed to come online")
+                msg = f"Service {name!r} failed to come online"
+                raise ValueError(msg)
 
         if exec_after_start:
             container.exec_run(exec_after_start)
@@ -208,13 +216,12 @@ def _get_base_tmp_path(tmp_path_factory: pytest.TempPathFactory) -> pathlib.Path
 
 
 def _get_ctrl_file(session: pytest.Session) -> pathlib.Path:
-    tmp_path = _get_base_tmp_path(session.config._tmp_path_factory)
+    tmp_path = _get_base_tmp_path(session.config._tmp_path_factory)  # type: ignore[attr-defined]
     return tmp_path / "ctrl"
 
 
 @pytest.hookimpl(wrapper=True)
-def pytest_sessionfinish(session: pytest.Session, exitstatus):
-    """Insert teardown that you want to occur only once here"""
+def pytest_sessionfinish(session: pytest.Session, exitstatus: int) -> Generator[Any, Any, Any]:
     try:
         return (yield)
     finally:

src/pytest_databases/docker/alloydb_omni.py

@@ -1,33 +1,44 @@
 from __future__ import annotations
 
+import dataclasses
 from typing import TYPE_CHECKING
 
 import psycopg
 import pytest
 
-from pytest_databases._service import DockerService
-from pytest_databases.docker import DockerServiceRegistry
 from pytest_databases.docker.postgres import (
     _make_connection_string,
     _provide_postgres_service,
-    PostgresService as AlloyDBService,
 )
-
-__all__ = ("AlloyDBService",)
-
+from pytest_databases.types import ServiceContainer
 
 if TYPE_CHECKING:
     from collections.abc import Generator
 
+    from pytest_databases._service import DockerService
+
+
+@dataclasses.dataclass
+class AlloyDBService(ServiceContainer):
+    database: str
+    password: str
+    user: str
+
 
 @pytest.fixture(autouse=False, scope="session")
 def alloydb_omni_service(
     docker_service: DockerService,
-) -> Generator[DockerServiceRegistry, None, None]:
+) -> Generator[AlloyDBService, None, None]:
     with _provide_postgres_service(
         docker_service=docker_service, image="google/alloydbomni", name="alloydb-omni"
     ) as service:
-        yield service
+        yield AlloyDBService(
+            host=service.host,
+            port=service.port,
+            password=service.password,
+            database=service.database,
+            user=service.user,
+        )
 
 
 @pytest.fixture(autouse=False, scope="session")

src/pytest_databases/docker/azure_blob.py

@@ -1,19 +1,20 @@
 from __future__ import annotations
 
 import json
-import secrets
 import subprocess  # noqa: S404
 from dataclasses import dataclass
-from typing import AsyncGenerator, Generator
+from typing import TYPE_CHECKING, AsyncGenerator, Generator
 
 import pytest
 from azure.storage.blob import ContainerClient
 from azure.storage.blob.aio import ContainerClient as AsyncContainerClient
 
-from pytest_databases._service import DockerService
 from pytest_databases.helpers import get_xdist_worker_num
 from pytest_databases.types import ServiceContainer
 
+if TYPE_CHECKING:
+    from pytest_databases._service import DockerService
+
 
 @dataclass
 class AzureBlobService(ServiceContainer):

src/pytest_databases/docker/bigquery.py

@@ -8,13 +8,14 @@
 from google.auth.credentials import AnonymousCredentials, Credentials
 from google.cloud import bigquery
 
-from pytest_databases._service import DockerService
 from pytest_databases.helpers import get_xdist_worker_id
 from pytest_databases.types import ServiceContainer
 
 if TYPE_CHECKING:
     from collections.abc import Generator
 
+    from pytest_databases._service import DockerService
+
 
 @dataclass
 class BigQueryService(ServiceContainer):

src/pytest_databases/docker/cockroachdb.py

@@ -1,18 +1,13 @@
 from __future__ import annotations
 
-import os
-import sys
 from dataclasses import dataclass
-from pathlib import Path
 from typing import TYPE_CHECKING
 
 import psycopg
 import pytest
 
 from pytest_databases._service import DockerService, ServiceContainer
-from pytest_databases.docker import DockerServiceRegistry
-from pytest_databases.docker.dragonfly import dragonfly_image
-from pytest_databases.helpers import simple_string_hash, get_xdist_worker_num
+from pytest_databases.helpers import get_xdist_worker_num
 
 if TYPE_CHECKING:
     from collections.abc import Generator

src/pytest_databases/docker/elastic_search.py

@@ -2,23 +2,19 @@
 
 import contextlib
 import dataclasses
-import os
-import sys
-from pathlib import Path
 from typing import TYPE_CHECKING
 
 import pytest
 from elasticsearch7 import Elasticsearch as Elasticsearch7
 from elasticsearch7 import Elasticsearch as Elasticsearch8
 
-from pytest_databases._service import DockerService
-from pytest_databases.docker import DockerServiceRegistry
-from pytest_databases.helpers import simple_string_hash
 from pytest_databases.types import ServiceContainer
 
 if TYPE_CHECKING:
     from collections.abc import Generator
 
+    from pytest_databases._service import DockerService
+
 
 @dataclasses.dataclass
 class ElasticsearchService(ServiceContainer):
@@ -48,33 +44,13 @@ def elasticsearch8_responsive(scheme: str, host: str, port: int, user: str, pass
         return False
 
 
-@pytest.fixture(scope="session")
-def elasticsearch_user() -> str:
-    return "elastic"
-
-
-@pytest.fixture(scope="session")
-def elasticsearch_password() -> str:
-    return "changeme"
-
-
-@pytest.fixture(scope="session")
-def elasticsearch_database() -> str:
-    return "db"
-
-
-@pytest.fixture(scope="session")
-def elasticsearch_scheme() -> str:
-    return "http"
-
-
 @contextlib.contextmanager
 def _provide_elasticsearch_service(
     docker_service: DockerService,
     image: str,
     name: str,
     client_cls: type[Elasticsearch7 | Elasticsearch8],
-):
+) -> Generator[ElasticsearchService, None, None]:
     user = "elastic"
     password = "changeme"
     database = "db"
@@ -100,6 +76,8 @@ def check(_service: ServiceContainer) -> bool:
             "xpack.security.enabled": "false",
         },
         check=check,
+        timeout=120,
+        pause=1,
     ) as service:
         yield ElasticsearchService(
             host=service.host,
@@ -134,5 +112,5 @@ def elasticsearch8_service(docker_service: DockerService) -> Generator[Elasticse
 
 
 @pytest.fixture(autouse=False, scope="session")
-def elasticsearch_service(elasticsearch8_service) -> ElasticsearchService:
+def elasticsearch_service(elasticsearch8_service: ElasticsearchService) -> ElasticsearchService:
     return elasticsearch8_service

src/pytest_databases/docker/keydb.py

@@ -14,7 +14,6 @@
     from pytest_databases._service import DockerService
 
 
-
 @dataclasses.dataclass
 class KeydbService(ServiceContainer):
     db: int

src/pytest_databases/docker/mariadb.py

@@ -7,13 +7,14 @@
 import pymysql
 import pytest
 
-from pytest_databases._service import DockerService
 from pytest_databases.helpers import get_xdist_worker_num
 from pytest_databases.types import ServiceContainer
 
 if TYPE_CHECKING:
     from collections.abc import Generator
 
+    from pytest_databases._service import DockerService
+
 
 @dataclass
 class MariaDBService(ServiceContainer):