1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
// Copyright 2016 Google LLC. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package clock contains time utilities, and types that allow mocking system
// time in tests.
package clock
import (
"sync"
"time"
"k8s.io/klog/v2"
)
// System is a default TimeSource that provides system time.
var System TimeSource = systemTimeSource{}
// TimeSource can provide the current time, or be replaced by a mock in tests
// to return specific values.
type TimeSource interface {
// Now returns the current time as seen by this TimeSource.
Now() time.Time
// NewTimer creates a timer that fires after the specified duration.
NewTimer(d time.Duration) Timer
}
// SecondsSince returns the time in seconds elapsed since t until now, as
// measured by the TimeSource.
func SecondsSince(ts TimeSource, t time.Time) float64 {
return ts.Now().Sub(t).Seconds()
}
// systemTimeSource provides the current system local time.
type systemTimeSource struct{}
// Now returns the true current local time.
func (s systemTimeSource) Now() time.Time {
return time.Now()
}
// NewTimer returns a real timer.
func (s systemTimeSource) NewTimer(d time.Duration) Timer {
return systemTimer{time.NewTimer(d)}
}
// FakeTimeSource provides time that can be arbitrarily set. For tests only.
type FakeTimeSource struct {
mu sync.RWMutex
now time.Time
timers map[int]*fakeTimer
nextID int
}
// NewFake creates a FakeTimeSource instance.
func NewFake(t time.Time) *FakeTimeSource {
timers := make(map[int]*fakeTimer)
return &FakeTimeSource{now: t, timers: timers}
}
// Now returns the time value this instance contains.
func (f *FakeTimeSource) Now() time.Time {
f.mu.RLock()
defer f.mu.RUnlock()
return f.now
}
// NewTimer returns a fake Timer.
func (f *FakeTimeSource) NewTimer(d time.Duration) Timer {
f.mu.Lock()
defer f.mu.Unlock()
id := f.nextID
f.nextID++
timer := newFakeTimer(f, id, f.now.Add(d))
f.timers[id] = timer
return timer
}
// unsubscribe removes the Timer with the specified ID if it exists, and
// returns the existence bit.
func (f *FakeTimeSource) unsubscribe(id int) bool {
f.mu.Lock()
defer f.mu.Unlock()
_, ok := f.timers[id]
if ok {
delete(f.timers, id)
}
return ok
}
// Set updates the time that this instance will report.
func (f *FakeTimeSource) Set(t time.Time) {
f.mu.Lock()
defer f.mu.Unlock()
f.now = t
for id, timer := range f.timers {
if timer.tryFire(t) {
delete(f.timers, id)
}
}
}
// PredefinedFake is a TimeSource that returns a predefined set of times
// computed as base time + delays[i]. Delays don't have to be monotonic.
type PredefinedFake struct {
Base time.Time
Delays []time.Duration
Next int
}
// Now returns the current time, which depends on how many times this method
// has already been invoked. Must not be called more than len(delays) times.
func (p *PredefinedFake) Now() time.Time {
adjustedTime := p.Base.Add(p.Delays[p.Next])
p.Next++
return adjustedTime
}
// NewTimer creates a timer with the specified delay. Not implemented.
func (p *PredefinedFake) NewTimer(d time.Duration) Timer {
klog.Exitf("PredefinedFake.NewTimer is not implemented")
return nil
}
|