Springify: Einen Test für das Empfangen gemischter Nachrichten hinzugefügt
[demos/kafka/training] / src / test / java / de / juplo / kafka / ApplicationTests.java
index 40dc149..c3fbe45 100644 (file)
@@ -1,31 +1,33 @@
 package de.juplo.kafka;
 
+import lombok.Value;
 import lombok.extern.slf4j.Slf4j;
-import org.apache.kafka.clients.consumer.ConsumerRecord;
 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.errors.RecordDeserializationException;
 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.kafka.KafkaAutoConfiguration;
+import org.springframework.boot.autoconfigure.kafka.KafkaProperties;
 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.context.annotation.Primary;
+import org.springframework.kafka.listener.adapter.ConsumerRecordMetadata;
+import org.springframework.kafka.support.serializer.JsonSerializer;
 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.time.LocalDateTime;
 import java.util.*;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.ExecutorService;
 import java.util.function.BiConsumer;
-import java.util.function.Consumer;
-import java.util.function.Function;
+import java.util.function.BiFunction;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 
@@ -35,11 +37,16 @@ import static org.assertj.core.api.Assertions.*;
 import static org.awaitility.Awaitility.*;
 
 
-@SpringJUnitConfig(initializers = ConfigDataApplicationContextInitializer.class)
-@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
+@SpringJUnitConfig(
+               initializers = ConfigDataApplicationContextInitializer.class,
+               classes = {
+                               EndlessConsumer.class,
+                               KafkaAutoConfiguration.class,
+                               ApplicationTests.Configuration.class })
 @TestPropertySource(
                properties = {
-                               "consumer.bootstrap-server=${spring.embedded.kafka.brokers}",
+                               "spring.kafka.consumer.bootstrap-servers=${spring.embedded.kafka.brokers}",
+                               "spring.kafka.producer.bootstrap-servers=${spring.embedded.kafka.brokers}",
                                "consumer.topic=" + TOPIC })
 @EmbeddedKafka(topics = TOPIC, partitions = PARTITIONS)
 @Slf4j
@@ -49,39 +56,64 @@ class ApplicationTests
        public static final int PARTITIONS = 10;
 
 
-       StringSerializer stringSerializer = new StringSerializer();
-
        @Autowired
        Serializer valueSerializer;
        @Autowired
        KafkaProducer<String, Bytes> kafkaProducer;
        @Autowired
-       KafkaConsumer<String, Long> kafkaConsumer;
-       @Autowired
        KafkaConsumer<Bytes, Bytes> offsetConsumer;
        @Autowired
-       ApplicationProperties properties;
+       ApplicationProperties applicationProperties;
+       @Autowired
+       KafkaProperties kafkaProperties;
+       @Autowired
+       EndlessConsumer endlessConsumer;
+       @Autowired
+       MessageHandler<ClientMessage> clientMessageHandler;
        @Autowired
-       ExecutorService executor;
+       MessageHandler<Greeting> greetingsHandler;
 
-       Consumer<ConsumerRecord<String, Long>> testHandler;
-       EndlessConsumer<String, Long> endlessConsumer;
        Map<TopicPartition, Long> oldOffsets;
        Map<TopicPartition, Long> newOffsets;
-       Set<ConsumerRecord<String, Long>> receivedRecords;
+       Set<Object> received;
 
 
        /** Tests methods */
 
        @Test
-       @Order(1) // << The poistion pill is not skipped. Hence, this test must run first
-       void commitsCurrentOffsetsOnSuccess() throws ExecutionException, InterruptedException
+       void commitsCurrentOffsetsOnSuccess()
+       {
+               send100Messages((key, counter) -> serializeAsClientMessage(key, counter));
+
+               await("100 records received")
+                               .atMost(Duration.ofSeconds(30))
+                               .until(() -> received.size() == 100);
+
+               await("Offsets committed")
+                               .atMost(Duration.ofSeconds(10))
+                               .untilAsserted(() ->
+                               {
+                                       checkSeenOffsetsForProgress();
+                                       compareToCommitedOffsets(newOffsets);
+                               });
+
+               assertThat(endlessConsumer.isRunning())
+                               .describedAs("Consumer should still be running")
+                               .isTrue();
+       }
+
+
+       @Test
+       void mixedMessages()
        {
-               send100Messages(i ->  new Bytes(valueSerializer.serialize(TOPIC, i)));
+               send100Messages((key, counter) ->
+                               counter%3 == 0
+                                               ? serializeAsGreeting(key)
+                                               : serializeAsClientMessage(key, counter));
 
                await("100 records received")
                                .atMost(Duration.ofSeconds(30))
-                               .until(() -> receivedRecords.size() >= 100);
+                               .until(() -> received.size() == 100);
 
                await("Offsets committed")
                                .atMost(Duration.ofSeconds(10))
@@ -91,44 +123,70 @@ class ApplicationTests
                                        compareToCommitedOffsets(newOffsets);
                                });
 
