recorder: 1.1.2 - The `JsonSerializer` is used for serialization recorder-1.1.2
authorKai Moritz <kai@juplo.de>
Sun, 5 May 2024 11:26:28 +0000 (13:26 +0200)
committerKai Moritz <kai@juplo.de>
Thu, 6 Jun 2024 18:40:09 +0000 (20:40 +0200)
* Configured the Spring Kafka `JsonSerializer` for serialization.
* The `JsonSerializer` is configured, to add _no_ type-info to the headers.
* Added an integration test to proof, that everything works as expected.

pom.xml
src/main/java/de/juplo/kafka/wordcount/recorder/RecorderApplication.java
src/test/java/de/juplo/kafka/wordcount/recorder/ApplicationTests.java
src/test/java/de/juplo/kafka/wordcount/splitter/TestRecording.java [new file with mode: 0644]

diff --git a/pom.xml b/pom.xml
index 4e87c6e..0377da1 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -10,7 +10,7 @@
        </parent>
        <groupId>de.juplo.kafka.wordcount</groupId>
        <artifactId>recorder</artifactId>
-       <version>1.1.1</version>
+       <version>1.1.2</version>
        <name>Wordcount-Recorder</name>
        <description>Recorder-service of the multi-user wordcount-example</description>
        <properties>
                        <artifactId>spring-boot-starter-test</artifactId>
                        <scope>test</scope>
                </dependency>
+               <dependency>
+                       <groupId>org.springframework.kafka</groupId>
+                       <artifactId>spring-kafka-test</artifactId>
+                       <scope>test</scope>
+               </dependency>
+               <dependency>
+                       <groupId>org.awaitility</groupId>
+                       <artifactId>awaitility</artifactId>
+                       <scope>test</scope>
+               </dependency>
        </dependencies>
 
        <build>
index 11248d8..3928f2f 100644 (file)
@@ -7,6 +7,7 @@ import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
+import org.springframework.kafka.support.serializer.JsonSerializer;
 import org.springframework.util.Assert;
 
 import java.util.Properties;
@@ -24,7 +25,8 @@ public class RecorderApplication
                Properties props = new Properties();
                props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, properties.getBootstrapServer());
                props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class);
-               props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class);
+               props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, JsonSerializer.class);
+               props.put(JsonSerializer.ADD_TYPE_INFO_HEADERS, false);
 
                return new KafkaProducer<>(props);
        }
index 885a408..3879d38 100644 (file)
 package de.juplo.kafka.wordcount.recorder;
 
+import de.juplo.kafka.wordcount.splitter.TestRecording;
+import lombok.extern.slf4j.Slf4j;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.http.MediaType;
+import org.springframework.kafka.annotation.KafkaListener;
+import org.springframework.kafka.support.KafkaHeaders;
+import org.springframework.kafka.test.context.EmbeddedKafka;
+import org.springframework.messaging.handler.annotation.Header;
+import org.springframework.messaging.handler.annotation.Payload;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.util.LinkedMultiValueMap;
+import org.springframework.util.MultiValueMap;
 
-@SpringBootTest
+import java.time.Duration;
+import java.util.List;
+import java.util.stream.Stream;
+
+import static de.juplo.kafka.wordcount.recorder.ApplicationTests.TOPIC_OUT;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.asyncDispatch;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+
+@SpringBootTest(
+               properties = {
+                               "spring.kafka.consumer.auto-offset-reset=earliest",
+                               "spring.kafka.consumer.value-deserializer=org.springframework.kafka.support.serializer.JsonDeserializer",
+                               "spring.kafka.consumer.properties.spring.json.value.default.type=de.juplo.kafka.wordcount.splitter.TestRecording",
+                               "spring.kafka.consumer.properties.spring.json.trusted.packages=de.juplo.kafka.wordcount.recorder",
+                               "logging.level.root=WARN",
+                               "logging.level.de.juplo=DEBUG",
+                               "juplo.wordcount.recorder.bootstrap-server=${spring.embedded.kafka.brokers}",
+                               "juplo.wordcount.recorder.topic=" + TOPIC_OUT })
+@AutoConfigureMockMvc
+@EmbeddedKafka(topics = { TOPIC_OUT })
+@Slf4j
 class ApplicationTests
 {
+       static final String TOPIC_OUT = "out";
+
+       @Autowired
+       MockMvc mockMvc;
+       @Autowired
+       Consumer consumer;
+
+
        @Test
-       void contextLoads()
+       @DisplayName("Posted messages are accepted and sent to Kafka")
+       void userMessagesAreAcceptedAndSentToKafka()
+       {
+               MultiValueMap<String, TestRecording> recordings = new LinkedMultiValueMap<>();
+
+               Stream
+                               .of(
+                                               new TestRecording("päter", "Hall° Wält?¢*&%€!"),
+                                               new TestRecording("päter", "Hallo Welt!"),
+                                               new TestRecording("klühs", "Müsch gäb's auch!"),
+                                               new TestRecording("päter", "Boäh, echt! ß mal nä Nümmäh!"))
+                               .forEach(recording ->
+                               {
+                                       sendRedording(recording.getUser(), recording.getSentence());
+                                       recordings.add(recording.getUser(), recording);
+                               });
+
+
+               await("Received expected messages")
+                               .atMost(Duration.ofSeconds(5))
+                               .untilAsserted(() -> recordings.forEach((user, userRecordings) ->
+                                               assertThat(consumer.receivedFor(user)).containsExactlyElementsOf(userRecordings)));
+       }
+
+       void sendRedording(String user, String sentence)
+       {
+               try
+               {
+                       MvcResult result = mockMvc
+                                       .perform(post("/{user}", user)
+                                                       .contentType(MediaType.TEXT_PLAIN)
+                                                       .content(sentence))
+                                       .andReturn();
+
+                       mockMvc.perform(asyncDispatch(result))
+                                       .andDo(print())
+                                       .andExpect(status().isOk())
+                                       .andExpect(jsonPath("$.username").value(user))
+                                       .andExpect(jsonPath("$.sentence").value(sentence));
+               }
+               catch (Exception e)
+               {
+                       throw new RuntimeException(e);
+               }
+       }
+
+
+       static class Consumer
+       {
+               private final MultiValueMap<String, TestRecording> received = new LinkedMultiValueMap<>();
+
+               @KafkaListener(groupId = "TEST", topics = TOPIC_OUT)
+               public synchronized void receive(
+                               @Header(KafkaHeaders.RECEIVED_KEY) String user,
+                               @Payload TestRecording recording)
+               {
+                       log.debug("Received message: {}={}", user, recording);
+                       received.add(user, recording);
+               }
+
+               synchronized List<TestRecording> receivedFor(String user)
+               {
+                       List<TestRecording> recordings = received.get(user);
+                       return recordings == null
+                                       ? List.of()
+                                       : received.get(user).stream().toList();
+               }
+       }
+
+       @TestConfiguration
+       static class Configuration
        {
+               @Bean
+               Consumer consumer()
+               {
+                       return new Consumer();
+               }
        }
 }
diff --git a/src/test/java/de/juplo/kafka/wordcount/splitter/TestRecording.java b/src/test/java/de/juplo/kafka/wordcount/splitter/TestRecording.java
new file mode 100644 (file)
index 0000000..f4aa016
--- /dev/null
@@ -0,0 +1,15 @@
+package de.juplo.kafka.wordcount.splitter;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class TestRecording
+{
+  String user;
+  String sentence;
+}