Fix intermittent logfile-in-use test failures #8
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
dkbennett
requested review from
guimafelipe,
krschau,
EricJohnson327 and
mathewleeza
dhoehna
reviewed
Nov 10, 2023
dhoehna
approved these changes
Nov 10, 2023
EricJohnson327
approved these changes
Nov 10, 2023
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.
Summary of the pull request
The asynchronous logfile writing in tests can lead to a test finishing before the logfile writer is done writing to the log. Since the test cleanup occurs immediately after the test is done and I/O is naturally much slower (the whole reason it is asynchronous), this can lead to a race where the test is finished but the logfile is not, and attempting to cleanup the folder with the logfile results in an uncaught I/O exception. This fix handles those races by catching the first IOException during test cleanup, waiting several seconds, and then trying again to allow time for the logfile writer to finish.
References and relevant issues
Closes https://github.com/microsoft/DevHomeADOExtension/issues/78
Detailed description of the pull request / Additional comments
Added a catch IOException clause to the Test Cleanup so if we enconter an IOException while cleaning up, wait ten seconds and try again. The retry will not be caught so we can detect real issues that aren't logfile writing races.
Validation steps performed
PR checklist