+++ /dev/null
-package de.juplo.kafka;
-
-import com.mongodb.client.MongoClient;
-import lombok.extern.slf4j.Slf4j;
-import org.apache.kafka.clients.consumer.ConsumerConfig;
-import org.apache.kafka.clients.consumer.KafkaConsumer;
-import org.apache.kafka.clients.producer.KafkaProducer;
-import org.apache.kafka.clients.producer.ProducerRecord;
-import org.apache.kafka.common.TopicPartition;
-import org.apache.kafka.common.serialization.*;
-import org.apache.kafka.common.utils.Bytes;
-import org.junit.jupiter.api.*;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
-import org.springframework.boot.autoconfigure.kafka.KafkaProperties;
-import org.springframework.boot.autoconfigure.mongo.MongoProperties;
-import org.springframework.boot.test.autoconfigure.data.mongo.AutoConfigureDataMongo;
-import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer;
-import org.springframework.boot.test.context.TestConfiguration;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Import;
-import org.springframework.kafka.config.ConcurrentKafkaListenerContainerFactory;
-import org.springframework.kafka.config.KafkaListenerEndpointRegistry;
-import org.springframework.kafka.core.ConsumerFactory;
-import org.springframework.kafka.core.DefaultKafkaConsumerFactory;
-import org.springframework.kafka.test.context.EmbeddedKafka;
-import org.springframework.test.context.TestPropertySource;
-import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
-
-import java.time.Duration;
-import java.util.*;
-import java.util.function.BiConsumer;
-import java.util.function.Consumer;
-import java.util.stream.Collectors;
-import java.util.stream.IntStream;
-
-import static de.juplo.kafka.GenericApplicationTests.PARTITIONS;
-import static de.juplo.kafka.GenericApplicationTests.TOPIC;
-import static org.assertj.core.api.Assertions.*;
-import static org.awaitility.Awaitility.*;
-
-
-@SpringJUnitConfig(initializers = ConfigDataApplicationContextInitializer.class)
-@TestPropertySource(
- properties = {
- "spring.kafka.bootstrap-servers=${spring.embedded.kafka.brokers}",
- "spring.kafka.producer.bootstrap-servers=${spring.embedded.kafka.brokers}",
- "sumup.adder.topic=" + TOPIC,
- "spring.kafka.consumer.auto-commit-interval=500ms",
- "spring.mongodb.embedded.version=4.4.13" })
-@EmbeddedKafka(topics = TOPIC, partitions = PARTITIONS)
-@EnableAutoConfiguration
-@AutoConfigureDataMongo
-@Slf4j
-abstract class GenericApplicationTests<K, V>
-{
- public static final String TOPIC = "FOO";
- public static final int PARTITIONS = 10;
-
-
- @Autowired
- org.apache.kafka.clients.consumer.Consumer<K, V> kafkaConsumer;
- @Autowired
- KafkaProperties kafkaProperties;
- @Autowired
- ApplicationProperties applicationProperties;
- @Autowired
- MongoClient mongoClient;
- @Autowired
- MongoProperties mongoProperties;
- @Autowired
- KafkaListenerEndpointRegistry kafkaListenerEndpointRegistry;
- @Autowired
- TestRecordHandler recordHandler;
- @Autowired
- DeadLetterTopicConsumer deadLetterTopicConsumer;
- @Autowired
- EndlessConsumer endlessConsumer;
-
- KafkaProducer<Bytes, Bytes> testRecordProducer;
- KafkaConsumer<Bytes, Bytes> offsetConsumer;
- Map<TopicPartition, Long> oldOffsets;
-
-
- final RecordGenerator recordGenerator;
- final Consumer<ProducerRecord<Bytes, Bytes>> messageSender;
-
- public GenericApplicationTests(RecordGenerator recordGenerator)
- {
- this.recordGenerator = recordGenerator;
- this.messageSender = (record) -> sendMessage(record);
- }
-
-
- /** Tests methods */
-
- @Test
- void commitsCurrentOffsetsOnSuccess() throws Exception
- {
- recordGenerator.generate(false, false, messageSender);
-
- int numberOfGeneratedMessages = recordGenerator.getNumberOfMessages();
-
- await(numberOfGeneratedMessages + " records received")
- .atMost(Duration.ofSeconds(30))
- .pollInterval(Duration.ofSeconds(1))
- .until(() -> recordHandler.receivedMessages >= numberOfGeneratedMessages);
-
- await("Offsets committed")
- .atMost(Duration.ofSeconds(10))
- .pollInterval(Duration.ofSeconds(1))
- .untilAsserted(() ->
- {
- checkSeenOffsetsForProgress();
- assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
- });
-
- assertThat(endlessConsumer.running())
- .describedAs("Consumer should still be running")
- .isTrue();
-
- endlessConsumer.stop();
- recordGenerator.assertBusinessLogic();
- }
-
- @Test
- @SkipWhenErrorCannotBeGenerated(poisonPill = true)
- void commitsOffsetOfErrorForReprocessingOnDeserializationError()
- {
- recordGenerator.generate(true, false, messageSender);
-
- int numberOfValidMessages =
- recordGenerator.getNumberOfMessages() -
- recordGenerator.getNumberOfPoisonPills();
-
- await(numberOfValidMessages + " records received")
- .atMost(Duration.ofSeconds(30))
- .pollInterval(Duration.ofSeconds(1))
- .until(() -> recordHandler.receivedMessages >= numberOfValidMessages);
- await(recordGenerator.getNumberOfPoisonPills() + " poison-pills received")
- .atMost(Duration.ofSeconds(30))
- .pollInterval(Duration.ofSeconds(1))
- .until(() -> deadLetterTopicConsumer.messages.size() == recordGenerator.getNumberOfPoisonPills());
-
- await("Offsets committed")
- .atMost(Duration.ofSeconds(10))
- .pollInterval(Duration.ofSeconds(1))
- .untilAsserted(() ->
- {
- checkSeenOffsetsForProgress();
- assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
- });
-
- assertThat(endlessConsumer.running())
- .describedAs("Consumer should still be running")
- .isTrue();
-
- endlessConsumer.stop();
- recordGenerator.assertBusinessLogic();
- }
-
- @Test
- @SkipWhenErrorCannotBeGenerated(logicError = true)
- void commitsOffsetsOfUnseenRecordsOnLogicError()
- {
- recordGenerator.generate(false, true, messageSender);
-
- int numberOfValidMessages =
- recordGenerator.getNumberOfMessages() -
- recordGenerator.getNumberOfLogicErrors();
-
- await(numberOfValidMessages + " records received")
- .atMost(Duration.ofSeconds(30))
- .pollInterval(Duration.ofSeconds(1))
- .until(() -> recordHandler.receivedMessages >= numberOfValidMessages);
- await(recordGenerator.getNumberOfLogicErrors() + " logic-errors received")
- .atMost(Duration.ofSeconds(30))
- .pollInterval(Duration.ofSeconds(1))
- .until(() -> deadLetterTopicConsumer.messages.size() == recordGenerator.getNumberOfLogicErrors());
-
- await("Offsets committed")
- .atMost(Duration.ofSeconds(10))
- .pollInterval(Duration.ofSeconds(1))
- .untilAsserted(() ->
- {
- checkSeenOffsetsForProgress();
- assertSeenOffsetsEqualCommittedOffsets(recordHandler.seenOffsets);
- });
-
- assertThat(endlessConsumer.running())
- .describedAs("Consumer should still be running")
- .isTrue();
-
- endlessConsumer.stop();
- recordGenerator.assertBusinessLogic();
- }
-
-
- /** Helper methods for the verification of expectations */
-
- void assertSeenOffsetsEqualCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
- {
- doForCurrentOffsets((tp, offset) ->
- {
- Long expected = offsetsToCheck.get(tp) + 1;
- log.debug("Checking, if the offset {} for {} is exactly {}", offset, tp, expected);
- assertThat(offset)
- .describedAs("Committed offset corresponds to the offset of the consumer")
- .isEqualTo(expected);
- });
- }
-
- void assertSeenOffsetsAreBehindCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
- {
- List<Boolean> isOffsetBehindSeen = new LinkedList<>();
-
- doForCurrentOffsets((tp, offset) ->
- {
- Long expected = offsetsToCheck.get(tp) + 1;
- log.debug("Checking, if the offset {} for {} is at most {}", offset, tp, expected);
- assertThat(offset)
- .describedAs("Committed offset must be at most equal to the offset of the consumer")
- .isLessThanOrEqualTo(expected);
- isOffsetBehindSeen.add(offset < expected);
- });
-
- assertThat(isOffsetBehindSeen.stream().reduce(false, (result, next) -> result | next))
- .describedAs("Committed offsets are behind seen offsets")
- .isTrue();
- }
-
- void checkSeenOffsetsForProgress()
- {
- // Be sure, that some messages were consumed...!
- Set<TopicPartition> withProgress = new HashSet<>();
- partitions().forEach(tp ->
- {
- Long oldOffset = oldOffsets.get(tp) + 1;
- Long newOffset = recordHandler.seenOffsets.get(tp) + 1;
- if (!oldOffset.equals(newOffset))
- {
- log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
- withProgress.add(tp);
- }
- });
- assertThat(withProgress)
- .describedAs("Some offsets must have changed, compared to the old offset-positions")
- .isNotEmpty();
- }
-
-
- /** Helper methods for setting up and running the tests */
-
- void seekToEnd()
- {
- offsetConsumer.assign(partitions());
- offsetConsumer.seekToEnd(partitions());
- partitions().forEach(tp ->
- {
- // seekToEnd() works lazily: it only takes effect on poll()/position()
- Long offset = offsetConsumer.position(tp);
- log.info("New position for {}: {}", tp, offset);
- });
- // The new positions must be commited!
- offsetConsumer.commitSync();
- offsetConsumer.unsubscribe();
- }
-
- void doForCurrentOffsets(BiConsumer<TopicPartition, Long> consumer)
- {
- offsetConsumer.assign(partitions());
- partitions().forEach(tp -> consumer.accept(tp, offsetConsumer.position(tp)));
- offsetConsumer.unsubscribe();
- }
-
- List<TopicPartition> partitions()
- {
- return
- IntStream
- .range(0, PARTITIONS)
- .mapToObj(partition -> new TopicPartition(TOPIC, partition))
- .collect(Collectors.toList());
- }
-
-
- public interface RecordGenerator
- {
- void generate(
- boolean poisonPills,
- boolean logicErrors,
- Consumer<ProducerRecord<Bytes, Bytes>> messageSender);
-
- int getNumberOfMessages();
- int getNumberOfPoisonPills();
- int getNumberOfLogicErrors();
-
- default boolean canGeneratePoisonPill()
- {
- return true;
- }
-
- default boolean canGenerateLogicError()
- {
- return true;
- }
-
- default void assertBusinessLogic()
- {
- log.debug("No business-logic to assert");
- }
- }
-
- void sendMessage(ProducerRecord<Bytes, Bytes> record)
- {
- testRecordProducer.send(record, (metadata, e) ->
- {
- if (metadata != null)
- {
- log.debug(
- "{}|{} - {}={}",
- metadata.partition(),
- metadata.offset(),
- record.key(),
- record.value());
- }
- else
- {
- log.warn(
- "Exception for {}={}: {}",
- record.key(),
- record.value(),
- e.toString());
- }
- });
- }
-
-
- @BeforeEach
- public void init()
- {
- Properties props;
- props = new Properties();
- props.put("bootstrap.servers", kafkaProperties.getBootstrapServers());
- props.put("linger.ms", 100);
- props.put("key.serializer", BytesSerializer.class.getName());
- props.put("value.serializer", BytesSerializer.class.getName());
- testRecordProducer = new KafkaProducer<>(props);
-
- props = new Properties();
- props.put("bootstrap.servers", kafkaProperties.getBootstrapServers());
- props.put("client.id", "OFFSET-CONSUMER");
- props.put("group.id", kafkaProperties.getConsumer().getGroupId());
- props.put("key.deserializer", BytesDeserializer.class.getName());
- props.put("value.deserializer", BytesDeserializer.class.getName());
- offsetConsumer = new KafkaConsumer<>(props);
-
- mongoClient.getDatabase(mongoProperties.getDatabase()).drop();
- seekToEnd();
-
- oldOffsets = new HashMap<>();
- recordHandler.seenOffsets = new HashMap<>();
- recordHandler.receivedMessages = 0;
-
- deadLetterTopicConsumer.messages.clear();
-
- doForCurrentOffsets((tp, offset) ->
- {
- oldOffsets.put(tp, offset - 1);
- recordHandler.seenOffsets.put(tp, offset - 1);
- });
-
- endlessConsumer.start();
- }
-
- @AfterEach
- public void deinit()
- {
- try
- {
- endlessConsumer.stop();
- }
- catch (Exception e)
- {
- log.debug("{}", e.toString());
- }
-
- try
- {
- testRecordProducer.close();
- offsetConsumer.close();
- }
- catch (Exception e)
- {
- log.info("Exception while stopping the consumer: {}", e.toString());
- }
- }
-
-
- @TestConfiguration
- @Import(ApplicationConfiguration.class)
- public static class Configuration
- {
- @Bean
- public RecordHandler recordHandler(RecordHandler applicationRecordHandler)
- {
- return new TestRecordHandler(applicationRecordHandler);
- }
-
- @Bean(destroyMethod = "close")
- public org.apache.kafka.clients.consumer.Consumer<String, Message> kafkaConsumer(ConsumerFactory<String, Message> factory)
- {
- return factory.createConsumer();
- }
-
- @Bean
- public ConcurrentKafkaListenerContainerFactory<String, String> dltContainerFactory(
- KafkaProperties properties)
- {
- Map<String, Object> consumerProperties = new HashMap<>();
-
- consumerProperties.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, properties.getBootstrapServers());
- consumerProperties.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class);
- consumerProperties.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class);
- consumerProperties.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest");
-
- DefaultKafkaConsumerFactory dltConsumerFactory =
- new DefaultKafkaConsumerFactory<>(consumerProperties);
- ConcurrentKafkaListenerContainerFactory<String, String> factory =
- new ConcurrentKafkaListenerContainerFactory<>();
- factory.setConsumerFactory(dltConsumerFactory);
- return factory;
- }
-
- @Bean
- public DeadLetterTopicConsumer deadLetterTopicConsumer()
- {
- return new DeadLetterTopicConsumer();
- }
- }
-}
projects / demos / kafka / training / blobdiff