PYTHON-4864 - Create async version of SpecRunnerThread

test/asynchronous/unified_format.py

@@ -35,6 +35,7 @@
     client_knobs,
     unittest,
 )
+from test.asynchronous.utils_spec_runner import SpecRunnerTask
 from test.unified_format_shared import (
     KMS_TLS_OPTS,
     PLACEHOLDER_MAP,
@@ -58,7 +59,6 @@
     snake_to_camel,
     wait_until,
 )
-from test.utils_spec_runner import SpecRunnerThread
 from test.version import Version
 from typing import Any, Dict, List, Mapping, Optional
 
@@ -382,8 +382,8 @@ async def drop(self: AsyncGridFSBucket, *args: Any, **kwargs: Any) -> None:
             return
         elif entity_type == "thread":
             name = spec["id"]
-            thread = SpecRunnerThread(name)
-            thread.start()
+            thread = SpecRunnerTask(name)
+            await thread.start()
             self[name] = thread
             return
 
@@ -1177,16 +1177,16 @@ def primary_changed() -> bool:
 
         wait_until(primary_changed, "change primary", timeout=timeout)
 
-    def _testOperation_runOnThread(self, spec):
+    async def _testOperation_runOnThread(self, spec):
         """Run the 'runOnThread' operation."""
         thread = self.entity_map[spec["thread"]]
-        thread.schedule(lambda: self.run_entity_operation(spec["operation"]))
+        await thread.schedule(functools.partial(self.run_entity_operation, spec["operation"]))
 
-    def _testOperation_waitForThread(self, spec):
+    async def _testOperation_waitForThread(self, spec):
         """Run the 'waitForThread' operation."""
         thread = self.entity_map[spec["thread"]]
-        thread.stop()
-        thread.join(10)
+        await thread.stop()
+        await thread.join(10)
         if thread.exc:
             raise thread.exc
         self.assertFalse(thread.is_alive(), "Thread {} is still running".format(spec["thread"]))

test/asynchronous/utils_spec_runner.py

@@ -47,46 +47,68 @@
 from pymongo.asynchronous.command_cursor import AsyncCommandCursor
 from pymongo.asynchronous.cursor import AsyncCursor
 from pymongo.errors import AutoReconnect, BulkWriteError, OperationFailure, PyMongoError
+from pymongo.lock import _async_create_condition, _async_create_lock
 from pymongo.read_concern import ReadConcern
 from pymongo.read_preferences import ReadPreference
 from pymongo.results import BulkWriteResult, _WriteResult
 from pymongo.write_concern import WriteConcern
 
 _IS_SYNC = False
 
+if _IS_SYNC:
+    PARENT = threading.Thread
+else:
+    PARENT = object
 
-class SpecRunnerThread(threading.Thread):
+
+class SpecRunnerTask(PARENT):
     def __init__(self, name):
         super().__init__()
         self.name = name
         self.exc = None
         self.daemon = True
-        self.cond = threading.Condition()
+        self.cond = _async_create_condition(_async_create_lock())
         self.ops = []
         self.stopped = False
+        self.task = None
+
+    if not _IS_SYNC:
+
+        async def start(self):
+            self.task = asyncio.create_task(self.run(), name=self.name)
 
-    def schedule(self, work):
+        async def join(self, timeout: float | None = 0):  # type: ignore[override]
+            if self.task is not None:
+                await asyncio.wait([self.task], timeout=timeout)
+
+        def is_alive(self):
+            return not self.stopped
+
+    async def schedule(self, work):
         self.ops.append(work)
-        with self.cond:
+        async with self.cond:
             self.cond.notify()
 
-    def stop(self):
+    async def stop(self):
         self.stopped = True
-        with self.cond:
+        async with self.cond:
             self.cond.notify()
 
-    def run(self):
+    async def run(self):
         while not self.stopped or self.ops:
             if not self.ops:
-                with self.cond:
-                    self.cond.wait(10)
+                async with self.cond:
+                    if _IS_SYNC:
+                        await self.cond.wait(10)  # type: ignore[call-arg]
+                    else:
+                        await asyncio.wait_for(self.cond.wait(), timeout=10)  # type: ignore[arg-type]
             if self.ops:
                 try:
                     work = self.ops.pop(0)
-                    work()
+                    await work()
                 except Exception as exc:
                     self.exc = exc
-                    self.stop()
+                    await self.stop()
 
 
 class AsyncSpecTestCreator:

test/unified_format.py

@@ -1167,7 +1167,7 @@ def primary_changed() -> bool:
     def _testOperation_runOnThread(self, spec):
         """Run the 'runOnThread' operation."""
         thread = self.entity_map[spec["thread"]]
-        thread.schedule(lambda: self.run_entity_operation(spec["operation"]))
+        thread.schedule(functools.partial(self.run_entity_operation, spec["operation"]))
 
     def _testOperation_waitForThread(self, spec):
         """Run the 'waitForThread' operation."""

test/utils_spec_runner.py

@@ -44,6 +44,7 @@
 from gridfs import GridFSBucket
 from gridfs.synchronous.grid_file import GridFSBucket
 from pymongo.errors import AutoReconnect, BulkWriteError, OperationFailure, PyMongoError
+from pymongo.lock import _create_condition, _create_lock
 from pymongo.read_concern import ReadConcern
 from pymongo.read_preferences import ReadPreference
 from pymongo.results import BulkWriteResult, _WriteResult
@@ -54,16 +55,34 @@
 
 _IS_SYNC = True
 
+if _IS_SYNC:
+    PARENT = threading.Thread
+else:
+    PARENT = object
 
-class SpecRunnerThread(threading.Thread):
+
+class SpecRunnerThread(PARENT):
     def __init__(self, name):
         super().__init__()
         self.name = name
         self.exc = None
         self.daemon = True
-        self.cond = threading.Condition()
+        self.cond = _create_condition(_create_lock())
         self.ops = []
         self.stopped = False
+        self.task = None
+
+    if not _IS_SYNC:
+
+        def start(self):
+            self.task = asyncio.create_task(self.run(), name=self.name)
+
+        def join(self, timeout: float | None = 0):  # type: ignore[override]
+            if self.task is not None:
+                asyncio.wait([self.task], timeout=timeout)
+
+        def is_alive(self):
+            return not self.stopped
 
     def schedule(self, work):
         self.ops.append(work)
@@ -79,7 +98,10 @@ def run(self):
         while not self.stopped or self.ops:
             if not self.ops:
                 with self.cond:
-                    self.cond.wait(10)
+                    if _IS_SYNC:
+                        self.cond.wait(10)  # type: ignore[call-arg]
+                    else:
+                        asyncio.wait_for(self.cond.wait(), timeout=10)  # type: ignore[arg-type]
             if self.ops:
                 try:
                     work = self.ops.pop(0)

tools/synchro.py

@@ -119,6 +119,7 @@
     "_async_create_lock": "_create_lock",
     "_async_create_condition": "_create_condition",
     "_async_cond_wait": "_cond_wait",
+    "SpecRunnerTask": "SpecRunnerThread",
 }
 
 docstring_replacements: dict[tuple[str, str], str] = {