-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
mem_test.go
477 lines (410 loc) · 12.5 KB
/
mem_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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
// Copyright 2016 Prometheus Team
// 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 mem
import (
"context"
"fmt"
"reflect"
"strconv"
"sync"
"testing"
"time"
"github.com/go-kit/log"
"github.com/kylelemons/godebug/pretty"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/common/model"
"github.com/stretchr/testify/require"
"go.uber.org/atomic"
"github.com/prometheus/alertmanager/store"
"github.com/prometheus/alertmanager/types"
)
var (
t0 = time.Now()
t1 = t0.Add(100 * time.Millisecond)
alert1 = &types.Alert{
Alert: model.Alert{
Labels: model.LabelSet{"bar": "foo"},
Annotations: model.LabelSet{"foo": "bar"},
StartsAt: t0,
EndsAt: t1,
GeneratorURL: "http://example.com/prometheus",
},
UpdatedAt: t0,
Timeout: false,
}
alert2 = &types.Alert{
Alert: model.Alert{
Labels: model.LabelSet{"bar": "foo2"},
Annotations: model.LabelSet{"foo": "bar2"},
StartsAt: t0,
EndsAt: t1,
GeneratorURL: "http://example.com/prometheus",
},
UpdatedAt: t0,
Timeout: false,
}
alert3 = &types.Alert{
Alert: model.Alert{
Labels: model.LabelSet{"bar": "foo3"},
Annotations: model.LabelSet{"foo": "bar3"},
StartsAt: t0,
EndsAt: t1,
GeneratorURL: "http://example.com/prometheus",
},
UpdatedAt: t0,
Timeout: false,
}
)
func init() {
pretty.CompareConfig.IncludeUnexported = true
}
// TestAlertsSubscribePutStarvation tests starvation of `iterator.Close` and
// `alerts.Put`. Both `Subscribe` and `Put` use the Alerts.mtx lock. `Subscribe`
// needs it to subscribe and more importantly unsubscribe `Alerts.listeners`. `Put`
// uses the lock to add additional alerts and iterate the `Alerts.listeners` map.
// If the channel of a listener is at its limit, `alerts.Lock` is blocked, whereby
// a listener can not unsubscribe as the lock is hold by `alerts.Lock`.
func TestAlertsSubscribePutStarvation(t *testing.T) {
marker := types.NewMarker(prometheus.NewRegistry())
alerts, err := NewAlerts(context.Background(), marker, 30*time.Minute, noopCallback{}, log.NewNopLogger(), nil)
if err != nil {
t.Fatal(err)
}
iterator := alerts.Subscribe()
alertsToInsert := []*types.Alert{}
// Exhaust alert channel
for i := 0; i < alertChannelLength+1; i++ {
alertsToInsert = append(alertsToInsert, &types.Alert{
Alert: model.Alert{
// Make sure the fingerprints differ
Labels: model.LabelSet{"iteration": model.LabelValue(strconv.Itoa(i))},
Annotations: model.LabelSet{"foo": "bar"},
StartsAt: t0,
EndsAt: t1,
GeneratorURL: "http://example.com/prometheus",
},
UpdatedAt: t0,
Timeout: false,
})
}
putIsDone := make(chan struct{})
putsErr := make(chan error, 1)
go func() {
if err := alerts.Put(alertsToInsert...); err != nil {
putsErr <- err
return
}
putIsDone <- struct{}{}
}()
// Increase probability that `iterator.Close` is called after `alerts.Put`.
time.Sleep(100 * time.Millisecond)
iterator.Close()
select {
case <-putsErr:
t.Fatal(err)
case <-putIsDone:
// continue
case <-time.After(100 * time.Millisecond):
t.Fatal("expected `alerts.Put` and `iterator.Close` not to starve each other")
}
}
func TestAlertsPut(t *testing.T) {
marker := types.NewMarker(prometheus.NewRegistry())
alerts, err := NewAlerts(context.Background(), marker, 30*time.Minute, noopCallback{}, log.NewNopLogger(), nil)
if err != nil {
t.Fatal(err)
}
insert := []*types.Alert{alert1, alert2, alert3}
if err := alerts.Put(insert...); err != nil {
t.Fatalf("Insert failed: %s", err)
}
for i, a := range insert {
res, err := alerts.Get(a.Fingerprint())
if err != nil {
t.Fatalf("retrieval error: %s", err)
}
if !alertsEqual(res, a) {
t.Errorf("Unexpected alert: %d", i)
t.Fatalf(pretty.Compare(res, a))
}
}
}
func TestAlertsSubscribe(t *testing.T) {
marker := types.NewMarker(prometheus.NewRegistry())
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
alerts, err := NewAlerts(ctx, marker, 30*time.Minute, noopCallback{}, log.NewNopLogger(), nil)
if err != nil {
t.Fatal(err)
}
// Add alert1 to validate if pending alerts will be sent.
if err := alerts.Put(alert1); err != nil {
t.Fatalf("Insert failed: %s", err)
}
expectedAlerts := map[model.Fingerprint]*types.Alert{
alert1.Fingerprint(): alert1,
alert2.Fingerprint(): alert2,
alert3.Fingerprint(): alert3,
}
// Start many consumers and make sure that each receives all the subsequent alerts.
var (
nb = 100
fatalc = make(chan string, nb)
wg sync.WaitGroup
)
wg.Add(nb)
for i := 0; i < nb; i++ {
go func(i int) {
defer wg.Done()
it := alerts.Subscribe()
defer it.Close()
received := make(map[model.Fingerprint]struct{})
for {
select {
case got, ok := <-it.Next():
if !ok {
fatalc <- fmt.Sprintf("Iterator %d closed", i)
return
}
if it.Err() != nil {
fatalc <- fmt.Sprintf("Iterator %d: %v", i, it.Err())
return
}
expected := expectedAlerts[got.Fingerprint()]
if !alertsEqual(got, expected) {
fatalc <- fmt.Sprintf("Unexpected alert (iterator %d)\n%s", i, pretty.Compare(got, expected))
return
}
received[got.Fingerprint()] = struct{}{}
if len(received) == len(expectedAlerts) {
return
}
case <-time.After(5 * time.Second):
fatalc <- fmt.Sprintf("Unexpected number of alerts for iterator %d, got: %d, expected: %d", i, len(received), len(expectedAlerts))
return
}
}
}(i)
}
// Add more alerts that should be received by the subscribers.
if err := alerts.Put(alert2); err != nil {
t.Fatalf("Insert failed: %s", err)
}
if err := alerts.Put(alert3); err != nil {
t.Fatalf("Insert failed: %s", err)
}
wg.Wait()
close(fatalc)
fatal, ok := <-fatalc
if ok {
t.Fatalf(fatal)
}
}
func TestAlertsGetPending(t *testing.T) {
marker := types.NewMarker(prometheus.NewRegistry())
alerts, err := NewAlerts(context.Background(), marker, 30*time.Minute, noopCallback{}, log.NewNopLogger(), nil)
if err != nil {
t.Fatal(err)
}
if err := alerts.Put(alert1, alert2); err != nil {
t.Fatalf("Insert failed: %s", err)
}
expectedAlerts := map[model.Fingerprint]*types.Alert{
alert1.Fingerprint(): alert1,
alert2.Fingerprint(): alert2,
}
iterator := alerts.GetPending()
for actual := range iterator.Next() {
expected := expectedAlerts[actual.Fingerprint()]
if !alertsEqual(actual, expected) {
t.Errorf("Unexpected alert")
t.Fatalf(pretty.Compare(actual, expected))
}
}
if err := alerts.Put(alert3); err != nil {
t.Fatalf("Insert failed: %s", err)
}
expectedAlerts = map[model.Fingerprint]*types.Alert{
alert1.Fingerprint(): alert1,
alert2.Fingerprint(): alert2,
alert3.Fingerprint(): alert3,
}
iterator = alerts.GetPending()
for actual := range iterator.Next() {
expected := expectedAlerts[actual.Fingerprint()]
if !alertsEqual(actual, expected) {
t.Errorf("Unexpected alert")
t.Fatalf(pretty.Compare(actual, expected))
}
}
}
func TestAlertsGC(t *testing.T) {
marker := types.NewMarker(prometheus.NewRegistry())
alerts, err := NewAlerts(context.Background(), marker, 200*time.Millisecond, noopCallback{}, log.NewNopLogger(), nil)
if err != nil {
t.Fatal(err)
}
insert := []*types.Alert{alert1, alert2, alert3}
if err := alerts.Put(insert...); err != nil {
t.Fatalf("Insert failed: %s", err)
}
for _, a := range insert {
marker.SetSilenced(a.Fingerprint(), 0, nil, nil)
marker.SetInhibited(a.Fingerprint())
if !marker.Active(a.Fingerprint()) {
t.Errorf("error setting status: %v", a)
}
}
time.Sleep(300 * time.Millisecond)
for i, a := range insert {
_, err := alerts.Get(a.Fingerprint())
require.Error(t, err)
require.Equal(t, store.ErrNotFound, err, fmt.Sprintf("alert %d didn't get GC'd: %v", i, err))
s := marker.Status(a.Fingerprint())
if s.State != types.AlertStateUnprocessed {
t.Errorf("marker %d didn't get GC'd: %v", i, s)
}
}
}
func TestAlertsStoreCallback(t *testing.T) {
cb := &limitCountCallback{limit: 3}
marker := types.NewMarker(prometheus.NewRegistry())
alerts, err := NewAlerts(context.Background(), marker, 200*time.Millisecond, cb, log.NewNopLogger(), nil)
if err != nil {
t.Fatal(err)
}
err = alerts.Put(alert1, alert2, alert3)
if err != nil {
t.Fatal(err)
}
if num := cb.alerts.Load(); num != 3 {
t.Fatalf("unexpected number of alerts in the store, expected %v, got %v", 3, num)
}
alert1Mod := *alert1
alert1Mod.Annotations = model.LabelSet{"foo": "bar", "new": "test"} // Update annotations for alert1
alert4 := &types.Alert{
Alert: model.Alert{
Labels: model.LabelSet{"bar4": "foo4"},
Annotations: model.LabelSet{"foo4": "bar4"},
StartsAt: t0,
EndsAt: t1,
GeneratorURL: "http://example.com/prometheus",
},
UpdatedAt: t0,
Timeout: false,
}
err = alerts.Put(&alert1Mod, alert4)
// Verify that we failed to put new alert into store (not reported via error, only checked using Load)
if err != nil {
t.Fatalf("unexpected error %v", err)
}
if num := cb.alerts.Load(); num != 3 {
t.Fatalf("unexpected number of alerts in the store, expected %v, got %v", 3, num)
}
// But we still managed to update alert1, since callback doesn't report error when updating existing alert.
a, err := alerts.Get(alert1.Fingerprint())
if err != nil {
t.Fatal(err)
}
if !alertsEqual(a, &alert1Mod) {
t.Errorf("Unexpected alert")
t.Fatalf(pretty.Compare(a, &alert1Mod))
}
// Now wait until existing alerts are GC-ed, and make sure that callback was called.
time.Sleep(300 * time.Millisecond)
if num := cb.alerts.Load(); num != 0 {
t.Fatalf("unexpected number of alerts in the store, expected %v, got %v", 0, num)
}
err = alerts.Put(alert4)
if err != nil {
t.Fatal(err)
}
}
func TestAlerts_Count(t *testing.T) {
marker := types.NewMarker(prometheus.NewRegistry())
alerts, err := NewAlerts(context.Background(), marker, 200*time.Millisecond, nil, log.NewNopLogger(), nil)
require.NoError(t, err)
states := []types.AlertState{types.AlertStateActive, types.AlertStateSuppressed, types.AlertStateUnprocessed}
countByState := func(st types.AlertState) int {
return alerts.count(st)
}
countTotal := func() int {
var count int
for _, st := range states {
count += countByState(st)
}
return count
}
// First, there shouldn't be any alerts.
require.Equal(t, 0, countTotal())
// When you insert a new alert that will eventually be active, it should be unprocessed first.
alerts.Put(alert1)
require.Equal(t, 1, countByState(types.AlertStateUnprocessed))
require.Equal(t, 1, countTotal())
// When we insert an alert and then silence it. It shows up with the correct filter.
alerts.Put(alert2)
marker.SetSilenced(alert2.Fingerprint(), 1, []string{"1"}, nil)
require.Equal(t, 1, countByState(types.AlertStateUnprocessed))
require.Equal(t, 1, countByState(types.AlertStateSuppressed))
require.Equal(t, 2, countTotal())
require.Eventually(t, func() bool {
// When the alerts eventually expire and are considered resolved they won't count.
return countTotal() == 0
}, 600*time.Millisecond, 100*time.Millisecond)
}
func alertsEqual(a1, a2 *types.Alert) bool {
if a1 == nil || a2 == nil {
return false
}
if !reflect.DeepEqual(a1.Labels, a2.Labels) {
return false
}
if !reflect.DeepEqual(a1.Annotations, a2.Annotations) {
return false
}
if a1.GeneratorURL != a2.GeneratorURL {
return false
}
if !a1.StartsAt.Equal(a2.StartsAt) {
return false
}
if !a1.EndsAt.Equal(a2.EndsAt) {
return false
}
if !a1.UpdatedAt.Equal(a2.UpdatedAt) {
return false
}
return a1.Timeout == a2.Timeout
}
type limitCountCallback struct {
alerts atomic.Int32
limit int
}
var errTooManyAlerts = fmt.Errorf("too many alerts")
func (l *limitCountCallback) PreStore(_ *types.Alert, existing bool) error {
if existing {
return nil
}
if int(l.alerts.Load())+1 > l.limit {
return errTooManyAlerts
}
return nil
}
func (l *limitCountCallback) PostStore(_ *types.Alert, existing bool) {
if !existing {
l.alerts.Inc()
}
}
func (l *limitCountCallback) PostDelete(_ *types.Alert) {
l.alerts.Dec()
}