-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
sqlwatcher_test.go
443 lines (389 loc) · 12.6 KB
/
sqlwatcher_test.go
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
// Copyright 2021 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
package spanconfigsqlwatcher_test
import (
"context"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/cockroachdb/cockroach/pkg/base"
"github.com/cockroachdb/cockroach/pkg/jobs"
"github.com/cockroachdb/cockroach/pkg/keys"
"github.com/cockroachdb/cockroach/pkg/kv/kvclient/rangefeed"
"github.com/cockroachdb/cockroach/pkg/spanconfig"
"github.com/cockroachdb/cockroach/pkg/spanconfig/spanconfigsqlwatcher"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
"github.com/cockroachdb/cockroach/pkg/testutils"
"github.com/cockroachdb/cockroach/pkg/testutils/sqlutils"
"github.com/cockroachdb/cockroach/pkg/testutils/testcluster"
"github.com/cockroachdb/cockroach/pkg/util/hlc"
"github.com/cockroachdb/cockroach/pkg/util/leaktest"
"github.com/cockroachdb/cockroach/pkg/util/syncutil"
"github.com/cockroachdb/errors"
"github.com/stretchr/testify/require"
)
// TestSQLWatcherReactsToUpdates verifies that the SQLWatcher emits the correct
// updates following changes made to system.descriptor or system.zones. It also
// ensures that the timestamp supplied to the handler function is monotonically
// increasing.
func TestSQLWatcherReactsToUpdates(t *testing.T) {
defer leaktest.AfterTest(t)()
testCases := []struct {
stmt string
expectedIDs descpb.IDs
}{
{
stmt: "CREATE TABLE t()",
expectedIDs: descpb.IDs{52},
},
{
stmt: "CREATE TABLE t2(); ALTER TABLE t2 CONFIGURE ZONE USING num_replicas = 3",
expectedIDs: descpb.IDs{53},
},
{
stmt: "CREATE DATABASE d; CREATE TABLE d.t1(); CREATE TABLE d.t2()",
expectedIDs: descpb.IDs{54, 55, 56},
},
{
stmt: "ALTER DATABASE d CONFIGURE ZONE USING num_replicas=5",
expectedIDs: descpb.IDs{54},
},
{
stmt: "CREATE TABLE t3(); CREATE TABLE t4()",
expectedIDs: descpb.IDs{57, 58},
},
{
stmt: "ALTER TABLE t3 CONFIGURE ZONE USING num_replicas=5; CREATE TABLE t5(); DROP TABLE t4;",
expectedIDs: descpb.IDs{57, 58, 59},
},
// Named zone tests.
{
stmt: "ALTER RANGE DEFAULT CONFIGURE ZONE USING num_replicas = 7",
expectedIDs: descpb.IDs{keys.RootNamespaceID},
},
{
stmt: "ALTER RANGE liveness CONFIGURE ZONE USING num_replicas = 7",
expectedIDs: descpb.IDs{keys.LivenessRangesID},
},
{
stmt: "ALTER RANGE meta CONFIGURE ZONE USING num_replicas = 7",
expectedIDs: descpb.IDs{keys.MetaRangesID},
},
{
stmt: "ALTER RANGE system CONFIGURE ZONE USING num_replicas = 7",
expectedIDs: descpb.IDs{keys.SystemRangesID},
},
{
stmt: "ALTER RANGE timeseries CONFIGURE ZONE USING num_replicas = 7",
expectedIDs: descpb.IDs{keys.TimeseriesRangesID},
},
// Test that events on types/schemas are also captured.
{
stmt: "CREATE DATABASE db; CREATE SCHEMA db.sc",
// One ID each for the parent database and the schema.
expectedIDs: descpb.IDs{60, 61},
},
{
stmt: "CREATE TYPE typ AS ENUM()",
// One ID each for the enum and the array type.
expectedIDs: descpb.IDs{62, 63},
},
}
tc := testcluster.StartTestCluster(t, 1, base.TestClusterArgs{
ServerArgs: base.TestServerArgs{
Knobs: base.TestingKnobs{
SpanConfig: &spanconfig.TestingKnobs{
ManagerDisableJobCreation: true, // disable the automatic job creation.
},
JobsTestingKnobs: jobs.NewTestingKnobsWithShortIntervals(), // speed up schema changes.
},
},
})
defer tc.Stopper().Stop(context.Background())
ts := tc.Server(0 /* idx */)
tdb := sqlutils.MakeSQLRunner(tc.ServerConn(0 /* idx */))
tdb.Exec(t, `SET CLUSTER SETTING kv.rangefeed.enabled = true`)
tdb.Exec(t, `SET CLUSTER SETTING kv.closed_timestamp.target_duration = '100ms'`)
sqlWatcher := spanconfigsqlwatcher.New(
keys.SystemSQLCodec,
ts.ClusterSettings(),
ts.RangeFeedFactory().(*rangefeed.Factory),
1<<20, /* 1 MB, bufferMemLimit */
ts.Stopper(),
nil, /* knobs */
)
var mu struct {
syncutil.Mutex
receivedIDs map[descpb.ID]struct{}
lastCheckpoint hlc.Timestamp
}
mu.receivedIDs = make(map[descpb.ID]struct{})
var wg sync.WaitGroup
watcherCtx, watcherCancel := context.WithCancel(context.Background())
wg.Add(1)
go func() {
defer wg.Done()
startTS := ts.Clock().Now()
mu.Lock()
mu.lastCheckpoint = startTS
mu.Unlock()
_ = sqlWatcher.WatchForSQLUpdates(watcherCtx, startTS,
func(ctx context.Context, updates []spanconfig.DescriptorUpdate, checkpointTS hlc.Timestamp) error {
mu.Lock()
defer mu.Unlock()
require.True(t, mu.lastCheckpoint.Less(checkpointTS))
mu.lastCheckpoint = checkpointTS
for _, update := range updates {
mu.receivedIDs[update.ID] = struct{}{}
}
return nil
})
}()
for _, tc := range testCases {
tdb.Exec(t, tc.stmt)
afterStmtTS := ts.Clock().Now()
testutils.SucceedsSoon(t, func() error {
mu.Lock()
defer mu.Unlock()
if mu.lastCheckpoint.Less(afterStmtTS) {
return errors.New("checkpoint precedes statement timestamp")
}
return nil
})
// Rangefeed events aren't guaranteed to be in any particular order for
// different keys.
mu.Lock()
require.Equal(t, len(tc.expectedIDs), len(mu.receivedIDs))
for _, id := range tc.expectedIDs {
_, seen := mu.receivedIDs[id]
require.True(t, seen)
delete(mu.receivedIDs, id)
}
mu.Unlock()
}
// Stop the watcher and wait for the goroutine to complete.
watcherCancel()
wg.Wait()
}
// TestSQLWatcherMultiple tests that we're able to fire off multiple sql watcher
// processes, both sequentially and concurrently.
func TestSQLWatcherMultiple(t *testing.T) {
defer leaktest.AfterTest(t)()
tc := testcluster.StartTestCluster(t, 1, base.TestClusterArgs{
ServerArgs: base.TestServerArgs{
Knobs: base.TestingKnobs{
SpanConfig: &spanconfig.TestingKnobs{
ManagerDisableJobCreation: true, // disable the automatic job creation.
},
JobsTestingKnobs: jobs.NewTestingKnobsWithShortIntervals(), // speed up schema changes.
},
},
})
ctx := context.Background()
defer tc.Stopper().Stop(ctx)
ts := tc.Server(0 /* idx */)
tdb := sqlutils.MakeSQLRunner(tc.ServerConn(0 /* idx */))
tdb.Exec(t, `SET CLUSTER SETTING kv.rangefeed.enabled = true`)
tdb.Exec(t, `SET CLUSTER SETTING kv.closed_timestamp.target_duration = '100ms'`)
sqlWatcher := spanconfigsqlwatcher.New(
keys.SystemSQLCodec,
ts.ClusterSettings(),
ts.RangeFeedFactory().(*rangefeed.Factory),
1<<20, /* 1 MB, bufferMemLimit */
ts.Stopper(),
nil, /* knobs */
)
beforeStmtTS := ts.Clock().Now()
tdb.Exec(t, "CREATE TABLE t()")
afterStmtTS := ts.Clock().Now()
const expDescID descpb.ID = 52
var wg sync.WaitGroup
mu := struct {
syncutil.Mutex
w1LastCheckpoint, w2LastCheckpoint, w3LastCheckpoint hlc.Timestamp
}{}
f := func(ctx context.Context, onExit func(), onCheckpoint func(hlc.Timestamp)) {
defer wg.Done()
receivedIDs := make(map[descpb.ID]struct{})
err := sqlWatcher.WatchForSQLUpdates(ctx, beforeStmtTS,
func(_ context.Context, updates []spanconfig.DescriptorUpdate, checkpointTS hlc.Timestamp) error {
onCheckpoint(checkpointTS)
for _, update := range updates {
receivedIDs[update.ID] = struct{}{}
}
return nil
})
require.True(t, testutils.IsError(err, "context canceled"))
require.Equal(t, 1, len(receivedIDs))
_, seen := receivedIDs[expDescID]
require.True(t, seen)
}
{
// Run the first watcher; wait for it to observe the update before
// tearing it down.
watcher1Ctx, watcher1Cancel := context.WithCancel(ctx)
wg.Add(1)
go f(watcher1Ctx, func() { wg.Done() }, func(ts hlc.Timestamp) {
mu.Lock()
mu.w1LastCheckpoint = ts
mu.Unlock()
})
testutils.SucceedsSoon(t, func() error {
mu.Lock()
defer mu.Unlock()
if mu.w1LastCheckpoint.Less(afterStmtTS) {
return errors.New("w1 checkpoint precedes statement timestamp")
}
return nil
})
watcher1Cancel()
wg.Wait()
}
{
// Run two more watchers; wait for each to independently observe the
// update before tearing them down.
watcher2Ctx, watcher2Cancel := context.WithCancel(ctx)
wg.Add(1)
go f(watcher2Ctx, func() { wg.Done() }, func(ts hlc.Timestamp) {
mu.Lock()
mu.w2LastCheckpoint = ts
mu.Unlock()
})
watcher3Ctx, watcher3Cancel := context.WithCancel(ctx)
wg.Add(1)
go f(watcher3Ctx, func() { wg.Done() }, func(ts hlc.Timestamp) {
mu.Lock()
mu.w3LastCheckpoint = ts
mu.Unlock()
})
testutils.SucceedsSoon(t, func() error {
mu.Lock()
defer mu.Unlock()
if mu.w2LastCheckpoint.Less(afterStmtTS) {
return errors.New("w2 checkpoint precedes statement timestamp")
}
if mu.w3LastCheckpoint.Less(afterStmtTS) {
return errors.New("w3 checkpoint precedes statement timestamp")
}
return nil
})
watcher2Cancel()
watcher3Cancel()
}
wg.Wait()
}
// TestSQLWatcherOnEventError ensures that if there is an error processing a
// rangefeed event the handler is never run and the error is bubbled back to
// the caller.
func TestSQLWatcherOnEventError(t *testing.T) {
defer leaktest.AfterTest(t)()
tc := testcluster.StartTestCluster(t, 1, base.TestClusterArgs{
ServerArgs: base.TestServerArgs{
Knobs: base.TestingKnobs{
SpanConfig: &spanconfig.TestingKnobs{
ManagerDisableJobCreation: true, // disable the automatic job creation.
},
JobsTestingKnobs: jobs.NewTestingKnobsWithShortIntervals(), // speed up schema changes.
},
},
})
ctx := context.Background()
defer tc.Stopper().Stop(ctx)
ts := tc.Server(0 /* idx */)
tdb := sqlutils.MakeSQLRunner(tc.ServerConn(0 /* idx */))
tdb.Exec(t, `SET CLUSTER SETTING kv.rangefeed.enabled = true`)
tdb.Exec(t, `SET CLUSTER SETTING kv.closed_timestamp.target_duration = '100ms'`)
sqlWatcher := spanconfigsqlwatcher.New(
keys.SystemSQLCodec,
ts.ClusterSettings(),
ts.RangeFeedFactory().(*rangefeed.Factory),
1<<20, /* 1 MB, bufferMemLimit */
ts.Stopper(),
&spanconfig.TestingKnobs{
SQLWatcherOnEventInterceptor: func() error {
return errors.New("boom")
},
},
)
startTS := ts.Clock().Now()
tdb.Exec(t, "CREATE TABLE t()")
err := sqlWatcher.WatchForSQLUpdates(ctx, startTS, func(context.Context, []spanconfig.DescriptorUpdate, hlc.Timestamp) error {
t.Fatal("handler should never run")
return nil
})
require.Error(t, err)
require.True(t, testutils.IsError(err, "boom"))
}
// TestSQLWatcherHandlerError ensures that no further calls are made to the
// handler after it returns an error.
func TestSQLWatcherHandlerError(t *testing.T) {
defer leaktest.AfterTest(t)()
tc := testcluster.StartTestCluster(t, 1, base.TestClusterArgs{
ServerArgs: base.TestServerArgs{
Knobs: base.TestingKnobs{
SpanConfig: &spanconfig.TestingKnobs{
ManagerDisableJobCreation: true, // disable the automatic job creation.
},
JobsTestingKnobs: jobs.NewTestingKnobsWithShortIntervals(), // speed up schema changes.
},
},
})
ctx := context.Background()
defer tc.Stopper().Stop(ctx)
ts := tc.Server(0 /* idx */)
tdb := sqlutils.MakeSQLRunner(tc.ServerConn(0 /* idx */))
tdb.Exec(t, `SET CLUSTER SETTING kv.rangefeed.enabled = true`)
tdb.Exec(t, `SET CLUSTER SETTING kv.closed_timestamp.target_duration = '100ms'`)
sqlWatcher := spanconfigsqlwatcher.New(
keys.SystemSQLCodec,
ts.ClusterSettings(),
ts.RangeFeedFactory().(*rangefeed.Factory),
1<<20, /* 1 MB, bufferMemLimit */
ts.Stopper(),
nil, /* knobs */
)
tdb.Exec(t, "CREATE TABLE t()")
stopTraffic := make(chan struct{})
startTS := ts.Clock().Now()
var wg sync.WaitGroup
wg.Add(1)
// Start a background thread that modifies zone configs on a table to trigger
// events on system.zones.
go func() {
defer wg.Done()
for {
select {
case <-stopTraffic:
return
default:
time.Sleep(100 * time.Millisecond)
}
tdb.Exec(t, "ALTER TABLE t CONFIGURE ZONE USING num_replicas=5")
}
}()
var numCalled int32
// Wrap the call to WatchForSQLUpdates in a SucceedsSoon to ensure it
// evaluates within 45 seconds.
testutils.SucceedsSoon(t, func() error {
err := sqlWatcher.WatchForSQLUpdates(ctx, startTS, func(context.Context, []spanconfig.DescriptorUpdate, hlc.Timestamp) error {
atomic.AddInt32(&numCalled, 1)
return errors.New("handler error")
})
require.Error(t, err)
require.True(t, testutils.IsError(err, "handler error"))
return nil
})
// Shutdown the background goroutine.
close(stopTraffic)
wg.Wait()
// Ensure that the handler was called only once.
require.Equal(t, int32(1), atomic.LoadInt32(&numCalled))
}