tests: require explicit polling timeouts

Make every poll_until and async_poll_until call state its timeout so bounded waiting is visible at the assertion site rather than hidden by a helper default.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: cartertinney

tests/conftest.py

@@ -16,7 +16,7 @@
 def poll_until():
     """Return a helper that polls a condition without exceeding a timeout."""
 
-    def poll_until_condition(condition, timeout=5, interval=0.01):
+    def poll_until_condition(condition, *, timeout, interval=0.01):
         deadline = time.monotonic() + timeout
         while not condition():
             remaining = deadline - time.monotonic()
@@ -31,7 +31,7 @@ def poll_until_condition(condition, timeout=5, interval=0.01):
 def async_poll_until():
     """Return an async helper that polls a condition without blocking the event loop."""
 
-    async def poll_until_condition(condition, timeout=5, interval=0.01):
+    async def poll_until_condition(condition, *, timeout, interval=0.01):
         async def poll_condition():
             while not condition():
                 await asyncio.sleep(interval)

tests/unit/common/pipeline/test_pipeline_stages_base.py

@@ -188,7 +188,7 @@ def test_invoke_handler(self, mocker, stage, event, poll_until):
         stage.on_connected_handler = mock_handler
         stage.handle_pipeline_event(event)
         # Wait for the handler invocation to complete
-        poll_until(lambda: mock_handler.call_count >= 1)
+        poll_until(lambda: mock_handler.call_count >= 1, timeout=5)
         assert mock_handler.call_count == 1
         assert mock_handler.call_args == mocker.call()
 
@@ -209,7 +209,7 @@ def test_invoke_handler(self, mocker, stage, event, poll_until):
         stage.on_disconnected_handler = mock_handler
         stage.handle_pipeline_event(event)
         # Wait for the handler invocation to complete
-        poll_until(lambda: mock_handler.call_count >= 1)
+        poll_until(lambda: mock_handler.call_count >= 1, timeout=5)
         assert mock_handler.call_count == 1
         assert mock_handler.call_args == mocker.call()
 
@@ -230,7 +230,7 @@ def test_invoke_handler(self, mocker, stage, event, poll_until):
         stage.on_new_sastoken_required_handler = mock_handler
         stage.handle_pipeline_event(event)
         # Wait for the handler invocation to complete
-        poll_until(lambda: mock_handler.call_count >= 1)
+        poll_until(lambda: mock_handler.call_count >= 1, timeout=5)
         assert mock_handler.call_count == 1
         assert mock_handler.call_args == mocker.call()
 
@@ -253,7 +253,7 @@ def test_invoke_handler(self, mocker, stage, event, poll_until):
         stage.on_background_exception_handler = mock_handler
         stage.handle_pipeline_event(event)
         # Wait for the handler invocation to complete
-        poll_until(lambda: mock_handler.call_count >= 1)
+        poll_until(lambda: mock_handler.call_count >= 1, timeout=5)
         assert mock_handler.call_count == 1
         assert mock_handler.call_args == mocker.call(event.e)
 
@@ -274,7 +274,7 @@ def test_invoke_handler(self, mocker, stage, event, poll_until):
         stage.on_pipeline_event_handler = mock_handler
         stage.handle_pipeline_event(event)
         # Wait for the handler invocation to complete
-        poll_until(lambda: mock_handler.call_count >= 1)
+        poll_until(lambda: mock_handler.call_count >= 1, timeout=5)
         assert mock_handler.call_count == 1
         assert mock_handler.call_args == mocker.call(event)
 

tests/unit/iothub/aio/test_async_handler_manager.py