-               assertThatExceptionOfType(IllegalStateException.class)
-                               .isThrownBy(() -> endlessConsumer.exitStatus())
-                               .describedAs("Consumer should still be running");
+               assertThat(endlessConsumer.isRunning())
+                               .describedAs("Consumer should still be running")
+                               .isTrue();
        }
 
        @Test
-       @Order(2)
-       void commitsOffsetOfErrorForReprocessingOnError()
+       void commitsCurrentOffsetsOnDeserializationError()
        {
-               send100Messages(counter ->
+               send100Messages((key, counter) ->
                                counter == 77
-                                               ? new Bytes(stringSerializer.serialize(TOPIC, "BOOM!"))
-                                               : new Bytes(valueSerializer.serialize(TOPIC, counter)));
+                                               ? serializeString("BOOM!", "message")
+                                               : serializeAsClientMessage(key, counter));
 
-               await("Consumer failed")
+               await("99 records received")
                                .atMost(Duration.ofSeconds(30))
-                               .until(() -> !endlessConsumer.running());
+                               .until(() -> received.size() == 99);
 
-               checkSeenOffsetsForProgress();
-               compareToCommitedOffsets(newOffsets);
+               await("Offsets committed")
+                               .atMost(Duration.ofSeconds(10))
+                               .untilAsserted(() ->
+                               {
+                                       // UNSCHÖN:
+                                       // Funktioniert nur, weil nach der Nachrichten, die den
+                                       // Deserialisierungs-Fehler auslöst noch valide Nachrichten
+                                       // gelesen werden.
+                                       // GRUND:
+                                       // Der MessageHandler sieht den Offset der Fehlerhaften
+                                       // Nachricht nicht!
+                                       checkSeenOffsetsForProgress();
+                                       compareToCommitedOffsets(newOffsets);
+                               });
 
-               endlessConsumer.start();
-               await("Consumer failed")
+               assertThat(endlessConsumer.isRunning())
+                               .describedAs("Consumer should still be running")
+                               .isTrue();
+       }
+
+       @Test
+       void commitsOffsetOnProgramLogicErrorFoo()
+       {
+               clientMessageHandler.testHandler = (clientMessage, metadata) ->
+               {
+                       if (Integer.parseInt(clientMessage.message)%10 ==0)
+                               throw new RuntimeException("BOOM: " + clientMessage.message + "%10 == 0");
+               };
+
+               send100Messages((key, counter) -> serializeAsClientMessage(key, counter));
+
+               await("80 records received")
                                .atMost(Duration.ofSeconds(30))
-                               .until(() -> !endlessConsumer.running());
-
-               checkSeenOffsetsForProgress();
-               compareToCommitedOffsets(newOffsets);
-               assertThat(receivedRecords.size())
-                               .describedAs("Received not all sent events")
-                               .isLessThan(100);
-
-               assertThatNoException()
-                               .describedAs("Consumer should not be running")
-                               .isThrownBy(() -> endlessConsumer.exitStatus());
-               assertThat(endlessConsumer.exitStatus())
-                               .describedAs("Consumer should have exited abnormally")
-                               .containsInstanceOf(RecordDeserializationException.class);
+                               .until(() -> received.size() == 100);
+
+               await("Offsets committed")
+                               .atMost(Duration.ofSeconds(10))
+                               .pollDelay(Duration.ofSeconds(1))
+                               .untilAsserted(() ->
+                               {
+                                       checkSeenOffsetsForProgress();
+                                       compareToCommitedOffsets(newOffsets);
+                               });
+
+               assertThat(endlessConsumer.isRunning())
+                               .describedAs("Consumer should still be running")
+                               .isTrue();
        }
 
 
