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.Import;
21 import org.springframework.kafka.test.context.EmbeddedKafka;
22 import org.springframework.test.context.TestPropertySource;
23 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
25 import java.time.Duration;
27 import java.util.concurrent.ExecutorService;
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 KafkaConsumer<K, V> kafkaConsumer;
59 Consumer<ConsumerRecord<K, V>> consumer;
61 ApplicationProperties properties;
63 ExecutorService executor;
65 StateRepository stateRepository;
67 MongoClient mongoClient;
69 MongoProperties mongoProperties;
71 PollIntervalAwareConsumerRebalanceListener rebalanceListener;
73 RecordHandler<K, V> recordHandler;
75 KafkaProducer<Bytes, Bytes> testRecordProducer;
76 KafkaConsumer<Bytes, Bytes> offsetConsumer;
77 EndlessConsumer<K, V> endlessConsumer;
78 Map<TopicPartition, Long> oldOffsets;
79 Map<TopicPartition, Long> newOffsets;
80 Set<ConsumerRecord<K, V>> receivedRecords;
83 final RecordGenerator recordGenerator;
84 final Consumer<ProducerRecord<Bytes, Bytes>> messageSender;
86 public GenericApplicationTests(RecordGenerator recordGenerator)
88 this.recordGenerator = recordGenerator;
89 this.messageSender = (record) -> sendMessage(record);
96 void commitsCurrentOffsetsOnSuccess()
98 int numberOfGeneratedMessages =
99 recordGenerator.generate(false, false, messageSender);
101 await(numberOfGeneratedMessages + " records received")
102 .atMost(Duration.ofSeconds(30))
103 .pollInterval(Duration.ofSeconds(1))
104 .until(() -> receivedRecords.size() >= numberOfGeneratedMessages);
106 await("Offsets committed")
107 .atMost(Duration.ofSeconds(10))
108 .pollInterval(Duration.ofSeconds(1))
111 checkSeenOffsetsForProgress();
112 compareToCommitedOffsets(newOffsets);
115 assertThatExceptionOfType(IllegalStateException.class)
116 .isThrownBy(() -> endlessConsumer.exitStatus())
117 .describedAs("Consumer should still be running");
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 compareToCommitedOffsets(newOffsets);
137 endlessConsumer.start();
138 await("Consumer failed")
139 .atMost(Duration.ofSeconds(30))
140 .pollInterval(Duration.ofSeconds(1))
141 .until(() -> !endlessConsumer.running());
143 checkSeenOffsetsForProgress();
144 compareToCommitedOffsets(newOffsets);
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 compareToCommitedOffsets(oldOffsets);
174 endlessConsumer.start();
175 await("Consumer failed")
176 .atMost(Duration.ofSeconds(30))
177 .pollInterval(Duration.ofSeconds(1))
178 .until(() -> !endlessConsumer.running());
180 checkSeenOffsetsForProgress();
181 compareToCommitedOffsets(oldOffsets);
183 assertThatNoException()
184 .describedAs("Consumer should not be running")
185 .isThrownBy(() -> endlessConsumer.exitStatus());
186 assertThat(endlessConsumer.exitStatus())
187 .describedAs("Consumer should have exited abnormally")
188 .containsInstanceOf(RuntimeException.class);
190 recordGenerator.assertBusinessLogic();
194 /** Helper methods for the verification of expectations */
196 void compareToCommitedOffsets(Map<TopicPartition, Long> offsetsToCheck)
198 doForCurrentOffsets((tp, offset) ->
200 Long expected = offsetsToCheck.get(tp) + 1;
201 log.debug("Checking, if the offset for {} is {}", tp, expected);
203 .describedAs("Committed offset corresponds to the offset of the consumer")
204 .isEqualTo(expected);
208 void checkSeenOffsetsForProgress()
210 // Be sure, that some messages were consumed...!
211 Set<TopicPartition> withProgress = new HashSet<>();
212 partitions().forEach(tp ->
214 Long oldOffset = oldOffsets.get(tp) + 1;
215 Long newOffset = newOffsets.get(tp) + 1;
216 if (!oldOffset.equals(newOffset))
218 log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
219 withProgress.add(tp);
222 assertThat(withProgress)
223 .describedAs("Some offsets must have changed, compared to the old offset-positions")
228 /** Helper methods for setting up and running the tests */
232 offsetConsumer.assign(partitions());
233 partitions().forEach(tp ->
235 Long offset = offsetConsumer.position(tp);
236 log.info("New position for {}: {}", tp, offset);
237 Integer partition = tp.partition();
238 StateDocument document =
240 .findById(partition.toString())
241 .orElse(new StateDocument(partition));
242 document.offset = offset;
243 stateRepository.save(document);
245 offsetConsumer.unsubscribe();
248 void doForCurrentOffsets(BiConsumer<TopicPartition, Long> consumer)
250 partitions().forEach(tp ->
252 String partition = Integer.toString(tp.partition());
253 Optional<Long> offset = stateRepository.findById(partition).map(document -> document.offset);
254 consumer.accept(tp, offset.orElse(0l));
258 List<TopicPartition> partitions()
262 .range(0, PARTITIONS)
263 .mapToObj(partition -> new TopicPartition(TOPIC, partition))
264 .collect(Collectors.toList());
268 public interface RecordGenerator
273 Consumer<ProducerRecord<Bytes, Bytes>> messageSender);
275 default boolean canGeneratePoisonPill()
280 default boolean canGenerateLogicError()
285 default void assertBusinessLogic()
287 log.debug("No business-logic to assert");
291 void sendMessage(ProducerRecord<Bytes, Bytes> record)
293 testRecordProducer.send(record, (metadata, e) ->
295 if (metadata != null)
299 metadata.partition(),
307 "Exception for {}={}: {}",
320 props = new Properties();
321 props.put("bootstrap.servers", properties.getBootstrapServer());
322 props.put("linger.ms", 100);
323 props.put("key.serializer", BytesSerializer.class.getName());
324 props.put("value.serializer", BytesSerializer.class.getName());
325 testRecordProducer = new KafkaProducer<>(props);
327 props = new Properties();
328 props.put("bootstrap.servers", properties.getBootstrapServer());
329 props.put("client.id", "OFFSET-CONSUMER");
330 props.put("group.id", properties.getGroupId());
331 props.put("key.deserializer", BytesDeserializer.class.getName());
332 props.put("value.deserializer", BytesDeserializer.class.getName());
333 offsetConsumer = new KafkaConsumer<>(props);
335 mongoClient.getDatabase(mongoProperties.getDatabase()).drop();
338 oldOffsets = new HashMap<>();
339 newOffsets = new HashMap<>();
340 receivedRecords = new HashSet<>();
342 doForCurrentOffsets((tp, offset) ->
344 oldOffsets.put(tp, offset - 1);
345 newOffsets.put(tp, offset - 1);
348 TestRecordHandler<K, V> captureOffsetAndExecuteTestHandler =
349 new TestRecordHandler<K, V>(recordHandler)
352 public void onNewRecord(ConsumerRecord<K, V> record)
355 new TopicPartition(record.topic(), record.partition()),
357 receivedRecords.add(record);
362 new EndlessConsumer<>(
364 properties.getClientId(),
365 properties.getTopic(),
368 captureOffsetAndExecuteTestHandler);
370 endlessConsumer.start();
378 endlessConsumer.stop();
379 testRecordProducer.close();
380 offsetConsumer.close();
384 log.info("Exception while stopping the consumer: {}", e.toString());
390 @Import(ApplicationConfiguration.class)
391 public static class Configuration