1 package de.juplo.kafka;
3 import lombok.extern.slf4j.Slf4j;
4 import org.apache.kafka.clients.consumer.ConsumerRecord;
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.BytesDeserializer;
10 import org.apache.kafka.common.serialization.BytesSerializer;
11 import org.apache.kafka.common.serialization.LongSerializer;
12 import org.apache.kafka.common.serialization.StringSerializer;
13 import org.apache.kafka.common.utils.Bytes;
14 import org.junit.jupiter.api.*;
15 import org.springframework.beans.factory.annotation.Autowired;
16 import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer;
17 import org.springframework.boot.test.context.TestConfiguration;
18 import org.springframework.context.annotation.Bean;
19 import org.springframework.context.annotation.Import;
20 import org.springframework.kafka.test.context.EmbeddedKafka;
21 import org.springframework.test.context.TestPropertySource;
22 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
24 import java.time.Duration;
26 import java.util.concurrent.ExecutionException;
27 import java.util.concurrent.ExecutorService;
28 import java.util.function.BiConsumer;
29 import java.util.function.Consumer;
30 import java.util.function.Function;
31 import java.util.stream.Collectors;
32 import java.util.stream.IntStream;
34 import static de.juplo.kafka.ApplicationTests.PARTITIONS;
35 import static de.juplo.kafka.ApplicationTests.TOPIC;
36 import static org.assertj.core.api.Assertions.assertThat;
37 import static org.awaitility.Awaitility.*;
40 @SpringJUnitConfig(initializers = ConfigDataApplicationContextInitializer.class)
41 @TestMethodOrder(MethodOrderer.OrderAnnotation.class)
44 "consumer.bootstrap-server=${spring.embedded.kafka.brokers}",
45 "consumer.topic=" + TOPIC })
46 @EmbeddedKafka(topics = TOPIC, partitions = PARTITIONS)
48 class ApplicationTests
50 public static final String TOPIC = "FOO";
51 public static final int PARTITIONS = 10;
54 StringSerializer stringSerializer = new StringSerializer();
55 LongSerializer longSerializer = new LongSerializer();
58 KafkaProducer<String, Bytes> kafkaProducer;
60 KafkaConsumer<String, Long> kafkaConsumer;
62 KafkaConsumer<Bytes, Bytes> offsetConsumer;
64 ApplicationProperties properties;
66 ExecutorService executor;
68 Consumer<ConsumerRecord<String, Long>> testHandler;
69 EndlessConsumer<String, Long> endlessConsumer;
70 Map<TopicPartition, Long> oldOffsets;
71 Map<TopicPartition, Long> newOffsets;
72 Set<ConsumerRecord<String, Long>> receivedRecords;
78 @Order(1) // << The poistion pill is not skipped. Hence, this test must run first
79 void commitsCurrentOffsetsOnSuccess() throws ExecutionException, InterruptedException
81 send100Messages(i -> new Bytes(longSerializer.serialize(TOPIC, i)));
83 await("100 records received")
84 .atMost(Duration.ofSeconds(30))
85 .until(() -> receivedRecords.size() >= 100);
87 await("Offsets committed")
88 .atMost(Duration.ofSeconds(10))
91 checkSeenOffsetsForProgress();
92 compareToCommitedOffsets(newOffsets);
98 void commitsOffsetOfErrorForReprocessingOnError()
100 send100Messages(counter ->
102 ? new Bytes(stringSerializer.serialize(TOPIC, "BOOM!"))
103 : new Bytes(longSerializer.serialize(TOPIC, counter)));
105 await("Consumer failed")
106 .atMost(Duration.ofSeconds(30))
107 .until(() -> !endlessConsumer.running());
109 checkSeenOffsetsForProgress();
110 compareToCommitedOffsets(newOffsets);
112 endlessConsumer.start();
113 await("Consumer failed")
114 .atMost(Duration.ofSeconds(30))
115 .until(() -> !endlessConsumer.running());
117 checkSeenOffsetsForProgress();
118 compareToCommitedOffsets(newOffsets);
119 assertThat(receivedRecords.size())
120 .describedAs("Received not all sent events")
125 /** Helper methods for the verification of expectations */
127 void compareToCommitedOffsets(Map<TopicPartition, Long> offsetsToCheck)
129 doForCurrentOffsets((tp, offset) ->
131 Long expected = offsetsToCheck.get(tp) + 1;
132 log.debug("Checking, if the offset for {} is {}", tp, expected);
134 .describedAs("Committed offset corresponds to the offset of the consumer")
135 .isEqualTo(expected);
139 void checkSeenOffsetsForProgress()
141 // Be sure, that some messages were consumed...!
142 Set<TopicPartition> withProgress = new HashSet<>();
143 partitions().forEach(tp ->
145 Long oldOffset = oldOffsets.get(tp);
146 Long newOffset = newOffsets.get(tp);
147 if (!oldOffset.equals(newOffset))
149 log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
150 withProgress.add(tp);
153 assertThat(withProgress)
154 .describedAs("Some offsets must have changed, compared to the old offset-positions")
159 /** Helper methods for setting up and running the tests */
161 void doForCurrentOffsets(BiConsumer<TopicPartition, Long> consumer)
163 offsetConsumer.assign(partitions());
164 partitions().forEach(tp -> consumer.accept(tp, offsetConsumer.position(tp)));
165 offsetConsumer.unsubscribe();
168 List<TopicPartition> partitions()
172 .range(0, PARTITIONS)
173 .mapToObj(partition -> new TopicPartition(TOPIC, partition))
174 .collect(Collectors.toList());
178 void send100Messages(Function<Long, Bytes> messageGenerator)
182 for (int partition = 0; partition < 10; partition++)
184 for (int key = 0; key < 10; key++)
186 Bytes value = messageGenerator.apply(++i);
188 ProducerRecord<String, Bytes> record =
189 new ProducerRecord<>(
192 Integer.toString(key%2),
195 kafkaProducer.send(record, (metadata, e) ->
197 if (metadata != null)
201 metadata.partition(),
209 "Exception for {}={}: {}",
223 testHandler = record -> {} ;
225 oldOffsets = new HashMap<>();
226 newOffsets = new HashMap<>();
227 receivedRecords = new HashSet<>();
229 doForCurrentOffsets((tp, offset) ->
231 oldOffsets.put(tp, offset - 1);
232 newOffsets.put(tp, offset - 1);
235 Consumer<ConsumerRecord<String, Long>> captureOffsetAndExecuteTestHandler =
239 new TopicPartition(record.topic(), record.partition()),
241 receivedRecords.add(record);
242 testHandler.accept(record);
246 new EndlessConsumer<>(
248 properties.getClientId(),
249 properties.getTopic(),
251 captureOffsetAndExecuteTestHandler);
253 endlessConsumer.start();
261 endlessConsumer.stop();
265 log.info("Exception while stopping the consumer: {}", e.toString());
271 @Import(ApplicationConfiguration.class)
272 public static class Configuration
275 KafkaProducer<String, Bytes> kafkaProducer(ApplicationProperties properties)
277 Properties props = new Properties();
278 props.put("bootstrap.servers", properties.getBootstrapServer());
279 props.put("linger.ms", 100);
280 props.put("key.serializer", StringSerializer.class.getName());
281 props.put("value.serializer", BytesSerializer.class.getName());
283 return new KafkaProducer<>(props);
287 KafkaConsumer<Bytes, Bytes> offsetConsumer(ApplicationProperties properties)
289 Properties props = new Properties();
290 props.put("bootstrap.servers", properties.getBootstrapServer());
291 props.put("client.id", "OFFSET-CONSUMER");
292 props.put("group.id", properties.getGroupId());
293 props.put("key.deserializer", BytesDeserializer.class.getName());
294 props.put("value.deserializer", BytesDeserializer.class.getName());
296 return new KafkaConsumer<>(props);