Change tests to use tempfile #338
Open
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
patkenneally
force-pushed
the
fix/change-test-to-use-tempfile
branch
from
2b6fed4
to
a549525
Compare
Twisol
reviewed
Sep 24, 2024
| @@ -60,10 +62,13 @@ def test_ck_read_write(show_plots): | |||
| timeWrite = scObjectLogger.times() | |||
| sigmaWrite = scObjectLogger.sigma_BN | |||
| omegaWrite = scObjectLogger.omega_BN_B | |||
| pyswice_ck_utilities.ckWrite("test.bc", timeWrite, sigmaWrite, omegaWrite, timeInit, spacecraft_id=-202) | |||
|
|
|||
| tempDirectory = tempfile.TemporaryDirectory() | |||
There was a problem hiding this comment.
We should either call .cleanup() on this object at some point, or -- and more preferably -- use it in a with block to ensure proper cleanup automatically.
| shutil.rmtree(dirName) | ||
| assert not os.path.exists(dirName), "No leftover data should exist after the test" | ||
| # shutil.rmtree(dirName) | ||
| tempDirectory.cleanup() |
There was a problem hiding this comment.
It would arguably be better to use a with statement rather than manually calling .cleanup(), especially in case an exception occurs (meaning the directory would not actually get cleaned up promptly).
Of course, if any native C or C++ code causes a SIGSEGV or SIGABRT, cleanup wouldn't happen even in a with block`; but those signals would indicate severe bugs unto themselves!
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.
Description
Tests shouldn't be creating directories in the source tree. Rather we should use managed contexts that manage temporary files and directories.
Verification
CI test run unchanged.
Documentation
NA
Future work
NA