Add a watcher (JUnit 3) test rule (JUnit 4) for hanging test logging #774
Conversation
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
HeikoKlare
force-pushed
the
hanging-test-logging
branch
from
95fc091 to
eb4e669
Compare
Test Results 534 files ±0 534 suites ±0 1h 11m 13s ⏱️ + 8m 5s For more details on these failures, see this check. Results for commit 1dd26d0. ± Comparison against base commit d0ec0a8. ♻️ This comment has been updated with latest results. |
HeikoKlare
force-pushed
the
hanging-test-logging
branch
5 times, most recently
from
112221b to
b92016e
Compare
Tests may be (and actually are every now and then) hanging for different reasons, such as livelocks or deadlocks. A hanging test does not log anything on its own anymore, which makes it difficult to identify a hanging test and the reasons for that. To this end, it would be useful to have an additional entity that logs the state of all threads, i.e., a thread dump, when a test takes longer than a defined threshold. Since several tests need to run in the UI thread, the JUnit Timeout rule cannot be used, as it executes a test in a different thread that can even be terminated preemptively after a timeout. Instead, this change introduces a HangingTestRule that spawns a watcher thread that writes a thread dump whenever a test (that is run in the UI thread) takes more time than a defined timeout. In total, this change does the following: - Makes the thread dump logic currently placed in TestBarrier2 reusable in a central TestUtil - Adds a HangingTestWatcher that writes a thread dump if not stopped after a given timeout (compatible with JUnit 3) - Adds a HangingTestRule that wraps the HangingTestWatcher into a JUnit 4 rule - Adds the HangingTestRule to the ResourceTest class to apply the logging to all subclasses that are executed with JUnit 4
HeikoKlare
force-pushed
the
hanging-test-logging
branch
from
b92016e to
1dd26d0
Compare
|
What is the status of this one? |
|
This implementation was made for JUnit 3/4 and we have migrated most tests to JUnit 5 by now. So I would need to adapt the PR to enable the functionality as a JUnit 5 extension. |
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.
Tests may be (and actually are every now and then) hanging for different reasons, such as livelocks or deadlocks. A hanging test does not log anything on its own anymore, which makes it difficult to identify a hanging test and the reasons for that. To this end, it would be useful to have an additional entity that logs the state of all threads, i.e., a thread dump, when a test takes longer than a defined threshold.
Since several tests need to run in the UI thread, the JUnit Timeout rule cannot be used, as it executes a test in a different thread that can even be terminated preemptively after a timeout. Instead, this change introduces a
HangingTestRulethat spawns a watcher thread that writes a thread dump whenever a test (that is run in the UI thread) takes more time than a defined timeout.In total, this change does the following:
TestBarrier2reusable in a centralTestUtilHangingTestWatcherthat writes a thread dump if not stopped after a given timeout (compatible with JUnit 3)HangingTestRulethat wraps theHangingTestWatcherinto a JUnit 4 ruleHangingTestWatcherto the JUnit 3CoreTestclass to apply the logging to all subclasses ofCoreTestAlso see eclipse-platform/eclipse.platform.ui#1229, which discusses some additional logging in Platform UI to help debugging hanging tests. That may be replaced by the proposed watcher/rule.