1 package de.juplo.kafka;
3 import com.mongodb.client.MongoClient;
4 import lombok.extern.slf4j.Slf4j;
5 import org.apache.kafka.clients.consumer.ConsumerRecord;
6 import org.apache.kafka.clients.consumer.KafkaConsumer;
7 import org.apache.kafka.clients.producer.KafkaProducer;
8 import org.apache.kafka.clients.producer.ProducerRecord;
9 import org.apache.kafka.common.TopicPartition;
10 import org.apache.kafka.common.errors.RecordDeserializationException;
11 import org.apache.kafka.common.serialization.*;
12 import org.apache.kafka.common.utils.Bytes;
13 import org.junit.jupiter.api.*;
14 import org.springframework.beans.factory.annotation.Autowired;
15 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
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.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.function.BiConsumer;
29 import java.util.function.Consumer;
30 import java.util.stream.Collectors;
31 import java.util.stream.IntStream;
33 import static de.juplo.kafka.GenericApplicationTests.PARTITIONS;
34 import static de.juplo.kafka.GenericApplicationTests.TOPIC;
35 import static org.assertj.core.api.Assertions.*;
36 import static org.awaitility.Awaitility.*;
39 @SpringJUnitConfig(initializers = ConfigDataApplicationContextInitializer.class)
42 "sumup.adder.bootstrap-server=${spring.embedded.kafka.brokers}",
43 "sumup.adder.topic=" + TOPIC,
44 "sumup.adder.commit-interval=500ms",
45 "spring.mongodb.embedded.version=4.4.13" })
46 @EmbeddedKafka(topics = TOPIC, partitions = PARTITIONS)
47 @EnableAutoConfiguration
48 @AutoConfigureDataMongo
50 abstract class GenericApplicationTests<K, V>
52 public static final String TOPIC = "FOO";
53 public static final int PARTITIONS = 10;
57 org.apache.kafka.clients.consumer.Consumer<K, V> kafkaConsumer;
59 Consumer<ConsumerRecord<K, V>> consumer;
61 ApplicationProperties applicationProperties;
63 MongoClient mongoClient;
65 MongoProperties mongoProperties;
67 RebalanceListener rebalanceListener;
69 TestRecordHandler<K, V> recordHandler;
71 EndlessConsumer<K, V> endlessConsumer;
73 KafkaProducer<Bytes, Bytes> testRecordProducer;
74 KafkaConsumer<Bytes, Bytes> offsetConsumer;
75 Map<TopicPartition, Long> oldOffsets;
78 final RecordGenerator recordGenerator;
79 final Consumer<ProducerRecord<Bytes, Bytes>> messageSender;
81 public GenericApplicationTests(RecordGenerator recordGenerator)
83 this.recordGenerator = recordGenerator;
84 this.messageSender = (record) -> sendMessage(record);
91 void commitsCurrentOffsetsOnSuccess() throws Exception
93 int numberOfGeneratedMessages =
94 recordGenerator.generate(false, false, messageSender);
96 await(numberOfGeneratedMessages + " records received")
97 .atMost(Duration.ofSeconds(30))
98 .pollInterval(Duration.ofSeconds(1))
99 .until(() -> recordHandler.receivedRecords.size() >= numberOfGeneratedMessages);
101 await("Offsets committed")
102 .atMost(Duration.ofSeconds(10))
103 .pollInterval(Duration.ofSeconds(1))
106 checkSeenOffsetsForProgress();
107 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
110 assertThatExceptionOfType(IllegalStateException.class)
111 .isThrownBy(() -> endlessConsumer.exitStatus())
112 .describedAs("Consumer should still be running");
114 endlessConsumer.stop();
115 recordGenerator.assertBusinessLogic();
119 @SkipWhenErrorCannotBeGenerated(poisonPill = true)
120 void commitsOffsetOfErrorForReprocessingOnDeserializationError()
122 int numberOfGeneratedMessages =
123 recordGenerator.generate(true, false, messageSender);
125 await("Consumer failed")
126 .atMost(Duration.ofSeconds(30))
127 .pollInterval(Duration.ofSeconds(1))
128 .until(() -> !endlessConsumer.running());
130 checkSeenOffsetsForProgress();
131 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
133 endlessConsumer.start();
134 await("Consumer failed")
135 .atMost(Duration.ofSeconds(30))
136 .pollInterval(Duration.ofSeconds(1))
137 .until(() -> !endlessConsumer.running());
139 checkSeenOffsetsForProgress();
140 assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
141 assertThat(recordHandler.receivedRecords.size())
142 .describedAs("Received not all sent events")
143 .isLessThan(numberOfGeneratedMessages);
145 assertThatNoException()
146 .describedAs("Consumer should not be running")
147 .isThrownBy(() -> endlessConsumer.exitStatus());
148 assertThat(endlessConsumer.exitStatus())
149 .describedAs("Consumer should have exited abnormally")
150 .containsInstanceOf(RecordDeserializationException.class);
152 recordGenerator.assertBusinessLogic();
156 @SkipWhenErrorCannotBeGenerated(logicError = true)
157 void doesNotCommitOffsetsOnLogicError()
159 int numberOfGeneratedMessages =
160 recordGenerator.generate(false, true, messageSender);
162 await("Consumer failed")
163 .atMost(Duration.ofSeconds(30))
164 .pollInterval(Duration.ofSeconds(1))
165 .until(() -> !endlessConsumer.running());
167 checkSeenOffsetsForProgress();
168 assertSeenOffsetsAreBehindCommittedOffsets(recordHandler.seenOffsets);
170 endlessConsumer.start();
171 await("Consumer failed")
172 .atMost(Duration.ofSeconds(30))
173 .pollInterval(Duration.ofSeconds(1))
174 .until(() -> !endlessConsumer.running());
176 assertSeenOffsetsAreBehindCommittedOffsets(recordHandler.seenOffsets);
178 assertThatNoException()
179 .describedAs("Consumer should not be running")
180 .isThrownBy(() -> endlessConsumer.exitStatus());
181 assertThat(endlessConsumer.exitStatus())
182 .describedAs("Consumer should have exited abnormally")
183 .containsInstanceOf(RuntimeException.class);
185 recordGenerator.assertBusinessLogic();
189 /** Helper methods for the verification of expectations */
191 void assertSeenOffsetsEqualCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
193 doForCurrentOffsets((tp, offset) ->
195 Long expected = offsetsToCheck.get(tp) + 1;
196 log.debug("Checking, if the offset {} for {} is exactly {}", offset, tp, expected);
198 .describedAs("Committed offset corresponds to the offset of the consumer")
199 .isEqualTo(expected);
203 void assertSeenOffsetsAreBehindCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
205 List<Boolean> isOffsetBehindSeen = new LinkedList<>();
207 doForCurrentOffsets((tp, offset) ->
209 Long expected = offsetsToCheck.get(tp) + 1;
210 log.debug("Checking, if the offset {} for {} is at most {}", offset, tp, expected);
212 .describedAs("Committed offset must be at most equal to the offset of the consumer")
213 .isLessThanOrEqualTo(expected);
214 isOffsetBehindSeen.add(offset < expected);
217 assertThat(isOffsetBehindSeen.stream().reduce(false, (result, next) -> result | next))
218 .describedAs("Committed offsets are behind seen offsets")
222 void checkSeenOffsetsForProgress()
224 // Be sure, that some messages were consumed...!
225 Set<TopicPartition> withProgress = new HashSet<>();
226 partitions().forEach(tp ->
228 Long oldOffset = oldOffsets.get(tp) + 1;
229 Long newOffset = recordHandler.seenOffsets.get(tp) + 1;
230 if (!oldOffset.equals(newOffset))
232 log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
233 withProgress.add(tp);
236 assertThat(withProgress)
237 .describedAs("Some offsets must have changed, compared to the old offset-positions")
242 /** Helper methods for setting up and running the tests */
246 offsetConsumer.assign(partitions());
247 offsetConsumer.seekToEnd(partitions());
248 partitions().forEach(tp ->
250 // seekToEnd() works lazily: it only takes effect on poll()/position()
251 Long offset = offsetConsumer.position(tp);
252 log.info("New position for {}: {}", tp, offset);
254 // The new positions must be commited!
255 offsetConsumer.commitSync();
256 offsetConsumer.unsubscribe();
259 void doForCurrentOffsets(BiConsumer<TopicPartition, Long> consumer)
261 offsetConsumer.assign(partitions());
262 partitions().forEach(tp -> consumer.accept(tp, offsetConsumer.position(tp)));
263 offsetConsumer.unsubscribe();
266 List<TopicPartition> partitions()
270 .range(0, PARTITIONS)
271 .mapToObj(partition -> new TopicPartition(TOPIC, partition))
272 .collect(Collectors.toList());
276 public interface RecordGenerator
281 Consumer<ProducerRecord<Bytes, Bytes>> messageSender);
283 default boolean canGeneratePoisonPill()
288 default boolean canGenerateLogicError()
293 default void assertBusinessLogic()
295 log.debug("No business-logic to assert");
299 void sendMessage(ProducerRecord<Bytes, Bytes> record)
301 testRecordProducer.send(record, (metadata, e) ->
303 if (metadata != null)
307 metadata.partition(),
315 "Exception for {}={}: {}",
328 props = new Properties();
329 props.put("bootstrap.servers", applicationProperties.getBootstrapServer());
330 props.put("linger.ms", 100);
331 props.put("key.serializer", BytesSerializer.class.getName());
332 props.put("value.serializer", BytesSerializer.class.getName());
333 testRecordProducer = new KafkaProducer<>(props);
335 props = new Properties();
336 props.put("bootstrap.servers", applicationProperties.getBootstrapServer());
337 props.put("client.id", "OFFSET-CONSUMER");
338 props.put("group.id", applicationProperties.getGroupId());
339 props.put("key.deserializer", BytesDeserializer.class.getName());
340 props.put("value.deserializer", BytesDeserializer.class.getName());
341 offsetConsumer = new KafkaConsumer<>(props);
343 mongoClient.getDatabase(mongoProperties.getDatabase()).drop();
346 oldOffsets = new HashMap<>();
347 recordHandler.seenOffsets = new HashMap<>();
348 recordHandler.receivedRecords = new HashSet<>();
350 doForCurrentOffsets((tp, offset) ->
352 oldOffsets.put(tp, offset - 1);
353 recordHandler.seenOffsets.put(tp, offset - 1);
356 endlessConsumer.start();
364 endlessConsumer.stop();
368 log.debug("{}", e.toString());
373 testRecordProducer.close();
374 offsetConsumer.close();
378 log.info("Exception while stopping the consumer: {}", e.toString());
384 @Import(ApplicationConfiguration.class)
385 public static class Configuration
388 public RecordHandler recordHandler(RecordHandler applicationRecordHandler)
390 return new TestRecordHandler(applicationRecordHandler);