@@ -413,7 +413,7 @@ async def test_handler_invoked(
         mock_obj = mocker.MagicMock()
         inbox.put(mock_obj)
         # Wait for the handler invocation to complete
-        await async_poll_until(lambda: handler_checker.handler_called)
+        await async_poll_until(lambda: handler_checker.handler_called, timeout=5)
 
         # Handler has been called with the item from the inbox
         assert handler_checker.handler_called is True
@@ -441,7 +441,7 @@ async def test_handler_invoked_multiple(
         for _ in range(5):
             inbox.put(mocker.MagicMock())
         # Wait for all handler invocations to complete
-        await async_poll_until(lambda: handler_checker.handler_call_count >= 5)
+        await async_poll_until(lambda: handler_checker.handler_call_count >= 5, timeout=5)
 
         # Handler has been called 5 times
         assert handler_checker.handler_call_count == 5
@@ -550,7 +550,7 @@ async def coro_handler(arg):
         # Add an item to corresponding inbox, triggering the handler
         inbox.put(mocker.MagicMock())
         # Wait for the background exception handler to be called
-        await async_poll_until(lambda: background_exc_spy.call_count >= 1)
+        await async_poll_until(lambda: background_exc_spy.call_count >= 1, timeout=5)
         # Background exception handler was called
         assert background_exc_spy.call_count == 1
         e = background_exc_spy.call_args[0][0]
@@ -567,7 +567,7 @@ async def coro_handler(arg):
         # Add an item to corresponding inbox, triggering the handler
         inbox.put(mocker.MagicMock())
         # Wait for the background exception handler to be called
-        await async_poll_until(lambda: background_exc_spy.call_count >= 1)
+        await async_poll_until(lambda: background_exc_spy.call_count >= 1, timeout=5)
         # Background exception handler was called
         assert background_exc_spy.call_count == 1
         e = background_exc_spy.call_args[0][0]
@@ -595,21 +595,25 @@ def handler1(arg):
 
         inbox.put(mocker.MagicMock())
         # Wait for handler1 to replace itself with handler2
-        await async_poll_until(lambda: getattr(handler_manager, handler_name) is handler2)
+        await async_poll_until(
+            lambda: getattr(handler_manager, handler_name) is handler2, timeout=5
+        )
         # The set handler (handler1) has been replaced with a new handler (handler2)
         assert getattr(handler_manager, handler_name) is not handler1
         assert getattr(handler_manager, handler_name) is handler2
         # Add a new item to the inbox
         inbox.put(mocker.MagicMock())
         # Wait for handler2 to replace itself with the mock
-        await async_poll_until(lambda: getattr(handler_manager, handler_name) is mock_handler)
+        await async_poll_until(
+            lambda: getattr(handler_manager, handler_name) is mock_handler, timeout=5
+        )
         # The set handler (handler2) has now been replaced by a mock handler
         assert getattr(handler_manager, handler_name) is not handler2
         assert getattr(handler_manager, handler_name) is mock_handler
         # Add a new item to the inbox
         inbox.put(mocker.MagicMock())
         # Wait for the mock handler invocation to complete
-        await async_poll_until(lambda: mock_handler.call_count >= 1)
+        await async_poll_until(lambda: mock_handler.call_count >= 1, timeout=5)
         # The mock was now called
         assert getattr(handler_manager, handler_name).call_count == 1
 
@@ -702,7 +706,7 @@ async def test_handler_invoked(
         # Add the event to the client inbox
         inbox.put(event)
         # Wait for the handler invocation to complete
-        await async_poll_until(lambda: handler_checker.handler_call_count >= 1)
+        await async_poll_until(lambda: handler_checker.handler_call_count >= 1, timeout=5)
 
         # Handler has been called with the arguments from the event
         assert handler_checker.handler_call_count == 1
@@ -712,7 +716,7 @@ async def test_handler_invoked(
         non_matching_event = client_event.ClientEvent("NON_MATCHING_EVENT")
         inbox.put(non_matching_event)
         # Wait for the runner to consume the non-matching event
-        await async_poll_until(inbox.empty)
+        await async_poll_until(inbox.empty, timeout=5)
 
         # Handler has not been called again
         assert handler_checker.handler_call_count == 1
@@ -739,7 +743,7 @@ async def test_handler_invoked_multiple(
         for _ in range(5):
             inbox.put(event)
         # Wait for all handler invocations to complete
-        await async_poll_until(lambda: handler_checker.handler_call_count >= 5)
+        await async_poll_until(lambda: handler_checker.handler_call_count >= 5, timeout=5)
 
         # Handler has been called 5 times
         assert handler_checker.handler_call_count == 5
@@ -773,7 +777,7 @@ async def coro_handler(*args):
         # Add an item to corresponding inbox, triggering the handler
         inbox.put(event)
         # Wait for the background exception handler to be called
-        await async_poll_until(lambda: background_exc_spy.call_count >= 1)
+        await async_poll_until(lambda: background_exc_spy.call_count >= 1, timeout=5)
         # Background exception handler was called
         assert background_exc_spy.call_count == 1
         e = background_exc_spy.call_args[0][0]
@@ -790,7 +794,7 @@ async def coro_handler(*args):
         # Add an item to corresponding inbox, triggering the handler
         inbox.put(event)
         # Wait for the background exception handler to be called
-        await async_poll_until(lambda: background_exc_spy.call_count >= 1)
+        await async_poll_until(lambda: background_exc_spy.call_count >= 1, timeout=5)
         # Background exception handler was called
         assert background_exc_spy.call_count == 1
         e = background_exc_spy.call_args[0][0]
@@ -818,21 +822,25 @@ def handler1(*args):
 
         inbox.put(event)
         # Wait for handler1 to replace itself with handler2
-        await async_poll_until(lambda: getattr(handler_manager, handler_name) is handler2)
+        await async_poll_until(
+            lambda: getattr(handler_manager, handler_name) is handler2, timeout=5
+        )
         # The set handler (handler1) has been replaced with a new handler (handler2)
         assert getattr(handler_manager, handler_name) is not handler1
         assert getattr(handler_manager, handler_name) is handler2
         # Add a new item to the inbox
         inbox.put(event)
         # Wait for handler2 to replace itself with the mock
-        await async_poll_until(lambda: getattr(handler_manager, handler_name) is mock_handler)
+        await async_poll_until(
+            lambda: getattr(handler_manager, handler_name) is mock_handler, timeout=5
+        )
         # The set handler (handler2) has now been replaced by a mock handler
         assert getattr(handler_manager, handler_name) is not handler2
         assert getattr(handler_manager, handler_name) is mock_handler
         # Add a new item to the inbox
         inbox.put(event)
         # Wait for the mock handler invocation to complete
-        await async_poll_until(lambda: mock_handler.call_count >= 1)
+        await async_poll_until(lambda: mock_handler.call_count >= 1, timeout=5)
         # The mock was now called
         assert getattr(handler_manager, handler_name).call_count == 1
 

tests/unit/iothub/test_sync_handler_manager.py

@@ -363,7 +363,7 @@ def test_handler_invoked(self, mocker, handler_name, handler_manager, inbox, pol
         mock_obj = mocker.MagicMock()
         inbox.put(mock_obj)
         # Wait for the handler invocation to complete
-        poll_until(lambda: mock_handler.call_count >= 1)
+        poll_until(lambda: mock_handler.call_count >= 1, timeout=5)
 
         # Handler has been called with the item from the inbox
         assert mock_handler.call_count == 1
@@ -385,7 +385,7 @@ def test_handler_invoked_multiple(
         for _ in range(5):
             inbox.put(mocker.MagicMock())
         # Wait for all handler invocations to complete
-        poll_until(lambda: mock_handler.call_count >= 5)
+        poll_until(lambda: mock_handler.call_count >= 5, timeout=5)
 
         # Handler has been called 5 times
         assert mock_handler.call_count == 5
@@ -485,7 +485,7 @@ def test_exception_in_handler(
         # Add an item to corresponding inbox, triggering the handler
         inbox.put(mocker.MagicMock())
         # Wait for the background exception handler to be called
-        poll_until(lambda: background_exc_spy.call_count >= 1)
+        poll_until(lambda: background_exc_spy.call_count >= 1, timeout=5)
         # Handler has now been called
         assert mock_handler.call_count == 1
         # Background exception handler was called
@@ -506,14 +506,14 @@ def handler(arg):
 
         inbox.put(mocker.MagicMock())
         # Wait for the handler to replace itself with the mock
-        poll_until(lambda: getattr(handler_manager, handler_name) is not handler)
+        poll_until(lambda: getattr(handler_manager, handler_name) is not handler, timeout=5)
         # Handler has been replaced with a mock, but the mock has not been invoked
         assert getattr(handler_manager, handler_name) is not handler
         assert getattr(handler_manager, handler_name).call_count == 0
         # Add a new item to the inbox
         inbox.put(mocker.MagicMock())
         # Wait for the mock handler invocation to complete
-        poll_until(lambda: getattr(handler_manager, handler_name).call_count >= 1)
+        poll_until(lambda: getattr(handler_manager, handler_name).call_count >= 1, timeout=5)
         # The mock was now called
         assert getattr(handler_manager, handler_name).call_count == 1
 
@@ -597,7 +597,7 @@ def test_handler_invoked(self, mocker, handler_name, handler_manager, inbox, eve
         # Add the event to the client event inbox
         inbox.put(event)
         # Wait for the handler invocation to complete
-        poll_until(lambda: mock_handler.call_count >= 1)
+        poll_until(lambda: mock_handler.call_count >= 1, timeout=5)
 
         # Handler has been called with the arguments from the event
         assert mock_handler.call_count == 1
@@ -607,7 +607,7 @@ def test_handler_invoked(self, mocker, handler_name, handler_manager, inbox, eve
         non_matching_event = client_event.ClientEvent("NON_MATCHING_EVENT")
         inbox.put(non_matching_event)
         # Wait for the runner to consume the non-matching event
-        poll_until(inbox.empty)
+        poll_until(inbox.empty, timeout=5)
 
         # Handler has not been called again
         assert mock_handler.call_count == 1
@@ -628,7 +628,7 @@ def test_handler_invoked_multiple(
         for _ in range(5):
             inbox.put(event)
         # Wait for all handler invocations to complete
-        poll_until(lambda: mock_handler.call_count >= 5)
+        poll_until(lambda: mock_handler.call_count >= 5, timeout=5)
 
         # Handler has been called 5 times
         assert mock_handler.call_count == 5
@@ -652,7 +652,7 @@ def test_exception_in_handler(
         # Add the event to the client event inbox, triggering the handler
         inbox.put(event)
         # Wait for the background exception handler to be called
-        poll_until(lambda: background_exc_spy.call_count >= 1)
+        poll_until(lambda: background_exc_spy.call_count >= 1, timeout=5)
         # Handler has now been called
         assert mock_handler.call_count == 1
         # Background exception handler was called
@@ -673,14 +673,14 @@ def handler(*args):
 
         inbox.put(event)
         # Wait for the handler to replace itself with the mock
-        poll_until(lambda: getattr(handler_manager, handler_name) is not handler)
+        poll_until(lambda: getattr(handler_manager, handler_name) is not handler, timeout=5)
         # Handler has been replaced with a mock, but the mock has not been invoked
         assert getattr(handler_manager, handler_name) is not handler
         assert getattr(handler_manager, handler_name).call_count == 0
         # Add a new event to the inbox
         inbox.put(event)
         # Wait for the mock handler invocation to complete
-        poll_until(lambda: getattr(handler_manager, handler_name).call_count >= 1)
+        poll_until(lambda: getattr(handler_manager, handler_name).call_count >= 1, timeout=5)
         # The mock was now called
         assert getattr(handler_manager, handler_name).call_count == 1