-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move controlledClock to ztest.MockClock
We need to be able to use the controlled clock for some other tests so move it from clock_test to the ztest package and rename it to MockClock. To keep the interface for the MockClock clear, don't embed the benbjohnson/clock and instead, use it as an attribute.
- Loading branch information
Showing
5 changed files
with
92 additions
and
45 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
// Copyright (c) 2021 Uber Technologies, Inc. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a copy | ||
// of this software and associated documentation files (the "Software"), to deal | ||
// in the Software without restriction, including without limitation the rights | ||
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
// copies of the Software, and to permit persons to whom the Software is | ||
// furnished to do so, subject to the following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included in | ||
// all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
// THE SOFTWARE. | ||
|
||
package ztest | ||
|
||
import ( | ||
"time" | ||
|
||
"github.com/benbjohnson/clock" | ||
) | ||
|
||
// MockClock provides control over the time. | ||
type MockClock struct{ m *clock.Mock } | ||
|
||
// MockClock builds a new mock clock that provides control of time. | ||
func NewMockClock() *MockClock { | ||
return &MockClock{clock.NewMock()} | ||
} | ||
|
||
// Now reports the current time. | ||
func (c *MockClock) Now() time.Time { | ||
return c.m.Now() | ||
} | ||
|
||
// NewTicker returns a time.Ticker that ticks at the specified frequency. | ||
func (c *MockClock) NewTicker(d time.Duration) *time.Ticker { | ||
return &time.Ticker{C: c.m.Ticker(d).C} | ||
} | ||
|
||
// Add progresses time by the given duration. | ||
func (c *MockClock) Add(d time.Duration) { | ||
c.m.Add(d) | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
package ztest | ||
|
||
import ( | ||
"testing" | ||
"time" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"go.uber.org/atomic" | ||
) | ||
|
||
func TestMockClock_NewTicker(t *testing.T) { | ||
var n atomic.Int32 | ||
clock := NewMockClock() | ||
|
||
done := make(chan struct{}) | ||
defer func() { <-done }() // wait for end | ||
|
||
quit := make(chan struct{}) | ||
// Create a channel to increment every microsecond. | ||
go func(ticker *time.Ticker) { | ||
defer close(done) | ||
for { | ||
select { | ||
case <-quit: | ||
ticker.Stop() | ||
return | ||
case <-ticker.C: | ||
n.Inc() | ||
} | ||
} | ||
}(clock.NewTicker(time.Microsecond)) | ||
|
||
// Move clock forward. | ||
clock.Add(2 * time.Microsecond) | ||
assert.Equal(t, int32(2), n.Load()) | ||
close(quit) | ||
} |
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
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
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