/
functional_test.go
480 lines (424 loc) · 12.4 KB
/
functional_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
478
479
480
//go:build functional
// +build functional
package sarama
import (
"context"
"errors"
"fmt"
"log"
"net"
"net/url"
"os"
"os/exec"
"strconv"
"strings"
"testing"
"time"
toxiproxy "github.com/Shopify/toxiproxy/v2/client"
)
const uncommittedTopic = "uncommitted-topic-test-4"
var (
testTopicDetails = map[string]*TopicDetail{
"test.1": {
NumPartitions: 1,
ReplicationFactor: 3,
},
"test.4": {
NumPartitions: 4,
ReplicationFactor: 3,
},
"test.64": {
NumPartitions: 64,
ReplicationFactor: 3,
},
uncommittedTopic: {
NumPartitions: 1,
ReplicationFactor: 3,
},
}
FunctionalTestEnv *testEnvironment
)
func TestMain(m *testing.M) {
// Functional tests for Sarama
//
// You can either set TOXIPROXY_ADDR, which points at a toxiproxy address
// already set up with 21801-21805 bound to zookeeper and 29091-29095
// bound to kafka. Alternatively, if TOXIPROXY_ADDR is not set, we'll try
// and use Docker to bring up a 5-node zookeeper cluster & 5-node kafka
// cluster, with toxiproxy configured as above.
//
// In either case, the following topics will be deleted (if they exist) and
// then created/pre-seeded with data for the functional test run:
// * uncommitted-topic-test-4
// * test.1
// * test.4
// * test.64
os.Exit(testMain(m))
}
func testMain(m *testing.M) int {
ctx := context.Background()
var env testEnvironment
if os.Getenv("DEBUG") == "true" {
Logger = log.New(os.Stdout, "[sarama] ", log.LstdFlags)
}
usingExisting, err := existingEnvironment(ctx, &env)
if err != nil {
panic(err)
}
if !usingExisting {
err := prepareDockerTestEnvironment(ctx, &env)
if err != nil {
_ = tearDownDockerTestEnvironment(ctx, &env)
panic(err)
}
defer tearDownDockerTestEnvironment(ctx, &env) // nolint:errcheck
}
if err := prepareTestTopics(ctx, &env); err != nil {
panic(err)
}
FunctionalTestEnv = &env
return m.Run()
}
type testEnvironment struct {
ToxiproxyClient *toxiproxy.Client
Proxies map[string]*toxiproxy.Proxy
KafkaBrokerAddrs []string
KafkaVersion string
}
// setupToxiProxies will configure the toxiproxy proxies with routes for the
// kafka brokers if they don't already exist
func setupToxiProxies(env *testEnvironment, endpoint string) error {
env.ToxiproxyClient = toxiproxy.NewClient(endpoint)
env.Proxies = map[string]*toxiproxy.Proxy{}
env.KafkaBrokerAddrs = nil
for i := 1; i <= 5; i++ {
proxyName := fmt.Sprintf("kafka%d", i)
proxy, err := env.ToxiproxyClient.Proxy(proxyName)
if err != nil {
proxy, err = env.ToxiproxyClient.CreateProxy(
proxyName,
fmt.Sprintf("0.0.0.0:%d", 29090+i),
fmt.Sprintf("kafka-%d:%d", i, 29090+i),
)
if err != nil {
return fmt.Errorf("failed to create toxiproxy: %w", err)
}
}
env.Proxies[proxyName] = proxy
env.KafkaBrokerAddrs = append(env.KafkaBrokerAddrs, fmt.Sprintf("127.0.0.1:%d", 29090+i))
}
return nil
}
func prepareDockerTestEnvironment(ctx context.Context, env *testEnvironment) error {
const expectedBrokers = 5
Logger.Println("bringing up docker-based test environment")
// Always (try to) tear down first.
if err := tearDownDockerTestEnvironment(ctx, env); err != nil {
return fmt.Errorf("failed to tear down existing env: %w", err)
}
if version, ok := os.LookupEnv("KAFKA_VERSION"); ok {
env.KafkaVersion = version
} else {
env.KafkaVersion = "3.1.2"
}
c := exec.Command("docker-compose", "up", "-d")
c.Stdout = os.Stdout
c.Stderr = os.Stderr
c.Env = append(os.Environ(), fmt.Sprintf("KAFKA_VERSION=%s", env.KafkaVersion))
err := c.Run()
if err != nil {
return fmt.Errorf("failed to run docker-compose to start test environment: %w", err)
}
if err := setupToxiProxies(env, "http://localhost:8474"); err != nil {
return fmt.Errorf("failed to setup toxiproxies: %w", err)
}
dialCheck := func(addr string, timeout time.Duration) error {
conn, err := net.DialTimeout("tcp", addr, timeout)
if err != nil {
return err
}
return conn.Close()
}
config := NewTestConfig()
config.Version, err = ParseKafkaVersion(env.KafkaVersion)
if err != nil {
return err
}
config.Net.DialTimeout = 1 * time.Second
config.Net.ReadTimeout = 1 * time.Second
config.Net.WriteTimeout = 1 * time.Second
config.ClientID = "sarama-tests"
// wait for the kafka brokers to come up
allBrokersUp := false
mainLoop:
for i := 0; i < 30 && !allBrokersUp; i++ {
Logger.Println("waiting for kafka brokers to come up")
time.Sleep(3 * time.Second)
brokersOk := make([]bool, len(env.KafkaBrokerAddrs))
// first check that all bootstrap brokers are TCP accessible
for _, addr := range env.KafkaBrokerAddrs {
if err := dialCheck(addr, time.Second); err != nil {
continue mainLoop
}
}
// now check we can bootstrap metadata from the cluster and all brokers
// are known and accessible at their advertised address
retryLoop:
for j, addr := range env.KafkaBrokerAddrs {
client, err := NewClient([]string{addr}, config)
if err != nil {
continue
}
err = client.RefreshMetadata()
if err != nil {
continue
}
brokers := client.Brokers()
if len(brokers) < expectedBrokers {
continue
}
for _, broker := range brokers {
err := broker.Open(client.Config())
if err != nil {
continue retryLoop
}
connected, err := broker.Connected()
if err != nil || !connected {
continue retryLoop
}
}
brokersOk[j] = true
}
allBrokersUp = true
for _, u := range brokersOk {
allBrokersUp = allBrokersUp && u
}
}
if !allBrokersUp {
c := exec.Command("docker-compose", "logs", "-t", "kafka-1", "kafka-2", "kafka-3", "kafka-4", "kafka-5")
c.Stdout = os.Stdout
c.Stderr = os.Stderr
_ = c.Run()
return fmt.Errorf("timed out waiting for one or more broker to come up")
}
return nil
}
func existingEnvironment(ctx context.Context, env *testEnvironment) (bool, error) {
toxiproxyAddr, ok := os.LookupEnv("TOXIPROXY_ADDR")
if !ok {
return false, nil
}
toxiproxyURL, err := url.Parse(toxiproxyAddr)
if err != nil {
return false, fmt.Errorf("$TOXIPROXY_ADDR not parseable as url")
}
if err := setupToxiProxies(env, toxiproxyURL.String()); err != nil {
return false, fmt.Errorf("failed to setup toxiproxies: %w", err)
}
env.KafkaVersion, ok = os.LookupEnv("KAFKA_VERSION")
if !ok {
return false, fmt.Errorf("KAFKA_VERSION needs to be provided with TOXIPROXY_ADDR")
}
return true, nil
}
func tearDownDockerTestEnvironment(ctx context.Context, env *testEnvironment) error {
c := exec.Command("docker-compose", "down", "--volumes")
c.Stdout = os.Stdout
c.Stderr = os.Stderr
downErr := c.Run()
c = exec.Command("docker-compose", "rm", "-v", "--force", "--stop")
c.Stdout = os.Stdout
c.Stderr = os.Stderr
rmErr := c.Run()
if downErr != nil {
return fmt.Errorf("failed to run docker-compose to stop test environment: %w", downErr)
}
if rmErr != nil {
return fmt.Errorf("failed to run docker-compose to rm test environment: %w", rmErr)
}
return nil
}
func startDockerTestBroker(ctx context.Context, brokerID int32) error {
service := fmt.Sprintf("kafka-%d", brokerID)
c := exec.Command("docker-compose", "start", service)
c.Stdout = os.Stdout
c.Stderr = os.Stderr
if err := c.Run(); err != nil {
return fmt.Errorf("failed to run docker-compose to start test broker kafka-%d: %w", brokerID, err)
}
return nil
}
func stopDockerTestBroker(ctx context.Context, brokerID int32) error {
service := fmt.Sprintf("kafka-%d", brokerID)
c := exec.Command("docker-compose", "stop", service)
c.Stdout = os.Stdout
c.Stderr = os.Stderr
if err := c.Run(); err != nil {
return fmt.Errorf("failed to run docker-compose to stop test broker kafka-%d: %w", brokerID, err)
}
return nil
}
func prepareTestTopics(ctx context.Context, env *testEnvironment) error {
Logger.Println("creating test topics")
var testTopicNames []string
for topic := range testTopicDetails {
testTopicNames = append(testTopicNames, topic)
}
Logger.Println("Creating topics")
config := NewTestConfig()
config.Metadata.Retry.Max = 5
config.Metadata.Retry.Backoff = 10 * time.Second
config.ClientID = "sarama-prepareTestTopics"
var err error
config.Version, err = ParseKafkaVersion(env.KafkaVersion)
if err != nil {
return fmt.Errorf("failed to parse kafka version %s: %w", env.KafkaVersion, err)
}
client, err := NewClient(env.KafkaBrokerAddrs, config)
if err != nil {
return fmt.Errorf("failed to connect to kafka: %w", err)
}
defer client.Close()
controller, err := client.Controller()
if err != nil {
return fmt.Errorf("failed to connect to kafka controller: %w", err)
}
defer controller.Close()
// Start by deleting the test topics (if they already exist)
deleteRes, err := controller.DeleteTopics(&DeleteTopicsRequest{
Topics: testTopicNames,
Timeout: time.Minute,
})
if err != nil {
return fmt.Errorf("failed to delete test topics: %w", err)
}
for topic, topicErr := range deleteRes.TopicErrorCodes {
if !isTopicNotExistsErrorOrOk(topicErr) {
return fmt.Errorf("failed to delete topic %s: %w", topic, topicErr)
}
}
// wait for the topics to _actually_ be gone - the delete is not guaranteed to be processed
// synchronously
{
var topicsOk bool
for i := 0; i < 60 && !topicsOk; i++ {
time.Sleep(1 * time.Second)
md, err := controller.GetMetadata(&MetadataRequest{
Topics: testTopicNames,
})
if err != nil {
return fmt.Errorf("failed to get metadata for test topics: %w", err)
}
if len(md.Topics) == len(testTopicNames) {
topicsOk = true
for _, topicsMd := range md.Topics {
if !isTopicNotExistsErrorOrOk(topicsMd.Err) {
topicsOk = false
}
}
}
}
if !topicsOk {
return fmt.Errorf("timed out waiting for test topics to be gone")
}
}
// now create the topics empty
createRes, err := controller.CreateTopics(&CreateTopicsRequest{
TopicDetails: testTopicDetails,
Timeout: time.Minute,
})
if err != nil {
return fmt.Errorf("failed to create test topics: %w", err)
}
for topic, topicErr := range createRes.TopicErrors {
if !isTopicExistsErrorOrOk(topicErr.Err) {
return fmt.Errorf("failed to create test topic %s: %w", topic, topicErr)
}
}
// wait for the topics to _actually_ exist - the creates are not guaranteed to be processed
// synchronously
{
var topicsOk bool
for i := 0; i < 60 && !topicsOk; i++ {
time.Sleep(1 * time.Second)
md, err := controller.GetMetadata(&MetadataRequest{
Topics: testTopicNames,
})
if err != nil {
return fmt.Errorf("failed to get metadata for test topics: %w", err)
}
if len(md.Topics) == len(testTopicNames) {
topicsOk = true
for _, topicsMd := range md.Topics {
if topicsMd.Err != ErrNoError {
topicsOk = false
}
}
}
}
if !topicsOk {
return fmt.Errorf("timed out waiting for test topics to be created")
}
}
return nil
}
func isTopicNotExistsErrorOrOk(err KError) bool {
return errors.Is(err, ErrUnknownTopicOrPartition) || errors.Is(err, ErrInvalidTopic) || errors.Is(err, ErrNoError)
}
func isTopicExistsErrorOrOk(err KError) bool {
return errors.Is(err, ErrTopicAlreadyExists) || errors.Is(err, ErrNoError)
}
func checkKafkaVersion(t testing.TB, requiredVersion string) {
kafkaVersion := FunctionalTestEnv.KafkaVersion
if kafkaVersion == "" {
t.Skipf("No KAFKA_VERSION set. This test requires Kafka version %s or higher. Continuing...", requiredVersion)
} else {
available := parseKafkaVersion(kafkaVersion)
required := parseKafkaVersion(requiredVersion)
if !available.satisfies(required) {
t.Skipf("Kafka version %s is required for this test; you have %s. Skipping...", requiredVersion, kafkaVersion)
}
}
}
func resetProxies(t testing.TB) {
if err := FunctionalTestEnv.ToxiproxyClient.ResetState(); err != nil {
t.Error(err)
}
}
func SaveProxy(t *testing.T, px string) {
if err := FunctionalTestEnv.Proxies[px].Save(); err != nil {
t.Fatal(err)
}
}
func setupFunctionalTest(t testing.TB) {
resetProxies(t)
}
func teardownFunctionalTest(t testing.TB) {
resetProxies(t)
}
type kafkaVersion []int
func (kv kafkaVersion) satisfies(other kafkaVersion) bool {
var ov int
for index, v := range kv {
if len(other) <= index {
ov = 0
} else {
ov = other[index]
}
if v < ov {
return false
} else if v > ov {
return true
}
}
return true
}
func parseKafkaVersion(version string) kafkaVersion {
numbers := strings.Split(version, ".")
result := make(kafkaVersion, 0, len(numbers))
for _, number := range numbers {
nr, _ := strconv.Atoi(number)
result = append(result, nr)
}
return result
}