ec1f89217a
Full Mattermost server source with integrated Community Enterprise features. Includes vendor directory for offline/air-gapped builds. Structure: - enterprise-impl/: Enterprise feature implementations - enterprise-community/: Init files that register implementations - enterprise/: Bridge imports (community_imports.go) - vendor/: All dependencies for offline builds Build (online): go build ./cmd/mattermost Build (offline/air-gapped): go build -mod=vendor ./cmd/mattermost 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
86 lines
2.2 KiB
Markdown
86 lines
2.2 KiB
Markdown
# clockwork
|
|
|
|
[](https://github.com/avelino/awesome-go#utilities)
|
|
|
|
[](https://github.com/jonboulle/clockwork/actions?query=workflow%3ACI)
|
|
[](https://goreportcard.com/report/github.com/jonboulle/clockwork)
|
|
|
|
[](https://pkg.go.dev/mod/github.com/jonboulle/clockwork)
|
|
|
|
**A simple fake clock for Go.**
|
|
|
|
|
|
## Usage
|
|
|
|
Replace uses of the `time` package with the `clockwork.Clock` interface instead.
|
|
|
|
For example, instead of using `time.Sleep` directly:
|
|
|
|
```go
|
|
func myFunc() {
|
|
time.Sleep(3 * time.Second)
|
|
doSomething()
|
|
}
|
|
```
|
|
|
|
Inject a clock and use its `Sleep` method instead:
|
|
|
|
```go
|
|
func myFunc(clock clockwork.Clock) {
|
|
clock.Sleep(3 * time.Second)
|
|
doSomething()
|
|
}
|
|
```
|
|
|
|
Now you can easily test `myFunc` with a `FakeClock`:
|
|
|
|
```go
|
|
func TestMyFunc(t *testing.T) {
|
|
ctx := context.Background()
|
|
c := clockwork.NewFakeClock()
|
|
|
|
// Start our sleepy function
|
|
var wg sync.WaitGroup
|
|
wg.Add(1)
|
|
go func() {
|
|
myFunc(c)
|
|
wg.Done()
|
|
}()
|
|
|
|
// Ensure we wait until myFunc is waiting on the clock.
|
|
// Use a context to avoid blocking forever if something
|
|
// goes wrong.
|
|
ctx, cancel := context.WithTimeout(ctx, 10*time.Second)
|
|
defer cancel()
|
|
c.BlockUntilContext(ctx, 1)
|
|
|
|
assertState()
|
|
|
|
// Advance the FakeClock forward in time
|
|
c.Advance(3 * time.Second)
|
|
|
|
// Wait until the function completes
|
|
wg.Wait()
|
|
|
|
assertState()
|
|
}
|
|
```
|
|
|
|
and in production builds, simply inject the real clock instead:
|
|
|
|
```go
|
|
myFunc(clockwork.NewRealClock())
|
|
```
|
|
|
|
See [example_test.go](example_test.go) for a full example.
|
|
|
|
|
|
# Credits
|
|
|
|
clockwork is inspired by @wickman's [threaded fake clock](https://gist.github.com/wickman/3840816), and the [Golang playground](https://blog.golang.org/playground#TOC_3.1.)
|
|
|
|
|
|
## License
|
|
|
|
Apache License, Version 2.0. Please see [License File](LICENSE) for more information.
|