gh-61215: threadingmock: Improve test suite to avoid race conditions #106822
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
Simplify tests and split them into multiple tests to prevent assertions from triggering race conditions. Additionally, we rely on calling the mocks without delay to validate the functionality of matching calls.
cjw296
approved these changes
Jul 17, 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.
Simplify tests and split them into multiple tests to prevent assertions from triggering race conditions.
Additionally, we rely on calling the mocks without delay to validate the functionality of matching calls.
The test suite had a lot of duplicated validation and tests that valdated multiple potentially racing calls that made it flaky.
The test suite has been changed to use single very short timeout that we wait on, so the only race that can happen is for the method to be called before we call "wait_until_X". Should that happen the test suite succeeds any way (as expected).
The change also runs the suite significantly faster (40% in my laptop).
@cjw296 let me know if you think I'm missing anything from testing but I think this does covers the whole functionality.