Upgrade to pytest-asyncio 1.4.0 and use event loop factory hook

See NGC-1985.

Author: bmerry

.pre-commit-config.yaml

@@ -52,6 +52,7 @@ repos:
             'prometheus-client==0.24.0',
             'pyparsing==3.3.1',
             'pytest==9.0.3',
+            'pytest-asyncio==1.4.0',
             'redis==7.1.0',  # Indirect dependency of katsdptelstate
             'spead2==4.4.1',
             'types-decorator==5.2.0.20251101',

pyproject.toml

@@ -67,7 +67,7 @@ test = [
     "katsdpsigproc[CUDA]",
     "matplotlib",
     "pytest>=8",
-    "pytest-asyncio>=0.24",
+    "pytest-asyncio>=1.4.0",
     "pytest-check>=1.3,<2.2.3",  # Upper bound due to https://github.com/okken/pytest-check/issues/173
     "pytest-custom_exit_code",
     "pytest-mock",
@@ -136,7 +136,7 @@ pytester_example_dir = "test/pytest_plugins/demo"
 # and only the top-level conftest.py is allowed to load plugins. See
 # test/pytest_plugins/demo/README.md for more info.
 addopts = "--cov-context=test --cov-report html --import-mode=prepend --ignore=test/pytest_plugins/demo"
-markers = ["mask_timestamp", "use_vkgdr", "cmdline_args", "spectra_per_heap", "slow"]
+markers = ["mask_timestamp", "use_vkgdr", "cmdline_args", "spectra_per_heap", "slow", "use_async_solipsism"]
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
 

qualification/requirements.txt

@@ -322,7 +322,7 @@ pytest==9.0.3
     #   pytest-check
     #   pytest-custom-exit-code
     #   pytest-reportlog
-pytest-asyncio==1.3.0
+pytest-asyncio==1.4.0
     # via
     #   -c qualification/../requirements-dev.txt
     #   katgpucbf (pyproject.toml)

requirements-dev.txt

@@ -344,7 +344,7 @@ pytest==9.0.3
     #   pytest-mock
     #   pytest-reportlog
     #   pytest-xdist
-pytest-asyncio==1.3.0
+pytest-asyncio==1.4.0
     # via katgpucbf (pyproject.toml)
 pytest-check==2.2.2
     # via katgpucbf (pyproject.toml)

test/conftest.py

@@ -50,6 +50,7 @@ def my_test(a, b):
 from typing import Any
 
 import aiokatcp
+import async_solipsism
 import katsdpsigproc.cuda
 import pycuda.driver
 import pytest
@@ -84,6 +85,7 @@ class _CombinationsCandidate:
     by_name: dict[str, Any]  # Lookup by argument name (for filtering)
 
 
+@pytest.hookimpl
 def pytest_generate_tests(metafunc) -> None:
     """Apply "combinations" marker."""
     all_combinations = metafunc.config.option.all_combinations
@@ -144,6 +146,15 @@ def pytest_generate_tests(metafunc) -> None:
         metafunc.parametrize(names, [combo.values for combo in combos])
 
 
+@pytest.hookimpl
+def pytest_asyncio_loop_factories(config: pytest.Config, item: pytest.Item) -> dict[str, Callable]:
+    """Override the event loop factory for tests with a ``use_async_solipsism`` mark."""
+    if item.get_closest_marker("use_async_solipsism") is not None:
+        return {"async_solipsism": async_solipsism.EventLoop}
+    else:
+        return {"stdlib": asyncio.new_event_loop}
+
+
 @pytest.fixture
 def mock_send_stream_network() -> IPv4Network:
     """Network mask to filter the queues returned by :func:`mock_send_stream`.

test/test_utils.py

@@ -25,7 +25,6 @@
 from unittest import mock
 
 import aiokatcp
-import async_solipsism
 import pytest
 from aiokatcp import DeviceStatus
 
@@ -71,14 +70,10 @@ async def discarding_iterator(counter: AsyncIterable[int]) -> SpyDiscardingItera
     return SpyDiscardingIterator(counter)
 
 
+@pytest.mark.use_async_solipsism
 class TestDiscardingIterator:
     """Test :class:`.DiscardingIterator`."""
 
-    @pytest.fixture
-    def event_loop_policy(self) -> async_solipsism.EventLoopPolicy:
-        """Use async_solipsism event loop."""
-        return async_solipsism.EventLoopPolicy()
-
     async def test_simple(self, discarding_iterator: SpyDiscardingIterator) -> None:
         """Test basic operations."""
         await asyncio.sleep(2.5)
@@ -228,14 +223,10 @@ def test_status_change(self, sensors: aiokatcp.SensorSet, mock_time: mock.Mock)
         assert ds.reading == aiokatcp.Reading(3456789012.0, aiokatcp.Sensor.Status.NOMINAL, DeviceStatus.OK)
 
 
+@pytest.mark.use_async_solipsism
 class TestTimeoutSensorStatus:
     """Tests for :func:`katgpucbf.utils.timeout_sensor_status`."""
 
-    @pytest.fixture
-    def event_loop_policy(self) -> async_solipsism.EventLoopPolicy:
-        """Use async_solipsism event loop."""
-        return async_solipsism.EventLoopPolicy()
-
     @pytest.fixture
     def sensor(self) -> aiokatcp.Sensor:
         """Create a dummy sensor."""

test/vgpu/test_send.py

@@ -26,19 +26,14 @@
 from typing import override
 from unittest import mock
 
-import async_solipsism
 import numpy as np
 import pytest
 import pytest_mock
 
 from katgpucbf.vgpu.main import VTP_DEFAULT_PORT
 from katgpucbf.vgpu.send import RateLimiter, VDIFFrame, VDIFSender
 
-
-@pytest.fixture
-def event_loop_policy() -> async_solipsism.EventLoopPolicy:
-    """Use async_solipsism event loop."""
-    return async_solipsism.EventLoopPolicy()
+pytestmark = pytest.mark.use_async_solipsism
 
 
 @dataclass(frozen=True)