/
ExactlyOnceWorkerSourceTaskTest.java
1254 lines (1035 loc) · 50.7 KB
/
ExactlyOnceWorkerSourceTaskTest.java
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
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.kafka.connect.runtime;
import org.apache.kafka.clients.producer.Producer;
import org.apache.kafka.clients.producer.RecordMetadata;
import org.apache.kafka.common.KafkaException;
import org.apache.kafka.common.MetricName;
import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.errors.InvalidTopicException;
import org.apache.kafka.common.errors.RecordTooLargeException;
import org.apache.kafka.common.header.Header;
import org.apache.kafka.common.header.Headers;
import org.apache.kafka.common.header.internals.RecordHeaders;
import org.apache.kafka.common.utils.MockTime;
import org.apache.kafka.common.utils.Time;
import org.apache.kafka.connect.data.Schema;
import org.apache.kafka.connect.errors.ConnectException;
import org.apache.kafka.connect.integration.MonitorableSourceConnector;
import org.apache.kafka.connect.runtime.ConnectMetrics.MetricGroup;
import org.apache.kafka.connect.runtime.errors.ErrorHandlingMetrics;
import org.apache.kafka.connect.runtime.errors.RetryWithToleranceOperatorTest;
import org.apache.kafka.connect.runtime.isolation.Plugins;
import org.apache.kafka.connect.runtime.standalone.StandaloneConfig;
import org.apache.kafka.connect.source.SourceRecord;
import org.apache.kafka.connect.source.SourceTask;
import org.apache.kafka.connect.source.TransactionContext;
import org.apache.kafka.connect.storage.CloseableOffsetStorageReader;
import org.apache.kafka.connect.storage.ClusterConfigState;
import org.apache.kafka.connect.storage.ConnectorOffsetBackingStore;
import org.apache.kafka.connect.storage.Converter;
import org.apache.kafka.connect.storage.HeaderConverter;
import org.apache.kafka.connect.storage.OffsetStorageWriter;
import org.apache.kafka.connect.storage.StatusBackingStore;
import org.apache.kafka.connect.storage.StringConverter;
import org.apache.kafka.connect.test.util.ConcurrencyUtils;
import org.apache.kafka.connect.test.util.MockitoUtils;
import org.apache.kafka.connect.util.Callback;
import org.apache.kafka.connect.util.ConnectorTaskId;
import org.apache.kafka.connect.util.ParameterizedTest;
import org.apache.kafka.connect.util.TopicAdmin;
import org.apache.kafka.connect.util.TopicCreationGroup;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
import org.mockito.stubbing.OngoingStubbing;
import org.mockito.verification.VerificationMode;
import java.time.Duration;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import static java.util.Collections.emptySet;
import static org.apache.kafka.connect.integration.MonitorableSourceConnector.TOPIC_CONFIG;
import static org.apache.kafka.connect.runtime.ConnectorConfig.CONNECTOR_CLASS_CONFIG;
import static org.apache.kafka.connect.runtime.ConnectorConfig.KEY_CONVERTER_CLASS_CONFIG;
import static org.apache.kafka.connect.runtime.ConnectorConfig.TASKS_MAX_CONFIG;
import static org.apache.kafka.connect.runtime.ConnectorConfig.VALUE_CONVERTER_CLASS_CONFIG;
import static org.apache.kafka.connect.runtime.SourceConnectorConfig.TOPIC_CREATION_GROUPS_CONFIG;
import static org.apache.kafka.connect.runtime.SourceConnectorConfig.TRANSACTION_BOUNDARY_CONFIG;
import static org.apache.kafka.connect.runtime.SourceConnectorConfig.TRANSACTION_BOUNDARY_INTERVAL_CONFIG;
import static org.apache.kafka.connect.runtime.TopicCreationConfig.DEFAULT_TOPIC_CREATION_PREFIX;
import static org.apache.kafka.connect.runtime.TopicCreationConfig.EXCLUDE_REGEX_CONFIG;
import static org.apache.kafka.connect.runtime.TopicCreationConfig.INCLUDE_REGEX_CONFIG;
import static org.apache.kafka.connect.runtime.TopicCreationConfig.PARTITIONS_CONFIG;
import static org.apache.kafka.connect.runtime.TopicCreationConfig.REPLICATION_FACTOR_CONFIG;
import static org.apache.kafka.connect.runtime.WorkerConfig.TOPIC_CREATION_ENABLE_CONFIG;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThrows;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;
@RunWith(Parameterized.class)
public class ExactlyOnceWorkerSourceTaskTest {
private static final String TOPIC = "topic";
private static final Map<String, byte[]> PARTITION = Collections.singletonMap("key", "partition".getBytes());
private static final Map<String, ?> OFFSET = offset(12);
// Connect-format data
private static final Schema KEY_SCHEMA = Schema.INT32_SCHEMA;
private static final Integer KEY = -1;
private static final Schema RECORD_SCHEMA = Schema.INT64_SCHEMA;
private static final Long VALUE_1 = 12L;
private static final Long VALUE_2 = 13L;
// Serialized data. The actual format of this data doesn't matter -- we just want to see that the right version
// is used in the right place.
private static final byte[] SERIALIZED_KEY = "converted-key".getBytes();
private static final byte[] SERIALIZED_RECORD = "converted-record".getBytes();
private final ExecutorService executor = Executors.newSingleThreadExecutor();
private final ConnectorTaskId taskId = new ConnectorTaskId("job", 0);
private WorkerConfig config;
private SourceConnectorConfig sourceConfig;
private Plugins plugins;
private MockConnectMetrics metrics;
@Mock private ErrorHandlingMetrics errorHandlingMetrics;
private Time time;
private ExactlyOnceWorkerSourceTask workerTask;
@Mock private SourceTask sourceTask;
@Mock private Converter keyConverter;
@Mock private Converter valueConverter;
@Mock private HeaderConverter headerConverter;
@Mock private TransformationChain<SourceRecord> transformationChain;
@Mock private Producer<byte[], byte[]> producer;
@Mock private TopicAdmin admin;
@Mock private CloseableOffsetStorageReader offsetReader;
@Mock private OffsetStorageWriter offsetWriter;
@Mock private ClusterConfigState clusterConfigState;
@Mock private TaskStatus.Listener statusListener;
@Mock private StatusBackingStore statusBackingStore;
@Mock private ConnectorOffsetBackingStore offsetStore;
@Mock private Runnable preProducerCheck;
@Mock private Runnable postProducerCheck;
@Rule public MockitoRule rule = MockitoJUnit.rule();
private static final Map<String, String> TASK_PROPS = new HashMap<>();
static {
TASK_PROPS.put(TaskConfig.TASK_CLASS_CONFIG, TestSourceTask.class.getName());
}
private static final TaskConfig TASK_CONFIG = new TaskConfig(TASK_PROPS);
private static final SourceRecord SOURCE_RECORD_1 =
new SourceRecord(PARTITION, OFFSET, TOPIC, null, KEY_SCHEMA, KEY, RECORD_SCHEMA, VALUE_1);
private static final SourceRecord SOURCE_RECORD_2 =
new SourceRecord(PARTITION, OFFSET, TOPIC, null, KEY_SCHEMA, KEY, RECORD_SCHEMA, VALUE_2);
private static final List<SourceRecord> RECORDS = Arrays.asList(SOURCE_RECORD_1, SOURCE_RECORD_2);
private final AtomicReference<CountDownLatch> pollLatch = new AtomicReference<>(new CountDownLatch(0));
private final AtomicReference<List<SourceRecord>> pollRecords = new AtomicReference<>(RECORDS);
private final boolean enableTopicCreation;
private boolean taskStarted;
private Future<?> workerTaskFuture;
@ParameterizedTest.Parameters
public static Collection<Boolean> parameters() {
return Arrays.asList(false, true);
}
public ExactlyOnceWorkerSourceTaskTest(boolean enableTopicCreation) {
this.enableTopicCreation = enableTopicCreation;
this.taskStarted = false;
}
@Before
public void setup() throws Exception {
Map<String, String> workerProps = workerProps();
plugins = new Plugins(workerProps);
config = new StandaloneConfig(workerProps);
sourceConfig = new SourceConnectorConfig(plugins, sourceConnectorProps(), true);
metrics = new MockConnectMetrics();
time = Time.SYSTEM;
when(offsetStore.primaryOffsetsTopic()).thenReturn("offsets-topic");
when(sourceTask.poll()).thenAnswer(invocation -> {
// Capture the records we'll return before decrementing the poll latch,
// since test cases may mutate the poll records field immediately
// after awaiting the latch
List<SourceRecord> result = pollRecords.get();
pollLatch.get().countDown();
Thread.sleep(10);
return result;
});
}
@After
public void teardown() throws Exception {
// In most tests, we don't really care about how many times the task got polled,
// how many times we prepared to write offsets, etc.
// We add these verify(..., anyTimes())... calls to make sure that those interactions
// with our mocks don't cause the verifyNoMoreInteractions(...) call to fail.
// Individual tests can add more fine-grained verification logic if necessary; the
// verifications here will not conflict with them
verify(sourceTask, MockitoUtils.anyTimes()).poll();
verify(sourceTask, MockitoUtils.anyTimes()).commit();
verify(sourceTask, MockitoUtils.anyTimes()).commitRecord(any(), any());
verify(offsetWriter, MockitoUtils.anyTimes()).offset(PARTITION, OFFSET);
verify(offsetWriter, MockitoUtils.anyTimes()).beginFlush();
verify(offsetWriter, MockitoUtils.anyTimes()).doFlush(any());
if (enableTopicCreation) {
verify(admin, MockitoUtils.anyTimes()).describeTopics(TOPIC);
}
verify(statusBackingStore, MockitoUtils.anyTimes()).getTopic(any(), any());
verify(offsetStore, MockitoUtils.anyTimes()).primaryOffsetsTopic();
verifyNoMoreInteractions(statusListener, producer, sourceTask, admin, offsetWriter, statusBackingStore, offsetStore, preProducerCheck, postProducerCheck);
if (metrics != null) metrics.stop();
}
private Map<String, String> workerProps() {
Map<String, String> props = new HashMap<>();
props.put("key.converter", "org.apache.kafka.connect.json.JsonConverter");
props.put("value.converter", "org.apache.kafka.connect.json.JsonConverter");
props.put("internal.key.converter", "org.apache.kafka.connect.json.JsonConverter");
props.put("internal.value.converter", "org.apache.kafka.connect.json.JsonConverter");
props.put("internal.key.converter.schemas.enable", "false");
props.put("internal.value.converter.schemas.enable", "false");
props.put("offset.storage.file.filename", "/tmp/connect.offsets");
props.put(TOPIC_CREATION_ENABLE_CONFIG, String.valueOf(enableTopicCreation));
return props;
}
private Map<String, String> sourceConnectorProps() {
return sourceConnectorProps(SourceTask.TransactionBoundary.DEFAULT);
}
private Map<String, String> sourceConnectorProps(SourceTask.TransactionBoundary transactionBoundary) {
// setup up props for the source connector
Map<String, String> props = new HashMap<>();
props.put("name", "foo-connector");
props.put(CONNECTOR_CLASS_CONFIG, MonitorableSourceConnector.class.getSimpleName());
props.put(TASKS_MAX_CONFIG, String.valueOf(1));
props.put(TOPIC_CONFIG, TOPIC);
props.put(KEY_CONVERTER_CLASS_CONFIG, StringConverter.class.getName());
props.put(VALUE_CONVERTER_CLASS_CONFIG, StringConverter.class.getName());
props.put(TOPIC_CREATION_GROUPS_CONFIG, String.join(",", "foo", "bar"));
props.put(DEFAULT_TOPIC_CREATION_PREFIX + REPLICATION_FACTOR_CONFIG, String.valueOf(1));
props.put(DEFAULT_TOPIC_CREATION_PREFIX + PARTITIONS_CONFIG, String.valueOf(1));
props.put(TRANSACTION_BOUNDARY_CONFIG, transactionBoundary.toString());
props.put(SourceConnectorConfig.TOPIC_CREATION_PREFIX + "foo" + "." + INCLUDE_REGEX_CONFIG, TOPIC);
props.put(SourceConnectorConfig.TOPIC_CREATION_PREFIX + "bar" + "." + INCLUDE_REGEX_CONFIG, ".*");
props.put(SourceConnectorConfig.TOPIC_CREATION_PREFIX + "bar" + "." + EXCLUDE_REGEX_CONFIG, TOPIC);
return props;
}
private static Map<String, ?> offset(int n) {
return Collections.singletonMap("key", n);
}
private void createWorkerTask() {
createWorkerTask(TargetState.STARTED);
}
private void createWorkerTask(TargetState initialState) {
createWorkerTask(initialState, keyConverter, valueConverter, headerConverter);
}
private void createWorkerTask(TargetState initialState, Converter keyConverter, Converter valueConverter, HeaderConverter headerConverter) {
workerTask = new ExactlyOnceWorkerSourceTask(taskId, sourceTask, statusListener, initialState, keyConverter, valueConverter, headerConverter,
transformationChain, producer, admin, TopicCreationGroup.configuredGroups(sourceConfig), offsetReader, offsetWriter, offsetStore,
config, clusterConfigState, metrics, errorHandlingMetrics, plugins.delegatingLoader(), time, RetryWithToleranceOperatorTest.NOOP_OPERATOR, statusBackingStore,
sourceConfig, Runnable::run, preProducerCheck, postProducerCheck);
}
@Test
public void testRemoveMetrics() {
createWorkerTask();
workerTask.removeMetrics();
assertEquals(emptySet(), filterToTaskMetrics(metrics.metrics().metrics().keySet()));
}
private Set<MetricName> filterToTaskMetrics(Set<MetricName> metricNames) {
return metricNames
.stream()
.filter(m -> metrics.registry().taskGroupName().equals(m.group())
|| metrics.registry().sourceTaskGroupName().equals(m.group()))
.collect(Collectors.toSet());
}
@Test
public void testStartPaused() throws Exception {
createWorkerTask(TargetState.PAUSED);
final CountDownLatch pauseLatch = new CountDownLatch(1);
doAnswer(invocation -> {
pauseLatch.countDown();
return null;
}).when(statusListener).onPause(eq(taskId));
startTaskThread();
assertTrue(pauseLatch.await(5, TimeUnit.SECONDS));
awaitShutdown();
verify(statusListener).onPause(taskId);
verify(sourceTask, never()).start(any());
verify(sourceTask, never()).poll();
verifyCleanShutdown();
assertPollMetrics(0);
}
@Test
public void testPause() throws Exception {
createWorkerTask();
expectSuccessfulSends();
expectSuccessfulFlushes();
final CountDownLatch pauseLatch = new CountDownLatch(1);
doAnswer(invocation -> {
pauseLatch.countDown();
return null;
}).when(statusListener).onPause(eq(taskId));
startTaskThread();
awaitPolls(2);
workerTask.transitionTo(TargetState.PAUSED);
long pollsBeforePause = pollCount();
ConcurrencyUtils.awaitLatch(pauseLatch, "task did not pause in time");
// since the transition is observed asynchronously, the count could be off by one loop iteration
assertTrue(pollCount() - pollsBeforePause <= 1);
awaitShutdown();
verify(statusListener).onPause(taskId);
// Task should have flushed offsets for every record poll, once on pause, and once for end-of-life offset commit
verifyTransactions(pollCount() + 2, pollCount() + 2);
verifySends();
verifyPossibleTopicCreation();
// make sure we didn't poll again after triggering shutdown
assertTrue(pollCount() - pollsBeforePause <= 1);
verifyPreflight();
verifyStartup();
verifyCleanShutdown();
}
@Test
public void testFailureInPreProducerCheck() throws Exception {
createWorkerTask();
Exception exception = new ConnectException("Failed to perform zombie fencing");
doThrow(exception).when(preProducerCheck).run();
workerTask.initialize(TASK_CONFIG);
// No need to execute on a separate thread; preflight checks should all take place before the poll-send loop starts
workerTask.run();
verify(preProducerCheck).run();
verifyShutdown(true, false);
}
@Test
public void testFailureInProducerInitialization() throws Exception {
createWorkerTask();
Exception exception = new ConnectException("You can't do that!");
doThrow(exception).when(producer).initTransactions();
workerTask.initialize(TASK_CONFIG);
// No need to execute on a separate thread; preflight checks should all take place before the poll-send loop starts
workerTask.run();
verify(preProducerCheck).run();
verify(producer).initTransactions();
verifyShutdown(true, false);
}
@Test
public void testFailureInPostProducerCheck() throws Exception {
createWorkerTask();
Exception exception = new ConnectException("New task configs for the connector have already been generated");
doThrow(exception).when(postProducerCheck).run();
workerTask.initialize(TASK_CONFIG);
// No need to execute on a separate thread; preflight checks should all take place before the poll-send loop starts
workerTask.run();
verify(preProducerCheck).run();
verify(producer).initTransactions();
verify(postProducerCheck).run();
verifyShutdown(true, false);
}
@Test
public void testFailureInOffsetStoreStart() throws Exception {
createWorkerTask();
Exception exception = new ConnectException("No soup for you!");
doThrow(exception).when(offsetStore).start();
workerTask.initialize(TASK_CONFIG);
// No need to execute on a separate thread; preflight checks should all take place before the poll-send loop starts
workerTask.run();
verify(preProducerCheck).run();
verify(producer).initTransactions();
verify(postProducerCheck).run();
verify(offsetStore).start();
verifyShutdown(true, false);
}
@Test
public void testPollsInBackground() throws Exception {
createWorkerTask();
expectSuccessfulSends();
expectSuccessfulFlushes();
startTaskThread();
int minPolls = 10;
awaitPolls(minPolls);
awaitShutdown();
// Task should have flushed offsets for every record poll and for end-of-life offset commit
verifyTransactions(pollCount() + 1, pollCount() + 1);
verifySends();
verifyPossibleTopicCreation();
verifyPreflight();
verifyStartup();
verifyCleanShutdown();
assertPollMetrics(minPolls);
assertTransactionMetrics(RECORDS.size());
}
@Test
public void testFailureInPoll() throws Exception {
createWorkerTask();
final CountDownLatch pollLatch = new CountDownLatch(1);
final RuntimeException exception = new RuntimeException();
when(sourceTask.poll()).thenAnswer(invocation -> {
pollLatch.countDown();
throw exception;
});
startTaskThread();
ConcurrencyUtils.awaitLatch(pollLatch, "task was not polled in time");
//Failure in poll should trigger automatic stop of the worker
awaitShutdown(false);
verifyPreflight();
verifyStartup();
verifyShutdown(true, false);
assertPollMetrics(0);
}
@Test
public void testFailureInPollAfterCancel() throws Exception {
createWorkerTask();
final CountDownLatch pollLatch = new CountDownLatch(1);
final CountDownLatch workerCancelLatch = new CountDownLatch(1);
final RuntimeException exception = new RuntimeException();
when(sourceTask.poll()).thenAnswer(invocation -> {
pollLatch.countDown();
ConcurrencyUtils.awaitLatch(workerCancelLatch, "task was not cancelled in time");
throw exception;
});
startTaskThread();
ConcurrencyUtils.awaitLatch(pollLatch, "task was not polled in time");
workerTask.cancel();
workerCancelLatch.countDown();
awaitShutdown(false);
verifyPreflight();
verifyStartup();
verifyShutdown(false, true);
assertPollMetrics(0);
}
@Test
public void testFailureInPollAfterStop() throws Exception {
createWorkerTask();
final CountDownLatch pollLatch = new CountDownLatch(1);
final CountDownLatch workerStopLatch = new CountDownLatch(1);
final RuntimeException exception = new RuntimeException();
// We check if there are offsets that need to be committed before shutting down the task
when(sourceTask.poll()).thenAnswer(invocation -> {
pollLatch.countDown();
ConcurrencyUtils.awaitLatch(workerStopLatch, "task was not stopped in time");
throw exception;
});
startTaskThread();
ConcurrencyUtils.awaitLatch(pollLatch, "task was not polled in time");
workerTask.stop();
workerStopLatch.countDown();
awaitShutdown(false);
verifyTransactions(0, 0);
verifyPreflight();
verifyStartup();
verifyCleanShutdown();
assertPollMetrics(0);
}
@Test
public void testPollReturnsNoRecords() throws Exception {
// Test that the task handles an empty list of records
createWorkerTask();
// Make sure the task returns empty batches from poll before we start polling it
pollRecords.set(Collections.emptyList());
when(offsetWriter.beginFlush()).thenReturn(false);
startTaskThread();
awaitEmptyPolls(10);
awaitShutdown();
// task commits for each empty poll, plus the final commit
verifyTransactions(pollCount() + 1, 0);
verifyPreflight();
verifyStartup();
verifyCleanShutdown();
assertPollMetrics(0);
}
@Test
public void testPollBasedCommit() throws Exception {
Map<String, String> connectorProps = sourceConnectorProps(SourceTask.TransactionBoundary.POLL);
sourceConfig = new SourceConnectorConfig(plugins, connectorProps, enableTopicCreation);
createWorkerTask();
expectSuccessfulSends();
expectSuccessfulFlushes();
startTaskThread();
awaitPolls(10);
awaitShutdown();
// Task should have flushed offsets for every record poll, and for end-of-life offset commit
verifyTransactions(pollCount() + 1, pollCount() + 1);
verifySends();
verifyPossibleTopicCreation();
verifyPreflight();
verifyStartup();
verifyCleanShutdown();
assertPollMetrics(1);
assertTransactionMetrics(RECORDS.size());
}
@Test
public void testIntervalBasedCommit() throws Exception {
long commitInterval = 618;
Map<String, String> connectorProps = sourceConnectorProps(SourceTask.TransactionBoundary.INTERVAL);
connectorProps.put(TRANSACTION_BOUNDARY_INTERVAL_CONFIG, Long.toString(commitInterval));
sourceConfig = new SourceConnectorConfig(plugins, connectorProps, enableTopicCreation);
time = new MockTime();
createWorkerTask();
expectSuccessfulSends();
expectSuccessfulFlushes();
startTaskThread();
awaitPolls(2);
assertEquals("No flushes should have taken place before offset commit interval has elapsed", 0, flushCount());
time.sleep(commitInterval);
awaitPolls(2);
assertEquals("One flush should have taken place after offset commit interval has elapsed", 1, flushCount());
time.sleep(commitInterval * 2);
awaitPolls(2);
assertEquals("Two flushes should have taken place after offset commit interval has elapsed again", 2, flushCount());
awaitShutdown();
// Task should have flushed offsets twice based on offset commit interval, and performed final end-of-life offset commit
verifyTransactions(3, 3);
verifySends();
verifyPossibleTopicCreation();
verifyPreflight();
verifyStartup();
verifyCleanShutdown();
assertPollMetrics(2);
assertTransactionMetrics(RECORDS.size() * 2);
}
@Test
public void testConnectorCommitOnBatch() throws Exception {
testConnectorBasedCommit(TransactionContext::commitTransaction, false);
}
@Test
public void testConnectorCommitOnRecord() throws Exception {
testConnectorBasedCommit(ctx -> ctx.commitTransaction(SOURCE_RECORD_2), false);
}
@Test
public void testConnectorAbortOnBatch() throws Exception {
testConnectorBasedCommit(TransactionContext::abortTransaction, true);
}
@Test
public void testConnectorAbortOnRecord() throws Exception {
testConnectorBasedCommit(ctx -> ctx.abortTransaction(SOURCE_RECORD_2), true);
}
private void testConnectorBasedCommit(Consumer<TransactionContext> requestCommit, boolean abort) throws Exception {
Map<String, String> connectorProps = sourceConnectorProps(SourceTask.TransactionBoundary.CONNECTOR);
sourceConfig = new SourceConnectorConfig(plugins, connectorProps, enableTopicCreation);
createWorkerTask();
expectSuccessfulSends();
expectSuccessfulFlushes();
TransactionContext transactionContext = workerTask.sourceTaskContext.transactionContext();
startTaskThread();
awaitPolls(3);
assertEquals("No flushes should have taken place without connector requesting transaction commit",
0, flushCount());
requestCommit.accept(transactionContext);
awaitPolls(3);
assertEquals("One flush should have taken place after transaction commit/abort was requested",
1, flushCount());
awaitPolls(3);
assertEquals("Only one flush should still have taken place without connector re-requesting commit/abort, even on identical records",
1, flushCount());
awaitShutdown();
assertEquals("Task should have flushed offsets once based on connector-defined boundaries, and skipped final end-of-life offset commit",
1, flushCount());
// We begin a new transaction after connector-requested aborts so that we can still write offsets for the source records that were aborted
verify(producer, times(abort ? 3 : 2)).beginTransaction();
verifySends();
if (abort) {
verify(producer).abortTransaction();
}
verify(producer).commitTransaction();
verifyPreflight();
verifyStartup();
verifyCleanShutdown();
verifyPossibleTopicCreation();
assertPollMetrics(1);
assertTransactionMetrics(abort ? 0 : (3 * RECORDS.size()));
}
@Test
public void testConnectorAbortsEmptyTransaction() throws Exception {
Map<String, String> connectorProps = sourceConnectorProps(SourceTask.TransactionBoundary.CONNECTOR);
sourceConfig = new SourceConnectorConfig(plugins, connectorProps, enableTopicCreation);
createWorkerTask();
expectPossibleTopicCreation();
expectTaskGetTopic();
expectApplyTransformationChain();
expectConvertHeadersAndKeyValue();
TransactionContext transactionContext = workerTask.sourceTaskContext.transactionContext();
startTaskThread();
// Ensure the task produces at least one non-empty batch
awaitPolls(1);
// Start returning empty batches from SourceTask::poll
awaitEmptyPolls(1);
// The task commits the active transaction, which should not be empty and should
// result in a single call to Producer::commitTransaction
transactionContext.commitTransaction();
// Ensure the task produces at least one empty batch after the transaction has been committed
awaitEmptyPolls(1);
// The task aborts the active transaction, which has no records in it and should not trigger a call to
// Producer::abortTransaction
transactionContext.abortTransaction();
// Make sure we go through at least one more poll, to give the framework a chance to handle the
// transaction abort request
awaitEmptyPolls(1);
awaitShutdown(true);
verify(producer, times(1)).beginTransaction();
verify(producer, times(1)).commitTransaction();
verify(producer, atLeast(RECORDS.size())).send(any(), any());
// We never abort transactions in this test!
verify(producer, never()).abortTransaction();
verifyPreflight();
verifyStartup();
verifyCleanShutdown();
verifyPossibleTopicCreation();
}
@Test
public void testMixedConnectorTransactionBoundaryCommitLastRecordAbortBatch() throws Exception {
// We fail tasks that try to abort and commit a transaction for the same record or same batch
// But we don't fail if they try to commit the last record of a batch and abort the entire batch
// Instead, we give precedence to the record-based operation
Map<String, String> connectorProps = sourceConnectorProps(SourceTask.TransactionBoundary.CONNECTOR);
sourceConfig = new SourceConnectorConfig(plugins, connectorProps, enableTopicCreation);
createWorkerTask();
expectPossibleTopicCreation();
expectTaskGetTopic();
expectApplyTransformationChain();
expectConvertHeadersAndKeyValue();
when(offsetWriter.beginFlush())
.thenReturn(true)
.thenReturn(false);
workerTask.initialize(TASK_CONFIG);
TransactionContext transactionContext = workerTask.sourceTaskContext.transactionContext();
// Request that the batch be aborted
transactionContext.abortTransaction();
// Request that the last record in the batch be committed
transactionContext.commitTransaction(RECORDS.get(RECORDS.size() - 1));
workerTask.toSend = RECORDS;
assertTrue(workerTask.sendRecords());
verifyTransactions(2, 1);
verifySends(RECORDS.size());
// We never abort transactions in this test!
verify(producer, never()).abortTransaction();
verifyPossibleTopicCreation();
}
@Test
public void testMixedConnectorTransactionBoundaryAbortLastRecordCommitBatch() throws Exception {
// We fail tasks that try to abort and commit a transaction for the same record or same batch
// But we don't fail if they try to abort the last record of a batch and commit the entire batch
// Instead, we give precedence to the record-based operation
Map<String, String> connectorProps = sourceConnectorProps(SourceTask.TransactionBoundary.CONNECTOR);
sourceConfig = new SourceConnectorConfig(plugins, connectorProps, enableTopicCreation);
createWorkerTask();
expectPossibleTopicCreation();
expectTaskGetTopic();
expectApplyTransformationChain();
expectConvertHeadersAndKeyValue();
when(offsetWriter.beginFlush())
.thenReturn(true)
.thenReturn(false);
workerTask.initialize(TASK_CONFIG);
TransactionContext transactionContext = workerTask.sourceTaskContext.transactionContext();
// Request that the last record in the batch be aborted
transactionContext.abortTransaction(RECORDS.get(RECORDS.size() - 1));
// Request that the batch be committed
transactionContext.commitTransaction();
workerTask.toSend = RECORDS;
assertTrue(workerTask.sendRecords());
verify(offsetWriter, times(2)).beginFlush();
verify(sourceTask, times(2)).commit();
// We open a transaction once for the aborted batch, and once to commit offsets for that batch
verify(producer, times(2)).beginTransaction();
verify(producer, times(1)).commitTransaction();
verify(offsetWriter, times(1)).doFlush(any());
verify(producer, times(1)).abortTransaction();
verifySends(RECORDS.size());
verifyPossibleTopicCreation();
}
@Test
public void testCommitFlushSyncCallbackFailure() throws Exception {
Exception failure = new RecordTooLargeException();
when(offsetWriter.beginFlush()).thenReturn(true);
when(offsetWriter.doFlush(any())).thenAnswer(invocation -> {
Callback<Void> callback = invocation.getArgument(0);
callback.onCompletion(failure, null);
return null;
});
testCommitFailure(failure, false);
}
@Test
public void testCommitFlushAsyncCallbackFailure() throws Exception {
Exception failure = new RecordTooLargeException();
when(offsetWriter.beginFlush()).thenReturn(true);
// doFlush delegates its callback to the producer,
// which delays completing the callback until commitTransaction
AtomicReference<Callback<Void>> callback = new AtomicReference<>();
when(offsetWriter.doFlush(any())).thenAnswer(invocation -> {
callback.set(invocation.getArgument(0));
return null;
});
doAnswer(invocation -> {
callback.get().onCompletion(failure, null);
return null;
}).when(producer).commitTransaction();
testCommitFailure(failure, true);
}
@Test
public void testCommitTransactionFailure() throws Exception {
Exception failure = new RecordTooLargeException();
when(offsetWriter.beginFlush()).thenReturn(true);
doThrow(failure).when(producer).commitTransaction();
testCommitFailure(failure, true);
}
private void testCommitFailure(Exception commitException, boolean executeCommit) throws Exception {
createWorkerTask();
// Unlike the standard WorkerSourceTask class, this one fails permanently when offset commits don't succeed
final CountDownLatch taskFailure = new CountDownLatch(1);
final AtomicReference<Exception> taskException = new AtomicReference<>();
doAnswer(invocation -> {
taskFailure.countDown();
taskException.set(invocation.getArgument(1));
return null;
}).when(statusListener).onFailure(eq(taskId), any());
expectSuccessfulSends();
startTaskThread();
ConcurrencyUtils.awaitLatch(taskFailure, "task did not fail in time");
awaitShutdown();
assertEquals(commitException, taskException.get().getCause());
verifySends();
verifyPossibleTopicCreation();
verify(producer).beginTransaction();
if (executeCommit) {
verify(producer).commitTransaction();
}
verify(offsetWriter).cancelFlush();
verifyPreflight();
verifyStartup();
verifyShutdown(true, false);
}
@Test
public void testSendRecordsRetries() {
createWorkerTask();
// Differentiate only by Kafka partition so we can reuse conversion expectations
SourceRecord record1 = new SourceRecord(PARTITION, offset(1), TOPIC, 1, KEY_SCHEMA, KEY, RECORD_SCHEMA, VALUE_1);
SourceRecord record2 = new SourceRecord(PARTITION, offset(2), TOPIC, 2, KEY_SCHEMA, KEY, RECORD_SCHEMA, VALUE_1);
SourceRecord record3 = new SourceRecord(PARTITION, offset(3), TOPIC, 3, KEY_SCHEMA, KEY, RECORD_SCHEMA, VALUE_1);
expectPossibleTopicCreation();
expectTaskGetTopic();
expectApplyTransformationChain();
expectConvertHeadersAndKeyValue();
// We're trying to send three records
workerTask.toSend = Arrays.asList(record1, record2, record3);
OngoingStubbing<Future<RecordMetadata>> producerSend = when(producer.send(any(), any()));
// The first one is sent successfully
producerSend = expectSuccessfulSend(producerSend);
// The second one encounters a retriable failure
producerSend = expectSynchronousFailedSend(producerSend, new org.apache.kafka.common.errors.TimeoutException("retriable sync failure"));
// All subsequent sends (which should include a retry of the second record and an initial try for the third) succeed
expectSuccessfulSend(producerSend);
assertFalse(workerTask.sendRecords());
assertEquals(Arrays.asList(record2, record3), workerTask.toSend);
verify(producer).beginTransaction();
// When using poll-based transaction boundaries, we do not commit transactions while retrying delivery for a batch
verify(producer, never()).commitTransaction();
verifySends(2);
verifyPossibleTopicCreation();
// Next they all succeed
assertTrue(workerTask.sendRecords());
assertNull(workerTask.toSend);
// After the entire batch is successfully dispatched to the producer, we can finally commit the transaction
verify(producer, times(1)).commitTransaction();
verifySends(4);
verify(offsetWriter).offset(PARTITION, offset(1));
verify(offsetWriter).offset(PARTITION, offset(2));
verify(offsetWriter).offset(PARTITION, offset(3));
}
@Test
public void testSendRecordsProducerSendFailsImmediately() {
createWorkerTask();
SourceRecord record1 = new SourceRecord(PARTITION, OFFSET, TOPIC, 1, KEY_SCHEMA, KEY, RECORD_SCHEMA, VALUE_1);
SourceRecord record2 = new SourceRecord(PARTITION, OFFSET, TOPIC, 2, KEY_SCHEMA, KEY, RECORD_SCHEMA, VALUE_1);
expectPossibleTopicCreation();
expectConvertHeadersAndKeyValue();
expectApplyTransformationChain();
when(producer.send(any(), any()))
.thenThrow(new KafkaException("Producer closed while send in progress", new InvalidTopicException(TOPIC)));
workerTask.toSend = Arrays.asList(record1, record2);
assertThrows(ConnectException.class, workerTask::sendRecords);
verify(producer).beginTransaction();
verify(producer).send(any(), any());
verify(offsetWriter, never()).offset(any(), any());
verifyPossibleTopicCreation();
}
@Test
public void testSlowTaskStart() throws Exception {
final CountDownLatch startupLatch = new CountDownLatch(1);
final CountDownLatch finishStartupLatch = new CountDownLatch(1);
createWorkerTask();
doAnswer(invocation -> {
startupLatch.countDown();
ConcurrencyUtils.awaitLatch(finishStartupLatch, "task was not allowed to finish startup in time");
return null;
}).when(sourceTask).start(eq(TASK_PROPS));
when(offsetWriter.beginFlush()).thenReturn(false);
startTaskThread();
// Stopping immediately while the other thread has work to do should result in no polling, no offset commits,
// exiting the work thread immediately, and the stop() method will be invoked in the background thread since it
// cannot be invoked immediately in the thread trying to stop the task.
ConcurrencyUtils.awaitLatch(startupLatch, "task did not start up in time");
workerTask.stop();
finishStartupLatch.countDown();
awaitShutdown(false);
verify(sourceTask, never()).poll();
// task commit called on shutdown
verifyTransactions(1, 0);
verifySends(0);
verifyPreflight();
verifyStartup();
verifyCleanShutdown();
}
@Test
public void testCancel() {