#2 add RabbitMQ support (#7)

Author: klu2

README.md

@@ -278,6 +278,23 @@ dependencies {
     * `minio.secret-key`
     * `minio.region`
 
+## RabbitMQ
+
+* **Module-ID**: rabbitmq
+* **Default-Image**: rabbitmq
+
+````kotlin
+dependencies {
+    testResourcesImplementation ("io.cloudflight.testresources.springboot:springboot-testresources-rabbitmq:0.0.3")
+}
+````
+
+* **Provided properties**:
+  * `spring.rabbitmq.host`
+  * `spring.rabbitmq.port`
+  * `spring.rabbitmq.username`
+  * `spring.rabbitmq.password`
+
 ## Redis
 
 * **Module-ID**: redis

settings.gradle.kts

@@ -9,9 +9,11 @@ include("springboot-testresources-minio")
 include("springboot-testresources-jdbc")
 include("springboot-testresources-jdbc:springboot-testresources-jdbc-mariadb")
 include("springboot-testresources-jdbc:springboot-testresources-jdbc-postgres")
+include("springboot-testresources-rabbitmq")
 include("springboot-testresources-redis")
 
 include("testprojects:jdbc:mariadb")
 include("testprojects:jdbc:postgres")
 include("testprojects:minio")
+include("testprojects:rabbitmq")
 include("testprojects:redis")

springboot-testresources-rabbitmq/build.gradle.kts

@@ -0,0 +1,5 @@
+description = "Spring Boot TestResourceProvider for RabbitMQ"
+
+dependencies {
+    implementation("org.testcontainers:rabbitmq")
+}

springboot-testresources-rabbitmq/src/main/java/io/cloudflight/testresources/springboot/rabbitmq/RabbitMQTestResourceProvider.java

@@ -0,0 +1,66 @@
+package io.cloudflight.testresources.springboot.rabbitmq;
+
+import io.micronaut.testresources.testcontainers.AbstractTestContainersProvider;
+import org.testcontainers.containers.RabbitMQContainer;
+import org.testcontainers.utility.DockerImageName;
+
+import java.util.*;
+
+public class RabbitMQTestResourceProvider extends AbstractTestContainersProvider<RabbitMQContainer> {
+
+    private static final String RABBITMQ_HOST = "spring.rabbitmq.host";
+    private static final String RABBITMQ_PORT = "spring.rabbitmq.port";
+    private static final String RABBITMQ_USERNAME = "spring.rabbitmq.username";
+    private static final String RABBITMQ_PASSWORD = "spring.rabbitmq.password";
+    private static final String DEFAULT_IMAGE = "rabbitmq";
+    private static final String SIMPLE_NAME = "rabbitmq";
+
+    private static final List<String> SUPPORTED_KEYS = List.of(RABBITMQ_HOST, RABBITMQ_PORT, RABBITMQ_USERNAME, RABBITMQ_PASSWORD);
+    private static final Set<String> SUPPORTED_KEYSET = Set.copyOf(SUPPORTED_KEYS);
+
+    @Override
+    public List<String> getResolvableProperties(Map<String, Collection<String>> propertyEntries, Map<String, Object> testResourcesConfig) {
+        return SUPPORTED_KEYS;
+    }
+
+    @Override
+    protected String getSimpleName() {
+        return SIMPLE_NAME;
+    }
+
+    @Override
+    protected String getDefaultImageName() {
+        return DEFAULT_IMAGE;
+    }
+
+    @Override
+    protected RabbitMQContainer createContainer(DockerImageName imageName, Map<String, Object> requestedProperties, Map<String, Object> testResourcesConfiguration) {
+        return new RabbitMQContainer(imageName);
+    }
+
+    @Override
+    protected Optional<String> resolveProperty(String propertyName, RabbitMQContainer container) {
+        switch (propertyName) {
+            case RABBITMQ_HOST -> {
+                return Optional.of(container.getHost());
+            }
+            case RABBITMQ_PORT -> {
+                return Optional.of(container.getAmqpPort().toString());
+            }
+            case RABBITMQ_USERNAME -> {
+                return Optional.of(container.getAdminUsername());
+            }
+            case RABBITMQ_PASSWORD -> {
+                return Optional.of(container.getAdminPassword());
+            }
+            default -> {
+                return Optional.empty();
+            }
+        }
+    }
+
+    @Override
+    protected boolean shouldAnswer(String propertyName, Map<String, Object> requestedProperties, Map<String, Object> testResourcesConfiguration) {
+        return SUPPORTED_KEYSET.contains(propertyName);
+    }
+}

springboot-testresources-rabbitmq/src/main/resources/META-INF/services/io.micronaut.testresources.core.TestResourcesResolver

@@ -0,0 +1 @@
+io.cloudflight.testresources.springboot.rabbitmq.RabbitMQTestResourceProvider

testprojects/rabbitmq/build.gradle.kts

@@ -0,0 +1,13 @@
+plugins {
+    id("io.micronaut.test-resources")
+}
+
+dependencies {
+    implementation("org.springframework.boot:spring-boot-starter-amqp")
+
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("org.awaitility:awaitility")
+
+    testRuntimeOnly(project(":springboot-testresources-client"))
+    testResourcesImplementation(project(":springboot-testresources-rabbitmq"))
+}

testprojects/rabbitmq/src/main/kotlin/io/cloudflight/testresources/springboot/rabbitmq/Application.kt

@@ -0,0 +1,29 @@
+package io.cloudflight.testresources.springboot.rabbitmq
+
+import org.springframework.amqp.core.Queue
+import org.springframework.amqp.rabbit.annotation.RabbitListener
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.stereotype.Service
+
+@SpringBootApplication
+class Application
+
+@Configuration
+class AmqpConfiguration {
+    @Bean
+    fun myQueue(): Queue {
+        return Queue("myQueue", false)
+    }
+}
+
+@Service
+class Receiver {
+
+    val messages  = mutableListOf<String>()
+    @RabbitListener(queues = ["myQueue"])
+    fun listen(message: String) {
+        messages.add(message)
+    }
+}

testprojects/rabbitmq/src/test/kotlin/io/cloudflight/testresources/springboot/rabbitmq/ApplicationTest.kt

@@ -0,0 +1,23 @@
+package io.cloudflight.testresources.springboot.rabbitmq
+
+import org.awaitility.Awaitility.await
+import org.junit.jupiter.api.Test
+import org.springframework.amqp.rabbit.core.RabbitTemplate
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.context.SpringBootTest
+import java.time.Duration.ofSeconds
+
+@SpringBootTest
+class ApplicationTest(
+    @Autowired private val rabbitTemplate: RabbitTemplate,
+    @Autowired private val receiver: Receiver
+) {
+
+    @Test
+    fun `send message via RabbitMQ`() {
+        rabbitTemplate.convertAndSend("myQueue", "Hello, world!");
+        await().atMost(ofSeconds(5)).until {
+            receiver.messages.size == 1 && receiver.messages.first() == "Hello, world!"
+        }
+    }
+}