[Backport] [1.x] Use try-with-resources with MockLogAppender (#1595)#1784
Merged
adnapibar merged 1 commit intoDec 22, 2021
Merged
Conversation
I previously added a helper that started a MockLogAppender to ensure it was never added to a Logger before it was started. I subsequently found the opposite case in RolloverIT.java where the appender was stopped before it was closed, therefore creating a race where a concurrently running test in the same JVM could cause a logging failure. This seems like a really easy mistake to make when writing a test or introduce when refactoring a test. I've made a change to use try-with-resources to ensure that proper setup and teardown is done. This should make it much harder to introduce this particular test bug in the future. Unfortunately, it did involve touching a lot of files. The changes here are purely structural to leverage try-with-resources; no testing logic has been changed. Signed-off-by: Andrew Ross <andrross@amazon.com>
Collaborator
|
Can one of the admins verify this patch? |
Member
Author
|
start gradle check |
adnapibar
approved these changes
Dec 22, 2021
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I previously added a helper that started a MockLogAppender to ensure it
was never added to a Logger before it was started. I subsequently found
the opposite case in RolloverIT.java where the appender was stopped
before it was closed, therefore creating a race where a concurrently
running test in the same JVM could cause a logging failure. This seems
like a really easy mistake to make when writing a test or introduce when
refactoring a test. I've made a change to use try-with-resources to
ensure that proper setup and teardown is done. This should make it much
harder to introduce this particular test bug in the future.
Unfortunately, it did involve touching a lot of files. The changes here
are purely structural to leverage try-with-resources; no testing logic
has been changed.
Signed-off-by: Andrew Ross andrross@amazon.com
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.