Add a Clock interface for testing #18
Conversation
This adds an interface that is used internally to allow a caller to intercept calls to time.Now() and time.Sleep(), and do better testing.
There was a problem hiding this comment.
Ideally we'd have the NewBucket function take a config struct, but we probably don't want to change the signature of that right now.
I would so write this package differently, but given what we have, and given minimal changes to the existing public functions, I think this is fine.
| @@ -33,12 +34,37 @@ type Bucket struct { | |||
| availTick int64 | |||
| } | |||
|
|
|||
| // Clock is used to inject testable fakes. | |||
| type Clock interface { | |||
There was a problem hiding this comment.
Hmm... this is the first time that I have looked at this code in detail.
The Clock interface that Juju uses elsewhere is a subset of this one:
https://github.com/juju/utils/blob/master/clock/clock.go
So, instead of Sleep, we generally use After. Mostly because we have selects with cancellation channels.
|
|
|
@howbazaar - when can we expect this PR to be merged? |
|
@axw - thanks a lot for very quick response. And I definitely wouldn't consider "24 hours" as a delay :) |
This adds an interface that is used internally to allow a caller to
intercept calls to time.Now() and time.Sleep(), and do better testing.
Fixes #17
@howbazaar this is about as simple as it gets. Unfortunately the factory functions are a bit tedious. Could be changed to "WithDeps" (or something like that) and have a Deps struct, but for now that is going to hold exactly 1 field. This code is simple enough that it probably won't accumulate more. Your call.