File: ready_test.go

package info (click to toggle)
golang-k8s-apiserver 0.33.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,660 kB
  • sloc: sh: 236; makefile: 5
file content (253 lines) | stat: -rw-r--r-- 7,041 bytes parent folder | download
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
/*
Copyright 2022 The Kubernetes Authors.

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 cacher

import (
	"context"
	"errors"
	"sync"
	"testing"
	"time"

	testingclock "k8s.io/utils/clock/testing"
)

func Test_newReady(t *testing.T) {
	errCh := make(chan error, 10)
	ready := newReady(testingclock.NewFakeClock(time.Now()))
	ready.setError(nil)
	// create 10 goroutines waiting for ready
	for i := 0; i < 10; i++ {
		go func() {
			errCh <- ready.wait(context.Background())
		}()
	}
	select {
	case <-time.After(1 * time.Second):
	case <-errCh:
		t.Errorf("ready should be blocking")
	}
	ready.setReady()
	for i := 0; i < 10; i++ {
		if err := <-errCh; err != nil {
			t.Errorf("unexpected error on channel %d", i)
		}
	}
}

func Test_newReadySetIdempotent(t *testing.T) {
	errCh := make(chan error, 10)
	ready := newReady(testingclock.NewFakeClock(time.Now()))
	ready.setError(nil)
	ready.setError(nil)
	ready.setError(nil)
	if generation, _, err := ready.checkAndReadGeneration(); generation != 0 || err == nil {
		t.Errorf("unexpected state: generation=%v ready=%v", generation, err)
	}
	ready.setReady()
	if generation, _, err := ready.checkAndReadGeneration(); generation != 1 || err != nil {
		t.Errorf("unexpected state: generation=%v ready=%v", generation, err)
	}
	ready.setReady()
	ready.setReady()
	if generation, _, err := ready.checkAndReadGeneration(); generation != 1 || err != nil {
		t.Errorf("unexpected state: generation=%v ready=%v", generation, err)
	}
	ready.setError(nil)
	// create 10 goroutines waiting for ready and stop
	for i := 0; i < 10; i++ {
		go func() {
			errCh <- ready.wait(context.Background())
		}()
	}
	select {
	case <-time.After(1 * time.Second):
	case <-errCh:
		t.Errorf("ready should be blocking")
	}
	ready.setReady()
	if generation, _, err := ready.checkAndReadGeneration(); generation != 2 || err != nil {
		t.Errorf("unexpected state: generation=%v ready=%v", generation, err)
	}
	for i := 0; i < 10; i++ {
		if err := <-errCh; err != nil {
			t.Errorf("unexpected error on channel %d", i)
		}
	}
}

// Test_newReadyRacy executes all the possible transitions randomly.
// It must run with the race detector enabled.
func Test_newReadyRacy(t *testing.T) {
	concurrency := 1000
	errCh := make(chan error, concurrency)
	ready := newReady(testingclock.NewFakeClock(time.Now()))
	ready.setError(nil)

	wg := sync.WaitGroup{}
	wg.Add(2 * concurrency)
	for i := 0; i < concurrency; i++ {
		go func() {
			errCh <- ready.wait(context.Background())
		}()
		go func() {
			defer wg.Done()
			ready.setError(nil)
		}()
		go func() {
			defer wg.Done()
			ready.setReady()
		}()
	}
	// Last one has to be set to true.
	wg.Wait()
	ready.setReady()

	for i := 0; i < concurrency; i++ {
		if err := <-errCh; err != nil {
			t.Errorf("unexpected error %v on channel %d", err, i)
		}
	}
}

func Test_newReadyStop(t *testing.T) {
	errCh := make(chan error, 10)
	ready := newReady(testingclock.NewFakeClock(time.Now()))
	ready.setError(nil)
	// create 10 goroutines waiting for ready and stop
	for i := 0; i < 10; i++ {
		go func() {
			errCh <- ready.wait(context.Background())
		}()
	}
	select {
	case <-time.After(1 * time.Second):
	case <-errCh:
		t.Errorf("ready should be blocking")
	}
	ready.stop()
	for i := 0; i < 10; i++ {
		if err := <-errCh; err == nil {
			t.Errorf("unexpected success on channel %d", i)
		}
	}
}

func Test_newReadyCheck(t *testing.T) {
	ready := newReady(testingclock.NewFakeClock(time.Now()))
	// it starts as false
	if _, err := ready.check(); err == nil {
		t.Errorf("unexpected ready state %v", err)
	}
	ready.setReady()
	if _, err := ready.check(); err != nil {
		t.Errorf("unexpected ready state %v", err)
	}
	// stop sets ready to false
	ready.stop()
	if _, err := ready.check(); err == nil {
		t.Errorf("unexpected ready state %v", err)
	}
	// can not set to true if is stopped
	ready.setReady()
	if _, err := ready.check(); err == nil {
		t.Errorf("unexpected ready state %v", err)
	}
	err := ready.wait(context.Background())
	if err == nil {
		t.Errorf("expected error waiting on a stopped state")
	}
}

func Test_newReadyCancelPending(t *testing.T) {
	errCh := make(chan error, 10)
	ready := newReady(testingclock.NewFakeClock(time.Now()))
	ready.setError(nil)
	ctx, cancel := context.WithCancel(context.Background())
	// create 10 goroutines stuck on pending
	for i := 0; i < 10; i++ {
		go func() {
			errCh <- ready.wait(ctx)
		}()
	}
	select {
	case <-time.After(1 * time.Second):
	case <-errCh:
		t.Errorf("ready should be blocking")
	}
	cancel()
	for i := 0; i < 10; i++ {
		if err := <-errCh; err == nil {
			t.Errorf("unexpected success on channel %d", i)
		}
	}
}

func Test_newReadyStateChangeTimestamp(t *testing.T) {
	fakeClock := testingclock.NewFakeClock(time.Now())
	fakeClock.SetTime(time.Now())

	ready := newReady(fakeClock)
	fakeClock.Step(time.Minute)
	checkReadyTransitionTime(t, ready, time.Minute)

	ready.setReady()
	fakeClock.Step(time.Minute)
	checkReadyTransitionTime(t, ready, time.Minute)
	fakeClock.Step(time.Minute)
	checkReadyTransitionTime(t, ready, 2*time.Minute)

	ready.setError(nil)
	fakeClock.Step(time.Minute)
	checkReadyTransitionTime(t, ready, time.Minute)
	fakeClock.Step(time.Minute)
	checkReadyTransitionTime(t, ready, 2*time.Minute)

	ready.setReady()
	fakeClock.Step(time.Minute)
	checkReadyTransitionTime(t, ready, time.Minute)

	ready.stop()
	fakeClock.Step(time.Minute)
	checkReadyTransitionTime(t, ready, time.Minute)
	fakeClock.Step(time.Minute)
	checkReadyTransitionTime(t, ready, 2*time.Minute)
}

func checkReadyTransitionTime(t *testing.T, r *ready, expectedLastStateChangeDuration time.Duration) {
	if lastStateChangeDuration, _ := r.check(); lastStateChangeDuration != expectedLastStateChangeDuration {
		t.Errorf("unexpected last state change duration: %v, expected: %v", lastStateChangeDuration, expectedLastStateChangeDuration)
	}
}

func TestReadyError(t *testing.T) {
	ready := newReady(testingclock.NewFakeClock(time.Now()))
	_, _, err := ready.checkAndReadGeneration()
	if err == nil || err.Error() != "storage is (re)initializing" {
		t.Errorf("Unexpected error when unready, got %q", err)
	}
	ready.setError(errors.New("etcd is down"))
	_, _, err = ready.checkAndReadGeneration()
	if err == nil || err.Error() != "storage is (re)initializing: etcd is down" {
		t.Errorf("Unexpected error when unready, got %q", err)
	}
	ready.setError(nil)
	_, _, err = ready.checkAndReadGeneration()
	if err == nil || err.Error() != "storage is (re)initializing" {
		t.Errorf("Unexpected error when unready, got %q", err)
	}
}