1 package de.juplo.kafka;
3 import com.mongodb.client.MongoClient;
4 import lombok.extern.slf4j.Slf4j;
5 import org.apache.kafka.clients.consumer.KafkaConsumer;
6 import org.apache.kafka.clients.producer.KafkaProducer;
7 import org.apache.kafka.clients.producer.ProducerRecord;
8 import org.apache.kafka.common.TopicPartition;
9 import org.apache.kafka.common.serialization.*;
10 import org.apache.kafka.common.utils.Bytes;
11 import org.junit.jupiter.api.*;
12 import org.springframework.beans.factory.annotation.Autowired;
13 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
14 import org.springframework.boot.autoconfigure.kafka.KafkaProperties;
15 import org.springframework.boot.autoconfigure.mongo.MongoProperties;
16 import org.springframework.boot.test.autoconfigure.data.mongo.AutoConfigureDataMongo;
17 import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer;
18 import org.springframework.boot.test.context.TestConfiguration;
19 import org.springframework.context.annotation.Bean;
20 import org.springframework.context.annotation.Import;
21 import org.springframework.kafka.config.KafkaListenerEndpointRegistry;
22 import org.springframework.kafka.core.ConsumerFactory;
23 import org.springframework.kafka.test.context.EmbeddedKafka;
24 import org.springframework.test.context.TestPropertySource;
25 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
27 import java.time.Duration;
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 "spring.kafka.bootstrap-servers=${spring.embedded.kafka.brokers}",
44 "spring.kafka.producer.bootstrap-servers=${spring.embedded.kafka.brokers}",
45 "sumup.adder.topic=" + TOPIC,
46 "spring.kafka.consumer.auto-commit-interval=500ms",
47 "spring.mongodb.embedded.version=4.4.13" })
48 @EmbeddedKafka(topics = TOPIC, partitions = PARTITIONS)
49 @EnableAutoConfiguration
50 @AutoConfigureDataMongo
52 abstract class GenericApplicationTests<K, V>
54 public static final String TOPIC = "FOO";
55 public static final int PARTITIONS = 10;
59 org.apache.kafka.clients.consumer.Consumer<K, V> kafkaConsumer;
61 KafkaProperties kafkaProperties;
63 ApplicationProperties applicationProperties;
65 MongoClient mongoClient;
67 MongoProperties mongoProperties;
69 KafkaListenerEndpointRegistry kafkaListenerEndpointRegistry;
71 TestRecordHandler recordHandler;
73 DeadLetterTopicConsumer deadLetterTopicConsumer;
75 EndlessConsumer endlessConsumer;
77 KafkaProducer<Bytes, Bytes> testRecordProducer;
78 KafkaConsumer<Bytes, Bytes> offsetConsumer;
79 Map<TopicPartition, Long> oldOffsets;
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 recordGenerator.generate(false, false, messageSender);
99 int numberOfGeneratedMessages = recordGenerator.getNumberOfMessages();
101 await(numberOfGeneratedMessages + " records received")
102 .atMost(Duration.ofSeconds(30))
103 .pollInterval(Duration.ofSeconds(1))
104 .until(() -> recordHandler.receivedMessages >= numberOfGeneratedMessages);
106 await("Offsets committed")
107 .atMost(Duration.ofSeconds(10))
108 .pollInterval(Duration.ofSeconds(1))
111 checkSeenOffsetsForProgress();
112 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
115 assertThat(endlessConsumer.running())
116 .describedAs("Consumer should still be running")
119 endlessConsumer.stop();
120 recordGenerator.assertBusinessLogic();
124 @SkipWhenErrorCannotBeGenerated(poisonPill = true)
125 void commitsOffsetOfErrorForReprocessingOnDeserializationError()
127 recordGenerator.generate(true, false, messageSender);
129 int numberOfValidMessages =
130 recordGenerator.getNumberOfMessages() -
131 recordGenerator.getNumberOfPoisonPills();
133 await(numberOfValidMessages + " records received")
134 .atMost(Duration.ofSeconds(30))
135 .pollInterval(Duration.ofSeconds(1))
136 .until(() -> recordHandler.receivedMessages >= numberOfValidMessages);
137 await(recordGenerator.getNumberOfPoisonPills() + " poison-pills received")
138 .atMost(Duration.ofSeconds(30))
139 .pollInterval(Duration.ofSeconds(1))
140 .until(() -> deadLetterTopicConsumer.messages.size() == recordGenerator.getNumberOfPoisonPills());
142 await("Offsets committed")
143 .atMost(Duration.ofSeconds(10))
144 .pollInterval(Duration.ofSeconds(1))
147 checkSeenOffsetsForProgress();
148 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
151 assertThat(endlessConsumer.running())
152 .describedAs("Consumer should still be running")
155 endlessConsumer.stop();
156 recordGenerator.assertBusinessLogic();
160 @SkipWhenErrorCannotBeGenerated(logicError = true)
161 void commitsOffsetsOfUnseenRecordsOnLogicError()
163 recordGenerator.generate(false, true, messageSender);
165 int numberOfValidMessages =
166 recordGenerator.getNumberOfMessages() -
167 recordGenerator.getNumberOfLogicErrors();
169 await(numberOfValidMessages + " records received")
170 .atMost(Duration.ofSeconds(30))
171 .pollInterval(Duration.ofSeconds(1))
172 .until(() -> recordHandler.receivedMessages >= numberOfValidMessages);
173 await(recordGenerator.getNumberOfLogicErrors() + " logic-errors received")
174 .atMost(Duration.ofSeconds(30))
175 .pollInterval(Duration.ofSeconds(1))
176 .until(() -> deadLetterTopicConsumer.messages.size() == recordGenerator.getNumberOfLogicErrors());
178 await("Offsets committed")
179 .atMost(Duration.ofSeconds(10))
180 .pollInterval(Duration.ofSeconds(1))
183 checkSeenOffsetsForProgress();
184 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
187 assertThat(endlessConsumer.running())
188 .describedAs("Consumer should still be running")
191 endlessConsumer.stop();
192 recordGenerator.assertBusinessLogic();
196 /** Helper methods for the verification of expectations */
198 void assertSeenOffsetsEqualCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
200 doForCurrentOffsets((tp, offset) ->
202 Long expected = offsetsToCheck.get(tp) + 1;
203 log.debug("Checking, if the offset {} for {} is exactly {}", offset, tp, expected);
205 .describedAs("Committed offset corresponds to the offset of the consumer")
206 .isEqualTo(expected);
210 void assertSeenOffsetsAreBehindCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
212 List<Boolean> isOffsetBehindSeen = new LinkedList<>();
214 doForCurrentOffsets((tp, offset) ->
216 Long expected = offsetsToCheck.get(tp) + 1;
217 log.debug("Checking, if the offset {} for {} is at most {}", offset, tp, expected);
219 .describedAs("Committed offset must be at most equal to the offset of the consumer")
220 .isLessThanOrEqualTo(expected);
221 isOffsetBehindSeen.add(offset < expected);
224 assertThat(isOffsetBehindSeen.stream().reduce(false, (result, next) -> result | next))
225 .describedAs("Committed offsets are behind seen offsets")
229 void checkSeenOffsetsForProgress()
231 // Be sure, that some messages were consumed...!
232 Set<TopicPartition> withProgress = new HashSet<>();
233 partitions().forEach(tp ->
235 Long oldOffset = oldOffsets.get(tp) + 1;
236 Long newOffset = recordHandler.seenOffsets.get(tp) + 1;
237 if (!oldOffset.equals(newOffset))
239 log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
240 withProgress.add(tp);
243 assertThat(withProgress)
244 .describedAs("Some offsets must have changed, compared to the old offset-positions")
249 /** Helper methods for setting up and running the tests */
253 offsetConsumer.assign(partitions());
254 offsetConsumer.seekToEnd(partitions());
255 partitions().forEach(tp ->
257 // seekToEnd() works lazily: it only takes effect on poll()/position()
258 Long offset = offsetConsumer.position(tp);
259 log.info("New position for {}: {}", tp, offset);
261 // The new positions must be commited!
262 offsetConsumer.commitSync();
263 offsetConsumer.unsubscribe();
266 void doForCurrentOffsets(BiConsumer<TopicPartition, Long> consumer)
268 offsetConsumer.assign(partitions());
269 partitions().forEach(tp -> consumer.accept(tp, offsetConsumer.position(tp)));
270 offsetConsumer.unsubscribe();
273 List<TopicPartition> partitions()
277 .range(0, PARTITIONS)
278 .mapToObj(partition -> new TopicPartition(TOPIC, partition))
279 .collect(Collectors.toList());
283 public interface RecordGenerator
288 Consumer<ProducerRecord<Bytes, Bytes>> messageSender);
290 int getNumberOfMessages();
291 int getNumberOfPoisonPills();
292 int getNumberOfLogicErrors();
294 default boolean canGeneratePoisonPill()
299 default boolean canGenerateLogicError()
304 default void assertBusinessLogic()
306 log.debug("No business-logic to assert");
310 void sendMessage(ProducerRecord<Bytes, Bytes> record)
312 testRecordProducer.send(record, (metadata, e) ->
314 if (metadata != null)
318 metadata.partition(),
326 "Exception for {}={}: {}",
339 props = new Properties();
340 props.put("bootstrap.servers", kafkaProperties.getBootstrapServers());
341 props.put("linger.ms", 100);
342 props.put("key.serializer", BytesSerializer.class.getName());
343 props.put("value.serializer", BytesSerializer.class.getName());
344 testRecordProducer = new KafkaProducer<>(props);
346 props = new Properties();
347 props.put("bootstrap.servers", kafkaProperties.getBootstrapServers());
348 props.put("client.id", "OFFSET-CONSUMER");
349 props.put("group.id", kafkaProperties.getConsumer().getGroupId());
350 props.put("key.deserializer", BytesDeserializer.class.getName());
351 props.put("value.deserializer", BytesDeserializer.class.getName());
352 offsetConsumer = new KafkaConsumer<>(props);
354 mongoClient.getDatabase(mongoProperties.getDatabase()).drop();
357 oldOffsets = new HashMap<>();
358 recordHandler.seenOffsets = new HashMap<>();
359 recordHandler.receivedMessages = 0;
361 deadLetterTopicConsumer.messages.clear();
363 doForCurrentOffsets((tp, offset) ->
365 oldOffsets.put(tp, offset - 1);
366 recordHandler.seenOffsets.put(tp, offset - 1);
369 endlessConsumer.start();
377 endlessConsumer.stop();
381 log.debug("{}", e.toString());
386 testRecordProducer.close();
387 offsetConsumer.close();
391 log.info("Exception while stopping the consumer: {}", e.toString());
397 @Import(ApplicationConfiguration.class)
398 public static class Configuration
401 public RecordHandler recordHandler(RecordHandler applicationRecordHandler)
403 return new TestRecordHandler(applicationRecordHandler);
406 @Bean(destroyMethod = "close")
407 public org.apache.kafka.clients.consumer.Consumer<String, Message> kafkaConsumer(ConsumerFactory<String, Message> factory)
409 return factory.createConsumer();
413 public DeadLetterTopicConsumer deadLetterTopicConsumer()
415 return new DeadLetterTopicConsumer();