From 3b57139b1e7ba2f986d35025ac9ab009fb43277d Mon Sep 17 00:00:00 2001 From: Ralf Ueberfuhr Date: Fri, 28 Jun 2024 12:54:46 +0200 Subject: [PATCH] Add test for producer. --- .../schulung/accounts/AccountsApiTests.java | 2 + .../schulung/accounts/IndexPageTests.java | 2 + .../boundary/AccountsBoundaryTests.java | 2 + .../AutoConfigureDisabledInitialization.java | 17 ++ .../AutoConfigureEnabledInitialization.java | 17 ++ .../domain/CustomersInitializerTests.java | 1 + .../accounts/domain/CustomersServiceTest.java | 1 + .../kafka/AutoConfigureEmbeddedKafka.java | 155 ++++++++++++++++++ .../kafka/CustomJsonDeserializer.java | 23 +++ .../kafka/CustomerEventsProducerTests.java | 54 ++++++ sample-requests/POST-customers.http | 4 +- 11 files changed, 276 insertions(+), 2 deletions(-) create mode 100644 account-service-provider/src/test/java/de/sample/schulung/accounts/domain/AutoConfigureDisabledInitialization.java create mode 100644 account-service-provider/src/test/java/de/sample/schulung/accounts/domain/AutoConfigureEnabledInitialization.java create mode 100644 account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/AutoConfigureEmbeddedKafka.java create mode 100644 account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/CustomJsonDeserializer.java create mode 100644 account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/CustomerEventsProducerTests.java diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/AccountsApiTests.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/AccountsApiTests.java index ca970ed..908b335 100644 --- a/account-service-provider/src/test/java/de/sample/schulung/accounts/AccountsApiTests.java +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/AccountsApiTests.java @@ -1,5 +1,6 @@ package de.sample.schulung.accounts; +import de.sample.schulung.accounts.domain.AutoConfigureDisabledInitialization; import de.sample.schulung.accounts.kafka.AutoConfigureKafkaTemplateMock; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Nested; @@ -20,6 +21,7 @@ @AutoConfigureMockMvc @AutoConfigureTestDatabase @AutoConfigureKafkaTemplateMock +@AutoConfigureDisabledInitialization class AccountsApiTests { @Autowired diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/IndexPageTests.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/IndexPageTests.java index 8ad13da..2883369 100644 --- a/account-service-provider/src/test/java/de/sample/schulung/accounts/IndexPageTests.java +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/IndexPageTests.java @@ -1,5 +1,6 @@ package de.sample.schulung.accounts; +import de.sample.schulung.accounts.domain.AutoConfigureDisabledInitialization; import de.sample.schulung.accounts.kafka.AutoConfigureKafkaTemplateMock; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -17,6 +18,7 @@ @AutoConfigureMockMvc @AutoConfigureTestDatabase @AutoConfigureKafkaTemplateMock +@AutoConfigureDisabledInitialization public class IndexPageTests { @Autowired diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/boundary/AccountsBoundaryTests.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/boundary/AccountsBoundaryTests.java index 8d9b5ac..9ccfa7e 100644 --- a/account-service-provider/src/test/java/de/sample/schulung/accounts/boundary/AccountsBoundaryTests.java +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/boundary/AccountsBoundaryTests.java @@ -1,5 +1,6 @@ package de.sample.schulung.accounts.boundary; +import de.sample.schulung.accounts.domain.AutoConfigureDisabledInitialization; import de.sample.schulung.accounts.domain.CustomersService; import de.sample.schulung.accounts.domain.NotFoundException; import de.sample.schulung.accounts.kafka.AutoConfigureKafkaTemplateMock; @@ -30,6 +31,7 @@ @AutoConfigureMockMvc @AutoConfigureTestDatabase @AutoConfigureKafkaTemplateMock +@AutoConfigureDisabledInitialization public class AccountsBoundaryTests { @Autowired diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/AutoConfigureDisabledInitialization.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/AutoConfigureDisabledInitialization.java new file mode 100644 index 0000000..62ccb21 --- /dev/null +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/AutoConfigureDisabledInitialization.java @@ -0,0 +1,17 @@ +package de.sample.schulung.accounts.domain; + +import org.springframework.test.context.TestPropertySource; + +import java.lang.annotation.*; + +@Documented +@Inherited +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +@TestPropertySource( + properties = """ + application.customers.initialization.enabled=false + """ +) +public @interface AutoConfigureDisabledInitialization { +} diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/AutoConfigureEnabledInitialization.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/AutoConfigureEnabledInitialization.java new file mode 100644 index 0000000..d1c1ef4 --- /dev/null +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/AutoConfigureEnabledInitialization.java @@ -0,0 +1,17 @@ +package de.sample.schulung.accounts.domain; + +import org.springframework.test.context.TestPropertySource; + +import java.lang.annotation.*; + +@Documented +@Inherited +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +@TestPropertySource( + properties = """ + application.customers.initialization.enabled=true + """ +) +public @interface AutoConfigureEnabledInitialization { +} diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/CustomersInitializerTests.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/CustomersInitializerTests.java index d4d57d5..8e52d31 100644 --- a/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/CustomersInitializerTests.java +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/CustomersInitializerTests.java @@ -17,6 +17,7 @@ ) @AutoConfigureTestDatabase @AutoConfigureKafkaTemplateMock +@AutoConfigureEnabledInitialization public class CustomersInitializerTests { @MockBean diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/CustomersServiceTest.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/CustomersServiceTest.java index b1cedd6..17a8674 100644 --- a/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/CustomersServiceTest.java +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/domain/CustomersServiceTest.java @@ -14,6 +14,7 @@ @SpringBootTest @AutoConfigureTestDatabase @AutoConfigureKafkaTemplateMock +@AutoConfigureDisabledInitialization public class CustomersServiceTest { @Autowired diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/AutoConfigureEmbeddedKafka.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/AutoConfigureEmbeddedKafka.java new file mode 100644 index 0000000..a4ea366 --- /dev/null +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/AutoConfigureEmbeddedKafka.java @@ -0,0 +1,155 @@ +package de.sample.schulung.accounts.kafka; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; +import lombok.SneakyThrows; +import org.apache.kafka.clients.admin.NewTopic; +import org.apache.kafka.clients.consumer.ConsumerConfig; +import org.apache.kafka.clients.consumer.ConsumerRecord; +import org.apache.kafka.common.serialization.UUIDDeserializer; +import org.junit.jupiter.api.extension.AfterEachCallback; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.api.extension.ExtensionContext; +import org.springframework.boot.test.context.TestConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Import; +import org.springframework.context.event.ContextClosedEvent; +import org.springframework.context.event.ContextRefreshedEvent; +import org.springframework.context.event.EventListener; +import org.springframework.kafka.core.DefaultKafkaConsumerFactory; +import org.springframework.kafka.listener.ContainerProperties; +import org.springframework.kafka.listener.KafkaMessageListenerContainer; +import org.springframework.kafka.listener.MessageListener; +import org.springframework.kafka.support.serializer.ErrorHandlingDeserializer; +import org.springframework.kafka.support.serializer.JsonDeserializer; +import org.springframework.kafka.test.EmbeddedKafkaBroker; +import org.springframework.kafka.test.context.EmbeddedKafka; +import org.springframework.kafka.test.utils.ContainerTestUtils; +import org.springframework.stereotype.Component; +import org.springframework.test.context.TestPropertySource; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +import java.lang.annotation.*; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.concurrent.TimeUnit; + +/** + * Auto-configures an {@link EmbeddedKafka} + * and provides an extension to run, reset and stop the container.
+ * We can get the following beans injected into our test class + * 
+ * \u0040Autowired
+ * EmbeddedKafkaBroker kafka;
+ * \u0040Autowired
+ * KafkaTestContext<Key,Value> context;
+ *
+ */ +@Documented +@Inherited +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +// Kafka Configuration +@EmbeddedKafka +@TestPropertySource( + properties = """ + spring.kafka.bootstrap-servers=${spring.embedded.kafka.brokers} + # we disable this in production, but need this for the tests + spring.kafka.producer.properties."[spring.json.add.type.headers]"=true + """ +) +@Import({ + AutoConfigureEmbeddedKafka.EmbeddedKafkaConfiguration.class, + AutoConfigureEmbeddedKafka.KafkaMessageListenerContainerLifecycleHandler.class +}) +@ExtendWith(AutoConfigureEmbeddedKafka.EmbeddedKafkaExtension.class) +public @interface AutoConfigureEmbeddedKafka { + + @RequiredArgsConstructor + @Getter(AccessLevel.PRIVATE) + class KafkaTestContext { + + private final BlockingQueue> records; + private final KafkaMessageListenerContainer container; + + @SneakyThrows + public Optional> poll(long timeout, TimeUnit unit) { + return Optional.ofNullable(this.records.poll(timeout, unit)); + } + + } + + + @TestConfiguration + class EmbeddedKafkaConfiguration { + + @Bean + @SuppressWarnings("SpringJavaInjectionPointsAutowiringInspection") + KafkaTestContext createKafkaTestContext(EmbeddedKafkaBroker kafka, List topics) { + final var consumerFactory = new DefaultKafkaConsumerFactory<>( + Map.of( + ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, kafka.getBrokersAsString(), + ConsumerConfig.GROUP_ID_CONFIG, "consumer", + ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG, "true", + ConsumerConfig.AUTO_COMMIT_INTERVAL_MS_CONFIG, "10", + ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG, "60000", + // not needed, but must not be null + ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, UUIDDeserializer.class, + ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, ErrorHandlingDeserializer.class, + ErrorHandlingDeserializer.VALUE_DESERIALIZER_CLASS, CustomJsonDeserializer.class.getName(), + JsonDeserializer.TRUSTED_PACKAGES, "*", + ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest" + ) + ); + final var containerProperties = new ContainerProperties( + topics + .stream() + .map(NewTopic::name) + .toArray(String[]::new) + ); + final var container = new KafkaMessageListenerContainer<>(consumerFactory, containerProperties); + final var records = new LinkedBlockingQueue>(); + container.setupMessageListener((MessageListener) records::add); + return new KafkaTestContext<>(records, container); + } + + } + + @Component + @RequiredArgsConstructor + class KafkaMessageListenerContainerLifecycleHandler { + + private final KafkaTestContext context; + private final EmbeddedKafkaBroker kafka; + + @EventListener(ContextRefreshedEvent.class) + public void startup() { + context.getContainer().start(); + ContainerTestUtils.waitForAssignment(context.getContainer(), kafka.getPartitionsPerTopic()); + } + + @EventListener(ContextClosedEvent.class) + public void shutdown() { + context.getContainer().stop(); + } + + } + + // we need to reset the records between the tests + class EmbeddedKafkaExtension implements AfterEachCallback { + + @Override + public void afterEach(ExtensionContext context) { + SpringExtension + .getApplicationContext(context) + .getBean(KafkaTestContext.class) + .getRecords() + .clear(); + } + } + +} diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/CustomJsonDeserializer.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/CustomJsonDeserializer.java new file mode 100644 index 0000000..6e1b710 --- /dev/null +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/CustomJsonDeserializer.java @@ -0,0 +1,23 @@ +package de.sample.schulung.accounts.kafka; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.PropertyNamingStrategies; +import com.fasterxml.jackson.databind.SerializationFeature; +import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; +import org.springframework.kafka.support.JacksonUtils; +import org.springframework.kafka.support.serializer.JsonDeserializer; + +public class CustomJsonDeserializer extends JsonDeserializer { + + private static ObjectMapper createCustomObjectMapper() { + final var result = JacksonUtils.enhancedObjectMapper(); + result.setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE); + result.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); + result.registerModule(new JavaTimeModule()); + return result; + } + + public CustomJsonDeserializer() { + super(createCustomObjectMapper()); + } +} \ No newline at end of file diff --git a/account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/CustomerEventsProducerTests.java b/account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/CustomerEventsProducerTests.java new file mode 100644 index 0000000..9532050 --- /dev/null +++ b/account-service-provider/src/test/java/de/sample/schulung/accounts/kafka/CustomerEventsProducerTests.java @@ -0,0 +1,54 @@ +package de.sample.schulung.accounts.kafka; + +import de.sample.schulung.accounts.domain.AutoConfigureDisabledInitialization; +import de.sample.schulung.accounts.domain.Customer; +import de.sample.schulung.accounts.domain.CustomersService; +import de.sample.schulung.accounts.kafka.AutoConfigureEmbeddedKafka.KafkaTestContext; +import org.apache.kafka.clients.consumer.ConsumerRecord; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase; +import org.springframework.boot.test.context.SpringBootTest; + +import java.time.LocalDate; +import java.time.Month; +import java.util.UUID; +import java.util.concurrent.TimeUnit; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.from; + +@SpringBootTest +@AutoConfigureTestDatabase +@AutoConfigureEmbeddedKafka +@AutoConfigureDisabledInitialization +class CustomerEventsProducerTests { + + @Autowired + CustomersService service; + @Autowired + KafkaTestContext context; + + + @Test + void shouldProduceCustomerEventWhenCustomerIsCreated() { + var customer = new Customer(); + customer.setName("Tom Mayer"); + customer.setState(Customer.CustomerState.ACTIVE); + customer.setDateOfBirth(LocalDate.of(2000, Month.DECEMBER, 20)); + + service.createCustomer(customer); + + assertThat(context.poll(3, TimeUnit.SECONDS)) + .isPresent() + .get() + .returns(KafkaConstants.CUSTOMER_EVENTS_TOPIC, from(ConsumerRecord::topic)) + .extracting(ConsumerRecord::value) + .returns("created", from(CustomerEventRecord::eventType)) + .returns(customer.getUuid(), from(CustomerEventRecord::uuid)) + .extracting(CustomerEventRecord::customer) + .returns("Tom Mayer", from(CustomerRecord::name)); + + } + +} diff --git a/sample-requests/POST-customers.http b/sample-requests/POST-customers.http index 89004f8..ba7efbb 100644 --- a/sample-requests/POST-customers.http +++ b/sample-requests/POST-customers.http @@ -3,8 +3,8 @@ Content-Type: application/json Accept: application/json { - "name": "Tom Mayer", - "birthdate": "1985-07-30", + "name": "Julia Schmidt", + "birthdate": "1996-01-10", "state": "active" }