Deflake serializer tests. #449
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
adk-swisstopo
force-pushed
the
fix-PB-694-flaky-serialization
branch
from
c4e7cd2
to
5359769
Compare
The serializer tests depend on test running "fast enough" for timestamp comparison to work. This is unreliable and causes inconsistent test failure. This change adds a time.sleep(5) right after we record the start time of the test such that timestamp comparison always fails. This ensures the next change that attemps to fix the test actually fixes it correctly. I plan to remove the delay afterwards.
We have no control over the exact value of the "created" and "updated" fields. All we can check is that their value is between test start time and test end time. This change ensures we perform that check instead of a flaky "start time +/- 2 seconds".
This was used to verify test flakiness is fixed. This is now done and there is no point delaying these tests any more.
adk-swisstopo
force-pushed
the
fix-PB-694-flaky-serialization
branch
from
5359769
to
d7f0f3f
Compare
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.
The serializer test involve comparing the "created" and "updated" fields of collections. These fields are populated with whatever Django thinks is the current time. Until this PR, the tests assumed that comparing to "test start time" +/- 2 seconds was good enough. As per PB-694 this has proved wrong several times.
This change updates the tests such that we only verify the field values are between the start time and end time of each test. As long as time goes forward this should be fine. In any case, it should already make the test much more reliable.
We verified this works by adding a 5 seconds delay after the start of the test (which was removed in the second to last change in this PR).