pytest-databases 0.5.0__tar.gz → 0.6.0__tar.gz

{pytest_databases-0.5.0 → pytest_databases-0.6.0}/.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.4.0" # make sure this is always consistent with hatch configs
+    rev: "v0.4.5" # make sure this is always consistent with hatch configs
     hooks:
       - id: ruff
         args: [--config, ./pyproject.toml]

{pytest_databases-0.5.0 → pytest_databases-0.6.0}/Makefile

@@ -111,6 +111,12 @@ lint: 												## Runs pre-commit hooks; includes ruff linting, codespell, bl
 
 .PHONY: test
 test:  												## Run the tests
+	@echo "=> Running test cases"
+	@hatch run +py=3.12 test:cov
+	@echo "=> Tests complete"
+
+.PHONY: test-all
+test-all:  												## Run the tests for all python versions
 	@echo "=> Running test cases"
 	@hatch run test:cov
 	@echo "=> Tests complete"

{pytest_databases-0.5.0 → pytest_databases-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pytest-databases
-Version: 0.5.0
+Version: 0.6.0
 Summary: Reusable database fixtures for any and all databases.
 Project-URL: Documentation, https://github.com/litestar-org/pytest-databases#readme
 Project-URL: Issues, https://github.com/litestar-org/pytest-databases/issues
@@ -20,6 +20,8 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.8
 Requires-Dist: pytest
+Provides-Extra: azure-storage
+Requires-Dist: azure-storage-blob; extra == 'azure-storage'
 Provides-Extra: bigquery
 Requires-Dist: google-cloud-bigquery; extra == 'bigquery'
 Provides-Extra: cockroachdb
@@ -94,6 +96,7 @@ It is designed to offer pre-configured testing setups for many different types a
 - **Dragonfly**: Latest server
 - **KeyDB**: Latest server
 - **Elasticsearch**: Version 7 and 8 are available
+- **Azure blob storage**: Via azurite
 
 ## Contributing
 

{pytest_databases-0.5.0 → pytest_databases-0.6.0}/README.md

@@ -44,6 +44,7 @@ It is designed to offer pre-configured testing setups for many different types a
 - **Dragonfly**: Latest server
 - **KeyDB**: Latest server
 - **Elasticsearch**: Version 7 and 8 are available
+- **Azure blob storage**: Via azurite
 
 ## Contributing
 

{pytest_databases-0.5.0 → pytest_databases-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 build-backend = "hatchling.build"
-requires = ["hatchling", "hatch-pip-compile"]
+requires = ["hatchling"]
 
 ####################
 # Project Metadata #
@@ -12,7 +12,7 @@ license = "MIT"
 name = "pytest-databases"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "0.5.0"
+version = "0.6.0"
 #
 authors = [{ name = "Cody Fincher", email = "cody.fincher@gmail.com" }]
 keywords = [
@@ -52,6 +52,7 @@ Issues = "https://github.com/litestar-org/pytest-databases/issues"
 Source = "https://github.com/litestar-org/pytest-databases"
 
 [project.optional-dependencies]
+azure-storage = ["azure-storage-blob"]
 bigquery = ["google-cloud-bigquery"]
 cockroachdb = ["psycopg"]
 dragonfly = ["redis"]
@@ -80,14 +81,8 @@ exclude = ["/.github", "/docs"]
 
 # Default environment with production dependencies
 [tool.hatch.envs.default]
-lock-filename = "requirements/requirements.txt"
-pip-compile-constraint = "default"
-pip-compile-hashes = false
-pip-compile-installer = "uv"
-pip-compile-resolver = "uv"
-python = "3.11"
-requires = ["hatch-pip-compile"]
-type = "pip-compile"
+installer = "uv"
+python = "3.12"
 
 [tool.hatch.envs.default.scripts]
 upgrade-all = "PIP_COMPILE_UPGRADE=1 hatch env run --env {env_name} -- python --version"
@@ -119,6 +114,7 @@ features = [
   "elasticsearch7",
   "elasticsearch8",
   "bigquery",
+  "azure-storage",
 ]
 template = "default"
 type = "virtual"
@@ -178,11 +174,9 @@ features = [
   "elasticsearch8",
   "bigquery",
 ]
-lock-filename = "requirements/requirements-docs.txt"
-pip-compile-constraint = "default"
 python = "3.11"
-template = "test"
-type = "pip-compile"
+template = "default"
+type = "virtual"
 
 [tool.hatch.envs.docs.env-vars]
 PYTHONPATH = "."
@@ -250,12 +244,10 @@ features = [
   "elasticsearch8",
   "bigquery",
 ]
-lock-filename = "requirements/requirements-dev.txt"
 path = ".venv/"
-pip-compile-constraint = "docs"
 python = "3.11"
 template = "docs"
-type = "pip-compile"
+type = "virtual"
 
 
 # Lint environment
@@ -291,6 +283,7 @@ features = [
 ]
 python = "3.11"
 template = "docs"
+type = "virtual"
 
 [tool.hatch.envs.lint.scripts]
 check = ["style", "typing"]
@@ -596,7 +589,11 @@ line-length = 120
 
 [tool.pytest.ini_options]
 addopts = "--dist loadfile -n 2 -ra -q --doctest-glob='*.md'"
-filterwarnings = ["ignore::DeprecationWarning:pkg_resources", "ignore::DeprecationWarning:xdist.*"]
+filterwarnings = [
+  "ignore::DeprecationWarning:pkg_resources",
+  "ignore::DeprecationWarning:xdist.*",
+  "ignore::DeprecationWarning:importlib._bootstrap",
+]
 markers = [
   "mysql: MySQL Tests",
   "postgres: Postgres Tests",

{pytest_databases-0.5.0 → pytest_databases-0.6.0}/src/pytest_databases/docker/__init__.py

@@ -29,7 +29,7 @@ import re
 import subprocess  # noqa: S404
 import sys
 import timeit
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Callable, Iterable
 
 import pytest
 
@@ -72,7 +72,12 @@ COMPOSE_PROJECT_NAME: str = f"pytest-databases-{simple_string_hash(__file__)}"
 
 
 class DockerServiceRegistry:
-    def __init__(self, worker_id: str, compose_project_name: str = COMPOSE_PROJECT_NAME) -> None:
+    def __init__(
+        self,
+        worker_id: str,
+        compose_project_name: str = COMPOSE_PROJECT_NAME,
+        before_start: Iterable[Callable[[], Any]] | None = None,
+    ) -> None:
         self._running_services: set[str] = set()
         self.docker_ip = self._get_docker_ip()
         self._base_command = ["docker-compose"] if USE_LEGACY_DOCKER_COMPOSE else ["docker", "compose"]
@@ -82,6 +87,7 @@ class DockerServiceRegistry:
                 f"--project-name={compose_project_name}-{worker_id}",
             ],
         )
+        self._before_start = list(before_start) if before_start else []
 
     @staticmethod
     def _get_docker_ip() -> str:
@@ -109,6 +115,9 @@ class DockerServiceRegistry:
         pause: float = 0.1,
         **kwargs: Any,
     ) -> None:
+        for before_start in self._before_start:
+            before_start()
+
         if SKIP_DOCKER_COMPOSE:
             self._running_services.add(name)
         if name not in self._running_services:

pytest_databases-0.6.0/src/pytest_databases/docker/azure_blob.py

@@ -0,0 +1,187 @@
+# MIT License
+
+# Copyright (c) 2024 Litestar
+
+# 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.
+from __future__ import annotations
+
+import json
+import os
+import secrets
+import subprocess  # noqa: S404
+from pathlib import Path
+from typing import AsyncGenerator, Generator
+
+import pytest
+from azure.storage.blob import ContainerClient
+from azure.storage.blob.aio import ContainerClient as AsyncContainerClient
+
+from pytest_databases.docker import DockerServiceRegistry
+from pytest_databases.helpers import simple_string_hash
+
+COMPOSE_PROJECT_NAME: str = f"pytest-databases-azure-blob-{simple_string_hash(__file__)}"
+
+
+def _get_container_ids(compose_file_name: str) -> list[str]:
+    proc = subprocess.run(
+        [  # noqa: S607
+            "docker",
+            "container",
+            "ls",
+            f"--filter=label=com.docker.compose.project.config_files={compose_file_name}",
+            "--format=json",
+        ],
+        capture_output=True,
+        text=True,
+        check=True,
+    )
+    return [json.loads(line)["ID"] for line in proc.stdout.splitlines()]
+
+
+def _get_container_logs(compose_file_name: str) -> str:
+    logs = ""
+    for container_id in _get_container_ids(compose_file_name):
+        stdout = subprocess.run(
+            ["docker", "logs", container_id],  # noqa: S607
+            capture_output=True,
+            text=True,
+            check=True,
+        ).stdout
+        logs += stdout
+    return logs
+
+
+@pytest.fixture(scope="session")
+def azure_blob_compose_project_name() -> str:
+    return os.environ.get("COMPOSE_PROJECT_NAME", COMPOSE_PROJECT_NAME)
+
+
+@pytest.fixture(scope="session")
+def azure_blob_service_startup_delay() -> int:
+    return 1
+
+
+@pytest.fixture(scope="session")
+def azure_blob_docker_services(
+    azure_blob_compose_project_name: str,
+    azure_blob_service_startup_delay: int,
+    worker_id: str = "main",
+) -> Generator[DockerServiceRegistry, None, None]:
+    registry = DockerServiceRegistry(
+        worker_id,
+        compose_project_name=azure_blob_compose_project_name,
+    )
+    try:
+        yield registry
+    finally:
+        registry.down()
+
+
+@pytest.fixture(scope="session")
+def azure_blob_connection_string() -> str:
+    return "DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;"
+
+
+@pytest.fixture(scope="session")
+def azure_blob_account_name() -> str:
+    return "devstoreaccount1"
+
+
+@pytest.fixture(scope="session")
+def azure_blob_account_key() -> str:
+    return "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="
+
+
+@pytest.fixture(scope="session")
+def azure_blob_account_url() -> str:
+    return "http://127.0.0.1:10000/devstoreaccount1"
+
+
+@pytest.fixture(scope="session")
+def azure_blob_port() -> int:
+    return 10000
+
+
+@pytest.fixture(scope="session")
+def azure_blob_docker_compose_files() -> list[Path]:
+    return [Path(Path(__file__).parent / "docker-compose.azurite.yml")]
+
+
+@pytest.fixture(scope="session")
+def default_azure_blob_redis_service_name() -> str:
+    return "azurite"
+
+
+@pytest.fixture(scope="session")
+def azure_blob_docker_ip(azure_blob_docker_services: DockerServiceRegistry) -> str:
+    return azure_blob_docker_services.docker_ip
+
+
+@pytest.fixture(scope="session")
+def azure_blob_default_container_name() -> str:
+    return secrets.token_hex(4)
+
+
+@pytest.fixture(scope="session")
+def azure_blob_container_client(
+    azure_blob_connection_string: str,
+    azure_blob_default_container_name: str,
+    azure_blob_service: None,
+) -> Generator[ContainerClient, None, None]:
+    with ContainerClient.from_connection_string(
+        azure_blob_connection_string, container_name=azure_blob_default_container_name
+    ) as container_client:
+        yield container_client
+
+
+@pytest.fixture(scope="session")
+async def azure_blob_async_container_client(
+    azure_blob_connection_string: str, azure_blob_default_container_name: str
+) -> AsyncGenerator[AsyncContainerClient, None]:
+    async with AsyncContainerClient.from_connection_string(
+        azure_blob_connection_string, container_name=azure_blob_default_container_name
+    ) as container_client:
+        yield container_client
+
+
+@pytest.fixture(autouse=False, scope="session")
+async def azure_blob_service(
+    azure_blob_docker_services: DockerServiceRegistry,
+    default_azure_blob_redis_service_name: str,
+    azure_blob_docker_compose_files: list[Path],
+    azure_blob_connection_string: str,
+    azure_blob_port: int,
+    azure_blob_default_container_name: str,
+) -> AsyncGenerator[None, None]:
+    os.environ["AZURE_BLOB_PORT"] = str(azure_blob_port)
+
+    def azurite_responsive(host: str, port: int) -> bool:
+        # because azurite has a bug where it will hang for a long time if you make a
+        # request against it before it has completed startup we can't ping it, so we're
+        # inspecting the container logs instead
+        logs = _get_container_logs(str(azure_blob_docker_compose_files[0].absolute()))
+        return "Azurite Blob service successfully listens on" in logs
+
+    await azure_blob_docker_services.start(
+        name=default_azure_blob_redis_service_name,
+        docker_compose_files=azure_blob_docker_compose_files,
+        check=azurite_responsive,
+        port=azure_blob_port,
+    )
+    yield

pytest_databases-0.6.0/src/pytest_databases/docker/docker-compose.azurite.yml

@@ -0,0 +1,9 @@
+version: "3.9"
+services:
+  azurite:
+    image: mcr.microsoft.com/azure-storage/azurite
+    hostname: azurite
+    restart: always
+    command: "azurite-blob --blobHost 0.0.0.0 --blobPort 10000"
+    ports:
+      - "10000:10000"

pytest_databases-0.6.0/tests/docker/test_azure_blob.py

@@ -0,0 +1,35 @@
+# MIT License
+
+# Copyright (c) 2024 Litestar
+
+# 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.
+
+import pytest
+from azure.storage.blob import ContainerClient
+
+pytestmark = pytest.mark.anyio
+
+
+pytest_plugins = [
+    "pytest_databases.docker.azure_blob",
+]
+
+
+async def test_azure_blob_service(azure_blob_container_client: ContainerClient) -> None:
+    assert not azure_blob_container_client.exists()