Springify: Testfall repariert - Seltsames Verhalten von `@KafkaHandler`!
[demos/kafka/training] / src / test / java / de / juplo / kafka / ApplicationTests.java
index 3f6a6a8..f13fdde 100644 (file)
@@ -1,12 +1,10 @@
 package de.juplo.kafka;
 
 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.*;
@@ -18,6 +16,7 @@ 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;
@@ -28,7 +27,6 @@ import java.util.*;
 import java.util.concurrent.ExecutionException;
 import java.util.function.BiConsumer;
 import java.util.function.BiFunction;
-import java.util.function.Consumer;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 
@@ -44,10 +42,10 @@ import static org.awaitility.Awaitility.*;
                                EndlessConsumer.class,
                                KafkaAutoConfiguration.class,
                                ApplicationTests.Configuration.class })
-@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
 @TestPropertySource(
                properties = {
                                "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
@@ -64,8 +62,6 @@ class ApplicationTests
        @Autowired
        KafkaProducer<String, Bytes> kafkaProducer;
        @Autowired
-       org.apache.kafka.clients.consumer.Consumer<String, ClientMessage> kafkaConsumer;
-       @Autowired
        KafkaConsumer<Bytes, Bytes> offsetConsumer;
        @Autowired
        ApplicationProperties applicationProperties;
@@ -74,24 +70,23 @@ class ApplicationTests
        @Autowired
        EndlessConsumer endlessConsumer;
        @Autowired
-       RecordHandler recordHandler;
+       ClientMessageHandler clientMessageHandler;
 
        Map<TopicPartition, Long> oldOffsets;
        Map<TopicPartition, Long> newOffsets;
-       Set<ConsumerRecord<String, ClientMessage>> receivedRecords;
+       Set<ClientMessage> received;
 
 
        /** Tests methods */
 
        @Test
-       @Order(1) // << The poistion pill is not skipped. Hence, this test must run first
        void commitsCurrentOffsetsOnSuccess() throws ExecutionException, InterruptedException
        {
                send100Messages((key, counter) -> serialize(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))
@@ -101,35 +96,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((key, counter) ->
                                counter == 77
                                                ? new Bytes(stringSerializer.serialize(TOPIC, "BOOM!"))
                                                : serialize(key, counter));
 
-               await("Consumer failed")
+               await("99 records received")
+                               .atMost(Duration.ofSeconds(30))
+                               .until(() -> received.size() == 99);
+
+               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);
+                               });
+
+               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) -> serialize(key, counter));
+
+               await("80 records received")
                                .atMost(Duration.ofSeconds(30))
-                               .untilAsserted(() -> 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())
-                               .containsInstanceOf(RecordDeserializationException.class)
-                               .describedAs("Consumer should have exited abnormally");
+                               .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();
        }
 
 
@@ -140,7 +170,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);
@@ -157,10 +187,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();
@@ -209,7 +240,7 @@ class ApplicationTests
                                        if (metadata != null)
                                        {
                                                log.debug(
-                                                               "{}|{} - {}={}",
+                                                               "TEST: Sending partition={}, offset={} - {}={}",
                                                                metadata.partition(),
                                                                metadata.offset(),
                                                                record.key(),
@@ -218,7 +249,7 @@ class ApplicationTests
                                        else
                                        {
                                                log.warn(
-                                                               "Exception for {}={}: {}",
+                                                               "TEST: Exception for {}={}: {}",
                                                                record.key(),
                                                                record.value(),
                                                                e.toString());
@@ -240,11 +271,11 @@ class ApplicationTests
        @BeforeEach
        public void init()
        {
-               recordHandler.testHandler = (record) -> {};
+               clientMessageHandler.testHandler = (clientMessage, metadata) -> {};
 
                oldOffsets = new HashMap<>();
                newOffsets = new HashMap<>();
-               receivedRecords = new HashSet<>();
+               received = new HashSet<>();
 
                doForCurrentOffsets((tp, offset) ->
                {
@@ -252,13 +283,13 @@ class ApplicationTests
                        newOffsets.put(tp, offset - 1);
                });
 
-               recordHandler.captureOffsets =
-                               record ->
+               clientMessageHandler.captureOffsets =
+                               (clientMessage, metadata) ->
                                {
-                                       receivedRecords.add(record);
+                                       received.add(clientMessage);
+                                       log.debug("TEST: Processing record #{}: {}", received.size(), clientMessage);
                                        newOffsets.put(
-                                                       new TopicPartition(record.topic(), record.partition()),
-                                                       record.offset());
+                                                       new TopicPartition(metadata.topic(), metadata.partition()), metadata.offset());
                                };
 
                endlessConsumer.start();
@@ -273,22 +304,22 @@ 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 RecordHandler implements Consumer<ConsumerRecord<String, ClientMessage>>
+       public static class ClientMessageHandler implements BiConsumer<ClientMessage, ConsumerRecordMetadata>
        {
-               Consumer<ConsumerRecord<String, ClientMessage>> captureOffsets;
-               Consumer<ConsumerRecord<String, ClientMessage>> testHandler;
+               BiConsumer<ClientMessage, ConsumerRecordMetadata> captureOffsets;
+               BiConsumer<ClientMessage, ConsumerRecordMetadata> testHandler;
 
 
                @Override
-               public void accept(ConsumerRecord<String, ClientMessage> record)
+               public void accept(ClientMessage clientMessage, ConsumerRecordMetadata metadata)
                {
                        captureOffsets
                                        .andThen(testHandler)
-                                       .accept(record);
+                                       .accept(clientMessage, metadata);
                }
        }
 
@@ -298,9 +329,9 @@ class ApplicationTests
        {
                @Primary
                @Bean
-               public Consumer<ConsumerRecord<String, ClientMessage>> testHandler()
+               public BiConsumer<ClientMessage, ConsumerRecordMetadata> testHandler()
                {
-                       return new RecordHandler();
+                       return new ClientMessageHandler();
                }
 
                @Bean