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 EndlessConsumer endlessConsumer;
75 KafkaProducer<Bytes, Bytes> testRecordProducer;
76 KafkaConsumer<Bytes, Bytes> offsetConsumer;
77 Map<TopicPartition, Long> oldOffsets;
80 final RecordGenerator recordGenerator;
81 final Consumer<ProducerRecord<Bytes, Bytes>> messageSender;
83 public GenericApplicationTests(RecordGenerator recordGenerator)
85 this.recordGenerator = recordGenerator;
86 this.messageSender = (record) -> sendMessage(record);
93 void commitsCurrentOffsetsOnSuccess() throws Exception
95 recordGenerator.generate(false, false, messageSender);
97 int numberOfGeneratedMessages = recordGenerator.getNumberOfMessages();
99 await(numberOfGeneratedMessages + " records received")
100 .atMost(Duration.ofSeconds(30))
101 .pollInterval(Duration.ofSeconds(1))
102 .until(() -> recordHandler.receivedMessages >= numberOfGeneratedMessages);
104 await("Offsets committed")
105 .atMost(Duration.ofSeconds(10))
106 .pollInterval(Duration.ofSeconds(1))
109 checkSeenOffsetsForProgress();
110 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
113 assertThat(endlessConsumer.running())
114 .describedAs("Consumer should still be running")
117 endlessConsumer.stop();
118 recordGenerator.assertBusinessLogic();
122 @SkipWhenErrorCannotBeGenerated(poisonPill = true)
123 void commitsOffsetOfErrorForReprocessingOnDeserializationError()
125 recordGenerator.generate(true, false, messageSender);
127 int numberOfValidMessages =
128 recordGenerator.getNumberOfMessages() -
129 recordGenerator.getNumberOfPoisonPills();
131 await(numberOfValidMessages + " records received")
132 .atMost(Duration.ofSeconds(30))
133 .pollInterval(Duration.ofSeconds(1))
134 .until(() -> recordHandler.receivedMessages >= numberOfValidMessages);
136 await("Offsets committed")
137 .atMost(Duration.ofSeconds(10))
138 .pollInterval(Duration.ofSeconds(1))
141 checkSeenOffsetsForProgress();
142 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
145 assertThat(endlessConsumer.running())
146 .describedAs("Consumer should still be running")
149 endlessConsumer.stop();
150 recordGenerator.assertBusinessLogic();
154 @SkipWhenErrorCannotBeGenerated(logicError = true)
155 void commitsOffsetsOfUnseenRecordsOnLogicError()
157 recordGenerator.generate(false, true, messageSender);
159 int numberOfValidMessages =
160 recordGenerator.getNumberOfMessages() -
161 recordGenerator.getNumberOfLogicErrors();
163 await(numberOfValidMessages + " records received")
164 .atMost(Duration.ofSeconds(30))
165 .pollInterval(Duration.ofSeconds(1))
166 .until(() -> recordHandler.receivedMessages >= numberOfValidMessages);
168 await("Offsets committed")
169 .atMost(Duration.ofSeconds(10))
170 .pollInterval(Duration.ofSeconds(1))
173 checkSeenOffsetsForProgress();
174 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
177 assertThat(endlessConsumer.running())
178 .describedAs("Consumer should still be running")
181 endlessConsumer.stop();
182 recordGenerator.assertBusinessLogic();
186 /** Helper methods for the verification of expectations */
188 void assertSeenOffsetsEqualCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
190 doForCurrentOffsets((tp, offset) ->
192 Long expected = offsetsToCheck.get(tp) + 1;
193 log.debug("Checking, if the offset {} for {} is exactly {}", offset, tp, expected);
195 .describedAs("Committed offset corresponds to the offset of the consumer")
196 .isEqualTo(expected);
200 void assertSeenOffsetsAreBehindCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
202 List<Boolean> isOffsetBehindSeen = new LinkedList<>();
204 doForCurrentOffsets((tp, offset) ->
206 Long expected = offsetsToCheck.get(tp) + 1;
207 log.debug("Checking, if the offset {} for {} is at most {}", offset, tp, expected);
209 .describedAs("Committed offset must be at most equal to the offset of the consumer")
210 .isLessThanOrEqualTo(expected);
211 isOffsetBehindSeen.add(offset < expected);
214 assertThat(isOffsetBehindSeen.stream().reduce(false, (result, next) -> result | next))
215 .describedAs("Committed offsets are behind seen offsets")
219 void checkSeenOffsetsForProgress()
221 // Be sure, that some messages were consumed...!
222 Set<TopicPartition> withProgress = new HashSet<>();
223 partitions().forEach(tp ->
225 Long oldOffset = oldOffsets.get(tp) + 1;
226 Long newOffset = recordHandler.seenOffsets.get(tp) + 1;
227 if (!oldOffset.equals(newOffset))
229 log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
230 withProgress.add(tp);
233 assertThat(withProgress)
234 .describedAs("Some offsets must have changed, compared to the old offset-positions")
239 /** Helper methods for setting up and running the tests */
243 offsetConsumer.assign(partitions());
244 offsetConsumer.seekToEnd(partitions());
245 partitions().forEach(tp ->
247 // seekToEnd() works lazily: it only takes effect on poll()/position()
248 Long offset = offsetConsumer.position(tp);
249 log.info("New position for {}: {}", tp, offset);
251 // The new positions must be commited!
252 offsetConsumer.commitSync();
253 offsetConsumer.unsubscribe();
256 void doForCurrentOffsets(BiConsumer<TopicPartition, Long> consumer)
258 offsetConsumer.assign(partitions());
259 partitions().forEach(tp -> consumer.accept(tp, offsetConsumer.position(tp)));
260 offsetConsumer.unsubscribe();
263 List<TopicPartition> partitions()
267 .range(0, PARTITIONS)
268 .mapToObj(partition -> new TopicPartition(TOPIC, partition))
269 .collect(Collectors.toList());
273 public interface RecordGenerator
278 Consumer<ProducerRecord<Bytes, Bytes>> messageSender);
280 int getNumberOfMessages();
281 int getNumberOfPoisonPills();
282 int getNumberOfLogicErrors();
284 default boolean canGeneratePoisonPill()
289 default boolean canGenerateLogicError()
294 default void assertBusinessLogic()
296 log.debug("No business-logic to assert");
300 void sendMessage(ProducerRecord<Bytes, Bytes> record)
302 testRecordProducer.send(record, (metadata, e) ->
304 if (metadata != null)
308 metadata.partition(),
316 "Exception for {}={}: {}",
329 props = new Properties();
330 props.put("bootstrap.servers", kafkaProperties.getBootstrapServers());
331 props.put("linger.ms", 100);
332 props.put("key.serializer", BytesSerializer.class.getName());
333 props.put("value.serializer", BytesSerializer.class.getName());
334 testRecordProducer = new KafkaProducer<>(props);
336 props = new Properties();
337 props.put("bootstrap.servers", kafkaProperties.getBootstrapServers());
338 props.put("client.id", "OFFSET-CONSUMER");
339 props.put("group.id", kafkaProperties.getConsumer().getGroupId());
340 props.put("key.deserializer", BytesDeserializer.class.getName());
341 props.put("value.deserializer", BytesDeserializer.class.getName());
342 offsetConsumer = new KafkaConsumer<>(props);
344 mongoClient.getDatabase(mongoProperties.getDatabase()).drop();
347 oldOffsets = new HashMap<>();
348 recordHandler.seenOffsets = new HashMap<>();
349 recordHandler.receivedMessages = 0;
351 doForCurrentOffsets((tp, offset) ->
353 oldOffsets.put(tp, offset - 1);
354 recordHandler.seenOffsets.put(tp, offset - 1);
357 endlessConsumer.start();
365 endlessConsumer.stop();
369 log.debug("{}", e.toString());
374 testRecordProducer.close();
375 offsetConsumer.close();
379 log.info("Exception while stopping the consumer: {}", e.toString());
385 @Import(ApplicationConfiguration.class)
386 public static class Configuration
389 public RecordHandler recordHandler(RecordHandler applicationRecordHandler)
391 return new TestRecordHandler(applicationRecordHandler);
394 @Bean(destroyMethod = "close")
395 public org.apache.kafka.clients.consumer.Consumer<String, Message> kafkaConsumer(ConsumerFactory<String, Message> factory)
397 return factory.createConsumer();