Fix test deadlock and other failures #3751
Merged
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
Building the dialog off the Swing thread gives the potential for deadlocks when we try to pack the dialog.
One of the tests was injecting a dummy implementation, but didn't clean up after itself. This made the order of the tests important. But now we always restore a real implementation after the tests are done, so that tests can now be run in any order and even multiple times.
Since adding and reading namespaces are both asynchronous processes, and sequential calls are not guaranteed to serialize with one another, we had to add `.get()` calls inside `MemoryDataStoreTest.createNamespaceWithInitialData()` so that we could be sure each namespace was created before being accessed.
Phergus
approved these changes
Nov 25, 2022
There was a problem hiding this comment.
Reviewed 4 of 4 files at r1, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @kwvanderlinde)
kwvanderlinde
deleted the
fixup/3750-hanging-tests-and-other-failures
branch
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.
Identify the Bug or Feature request
Fixes (hopefully) #3750
Description of the Change
The
CampaignPropertiesDialogTestis now run on the Swing thread in order to avoid deadlocks that would sometimes occur when running on the main test thread.The
GetInfoFunctionTestis now repeatable and not dependent on the order of the tests. The problem was that one test was injecting a dummySysInfoProviderthat could be consumed by the other test. This is fixed by always restoring theSysInfoProviderimplementation after each test.The
MemoryDataStoreTestwas sensitive to the ordering of its various asynchronous calls. Meanwhile,MemoryDataStoredoes not guarantee the ordering of effects as it runs everything on the common fork-join pool. Sprinkling in some more.get()fixes that.Prior to this change, I could only complete a few test suite runs before encountering a deadlock or other failure. With this change, I have been consistently able to complete thousands of test suite runs, each completing promptly.
Possible Drawbacks
Should be sunshine and rainbows.
Documentation Notes
N/A
Release Notes
N/A
This change is