Store test-suite temporary files in temporary directories #422
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
When writing files as part of test cases, write them to a temporary directory (created in setUpClass and destroyed in tearDownClass) rather than writing them to the current working directory. This allows running tests without modifying the working tree, which means multiple test processes can run simultaneously from the same working tree (e.g., using pytest-xdist).
|
Looks great. tempfile is new to me. Good to know! |
tompollard
approved these changes
Sep 20, 2022
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.
When writing files as part of test cases, write them to a temporary
directory (created in setUpClass and destroyed in tearDownClass)
rather than writing them to the current working directory.
This allows running tests without modifying the working tree. It
enables running tests in parallel using
pytest-xdist, which allowsrunning the whole test suite in around 12 seconds rather than 35
seconds.
It's also just cleaner not to dump a lot of temporary files in the
working tree.
It does feel weird to be creating and deleting temporary directories
in class methods, but it seems to work. (The alternative, using
setUp and tearDown, would mean creating a new directory for each
individual test function.)