-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Resolve flaky timeouts in unit tests #136
Merged
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
CBielstein
changed the title
Switch to using xUnit timeout for tests
Resolve flaky timeouts in unit tests
Jun 17, 2022
Closed
3 tasks
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.
Description
Currently, we execute tests in parallel using our own wall-clock test timeout check to guard against infinite-running tests. However, the parallelism and incomplete test isolation makes the tests impossible to time accurately, resulting in intermittent transient failures.
Specifically, we were facing the following challenges:
AprsIsClient
disposal lead to further interactions between tests regressing individual test performances.The third item in that list was an issue in the interplay between
AprsIsClient
disposal and mocking.AprsIsClient.Dispose()
relied on disposing the underlyingTcpConnection
object. In production, a disposed object would result inTcpConnection.Connected
returning false and terminating the worker task. However, in unit tests, the mockedTcpConnection
would return true when querying connected no matter what else happened, resulting in the worker task never terminating. As tests accumulated, background tasks would start to add up and cause timeouts.To address these issues, the following changes were made:
TaskCompletionSource
instead of synchronous pollingDisconnect()
fromDispose()
inAprsIsClient
This resolves #125.
Changes
WaitForCondition
method and switch to using xUnit timeout settingawait
on aTaskCompletionSource
instead of polling a specific lambda to know when the test can continueAprsIsClient.Disconnect()
as part ofAprsIsClient.Dispose()
to ensure background task terminatesThread.Yield()
code inAprsIsClient
receive task as the stream read call at the top of the loop is blocking, soThread.Yield()
should never be needed.Validation