1 package de.juplo.kafka;
3 import com.mongodb.client.MongoClient;
4 import lombok.extern.slf4j.Slf4j;
5 import org.apache.kafka.clients.consumer.ConsumerRebalanceListener;
6 import org.apache.kafka.clients.consumer.ConsumerRecord;
7 import org.apache.kafka.clients.consumer.KafkaConsumer;
8 import org.apache.kafka.clients.producer.KafkaProducer;
9 import org.apache.kafka.clients.producer.ProducerRecord;
10 import org.apache.kafka.common.TopicPartition;
11 import org.apache.kafka.common.errors.RecordDeserializationException;
12 import org.apache.kafka.common.serialization.*;
13 import org.apache.kafka.common.utils.Bytes;
14 import org.junit.jupiter.api.*;
15 import org.springframework.beans.factory.annotation.Autowired;
16 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
17 import org.springframework.boot.autoconfigure.mongo.MongoProperties;
18 import org.springframework.boot.test.autoconfigure.data.mongo.AutoConfigureDataMongo;
19 import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer;
20 import org.springframework.boot.test.context.TestConfiguration;
21 import org.springframework.context.annotation.Import;
22 import org.springframework.kafka.test.context.EmbeddedKafka;
23 import org.springframework.test.context.TestPropertySource;
24 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
26 import java.time.Duration;
28 import java.util.concurrent.ExecutorService;
29 import java.util.function.BiConsumer;
30 import java.util.function.Consumer;
31 import java.util.stream.Collectors;
32 import java.util.stream.IntStream;
34 import static de.juplo.kafka.GenericApplicationTests.PARTITIONS;
35 import static de.juplo.kafka.GenericApplicationTests.TOPIC;
36 import static org.assertj.core.api.Assertions.*;
37 import static org.awaitility.Awaitility.*;
40 @SpringJUnitConfig(initializers = ConfigDataApplicationContextInitializer.class)
43 "sumup.adder.bootstrap-server=${spring.embedded.kafka.brokers}",
44 "sumup.adder.topic=" + TOPIC,
45 "sumup.adder.commit-interval=500ms",
46 "spring.mongodb.embedded.version=4.4.13" })
47 @EmbeddedKafka(topics = TOPIC, partitions = PARTITIONS)
48 @EnableAutoConfiguration
49 @AutoConfigureDataMongo
51 abstract class GenericApplicationTests<K, V>
53 public static final String TOPIC = "FOO";
54 public static final int PARTITIONS = 10;
58 KafkaConsumer<K, V> kafkaConsumer;
60 Consumer<ConsumerRecord<K, V>> consumer;
62 ApplicationProperties properties;
64 ExecutorService executor;
66 MongoClient mongoClient;
68 MongoProperties mongoProperties;
70 ConsumerRebalanceListener rebalanceListener;
72 RecordHandler<K, V> recordHandler;
74 KafkaProducer<Bytes, Bytes> testRecordProducer;
75 KafkaConsumer<Bytes, Bytes> offsetConsumer;
76 EndlessConsumer<K, V> endlessConsumer;
77 Map<TopicPartition, Long> oldOffsets;
78 Map<TopicPartition, Long> seenOffsets;
79 Set<ConsumerRecord<K, V>> receivedRecords;
82 final RecordGenerator recordGenerator;
83 final Consumer<ProducerRecord<Bytes, Bytes>> messageSender;
85 public GenericApplicationTests(RecordGenerator recordGenerator)
87 this.recordGenerator = recordGenerator;
88 this.messageSender = (record) -> sendMessage(record);
95 void commitsCurrentOffsetsOnSuccess() throws Exception
97 int numberOfGeneratedMessages =
98 recordGenerator.generate(false, false, messageSender);
100 await(numberOfGeneratedMessages + " records received")
101 .atMost(Duration.ofSeconds(30))
102 .pollInterval(Duration.ofSeconds(1))
103 .until(() -> receivedRecords.size() >= numberOfGeneratedMessages);
105 await("Offsets committed")
106 .atMost(Duration.ofSeconds(10))
107 .pollInterval(Duration.ofSeconds(1))
110 checkSeenOffsetsForProgress();
111 assertSeenOffsetsEqualCommittedOffsets(seenOffsets);
114 assertThatExceptionOfType(IllegalStateException.class)
115 .isThrownBy(() -> endlessConsumer.exitStatus())
116 .describedAs("Consumer should still be running");
118 endlessConsumer.stop();
119 recordGenerator.assertBusinessLogic();
123 @SkipWhenErrorCannotBeGenerated(poisonPill = true)
124 void commitsOffsetOfErrorForReprocessingOnDeserializationError()
126 int numberOfGeneratedMessages =
127 recordGenerator.generate(true, false, messageSender);
129 await("Consumer failed")
130 .atMost(Duration.ofSeconds(30))
131 .pollInterval(Duration.ofSeconds(1))
132 .until(() -> !endlessConsumer.running());
134 checkSeenOffsetsForProgress();
135 assertSeenOffsetsEqualCommittedOffsets(seenOffsets);
137 endlessConsumer.start();
138 await("Consumer failed")
139 .atMost(Duration.ofSeconds(30))
140 .pollInterval(Duration.ofSeconds(1))
141 .until(() -> !endlessConsumer.running());
143 checkSeenOffsetsForProgress();
144 assertSeenOffsetsEqualCommittedOffsets(seenOffsets);
145 assertThat(receivedRecords.size())
146 .describedAs("Received not all sent events")
147 .isLessThan(numberOfGeneratedMessages);
149 assertThatNoException()
150 .describedAs("Consumer should not be running")
151 .isThrownBy(() -> endlessConsumer.exitStatus());
152 assertThat(endlessConsumer.exitStatus())
153 .describedAs("Consumer should have exited abnormally")
154 .containsInstanceOf(RecordDeserializationException.class);
156 recordGenerator.assertBusinessLogic();
160 @SkipWhenErrorCannotBeGenerated(logicError = true)
161 void doesNotCommitOffsetsOnLogicError()
163 int numberOfGeneratedMessages =
164 recordGenerator.generate(false, true, messageSender);
166 await("Consumer failed")
167 .atMost(Duration.ofSeconds(30))
168 .pollInterval(Duration.ofSeconds(1))
169 .until(() -> !endlessConsumer.running());
171 checkSeenOffsetsForProgress();
172 assertSeenOffsetsAreBehindCommittedOffsets(seenOffsets);
174 endlessConsumer.start();
175 await("Consumer failed")
176 .atMost(Duration.ofSeconds(30))
177 .pollInterval(Duration.ofSeconds(1))
178 .until(() -> !endlessConsumer.running());
180 assertSeenOffsetsAreBehindCommittedOffsets(seenOffsets);
182 assertThatNoException()
183 .describedAs("Consumer should not be running")
184 .isThrownBy(() -> endlessConsumer.exitStatus());
185 assertThat(endlessConsumer.exitStatus())
186 .describedAs("Consumer should have exited abnormally")
187 .containsInstanceOf(RuntimeException.class);
189 recordGenerator.assertBusinessLogic();
193 /** Helper methods for the verification of expectations */
195 void assertSeenOffsetsEqualCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
197 doForCurrentOffsets((tp, offset) ->
199 Long expected = offsetsToCheck.get(tp) + 1;
200 log.debug("Checking, if the offset {} for {} is exactly {}", offset, tp, expected);
202 .describedAs("Committed offset corresponds to the offset of the consumer")
203 .isEqualTo(expected);
207 void assertSeenOffsetsAreBehindCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
209 List<Boolean> isOffsetBehindSeen = new LinkedList<>();
211 doForCurrentOffsets((tp, offset) ->
213 Long expected = offsetsToCheck.get(tp) + 1;
214 log.debug("Checking, if the offset {} for {} is at most {}", offset, tp, expected);
216 .describedAs("Committed offset must be at most equal to the offset of the consumer")
217 .isLessThanOrEqualTo(expected);
218 isOffsetBehindSeen.add(offset < expected);
221 assertThat(isOffsetBehindSeen.stream().reduce(false, (result, next) -> result | next))
222 .describedAs("Committed offsets are behind seen offsets")
226 void checkSeenOffsetsForProgress()
228 // Be sure, that some messages were consumed...!
229 Set<TopicPartition> withProgress = new HashSet<>();
230 partitions().forEach(tp ->
232 Long oldOffset = oldOffsets.get(tp) + 1;
233 Long newOffset = seenOffsets.get(tp) + 1;
234 if (!oldOffset.equals(newOffset))
236 log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
237 withProgress.add(tp);
240 assertThat(withProgress)
241 .describedAs("Some offsets must have changed, compared to the old offset-positions")
246 /** Helper methods for setting up and running the tests */
250 offsetConsumer.assign(partitions());
251 offsetConsumer.seekToEnd(partitions());
252 partitions().forEach(tp ->
254 // seekToEnd() works lazily: it only takes effect on poll()/position()
255 Long offset = offsetConsumer.position(tp);
256 log.info("New position for {}: {}", tp, offset);
258 // The new positions must be commited!
259 offsetConsumer.commitSync();
260 offsetConsumer.unsubscribe();
263 void doForCurrentOffsets(BiConsumer<TopicPartition, Long> consumer)
265 offsetConsumer.assign(partitions());
266 partitions().forEach(tp -> consumer.accept(tp, offsetConsumer.position(tp)));
267 offsetConsumer.unsubscribe();
270 List<TopicPartition> partitions()
274 .range(0, PARTITIONS)
275 .mapToObj(partition -> new TopicPartition(TOPIC, partition))
276 .collect(Collectors.toList());
280 public interface RecordGenerator
285 Consumer<ProducerRecord<Bytes, Bytes>> messageSender);
287 default boolean canGeneratePoisonPill()
292 default boolean canGenerateLogicError()
297 default void assertBusinessLogic()
299 log.debug("No business-logic to assert");
303 void sendMessage(ProducerRecord<Bytes, Bytes> record)
305 testRecordProducer.send(record, (metadata, e) ->
307 if (metadata != null)
311 metadata.partition(),
319 "Exception for {}={}: {}",
332 props = new Properties();
333 props.put("bootstrap.servers", properties.getBootstrapServer());
334 props.put("linger.ms", 100);
335 props.put("key.serializer", BytesSerializer.class.getName());
336 props.put("value.serializer", BytesSerializer.class.getName());
337 testRecordProducer = new KafkaProducer<>(props);
339 props = new Properties();
340 props.put("bootstrap.servers", properties.getBootstrapServer());
341 props.put("client.id", "OFFSET-CONSUMER");
342 props.put("group.id", properties.getGroupId());
343 props.put("key.deserializer", BytesDeserializer.class.getName());
344 props.put("value.deserializer", BytesDeserializer.class.getName());
345 offsetConsumer = new KafkaConsumer<>(props);
347 mongoClient.getDatabase(mongoProperties.getDatabase()).drop();
350 oldOffsets = new HashMap<>();
351 seenOffsets = new HashMap<>();
352 receivedRecords = new HashSet<>();
354 doForCurrentOffsets((tp, offset) ->
356 oldOffsets.put(tp, offset - 1);
357 seenOffsets.put(tp, offset - 1);
360 TestRecordHandler<K, V> captureOffsetAndExecuteTestHandler =
361 new TestRecordHandler<K, V>(recordHandler)
364 public void onNewRecord(ConsumerRecord<K, V> record)
367 new TopicPartition(record.topic(), record.partition()),
369 receivedRecords.add(record);
374 new EndlessConsumer<>(
376 properties.getClientId(),
377 properties.getTopic(),
380 captureOffsetAndExecuteTestHandler);
382 endlessConsumer.start();
390 testRecordProducer.close();
391 offsetConsumer.close();
395 log.info("Exception while stopping the consumer: {}", e.toString());
401 @Import(ApplicationConfiguration.class)
402 public static class Configuration