Fix flaky Observer tests using fake clock #3318
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
…into william/fix_observer_test
Mr-Anyone
approved these changes
Oct 12, 2024
Lmh-java
pushed a commit
to Lmh-java/Software
that referenced
this pull request
Oct 25, 2024
* Fix observer test flakiness using FakeClock * Add FakeClock unit tests * Run formatting * Use using instead of typedef * [pre-commit.ci lite] apply automatic fixes --------- Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
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
The tests in
observer_test.cppthat call helper functiontestGetDataReceivedPerSecondByFillingBufferare flaky in CI because they rely on the passage of actual time.This PR adds a
FakeClockthat simulates the passage of time and can be substituted for anystd::chronoclock. The time point ofFakeClockis fixed and can be explicitly advanced forward withFakeClock::advance.Observernow has a template arg that specifies the clock to use (default isstd::chrono::steady_clock) which enables usage ofFakeClockinobserver_test.cpp.Testing Done
observer_test.cpppassesfake_clock_test.cppResolved Issues
Resolves #3309
Length Justification and Key Files to Review
Review Checklist
It is the reviewers responsibility to also make sure every item here has been covered
.hfile) should have a javadoc style comment at the start of them. For examples, see the functions defined inthunderbots/software/geom. Similarly, all classes should have an associated Javadoc comment explaining the purpose of the class.TODO(or similar) statements should either be completed or associated with a github issue