-
Notifications
You must be signed in to change notification settings - Fork 175
Expand file tree
/
Copy pathcentral_receiver_test.go
More file actions
454 lines (379 loc) · 13.9 KB
/
central_receiver_test.go
File metadata and controls
454 lines (379 loc) · 13.9 KB
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
package sensor
import (
"context"
"fmt"
"io"
"os"
"testing"
"time"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/stackrox/rox/generated/internalapi/central"
"github.com/stackrox/rox/pkg/centralsensor"
"github.com/stackrox/rox/pkg/env"
op "github.com/stackrox/rox/pkg/metrics"
"github.com/stackrox/rox/pkg/sync"
"github.com/stackrox/rox/pkg/testutils/goleak"
"github.com/stackrox/rox/sensor/common"
"github.com/stackrox/rox/sensor/common/message"
"github.com/stackrox/rox/sensor/common/metrics"
mocksClient "github.com/stackrox/rox/sensor/common/sensor/mocks"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"go.uber.org/mock/gomock"
)
const (
totalMetric = "rox_sensor_component_queue_operations_total"
errorsMetric = "rox_sensor_component_process_message_errors_total"
)
type centralReceiverSuite struct {
suite.Suite
controller *gomock.Controller
mockClient *mocksClient.MockServiceCommunicateClient
receiver CentralReceiver
finished *sync.WaitGroup
}
var _ suite.SetupTestSuite = (*centralReceiverSuite)(nil)
var (
testMsg = ¢ral.MsgToSensor{
Msg: ¢ral.MsgToSensor_PolicySync{
PolicySync: ¢ral.PolicySync{},
},
}
ignoredMsg = ¢ral.MsgToSensor{
Msg: ¢ral.MsgToSensor_Hello{},
}
)
func (s *centralReceiverSuite) SetupTest() {
s.controller = gomock.NewController(s.T())
s.mockClient = mocksClient.NewMockServiceCommunicateClient(s.controller)
s.finished = &sync.WaitGroup{}
s.finished.Add(1)
}
func (s *centralReceiverSuite) TearDownTest() {
if s.receiver != nil {
s.receiver.Stop()
s.finished.Wait()
}
goleak.AssertNoGoroutineLeaks(s.T())
}
func Test_CentralReceiverSuite(t *testing.T) {
suite.Run(t, new(centralReceiverSuite))
}
func (s *centralReceiverSuite) Test_StreamContextCancelShouldStopFlow() {
s.receiver = NewCentralReceiver(s.finished)
streamContext, cancel := context.WithCancel(context.Background())
defer cancel()
s.mockClient.EXPECT().Context().AnyTimes().Return(streamContext).AnyTimes()
s.mockClient.EXPECT().Recv().Times(1).DoAndReturn(func() (*central.MsgToSensor, error) {
cancel()
s.T().Log("Canceled context")
return testMsg, nil
})
s.receiver.Start(s.mockClient)
s.finished.Wait()
s.EqualError(s.receiver.Stopped().Err(), "context canceled")
}
func (s *centralReceiverSuite) Test_RecvErrorShouldStopFlow() {
s.receiver = NewCentralReceiver(s.finished)
s.mockClient.EXPECT().Context().AnyTimes().Return(context.Background()).AnyTimes()
s.mockClient.EXPECT().Recv().Times(1).DoAndReturn(func() (*central.MsgToSensor, error) {
return nil, errors.New("some error")
})
s.receiver.Start(s.mockClient)
s.finished.Wait()
s.EqualError(s.receiver.Stopped().Err(), "some error")
}
func (s *centralReceiverSuite) Test_EofShouldStopFlowWithNoError() {
s.receiver = NewCentralReceiver(s.finished)
s.mockClient.EXPECT().Context().AnyTimes().Return(context.Background()).AnyTimes()
s.mockClient.EXPECT().Recv().Times(1).DoAndReturn(func() (*central.MsgToSensor, error) {
return nil, io.EOF
})
s.receiver.Start(s.mockClient)
s.finished.Wait()
s.NoError(s.receiver.Stopped().Err())
}
func (s *centralReceiverSuite) Test_SlowComponentDoesNotBlockOthers() {
fastTick := make(chan struct{})
close(fastTick)
fastComponent := &testSensorComponent{
t: s.T(),
name: "fast",
tick: fastTick,
responsesC: make(chan *message.ExpiringMessage),
}
blockedChan := make(chan struct{})
blockingComponent := &testSensorComponent{
t: s.T(),
name: "blocked",
tick: blockedChan,
responsesC: make(chan *message.ExpiringMessage),
}
components := []common.SensorComponent{fastComponent, blockingComponent}
s.receiver = NewCentralReceiver(s.finished, components...)
s.mockClient.EXPECT().Context().AnyTimes().Return(context.Background()).AnyTimes()
msgCount := 3
s.mockClient.EXPECT().Recv().MinTimes(msgCount).DoAndReturn(func() (*central.MsgToSensor, error) {
return testMsg, nil
})
s.receiver.Start(s.mockClient)
for i := 0; i < msgCount; i++ {
select {
case <-fastComponent.ResponsesC():
s.T().Log("Fast component processed the message")
case <-blockingComponent.ResponsesC():
assert.FailNow(s.T(), "blocked component should not process the message")
}
}
s.receiver.Stop()
s.finished.Wait()
s.NoError(s.receiver.Stopped().Err())
}
func (s *centralReceiverSuite) Test_FilterIgnoresMessages() {
const (
numberOfCentralMessages = 5
queueSize = 3
)
s.T().Setenv(env.RequestsChannelBufferSize.EnvVar(), fmt.Sprintf("%d", queueSize))
tick := make(chan struct{})
fastComponent := &testSensorComponent{
t: s.T(),
name: "filtered",
tick: tick,
responsesC: make(chan *message.ExpiringMessage, numberOfCentralMessages),
}
close(tick)
components := []common.SensorComponent{fastComponent}
s.receiver = NewCentralReceiver(s.finished, components...)
// Get initial metric values before test
initialDropped := getOpMetricValue(s.T(), fastComponent.Name(), op.Dropped.String())
initialAddOperations := getOpMetricValue(s.T(), fastComponent.Name(), op.Add.String())
initialRemoveOperations := getOpMetricValue(s.T(), fastComponent.Name(), op.Remove.String())
s.mockClient.EXPECT().Context().AnyTimes().Return(context.Background()).AnyTimes()
messagesFromCentral := make(chan *central.MsgToSensor, numberOfCentralMessages)
s.mockClient.EXPECT().Recv().MinTimes(5).DoAndReturn(func() (*central.MsgToSensor, error) {
msg, ok := <-messagesFromCentral
if !ok {
s.T().Log("received EOF from central")
return nil, io.EOF
}
s.T().Log("received the message from central")
return msg, nil
})
s.receiver.Start(s.mockClient)
s.T().Logf("Sending %d messages from central", numberOfCentralMessages)
for i := 0; i < numberOfCentralMessages; i++ {
messagesFromCentral <- ignoredMsg
time.Sleep(time.Millisecond)
}
s.T().Log("Everything should be dropped")
s.T().Log("Sending EOF from central")
close(messagesFromCentral)
s.T().Log("Waiting for receiever to stop")
s.finished.Wait()
fastComponent.Stop()
_, ok := <-fastComponent.ResponsesC()
s.False(ok, "all message should be filtered")
// Verify queue metrics - calculate deltas
finalDropped := getOpMetricValue(s.T(), fastComponent.Name(), op.Dropped.String())
finalAddOperations := getOpMetricValue(s.T(), fastComponent.Name(), op.Add.String())
finalRemoveOperations := getOpMetricValue(s.T(), fastComponent.Name(), op.Remove.String())
droppedDelta := finalDropped - initialDropped
addDelta := finalAddOperations - initialAddOperations
removeDelta := finalRemoveOperations - initialRemoveOperations
s.Equal(float64(0), droppedDelta)
s.Equal(float64(0), addDelta)
s.Equal(float64(0), removeDelta)
s.NoError(s.receiver.Stopped().Err())
}
func (s *centralReceiverSuite) Test_SlowComponentDropMessages() {
const (
numberOfCentralMessages = 5
queueSize = 3
)
s.Require().NoError(os.Setenv(env.RequestsChannelBufferSize.EnvVar(), fmt.Sprintf("%d", queueSize)))
s.T().Cleanup(func() {
s.NoError(os.Unsetenv(env.RequestsChannelBufferSize.EnvVar()))
})
tick := make(chan struct{})
slowComponent := &testSensorComponent{
t: s.T(),
name: "slow",
tick: tick,
responsesC: make(chan *message.ExpiringMessage, numberOfCentralMessages),
}
components := []common.SensorComponent{slowComponent}
s.receiver = NewCentralReceiver(s.finished, components...)
// Get initial metric values before test
initialDropped := getOpMetricValue(s.T(), slowComponent.Name(), op.Dropped.String())
initialAddOperations := getOpMetricValue(s.T(), slowComponent.Name(), op.Add.String())
initialRemoveOperations := getOpMetricValue(s.T(), slowComponent.Name(), op.Remove.String())
s.mockClient.EXPECT().Context().AnyTimes().Return(context.Background()).AnyTimes()
messagesFromCentral := make(chan *central.MsgToSensor, numberOfCentralMessages)
s.mockClient.EXPECT().Recv().MinTimes(5).DoAndReturn(func() (*central.MsgToSensor, error) {
msg, ok := <-messagesFromCentral
if !ok {
s.T().Log("received EOF from central")
return nil, io.EOF
}
s.T().Log("received the message from central")
return msg, nil
})
s.receiver.Start(s.mockClient)
s.T().Logf("Sending %d messages from central", numberOfCentralMessages)
for i := 0; i < numberOfCentralMessages; i++ {
messagesFromCentral <- testMsg
time.Sleep(time.Millisecond)
}
s.T().Logf("Only %d messages should be processed and rest should be dropped", queueSize)
s.T().Log("Unblocking component")
close(tick)
s.T().Log("Reading responses from component.")
for i := 0; i <= queueSize; i++ {
<-slowComponent.ResponsesC()
}
s.T().Log("Sending EOF from central")
close(messagesFromCentral)
s.T().Log("Waiting for receiver to stop")
s.finished.Wait()
slowComponent.Stop()
_, ok := <-slowComponent.ResponsesC()
s.False(ok, "no more message should be processed than what was already read")
// Verify queue metrics - calculate deltas
finalDropped := getOpMetricValue(s.T(), slowComponent.Name(), op.Dropped.String())
finalAddOperations := getOpMetricValue(s.T(), slowComponent.Name(), op.Add.String())
finalRemoveOperations := getOpMetricValue(s.T(), slowComponent.Name(), op.Remove.String())
droppedDelta := finalDropped - initialDropped
addDelta := finalAddOperations - initialAddOperations
removeDelta := finalRemoveOperations - initialRemoveOperations
s.Equal(float64(numberOfCentralMessages-queueSize-1), droppedDelta, "should drop excess messages beyond queue capacity")
s.Equal(float64(numberOfCentralMessages-1), addDelta, "should track all add operations")
s.Equal(float64(queueSize+1), removeDelta, "should track all remove operations")
s.NoError(s.receiver.Stopped().Err())
}
func (s *centralReceiverSuite) Test_ComponentProcessMessageErrorsMetric() {
const numberOfCentralMessages = 5
errorComponent := &testErrorSensorComponent{testSensorComponent{
t: s.T(),
name: "error-component",
}}
components := []common.SensorComponent{errorComponent}
s.receiver = NewCentralReceiver(s.finished, components...)
// Get initial error count before test
initialErrors := getMetricValue(s.T(), errorsMetric, map[string]string{metrics.ComponentName: "error-component"})
s.mockClient.EXPECT().Context().AnyTimes().Return(context.Background()).AnyTimes()
messagesFromCentral := make(chan *central.MsgToSensor)
s.mockClient.EXPECT().Recv().MinTimes(numberOfCentralMessages).DoAndReturn(func() (*central.MsgToSensor, error) {
msg, ok := <-messagesFromCentral
if !ok {
s.T().Log("received EOF from central")
return nil, io.EOF
}
s.T().Log("received the message from central")
return msg, nil
})
s.receiver.Start(s.mockClient)
s.T().Logf("Sending %d messages from central", numberOfCentralMessages)
for i := 0; i < numberOfCentralMessages; i++ {
messagesFromCentral <- testMsg
}
s.EventuallyWithT(func(c *assert.CollectT) {
finalErrors := getMetricValue(s.T(), errorsMetric, map[string]string{metrics.ComponentName: "error-component"})
assert.Equal(c, numberOfCentralMessages, int(finalErrors-initialErrors))
}, 5*time.Second, 10*time.Millisecond, "error metric should be incremented when ProcessMessage returns an error")
s.T().Log("Sending EOF from central")
close(messagesFromCentral)
s.T().Log("Waiting for receiever to stop")
s.finished.Wait()
s.NoError(s.receiver.Stopped().Err())
}
// testSensorComponent process messages with every tick
type testSensorComponent struct {
t *testing.T
name string
tick <-chan struct{}
responsesC chan *message.ExpiringMessage
}
func (t *testSensorComponent) Accepts(msg *central.MsgToSensor) bool {
return msg.GetPolicySync() != nil
}
func (t *testSensorComponent) ProcessMessage(ctx context.Context, msg *central.MsgToSensor) error {
require.NotNil(t.t, msg.GetPolicySync(), "should have received policy sync")
select {
case <-t.tick:
select {
case t.responsesC <- &message.ExpiringMessage{}:
t.t.Logf("%s: message processed", t.Name())
return nil
case <-ctx.Done():
t.t.Logf("%s: %s", t.Name(), ctx.Err())
return ctx.Err()
}
case <-ctx.Done():
t.t.Logf("%s: %s", t.Name(), ctx.Err())
return ctx.Err()
}
}
func (t *testSensorComponent) Name() string {
return t.name
}
func (t *testSensorComponent) Notify(common.SensorComponentEvent) {}
func (t *testSensorComponent) Start() error {
return nil
}
func (t *testSensorComponent) Stop() {
close(t.responsesC)
}
func (t *testSensorComponent) Capabilities() []centralsensor.SensorCapability {
return []centralsensor.SensorCapability{}
}
func (t *testSensorComponent) ResponsesC() <-chan *message.ExpiringMessage {
return t.responsesC
}
// testErrorSensorComponent always returns an error from ProcessMessage
type testErrorSensorComponent struct {
testSensorComponent
}
func (t *testErrorSensorComponent) ProcessMessage(_ context.Context, _ *central.MsgToSensor) error {
t.t.Logf("%s: returning error", t.Name())
return errors.New("test error")
}
func getOpMetricValue(t *testing.T, componet, op string) float64 {
t.Helper()
return getMetricValue(t, totalMetric, map[string]string{metrics.ComponentName: componet, metrics.Operation: op})
}
func getMetricValue(t *testing.T, metricName string, labels map[string]string) float64 {
families, err := prometheus.DefaultGatherer.Gather()
assert.NoError(t, err)
for _, family := range families {
if family.GetName() == metricName {
for _, metric := range family.GetMetric() {
labelMatch := true
for requiredKey, requiredValue := range labels {
found := false
for _, labelPair := range metric.GetLabel() {
if labelPair.GetName() == requiredKey && labelPair.GetValue() == requiredValue {
found = true
break
}
}
if !found {
labelMatch = false
break
}
}
if labelMatch {
if metric.GetCounter() != nil {
return metric.GetCounter().GetValue()
}
if metric.GetGauge() != nil {
return metric.GetGauge().GetValue()
}
}
}
}
}
return 0
}