Merge pull request #2323 from VWS-Python/parallel-tests

Make it possible to run all tests in parallel

Author: adamtheturtle

README.rst

@@ -20,35 +20,6 @@ language.
 Getting Started
 ---------------
 
-.. invisible-code-block: python
-
-   import contextlib
-   import pathlib
-   import shutil
-
-   import vws_test_fixtures
-   from mock_vws import MockVWS
-   from mock_vws.database import VuforiaDatabase
-
-   # We use a low processing time so that tests run quickly.
-   mock = MockVWS(processing_time_seconds=0.2)
-   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]',
-   )
-   mock.add_database(database=database)
-   stack = contextlib.ExitStack()
-   stack.enter_context(mock)
-
-   # We rely on implementation details of the fixtures package.
-   image = pathlib.Path(vws_test_fixtures.__path__[0]) / 'high_quality_image.jpg'
-   assert image.exists(), image.resolve()
-   new_image = pathlib.Path('high_quality_image.jpg')
-   shutil.copy(image, new_image)
-
-
 .. code-block:: python
 
    import pathlib
@@ -84,11 +55,6 @@ Getting Started
 
    assert matching_targets[0].target_id == target_id
 
-.. invisible-code-block: python
-   new_image = pathlib.Path('high_quality_image.jpg')
-   new_image.unlink()
-   stack.close()
-
 Full Documentation
 ------------------
 

conftest.py

@@ -1,9 +1,14 @@
 """Setup for Sybil."""
 
+import io
+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,
@@ -21,11 +26,46 @@ def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
             item.obj = beartype(obj=item.obj)
 
 
+@pytest.fixture
+def make_image_file(
+    high_quality_image: io.BytesIO,
+) -> Generator[None, None, 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
+def mock_vws() -> Generator[None, None, None]:
+    """
+    Yield a mock VWS.
+
+    The keys used here match the keys in the documentation.
+    """
+    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]",
+    )
+    # 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()

docs/source/index.rst

@@ -16,33 +16,6 @@ Usage
 
 See the :doc:`api-reference` for full usage details.
 
-.. invisible-code-block: python
-
-   import contextlib
-   import pathlib
-   import shutil
-
-   import vws_test_fixtures
-   from mock_vws import MockVWS
-   from mock_vws.database import VuforiaDatabase
-
-   mock = MockVWS(real_http=False)
-   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]',
-   )
-   mock.add_database(database=database)
-   stack = contextlib.ExitStack()
-   stack.enter_context(mock)
-
-   # We rely on implementation details of the fixtures package.
-   image = pathlib.Path(vws_test_fixtures.__path__[0]) / 'high_quality_image.jpg'
-   assert image.exists(), image.resolve()
-   new_image = pathlib.Path('high_quality_image.jpg')
-   shutil.copy(image, new_image)
-
 .. code-block:: python
 
    import pathlib
@@ -62,7 +35,8 @@ See the :doc:`api-reference` for full usage details.
        client_access_key=client_access_key,
        client_secret_key=client_secret_key,
    )
-   name = 'my_image_name'
+   import uuid
+   name = 'my_image_name' + uuid.uuid4().hex
 
    image = pathlib.Path('high_quality_image.jpg')
    with image.open(mode='rb') as my_image_file:
@@ -79,12 +53,6 @@ See the :doc:`api-reference` for full usage details.
    assert matching_targets[0].target_id == target_id
    a = 1
 
-.. invisible-code-block: python
-
-   new_image = pathlib.Path('high_quality_image.jpg')
-   new_image.unlink()
-   stack.close()
-
 Testing
 -------
 
@@ -96,19 +64,6 @@ To write unit tests for code which uses this library, without using your Vuforia
 
 .. clear-namespace
 
-.. invisible-code-block: python
-
-   import pathlib
-   import shutil
-
-   import vws_test_fixtures
-
-   # We rely on implementation details of the fixtures package.
-   image = pathlib.Path(vws_test_fixtures.__path__[0]) / 'high_quality_image.jpg'
-   assert image.exists(), image.resolve()
-   new_image = pathlib.Path('high_quality_image.jpg')
-   shutil.copy(image, new_image)
-
 .. code-block:: python
 
    import pathlib
@@ -129,7 +84,6 @@ To write unit tests for code which uses this library, without using your Vuforia
            client_secret_key=database.client_secret_key,
        )
 
-
        image = pathlib.Path('high_quality_image.jpg')
        with image.open(mode='rb') as my_image_file:
          target_id = vws_client.add_target(
@@ -140,11 +94,6 @@ To write unit tests for code which uses this library, without using your Vuforia
             active_flag=True,
          )
 
-.. invisible-code-block: python
-
-   new_image = pathlib.Path('high_quality_image.jpg')
-   new_image.unlink()
-
 There are some differences between the mock and the real Vuforia.
 See https://vws-python-mock.readthedocs.io/en/latest/differences-to-vws.html for details.
 

pyproject.toml

@@ -117,7 +117,12 @@ lint.ignore = [
     "S101",
 ]
 
-lint.per-file-ignores."tests/test_*.py" = [
+lint.per-file-ignores."conftest.py" = [
+    # Allow hardcoded secrets in tests.
+    "S106",
+]
+
+lint.per-file-ignores."tests/*.py" = [
     # Do not require tests to have a one-line summary.
     "D205",
 ]