@@ -139,7 +197,7 @@ class ApplicationTests
                doForCurrentOffsets((tp, offset) ->
                {
                        Long expected = offsetsToCheck.get(tp) + 1;
-                       log.debug("Checking, if the offset for {} is {}", tp, expected);
+                       log.debug("TEST: Comparing the expected offset of {} for {} to {}", expected, tp, offset);
                        assertThat(offset)
                                        .describedAs("Committed offset corresponds to the offset of the consumer")
                                        .isEqualTo(expected);
@@ -156,10 +214,11 @@ class ApplicationTests
                        Long newOffset = newOffsets.get(tp);
                        if (!oldOffset.equals(newOffset))
                        {
-                               log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
+                               log.debug("TEST: Progress for {}: {} -> {}", tp, oldOffset, newOffset);
                                withProgress.add(tp);
                        }
                });
+               log.debug("TEST: Offsets with progress: {}", withProgress);
                assertThat(withProgress)
                                .describedAs("Some offsets must have changed, compared to the old offset-positions")
                                .isNotEmpty();
@@ -185,7 +244,7 @@ class ApplicationTests
        }
 
 
-       void send100Messages(Function<Long, Bytes> messageGenerator)
+       void send100Messages(BiFunction<Integer, Long, BytesAndType> recordGenerator)
        {
                long i = 0;
 
@@ -193,21 +252,22 @@ class ApplicationTests
                {
                        for (int key = 0; key < 10; key++)
                        {
-                               Bytes value = messageGenerator.apply(++i);
+                               BytesAndType bat = recordGenerator.apply(key, ++i);
 
                                ProducerRecord<String, Bytes> record =
                                                new ProducerRecord<>(
                                                                TOPIC,
                                                                partition,
                                                                Integer.toString(key%2),
-                                                               value);
+                                                               bat.getValue());
 
+                               record.headers().add("__TypeId__", bat.getType());
                                kafkaProducer.send(record, (metadata, e) ->
                                {
                                        if (metadata != null)
                                        {
                                                log.debug(
-                                                               "{}|{} - {}={}",
+                                                               "TEST: Sending partition={}, offset={} - {}={}",
                                                                metadata.partition(),
                                                                metadata.offset(),
                                                                record.key(),
@@ -216,7 +276,7 @@ class ApplicationTests
                                        else
                                        {
                                                log.warn(
-                                                               "Exception for {}={}: {}",
+                                                               "TEST: Exception for {}={}: {}",
                                                                record.key(),
                                                                record.value(),
                                                                e.toString());
@@ -226,15 +286,42 @@ class ApplicationTests
                }
        }
 
+       BytesAndType serializeAsClientMessage(Integer key, Long value)
+       {
+               ClientMessage message = new ClientMessage();
+               message.setClient(key.toString());
+               message.setMessage(value.toString());
+               return new BytesAndType(serialize(message), "message");
+       }
+
+       BytesAndType serializeAsGreeting(Integer key)
+       {
+               Greeting greeting = new Greeting();
+               greeting.setName(key.toString());
+               greeting.setWhen(LocalDateTime.now());
+               return new BytesAndType(serialize(greeting), "greeting");
+       }
+
+       BytesAndType serializeString(String message, String messageType)
+       {
+               return new BytesAndType(new Bytes(message.getBytes()), messageType);
+       }
+
+       Bytes serialize(Object message)
+       {
+               return new Bytes(valueSerializer.serialize(TOPIC, message));
+       }
+
 
        @BeforeEach
        public void init()
        {
-               testHandler = record -> {} ;
+               clientMessageHandler.testHandler = (clientMessage, metadata) -> {};
+               greetingsHandler.testHandler = (greeting, metadata) -> {};
 
                oldOffsets = new HashMap<>();
                newOffsets = new HashMap<>();
-               receivedRecords = new HashSet<>();
+               received = new HashSet<>();
 
                doForCurrentOffsets((tp, offset) ->
                {
@@ -242,23 +329,19 @@ class ApplicationTests
                        newOffsets.put(tp, offset - 1);
                });
 
-               Consumer<ConsumerRecord<String, Long>> captureOffsetAndExecuteTestHandler =
-                               record ->
+               BiConsumer<?, ConsumerRecordMetadata> captureOffsets =
+                               (clientMessage, metadata) ->
                                {
+                                       received.add(clientMessage);
+                                       log.debug("TEST: Processing record #{}: {}", received.size(), clientMessage);
                                        newOffsets.put(
-                                                       new TopicPartition(record.topic(), record.partition()),
-                                                       record.offset());
-                                       receivedRecords.add(record);
-                                       testHandler.accept(record);
+                                                       new TopicPartition(metadata.topic(), metadata.partition()), metadata.offset());
                                };
 
-               endlessConsumer =
-                               new EndlessConsumer<>(
-                                               executor,
-                                               properties.getClientId(),
-                                               properties.getTopic(),
-                                               kafkaConsumer,
-                                               captureOffsetAndExecuteTestHandler);
+               clientMessageHandler.captureOffsets =
+                               (BiConsumer<ClientMessage, ConsumerRecordMetadata>)captureOffsets;
+               greetingsHandler.captureOffsets =
+                               (BiConsumer<Greeting, ConsumerRecordMetadata>)captureOffsets;
 
                endlessConsumer.start();
        }
@@ -272,26 +355,54 @@ class ApplicationTests
                }
                catch (Exception e)
                {
-                       log.info("Exception while stopping the consumer: {}", e.toString());
+                       log.info("TEST: Exception while stopping the consumer: {}", e.toString());
                }
        }
 
+       public static class MessageHandler<T> implements BiConsumer<T, ConsumerRecordMetadata>
+       {
+               BiConsumer<T, ConsumerRecordMetadata> captureOffsets;
+               BiConsumer<T, ConsumerRecordMetadata> testHandler;
+
+
+               @Override
+               public void accept(T message, ConsumerRecordMetadata metadata)
+               {
+                       captureOffsets
+                                       .andThen(testHandler)
+                                       .accept(message, metadata);
+               }
+       }
 
        @TestConfiguration
        @Import(ApplicationConfiguration.class)
        public static class Configuration
        {
+               @Primary
+               @Bean
+               public MessageHandler<ClientMessage> messageHandler()
+               {
+                       return new MessageHandler<>();
+               }
+
+               @Primary
+               @Bean
+               public MessageHandler<Greeting> greetingsHandler()
+               {
+                       return new MessageHandler<>();
+               }
+
                @Bean
-               Serializer<Long> serializer()
+               Serializer<ClientMessage> serializer()
                {
-                       return new LongSerializer();
+                       return new JsonSerializer<>();
                }
 
                @Bean
-               KafkaProducer<String, Bytes> kafkaProducer(ApplicationProperties properties)
+               KafkaProducer<String, Bytes> kafkaProducer(KafkaProperties properties)
                {
                        Properties props = new Properties();
-                       props.put("bootstrap.servers", properties.getBootstrapServer());
+                       props.put("bootstrap.servers", properties.getConsumer().getBootstrapServers());
                        props.put("linger.ms", 100);
                        props.put("key.serializer", StringSerializer.class.getName());
                        props.put("value.serializer", BytesSerializer.class.getName());
@@ -300,16 +411,31 @@ class ApplicationTests
                }
 
                @Bean
-               KafkaConsumer<Bytes, Bytes> offsetConsumer(ApplicationProperties properties)
+               KafkaConsumer<Bytes, Bytes> offsetConsumer(KafkaProperties properties)
                {
                        Properties props = new Properties();
-                       props.put("bootstrap.servers", properties.getBootstrapServer());
+                       props.put("bootstrap.servers", properties.getConsumer().getBootstrapServers());
                        props.put("client.id", "OFFSET-CONSUMER");
-                       props.put("group.id", properties.getGroupId());
+                       props.put("group.id", properties.getConsumer().getGroupId());
                        props.put("key.deserializer", BytesDeserializer.class.getName());
                        props.put("value.deserializer", BytesDeserializer.class.getName());
 
                        return new KafkaConsumer<>(props);
                }
        }
+
+
+       @Value
+       static class BytesAndType
+       {
+               private final Bytes value;
+               private final byte[] type;
+
+
+               BytesAndType(Bytes value, String type)
+               {
+                       this.value = value;
+                       this.type = type.getBytes();
+               }
+       }
 }