-
Notifications
You must be signed in to change notification settings - Fork 414
/
sarama_test.go
318 lines (272 loc) · 9.68 KB
/
sarama_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
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2016 Datadog, Inc.
package sarama
import (
"context"
"testing"
"time"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/ext"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/mocktracer"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
"github.com/Shopify/sarama"
"github.com/stretchr/testify/assert"
)
func TestConsumer(t *testing.T) {
mt := mocktracer.Start()
defer mt.Stop()
broker := sarama.NewMockBroker(t, 0)
defer broker.Close()
broker.SetHandlerByMap(map[string]sarama.MockResponse{
"MetadataRequest": sarama.NewMockMetadataResponse(t).
SetBroker(broker.Addr(), broker.BrokerID()).
SetLeader("test-topic", 0, broker.BrokerID()),
"OffsetRequest": sarama.NewMockOffsetResponse(t).
SetOffset("test-topic", 0, sarama.OffsetOldest, 0).
SetOffset("test-topic", 0, sarama.OffsetNewest, 1),
"FetchRequest": sarama.NewMockFetchResponse(t, 1).
SetMessage("test-topic", 0, 0, sarama.StringEncoder("hello")).
SetMessage("test-topic", 0, 1, sarama.StringEncoder("world")),
})
cfg := sarama.NewConfig()
cfg.Version = sarama.MinVersion
client, err := sarama.NewClient([]string{broker.Addr()}, cfg)
if err != nil {
t.Fatal(err)
}
defer client.Close()
consumer, err := sarama.NewConsumerFromClient(client)
if err != nil {
t.Fatal(err)
}
defer consumer.Close()
consumer = WrapConsumer(consumer)
partitionConsumer, err := consumer.ConsumePartition("test-topic", 0, 0)
if err != nil {
t.Fatal(err)
}
msg1 := <-partitionConsumer.Messages()
msg2 := <-partitionConsumer.Messages()
partitionConsumer.Close()
// wait for the channel to be closed
<-partitionConsumer.Messages()
spans := mt.FinishedSpans()
assert.Len(t, spans, 2)
{
s := spans[0]
spanctx, err := tracer.Extract(NewConsumerMessageCarrier(msg1))
assert.NoError(t, err)
assert.Equal(t, spanctx.TraceID(), s.TraceID(),
"span context should be injected into the consumer message headers")
assert.Equal(t, int32(0), s.Tag("partition"))
assert.Equal(t, int64(0), s.Tag("offset"))
assert.Equal(t, "kafka", s.Tag(ext.ServiceName))
assert.Equal(t, "Consume Topic test-topic", s.Tag(ext.ResourceName))
assert.Equal(t, "queue", s.Tag(ext.SpanType))
assert.Equal(t, "kafka.consume", s.OperationName())
assert.Equal(t, "Shopify/sarama", s.Tag(ext.Component))
assert.Equal(t, ext.SpanKindConsumer, s.Tag(ext.SpanKind))
}
{
s := spans[1]
spanctx, err := tracer.Extract(NewConsumerMessageCarrier(msg2))
assert.NoError(t, err)
assert.Equal(t, spanctx.TraceID(), s.TraceID(),
"span context should be injected into the consumer message headers")
assert.Equal(t, int32(0), s.Tag("partition"))
assert.Equal(t, int64(1), s.Tag("offset"))
assert.Equal(t, "kafka", s.Tag(ext.ServiceName))
assert.Equal(t, "Consume Topic test-topic", s.Tag(ext.ResourceName))
assert.Equal(t, "queue", s.Tag(ext.SpanType))
assert.Equal(t, "kafka.consume", s.OperationName())
assert.Equal(t, "Shopify/sarama", s.Tag(ext.Component))
assert.Equal(t, ext.SpanKindConsumer, s.Tag(ext.SpanKind))
}
}
func TestSyncProducer(t *testing.T) {
mt := mocktracer.Start()
defer mt.Stop()
seedBroker := sarama.NewMockBroker(t, 1)
defer seedBroker.Close()
leader := sarama.NewMockBroker(t, 2)
defer leader.Close()
metadataResponse := new(sarama.MetadataResponse)
metadataResponse.AddBroker(leader.Addr(), leader.BrokerID())
metadataResponse.AddTopicPartition("my_topic", 0, leader.BrokerID(), nil, nil, nil, sarama.ErrNoError)
seedBroker.Returns(metadataResponse)
prodSuccess := new(sarama.ProduceResponse)
prodSuccess.AddTopicPartition("my_topic", 0, sarama.ErrNoError)
leader.Returns(prodSuccess)
cfg := sarama.NewConfig()
cfg.Version = sarama.MinVersion
cfg.Producer.Return.Successes = true
producer, err := sarama.NewSyncProducer([]string{seedBroker.Addr()}, cfg)
if err != nil {
t.Fatal(err)
}
producer = WrapSyncProducer(cfg, producer)
msg1 := &sarama.ProducerMessage{
Topic: "my_topic",
Value: sarama.StringEncoder("test 1"),
Metadata: "test",
}
producer.SendMessage(msg1)
spans := mt.FinishedSpans()
assert.Len(t, spans, 1)
{
s := spans[0]
assert.Equal(t, "kafka", s.Tag(ext.ServiceName))
assert.Equal(t, "queue", s.Tag(ext.SpanType))
assert.Equal(t, "Produce Topic my_topic", s.Tag(ext.ResourceName))
assert.Equal(t, "kafka.produce", s.OperationName())
assert.Equal(t, int32(0), s.Tag("partition"))
assert.Equal(t, int64(0), s.Tag("offset"))
assert.Equal(t, "Shopify/sarama", s.Tag(ext.Component))
assert.Equal(t, ext.SpanKindProducer, s.Tag(ext.SpanKind))
}
}
func TestSyncProducerSendMessages(t *testing.T) {
mt := mocktracer.Start()
defer mt.Stop()
seedBroker := sarama.NewMockBroker(t, 1)
defer seedBroker.Close()
leader := sarama.NewMockBroker(t, 2)
defer leader.Close()
metadataResponse := new(sarama.MetadataResponse)
metadataResponse.AddBroker(leader.Addr(), leader.BrokerID())
metadataResponse.AddTopicPartition("my_topic", 0, leader.BrokerID(), nil, nil, nil, sarama.ErrNoError)
seedBroker.Returns(metadataResponse)
prodSuccess := new(sarama.ProduceResponse)
prodSuccess.AddTopicPartition("my_topic", 0, sarama.ErrNoError)
leader.Returns(prodSuccess)
cfg := sarama.NewConfig()
cfg.Version = sarama.MinVersion
cfg.Producer.Return.Successes = true
cfg.Producer.Flush.Messages = 2
producer, err := sarama.NewSyncProducer([]string{seedBroker.Addr()}, cfg)
if err != nil {
t.Fatal(err)
}
producer = WrapSyncProducer(cfg, producer)
msg1 := &sarama.ProducerMessage{
Topic: "my_topic",
Value: sarama.StringEncoder("test 1"),
Metadata: "test",
}
msg2 := &sarama.ProducerMessage{
Topic: "my_topic",
Value: sarama.StringEncoder("test 2"),
Metadata: "test",
}
producer.SendMessages([]*sarama.ProducerMessage{msg1, msg2})
spans := mt.FinishedSpans()
assert.Len(t, spans, 2)
for _, s := range spans {
assert.Equal(t, "kafka", s.Tag(ext.ServiceName))
assert.Equal(t, "queue", s.Tag(ext.SpanType))
assert.Equal(t, "Produce Topic my_topic", s.Tag(ext.ResourceName))
assert.Equal(t, "kafka.produce", s.OperationName())
assert.Equal(t, int32(0), s.Tag("partition"))
assert.Equal(t, "Shopify/sarama", s.Tag(ext.Component))
assert.Equal(t, ext.SpanKindProducer, s.Tag(ext.SpanKind))
}
}
func TestAsyncProducer(t *testing.T) {
// the default for producers is a fire-and-forget model that doesn't return
// successes
t.Run("Without Successes", func(t *testing.T) {
t.Skip("Skipping test because sarama.MockBroker doesn't work with versions >= sarama.V0_11_0_0 " +
"https://github.com/Shopify/sarama/issues/1665")
mt := mocktracer.Start()
defer mt.Stop()
broker := newMockBroker(t)
cfg := sarama.NewConfig()
cfg.Version = sarama.V0_11_0_0
producer, err := sarama.NewAsyncProducer([]string{broker.Addr()}, cfg)
if err != nil {
t.Fatal(err)
}
producer = WrapAsyncProducer(nil, producer)
msg1 := &sarama.ProducerMessage{
Topic: "my_topic",
Value: sarama.StringEncoder("test 1"),
}
producer.Input() <- msg1
waitForSpans(mt, 1, time.Second*10)
spans := mt.FinishedSpans()
assert.Len(t, spans, 1)
{
s := spans[0]
assert.Equal(t, "kafka", s.Tag(ext.ServiceName))
assert.Equal(t, "queue", s.Tag(ext.SpanType))
assert.Equal(t, "Produce Topic my_topic", s.Tag(ext.ResourceName))
assert.Equal(t, "kafka.produce", s.OperationName())
assert.Equal(t, int32(0), s.Tag("partition"))
assert.Equal(t, int64(0), s.Tag("offset"))
assert.Equal(t, "Shopify/sarama", s.Tag(ext.Component))
assert.Equal(t, ext.SpanKindProducer, s.Tag(ext.SpanKind))
}
})
t.Run("With Successes", func(t *testing.T) {
t.Skip("Skipping test because sarama.MockBroker doesn't work with versions >= sarama.V0_11_0_0 " +
"https://github.com/Shopify/sarama/issues/1665")
mt := mocktracer.Start()
defer mt.Stop()
broker := newMockBroker(t)
cfg := sarama.NewConfig()
cfg.Version = sarama.V0_11_0_0
cfg.Producer.Return.Successes = true
producer, err := sarama.NewAsyncProducer([]string{broker.Addr()}, cfg)
if err != nil {
t.Fatal(err)
}
producer = WrapAsyncProducer(cfg, producer)
msg1 := &sarama.ProducerMessage{
Topic: "my_topic",
Value: sarama.StringEncoder("test 1"),
}
producer.Input() <- msg1
<-producer.Successes()
spans := mt.FinishedSpans()
assert.Len(t, spans, 1)
{
s := spans[0]
assert.Equal(t, "kafka", s.Tag(ext.ServiceName))
assert.Equal(t, "queue", s.Tag(ext.SpanType))
assert.Equal(t, "Produce Topic my_topic", s.Tag(ext.ResourceName))
assert.Equal(t, "kafka.produce", s.OperationName())
assert.Equal(t, int32(0), s.Tag("partition"))
assert.Equal(t, int64(0), s.Tag("offset"))
assert.Equal(t, "Shopify/sarama", s.Tag(ext.Component))
assert.Equal(t, ext.SpanKindProducer, s.Tag(ext.SpanKind))
}
})
}
func newMockBroker(t *testing.T) *sarama.MockBroker {
broker := sarama.NewMockBroker(t, 1)
metadataResponse := new(sarama.MetadataResponse)
metadataResponse.AddBroker(broker.Addr(), broker.BrokerID())
metadataResponse.AddTopicPartition("my_topic", 0, broker.BrokerID(), nil, nil, nil, sarama.ErrNoError)
broker.Returns(metadataResponse)
prodSuccess := new(sarama.ProduceResponse)
prodSuccess.AddTopicPartition("my_topic", 0, sarama.ErrNoError)
for i := 0; i < 10; i++ {
broker.Returns(prodSuccess)
}
return broker
}
// waitForSpans polls the mock tracer until the expected number of spans
// appear
func waitForSpans(mt mocktracer.Tracer, sz int, maxWait time.Duration) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
defer cancel()
for len(mt.FinishedSpans()) < sz {
select {
case <-ctx.Done():
return
default:
}
time.Sleep(time.Millisecond * 100)
}
}