conftest.py

"""
Setup for Sybil.
"""

import io
import uuid
from collections.abc import Generator
from doctest import ELLIPSIS
from pathlib import Path

import pytest
from beartype import beartype
from mock_vws import MockVWS
from mock_vws.database import VuforiaDatabase
from sybil import Sybil
from sybil.parsers.rest import (
    ClearNamespaceParser,
    DocTestParser,
    PythonCodeBlockParser,
)


def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
    """
    Apply the beartype decorator to all collected test functions.
    """
    for item in items:
        if isinstance(item, pytest.Function):
            item.obj = beartype(obj=item.obj)


@pytest.fixture(name="make_image_file")
def fixture_make_image_file(
    high_quality_image: io.BytesIO,
) -> Generator[None]:
    """Make an image file available in the test directory.

    The path of this file matches the path in the documentation.
    """
    new_image = Path("high_quality_image.jpg")
    buffer = high_quality_image.getvalue()
    new_image.write_bytes(data=buffer)
    yield
    new_image.unlink()


@pytest.fixture(name="mock_vws")
def fixture_mock_vws(
    monkeypatch: pytest.MonkeyPatch,
) -> Generator[None]:
    """Yield a mock VWS.

    The keys used here match the keys in the documentation.
    """
    server_access_key = uuid.uuid4().hex
    server_secret_key = uuid.uuid4().hex
    client_access_key = uuid.uuid4().hex
    client_secret_key = uuid.uuid4().hex

    database = VuforiaDatabase(
        server_access_key=server_access_key,
        server_secret_key=server_secret_key,
        client_access_key=client_access_key,
        client_secret_key=client_secret_key,
    )

    monkeypatch.setenv(name="VWS_SERVER_ACCESS_KEY", value=server_access_key)
    monkeypatch.setenv(name="VWS_SERVER_SECRET_KEY", value=server_secret_key)
    monkeypatch.setenv(name="VWS_CLIENT_ACCESS_KEY", value=client_access_key)
    monkeypatch.setenv(name="VWS_CLIENT_SECRET_KEY", value=client_secret_key)
    # We use a low processing time so that tests run quickly.
    with MockVWS(processing_time_seconds=0.2) as mock:
        mock.add_database(database=database)
        yield


pytest_collect_file = Sybil(
    parsers=[
        ClearNamespaceParser(),
        DocTestParser(optionflags=ELLIPSIS),
        PythonCodeBlockParser(),
    ],
    patterns=["*.rst", "*.py"],
    fixtures=["make_image_file", "mock_vws"],
).pytest()