make time unit test more reliable #3
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
satmihir
approved these changes
Nov 10, 2024
ccoVeille
reviewed
Nov 10, 2024
| @@ -12,11 +12,11 @@ func TestClock(t *testing.T) { | |||
| t1 := time.Now() | |||
| t2 := clk.Now() | |||
|
|
|||
| assert.True(t, t2.After(t1)) | |||
| assert.True(t, t2.Compare(t1) >= 0) | |||
There was a problem hiding this comment.
It's worth trying
Suggested change
| assert.True(t, t2.Compare(t1) >= 0) | |
| assert.GreaterOrEqual(t, t2, t1) |
https://pkg.go.dev/github.com/stretchr/testify/assert#GreaterOrEqualf
As you can see here, testify supports time.Time
https://github.com/stretchr/testify/blob/v1.9.0/assert%2Fassertion_compare.go#L317-L329
The output will be way better in case of error.
You can simulate it by inverting t1 and t2 temporarily and locally
| @@ -12,11 +12,11 @@ func TestClock(t *testing.T) { | |||
| t1 := time.Now() | |||
| t2 := clk.Now() | |||
|
|
|||
| assert.True(t, t2.After(t1)) | |||
| assert.True(t, t2.Compare(t1) >= 0) | |||
There was a problem hiding this comment.
Please note another way to write it could have been simpler
Suggested change
| assert.True(t, t2.Compare(t1) >= 0) | |
| assert.False(t, t2.Before(t1)) |
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.
When running the unit tests on a Windows machine, I see the failure
--- FAIL: TestClock (0.01s)
time_utils_test.go:15:
Error Trace: C:/onebranch/fair/pkg/utils/time_utils_test.go:15
Error: Should be true
Test: TestClock
I believe this is because t1 and t2 happen closer together than the resolution of the clock so they evaluate as the same time, rather than one being later than the other.
This change allows t2 to be equal or greater than t1.
I didn't observe a failure in the second assert, but for consistency it seems reasonable to allow the delta to be exactly 10ms.