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.errors.RecordDeserializationException;
10 import org.apache.kafka.common.serialization.*;
11 import org.apache.kafka.common.utils.Bytes;
12 import org.junit.jupiter.api.*;
13 import org.springframework.beans.factory.annotation.Autowired;
14 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
15 import org.springframework.boot.autoconfigure.kafka.KafkaProperties;
16 import org.springframework.boot.autoconfigure.mongo.MongoProperties;
17 import org.springframework.boot.test.autoconfigure.data.mongo.AutoConfigureDataMongo;
18 import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer;
19 import org.springframework.boot.test.context.TestConfiguration;
20 import org.springframework.context.annotation.Bean;
21 import org.springframework.context.annotation.Import;
22 import org.springframework.kafka.config.KafkaListenerEndpointRegistry;
23 import org.springframework.kafka.core.ConsumerFactory;
24 import org.springframework.kafka.test.context.EmbeddedKafka;
25 import org.springframework.test.context.TestPropertySource;
26 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
28 import java.time.Duration;
30 import java.util.function.BiConsumer;
31 import java.util.function.Consumer;
32 import java.util.stream.Collectors;
33 import java.util.stream.IntStream;
35 import static de.juplo.kafka.GenericApplicationTests.PARTITIONS;
36 import static de.juplo.kafka.GenericApplicationTests.TOPIC;
37 import static org.assertj.core.api.Assertions.*;
38 import static org.awaitility.Awaitility.*;
41 @SpringJUnitConfig(initializers = ConfigDataApplicationContextInitializer.class)
44 "spring.kafka.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 numberOfGeneratedMessages = recordGenerator.getNumberOfMessages();
129 await("Consumer failed")
130 .atMost(Duration.ofSeconds(30))
131 .pollInterval(Duration.ofSeconds(1))
132 .until(() -> !endlessConsumer.running());
134 checkSeenOffsetsForProgress();
135 assertSeenOffsetsEqualCommittedOffsets(recordHandler.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(recordHandler.seenOffsets);
145 assertThat(recordHandler.receivedMessages)
146 .describedAs("Received not all sent events")
147 .isLessThan(numberOfGeneratedMessages);
149 assertThat(endlessConsumer.running())
150 .describedAs("Consumer should have exited")
153 recordGenerator.assertBusinessLogic();
157 @SkipWhenErrorCannotBeGenerated(logicError = true)
158 void commitsOffsetsOfUnseenRecordsOnLogicError()
160 recordGenerator.generate(false, true, messageSender);
162 int numberOfGeneratedMessages = recordGenerator.getNumberOfMessages();
164 await("Consumer failed")
165 .atMost(Duration.ofSeconds(30))
166 .pollInterval(Duration.ofSeconds(1))
167 .until(() -> !endlessConsumer.running());
169 checkSeenOffsetsForProgress();
170 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
172 endlessConsumer.start();
173 await("Consumer failed")
174 .atMost(Duration.ofSeconds(30))
175 .pollInterval(Duration.ofSeconds(1))
176 .until(() -> !endlessConsumer.running());
178 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
180 assertThat(endlessConsumer.running())
181 .describedAs("Consumer should not be running")
184 recordGenerator.assertBusinessLogic();
188 /** Helper methods for the verification of expectations */
190 void assertSeenOffsetsEqualCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
192 doForCurrentOffsets((tp, offset) ->
194 Long expected = offsetsToCheck.get(tp) + 1;
195 log.debug("Checking, if the offset {} for {} is exactly {}", offset, tp, expected);
197 .describedAs("Committed offset corresponds to the offset of the consumer")
198 .isEqualTo(expected);
202 void assertSeenOffsetsAreBehindCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
204 List<Boolean> isOffsetBehindSeen = new LinkedList<>();
206 doForCurrentOffsets((tp, offset) ->
208 Long expected = offsetsToCheck.get(tp) + 1;
209 log.debug("Checking, if the offset {} for {} is at most {}", offset, tp, expected);
211 .describedAs("Committed offset must be at most equal to the offset of the consumer")
212 .isLessThanOrEqualTo(expected);
213 isOffsetBehindSeen.add(offset < expected);
216 assertThat(isOffsetBehindSeen.stream().reduce(false, (result, next) -> result | next))
217 .describedAs("Committed offsets are behind seen offsets")
221 void checkSeenOffsetsForProgress()
223 // Be sure, that some messages were consumed...!
224 Set<TopicPartition> withProgress = new HashSet<>();
225 partitions().forEach(tp ->
227 Long oldOffset = oldOffsets.get(tp) + 1;
228 Long newOffset = recordHandler.seenOffsets.get(tp) + 1;
229 if (!oldOffset.equals(newOffset))
231 log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
232 withProgress.add(tp);
235 assertThat(withProgress)
236 .describedAs("Some offsets must have changed, compared to the old offset-positions")
241 /** Helper methods for setting up and running the tests */
245 offsetConsumer.assign(partitions());
246 offsetConsumer.seekToEnd(partitions());
247 partitions().forEach(tp ->
249 // seekToEnd() works lazily: it only takes effect on poll()/position()
250 Long offset = offsetConsumer.position(tp);
251 log.info("New position for {}: {}", tp, offset);
253 // The new positions must be commited!
254 offsetConsumer.commitSync();
255 offsetConsumer.unsubscribe();
258 void doForCurrentOffsets(BiConsumer<TopicPartition, Long> consumer)
260 offsetConsumer.assign(partitions());
261 partitions().forEach(tp -> consumer.accept(tp, offsetConsumer.position(tp)));
262 offsetConsumer.unsubscribe();
265 List<TopicPartition> partitions()
269 .range(0, PARTITIONS)
270 .mapToObj(partition -> new TopicPartition(TOPIC, partition))
271 .collect(Collectors.toList());
275 public interface RecordGenerator
280 Consumer<ProducerRecord<Bytes, Bytes>> messageSender);
282 int getNumberOfMessages();
283 int getNumberOfPoisonPills();
284 int getNumberOfLogicErrors();
286 default boolean canGeneratePoisonPill()
291 default boolean canGenerateLogicError()
296 default void assertBusinessLogic()
298 log.debug("No business-logic to assert");
302 void sendMessage(ProducerRecord<Bytes, Bytes> record)
304 testRecordProducer.send(record, (metadata, e) ->
306 if (metadata != null)
310 metadata.partition(),
318 "Exception for {}={}: {}",
331 props = new Properties();
332 props.put("bootstrap.servers", kafkaProperties.getBootstrapServers());
333 props.put("linger.ms", 100);
334 props.put("key.serializer", BytesSerializer.class.getName());
335 props.put("value.serializer", BytesSerializer.class.getName());
336 testRecordProducer = new KafkaProducer<>(props);
338 props = new Properties();
339 props.put("bootstrap.servers", kafkaProperties.getBootstrapServers());
340 props.put("client.id", "OFFSET-CONSUMER");
341 props.put("group.id", kafkaProperties.getConsumer().getGroupId());
342 props.put("key.deserializer", BytesDeserializer.class.getName());
343 props.put("value.deserializer", BytesDeserializer.class.getName());
344 offsetConsumer = new KafkaConsumer<>(props);
346 mongoClient.getDatabase(mongoProperties.getDatabase()).drop();
349 oldOffsets = new HashMap<>();
350 recordHandler.seenOffsets = new HashMap<>();
351 recordHandler.receivedMessages = 0;
353 doForCurrentOffsets((tp, offset) ->
355 oldOffsets.put(tp, offset - 1);
356 recordHandler.seenOffsets.put(tp, offset - 1);
359 endlessConsumer.start();
367 endlessConsumer.stop();
371 log.debug("{}", e.toString());
376 testRecordProducer.close();
377 offsetConsumer.close();
381 log.info("Exception while stopping the consumer: {}", e.toString());
387 @Import(ApplicationConfiguration.class)
388 public static class Configuration
391 public RecordHandler recordHandler(RecordHandler applicationRecordHandler)
393 return new TestRecordHandler(applicationRecordHandler);
396 @Bean(destroyMethod = "close")
397 public org.apache.kafka.clients.consumer.Consumer<String, Message> kafkaConsumer(ConsumerFactory<String, Message> factory)
399 return factory.createConsumer();