Merge pull request #880 from nolar/get-rid-of-async-timeout

Replace async-timeout with pytest-timeout and builtin asyncio routines

.github/workflows/ci.yaml

@@ -51,7 +51,7 @@ jobs:
       - run: pip install -r requirements.txt
       - run: pip install -e .[${{ matrix.install-extras }}]
         if: ${{ matrix.install-extras }}
-      - run: pytest --color=yes --cov=kopf --cov-branch
+      - run: pytest --color=yes --timeout=2 --cov=kopf --cov-branch
 
       - name: Publish coverage to Coveralls.io
         if: success()
@@ -94,7 +94,7 @@ jobs:
       - run: pip install -r requirements.txt
       - run: pip install -e .[${{ matrix.install-extras }}]
         if: ${{ matrix.install-extras }}
-      - run: pytest --color=yes --no-cov
+      - run: pytest --color=yes --timeout=2 --no-cov
 
   functional:
     strategy:
@@ -114,7 +114,7 @@ jobs:
           version: ${{ matrix.k3s }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
       - run: pip install -r requirements.txt -r examples/requirements.txt
-      - run: pytest --color=yes --only-e2e
+      - run: pytest --color=yes --timeout=30 --only-e2e
 
   coveralls-finish:
     name: Finalize coveralls.io

.github/workflows/thorough.yaml

@@ -55,7 +55,7 @@ jobs:
       - run: pip install -r requirements.txt
       - run: pip install -e .[${{ matrix.install-extras }}]
         if: ${{ matrix.install-extras }}
-      - run: pytest --color=yes --cov=kopf --cov-branch
+      - run: pytest --color=yes --timeout=2 --cov=kopf --cov-branch
 
       - name: Publish coverage to Coveralls.io
         if: success()
@@ -98,7 +98,7 @@ jobs:
       - run: pip install -r requirements.txt
       - run: pip install -e .[${{ matrix.install-extras }}]
         if: ${{ matrix.install-extras }}
-      - run: pytest --color=yes --no-cov
+      - run: pytest --color=yes --timeout=2 --no-cov
 
   functional:
     strategy:
@@ -118,7 +118,7 @@ jobs:
           version: ${{ matrix.k3s }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
       - run: pip install -r requirements.txt -r examples/requirements.txt
-      - run: pytest --color=yes --only-e2e
+      - run: pytest --color=yes --timeout=30 --only-e2e
 
   full-scale:
     strategy:
@@ -137,7 +137,7 @@ jobs:
           python-version: "3.10"
       - run: tools/install-minikube.sh
       - run: pip install -r requirements.txt -r examples/requirements.txt
-      - run: pytest --color=yes --only-e2e
+      - run: pytest --color=yes --timeout=30 --only-e2e
 
   coveralls-finish:
     name: Finalize coveralls.io

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+addopts =
+    --strict-markers

requirements.txt

@@ -3,7 +3,6 @@
 -e .
 aresponses
 astpath[xpath]
-async-timeout
 asynctest
 certbuilder
 certvalidator
@@ -23,5 +22,6 @@ pytest-aiohttp
 pytest-asyncio
 pytest-cov
 pytest-mock
+pytest-timeout
 types-pkg_resources
 types-PyYAML

tests/handling/indexing/test_blocking_until_indexed.py

@@ -1,7 +1,6 @@
 import asyncio
 import logging
 
-import async_timeout
 import pytest
 
 from kopf._cogs.aiokits.aiotoggles import ToggleSet
@@ -22,7 +21,7 @@ async def test_reporting_on_resource_readiness(
 
     operator_indexed = ToggleSet(all)
     resource_indexed = await operator_indexed.make_toggle()
-    async with timer, async_timeout.timeout(0.5) as timeout:
+    with timer:
         await process_resource_event(
             lifecycle=all_at_once,
             registry=registry,
@@ -36,7 +35,6 @@ async def test_reporting_on_resource_readiness(
             operator_indexed=operator_indexed,
             resource_indexed=resource_indexed,
         )
-    assert not timeout.expired
     assert timer.seconds < 0.2  # asap, nowait
     assert operator_indexed.is_on()
     assert set(operator_indexed) == set()  # save RAM
@@ -51,22 +49,20 @@ async def test_blocking_when_operator_is_not_ready(
     operator_indexed = ToggleSet(all)
     resource_listed = await operator_indexed.make_toggle()
     resource_indexed = await operator_indexed.make_toggle()
-    with pytest.raises(asyncio.TimeoutError):
-        async with timer, async_timeout.timeout(0.2) as timeout:
-            await process_resource_event(
-                lifecycle=all_at_once,
-                registry=registry,
-                settings=settings,
-                resource=resource,
-                indexers=indexers,
-                memories=ResourceMemories(),
-                memobase=Memo(),
-                raw_event={'type': event_type, 'object': {}},
-                event_queue=asyncio.Queue(),
-                operator_indexed=operator_indexed,
-                resource_indexed=resource_indexed,
-            )
-    assert timeout.expired
+    with pytest.raises(asyncio.TimeoutError), timer:
+        await asyncio.wait_for(process_resource_event(
+            lifecycle=all_at_once,
+            registry=registry,
+            settings=settings,
+            resource=resource,
+            indexers=indexers,
+            memories=ResourceMemories(),
+            memobase=Memo(),
+            raw_event={'type': event_type, 'object': {}},
+            event_queue=asyncio.Queue(),
+            operator_indexed=operator_indexed,
+            resource_indexed=resource_indexed,
+        ), timeout=0.2)
     assert 0.2 < timer.seconds < 0.4
     assert operator_indexed.is_off()
     assert set(operator_indexed) == {resource_listed}
@@ -85,7 +81,7 @@ async def delayed_readiness(delay: float):
     operator_indexed = ToggleSet(all)
     resource_listed = await operator_indexed.make_toggle()
     resource_indexed = await operator_indexed.make_toggle()
-    async with timer, async_timeout.timeout(1.0) as timeout:
+    with timer:
         asyncio.create_task(delayed_readiness(0.2))
         await process_resource_event(
             lifecycle=all_at_once,
@@ -100,7 +96,6 @@ async def delayed_readiness(delay: float):
             operator_indexed=operator_indexed,
             resource_indexed=resource_indexed,
         )
-    assert not timeout.expired
     assert 0.2 < timer.seconds < 0.4
     assert operator_indexed.is_on()
     assert set(operator_indexed) == {resource_listed}

tests/k8s/test_watching_with_freezes.py

@@ -1,7 +1,6 @@
 import asyncio
 import logging
 
-import async_timeout
 import pytest
 
 from kopf._cogs.aiokits.aiotoggles import ToggleSet
@@ -15,15 +14,14 @@ async def test_pausing_is_ignored_if_turned_off(
     operator_paused = ToggleSet(any)
     await operator_paused.make_toggle(False)
 
-    async with timer, async_timeout.timeout(0.5) as timeout:
+    with timer:
         async with streaming_block(
             resource=resource,
             namespace=namespace,
             operator_paused=operator_paused,
         ):
             pass
 
-    assert not timeout.expired
     assert timer.seconds < 0.2  # no waits, exits as soon as possible
     assert_logs([], prohibited=[
         r"Pausing the watch-stream for",
@@ -38,16 +36,17 @@ async def test_pausing_waits_forever_if_not_resumed(
     operator_paused = ToggleSet(any)
     await operator_paused.make_toggle(True)
 
-    with pytest.raises(asyncio.TimeoutError):
-        async with timer, async_timeout.timeout(0.5) as timeout:
-            async with streaming_block(
+    async def do_it():
+        async with streaming_block(
                 resource=resource,
                 namespace=namespace,
                 operator_paused=operator_paused,
-            ):
-                pass
+        ):
+            pass
+
+    with pytest.raises(asyncio.TimeoutError), timer:
+        await asyncio.wait_for(do_it(), timeout=0.5)
 
-    assert timeout.expired
     assert timer.seconds >= 0.5
     assert_logs([
         r"Pausing the watch-stream for",
@@ -67,7 +66,7 @@ async def delayed_resuming(delay: float):
         await asyncio.sleep(delay)
         await conflicts_found.turn_to(False)
 
-    async with timer, async_timeout.timeout(1.0) as timeout:
+    with timer:
         asyncio.create_task(delayed_resuming(0.2))
         async with streaming_block(
             resource=resource,
@@ -76,7 +75,6 @@ async def delayed_resuming(delay: float):
         ):
             pass
 
-    assert not timeout.expired
     assert timer.seconds >= 0.2
     assert timer.seconds <= 0.5
     assert_logs([

tests/observation/test_processing_of_namespaces.py

@@ -1,6 +1,5 @@
 import asyncio
 
-import async_timeout
 import pytest
 
 from kopf._cogs.structs.bodies import RawBody, RawEvent
@@ -19,11 +18,9 @@ async def delayed_injection(delay: float):
 
     task = asyncio.create_task(delayed_injection(0))
     with pytest.raises(asyncio.TimeoutError):
-        async with async_timeout.timeout(0.1) as timeout:
-            async with insights.revised:
-                await insights.revised.wait()
+        async with insights.revised:
+            await asyncio.wait_for(insights.revised.wait(), timeout=0.1)
     await task
-    assert timeout.expired
     assert not insights.namespaces
 
 
@@ -38,7 +35,7 @@ async def delayed_injection(delay: float):
             insights=insights, raw_event=e1, namespaces=['ns*'])
 
     task = asyncio.create_task(delayed_injection(0.1))
-    async with timer, async_timeout.timeout(1):
+    with timer:
         async with insights.revised:
             await insights.revised.wait()
     await task
@@ -58,7 +55,7 @@ async def delayed_injection(delay: float):
             insights=insights, raw_event=e1, namespaces=['ns*'])
 
     task = asyncio.create_task(delayed_injection(0.1))
-    async with timer, async_timeout.timeout(1):
+    with timer:
         async with insights.revised:
             await insights.revised.wait()
     await task

tests/observation/test_processing_of_resources.py

@@ -1,7 +1,6 @@
 import asyncio
 
 import aiohttp.web
-import async_timeout
 import pytest
 
 import kopf
@@ -126,7 +125,7 @@ async def delayed_injection(delay: float):
             insights=insights, raw_event=e1, registry=registry, settings=settings)
 
     task = asyncio.create_task(delayed_injection(0.1))
-    async with timer, async_timeout.timeout(1.0):
+    with timer:
         async with insights.revised:
             await insights.revised.wait()
     await task
@@ -148,11 +147,9 @@ async def delayed_injection(delay: float):
 
     task = asyncio.create_task(delayed_injection(0))
     with pytest.raises(asyncio.TimeoutError):
-        async with async_timeout.timeout(0.1) as timeout:
-            async with insights.revised:
-                await insights.revised.wait()
+        async with insights.revised:
+            await asyncio.wait_for(insights.revised.wait(), timeout=0.1)
     await task
-    assert timeout.expired
     assert not insights.indexed_resources
     assert not insights.watched_resources
     assert not insights.webhook_resources
@@ -173,7 +170,7 @@ async def delayed_injection(delay: float):
             insights=insights, raw_event=e1, registry=registry, settings=settings)
 
     task = asyncio.create_task(delayed_injection(0.1))
-    async with timer, async_timeout.timeout(1.0):
+    with timer:
         async with insights.revised:
             await insights.revised.wait()
     await task
@@ -198,7 +195,7 @@ async def delayed_injection(delay: float):
             insights=insights, raw_event=e1, registry=registry, settings=settings)
 
     task = asyncio.create_task(delayed_injection(0.1))
-    async with timer, async_timeout.timeout(1.0):
+    with timer:
         async with insights.revised:
             await insights.revised.wait()
     await task
@@ -222,7 +219,7 @@ async def delayed_injection(delay: float):
             insights=insights, raw_event=e1, registry=registry, settings=settings)
 
     task = asyncio.create_task(delayed_injection(0.1))
-    async with timer, async_timeout.timeout(1.0):
+    with timer:
         async with insights.revised:
             await insights.revised.wait()
     await task
@@ -244,7 +241,7 @@ async def delayed_injection(delay: float):
             insights=insights, raw_event=e1, registry=registry, settings=settings)
 
     task = asyncio.create_task(delayed_injection(0.1))
-    async with timer, async_timeout.timeout(1.0):
+    with timer:
         await insights.backbone.wait_for(NAMESPACES)
     await task
     assert 0.1 < timer.seconds < 1.0

tests/posting/test_poster.py

@@ -1,9 +1,7 @@
 import asyncio
 import logging
 
-import async_timeout
 import pytest
-from asynctest import call
 
 from kopf import event, exception, info, warn
 from kopf._cogs.structs.references import Backbone, Resource
@@ -45,8 +43,7 @@ def _cancel(*args, **kwargs):
 
     # A way to cancel a `while True` cycle by timing, even if the routines are not called.
     with pytest.raises(asyncio.CancelledError):
-        async with async_timeout.timeout(0.5):
-            await poster(event_queue=event_queue, backbone=backbone, settings=settings)
+        await poster(event_queue=event_queue, backbone=backbone, settings=settings)
 
     assert post.call_count == 2
     assert post.call_args_list[0][1]['url'] == '/api/v1/namespaces/ns1/events'

tests/primitives/test_conditions.py

@@ -1,6 +1,5 @@
 import asyncio
 
-import async_timeout
 import pytest
 
 from kopf._cogs.aiokits.aiobindings import condition_chain
@@ -11,14 +10,9 @@ async def test_no_triggering():
     target = asyncio.Condition()
     task = asyncio.create_task(condition_chain(source, target))
     try:
-
         with pytest.raises(asyncio.TimeoutError):
-            async with async_timeout.timeout(0.1) as timeout:
-                async with target:
-                    await target.wait()
-
-        assert timeout.expired
-
+            async with target:
+                await asyncio.wait_for(target.wait(), timeout=0.1)
     finally:
         task.cancel()
         await asyncio.wait([task])
@@ -36,11 +30,10 @@ async def delayed_trigger():
 
         event_loop.call_later(0.1, asyncio.create_task, delayed_trigger())
 
-        async with timer, async_timeout.timeout(10) as timeout:
+        with timer:
             async with target:
                 await target.wait()
 
-        assert not timeout.expired
         assert 0.1 <= timer.seconds <= 0.2
 
     finally: