Replace async-timeout with pytest-timeout and builtin asyncio routines #880
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nolar
force-pushed
the
get-rid-of-async-timeout
branch
from
05445a6
to
2964d0b
Compare
Normally, individual tests should not take longer than 1 second, preferably closer to 0 seconds. Some selected tests, however, are slow by their nature (e.g. ngrok or kopf-runner) — so they take around 1-2 seconds. But this limit is only applicable to CI — not to local dev-mode runs, where breakpoints and infinite pauses are needed. This change should prevent the test-runs from being stuck at one single test if the test is designed improperly or because of the environment issues. This removes the need to keep the timing safeguards inside the tests, which complicates the tests themselves (e.g. with `async-timeout`) — unless such safe-guards are a part of the test design. Signed-off-by: Sergey Vasilyev <nolar@nolar.info>
nolar
force-pushed
the
get-rid-of-async-timeout
branch
from
2964d0b
to
ead16a2
Compare
`async-timeout` was used in tests for 2 purposes: * Extra safety against hanging the test-run if some tests are designed improperly. This function is now taken by `pytest-timeout` (see the previous commit). * As a part of test design to limit the expectedly infinite or long sleep. `async-timeout` was convenient to put on the same line as the `pytest.raises(asyncio.TimeoutError)` that it causes. Since `async-timeout` stopped supporting sync context manager protocol, it now requires a separate `async with` and an additional level of indenting — so, it became less useful, or not useful at all. This job is better done by the native `asyncio.wait_for(…, timeout=…)`. This change will also simplify the tests in the coming refactoring with the fake (simulated) time of event loops. Signed-off-by: Sergey Vasilyev <nolar@nolar.info>
nolar
force-pushed
the
get-rid-of-async-timeout
branch
from
ead16a2
to
a83943c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
async-timeoutwas used in tests for 2 purposes:pytest-timeoutin CI runs.async-timeoutwas convenient to put on the same line as thepytest.raises(asyncio.TimeoutError)that it causes. Sinceasync-timeoutstopped supporting sync context manager protocol, it now requires a separateasync withand an additional level of indenting — so, it became less useful, or not useful at all. This job is better done by the nativeasyncio.wait_for(…, timeout=…).This change will also simplify the tests in the coming refactoring with the fake (simulated) time of event loops.