chore: do not close connections at the end of pytest #3811
Merged
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
Signed-off-by: kostas <[email protected]>
kostasrim
commented
Sep 27, 2024
| @pytest.fixture(scope="function", params=[{}]) | ||
| def df_factory(request, tmp_dir, test_env) -> DflyInstanceFactory: | ||
| @pytest_asyncio.fixture(scope="function", params=[{}]) | ||
| async def df_factory(request, tmp_dir, test_env) -> DflyInstanceFactory: |
There was a problem hiding this comment.
This is the bread and butter of the PR. Fixtures can be async! This allows us to:
- Save all clients we create on df instance
- Clean them at the end of the fixture (since we can now
await close())
dranikpg
approved these changes
Sep 27, 2024
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.
A common case is that we need to clean up a connection before we exit a test via
.close()method. This is needed because otherwise the connection will raise a warning that it is left unclosed. However, remembering to call.close()at each connection at the end of the test is cumbersome! Luckily, fixtures in python can be marked asasyncwhich allow us to:DflyInstance.client()This PR adds this behaviour and cleans up the code in pytests. Bonus point is that no warnings are now generated.