Add spring-cloud-azure-servicebus example

eddumelendez · Jan 10, 2025 · 40a883d · 40a883d
1 parent 3016260
commit 40a883d
Show file tree

Hide file tree

Showing 7 changed files with 340 additions and 0 deletions.
diff --git a/spring-cloud-azure-servicebus/pom.xml b/spring-cloud-azure-servicebus/pom.xml
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-parent</artifactId>
+		<version>3.3.4</version>
+		<relativePath/> <!-- lookup parent from repository -->
+	</parent>
+	<groupId>com.example</groupId>
+	<artifactId>spring-cloud-azure-servicebus</artifactId>
+	<version>0.0.1-SNAPSHOT</version>
+	<name>spring-cloud-azure-servicebus</name>
+	<description>Demo project for Spring Boot</description>
+	<properties>
+		<java.version>21</java.version>
+		<spring-cloud-azure.version>5.19.0</spring-cloud-azure.version>
+		<testcontainers.version>1.20.4</testcontainers.version>
+	</properties>
+	<dependencies>
+		<dependency>
+			<groupId>com.azure.spring</groupId>
+			<artifactId>spring-cloud-azure-starter-servicebus</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>com.azure</groupId>
+					<artifactId>azure-messaging-servicebus</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
+		<dependency>
+			<groupId>com.azure</groupId>
+			<artifactId>azure-messaging-servicebus</artifactId>
+			<version>7.17.8</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.testcontainers</groupId>
+			<artifactId>junit-jupiter</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.awaitility</groupId>
+			<artifactId>awaitility</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>com.azure.spring</groupId>
+				<artifactId>spring-cloud-azure-dependencies</artifactId>
+				<version>${spring-cloud-azure.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+		</plugins>
+	</build>
+
+	<repositories>
+		<repository>
+			<id>spring-milestones</id>
+			<name>Spring Milestones</name>
+			<url>https://repo.spring.io/milestone</url>
+			<snapshots>
+				<enabled>false</enabled>
+			</snapshots>
+		</repository>
+	</repositories>
+	<pluginRepositories>
+		<pluginRepository>
+			<id>spring-milestones</id>
+			<name>Spring Milestones</name>
+			<url>https://repo.spring.io/milestone</url>
+			<snapshots>
+				<enabled>false</enabled>
+			</snapshots>
+		</pluginRepository>
+	</pluginRepositories>
+
+</project>
diff --git a/...n/java/com/example/springcloudazureeservicebus/SpringCloudAzureServiceBusApplication.java b/...n/java/com/example/springcloudazureeservicebus/SpringCloudAzureServiceBusApplication.java
@@ -0,0 +1,13 @@
+package com.example.springcloudazureservicebus;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class SpringCloudAzureServiceBusApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.run(SpringCloudAzureServiceBusApplication.class, args);
+	}
+
+}
diff --git a/spring-cloud-azure-servicebus/src/main/resources/application.properties b/spring-cloud-azure-servicebus/src/main/resources/application.properties
diff --git a/...va/com/example/springcloudazureservicebus/SpringCloudAzureServiceBusApplicationTests.java b/...va/com/example/springcloudazureservicebus/SpringCloudAzureServiceBusApplicationTests.java
@@ -0,0 +1,105 @@
+package com.example.springcloudazureservicebus;
+
+import com.azure.messaging.servicebus.ServiceBusMessage;
+import com.azure.messaging.servicebus.ServiceBusReceivedMessage;
+import com.azure.messaging.servicebus.ServiceBusSenderClient;
+import com.azure.spring.cloud.service.servicebus.consumer.ServiceBusErrorHandler;
+import com.azure.spring.cloud.service.servicebus.consumer.ServiceBusRecordMessageListener;
+import com.github.dockerjava.api.model.Capability;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.DisabledIfEnvironmentVariable;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.test.context.DynamicPropertyRegistry;
+import org.springframework.test.context.DynamicPropertySource;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.Network;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+import org.testcontainers.utility.MountableFile;
+
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.waitAtMost;
+
+@SpringBootTest(properties = { "spring.cloud.azure.servicebus.entity-name=queue.1",
+		"spring.cloud.azure.servicebus.entity-type=queue" })
+@Testcontainers
+class SpringCloudAzureServiceBusApplicationTests {
+
+	private static final Network network = Network.newNetwork();
+
+	private static final int AZURE_SERVICEBUS_PORT = 5672;
+
+	private static final GenericContainer<?> azureSqlEdge = new GenericContainer<>(
+			"mcr.microsoft.com/azure-sql-edge:latest")
+		.withExposedPorts(1433)
+		.withNetwork(network)
+		.withNetworkAliases("sqledge")
+		.withEnv("ACCEPT_EULA", "Y")
+		.withEnv("MSSQL_SA_PASSWORD", "yourStrong(!)Password")
+		.withCreateContainerCmdModifier(cmd -> cmd.getHostConfig().withCapAdd(Capability.SYS_PTRACE));
+
+	@Container
+	private static final GenericContainer<?> serviceBus = new GenericContainer<>(
+			"mcr.microsoft.com/azure-messaging/servicebus-emulator:latest")
+		.withCopyFileToContainer(MountableFile.forClasspathResource("Config.json"),
+				"/ServiceBus_Emulator/ConfigFiles/Config.json")
+		.withExposedPorts(AZURE_SERVICEBUS_PORT)
+		.waitingFor(Wait.forLogMessage(".*Emulator Service is Successfully Up!.*", 1))
+		.withNetwork(network)
+		.withEnv("SQL_SERVER", "sqledge")
+		.withEnv("MSSQL_SA_PASSWORD", "yourStrong(!)Password")
+		.withEnv("ACCEPT_EULA", "Y")
+		.dependsOn(azureSqlEdge);
+
+	@DynamicPropertySource
+	static void properties(DynamicPropertyRegistry registry) {
+		var serviceBusHost = serviceBus.getHost();
+		var serviceBusPort = serviceBus.getMappedPort(AZURE_SERVICEBUS_PORT);
+		var connectionString = "Endpoint=sb://%s:%d;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"
+			.formatted(serviceBusHost, serviceBusPort);
+		registry.add("spring.cloud.azure.servicebus.connection-string", () -> connectionString);
+	}
+
+	@Autowired
+	private ServiceBusSenderClient senderClient;
+
+	@Test
+	void contextLoads() {
+		this.senderClient.sendMessage(new ServiceBusMessage("testcontainers"));
+
+		waitAtMost(Duration.ofSeconds(30)).pollDelay(Duration.ofSeconds(5)).untilAsserted(() -> {
+			assertThat(Config.messages).hasSize(1);
+			assertThat(Config.messages.getFirst().getBody().toString()).isEqualTo("testcontainers");
+		});
+	}
+
+	@TestConfiguration
+	static class Config {
+
+		static final List<ServiceBusReceivedMessage> messages = new ArrayList<>();
+
+		@Bean
+		ServiceBusRecordMessageListener processMessage() {
+			return context -> {
+				messages.add(context.getMessage());
+			};
+		}
+
+		@Bean
+		ServiceBusErrorHandler errorHandler() {
+			return (context) -> {
+				throw new RuntimeException("Error processing message: " + context.getException().getMessage());
+			};
+		}
+
+	}
+
+}
diff --git a/spring-cloud-azure-servicebus/src/test/resources/Config.json b/spring-cloud-azure-servicebus/src/test/resources/Config.json
@@ -0,0 +1,108 @@
+{
+  "UserConfig": {
+    "Namespaces": [
+      {
+        "Name": "sbemulatorns",
+        "Queues": [
+          {
+            "Name": "queue.1",
+            "Properties": {
+              "DeadLetteringOnMessageExpiration": false,
+              "DefaultMessageTimeToLive": "PT1H",
+              "DuplicateDetectionHistoryTimeWindow": "PT20S",
+              "ForwardDeadLetteredMessagesTo": "",
+              "ForwardTo": "",
+              "LockDuration": "PT1M",
+              "MaxDeliveryCount": 10,
+              "RequiresDuplicateDetection": false,
+              "RequiresSession": false
+            }
+          }
+        ],
+
+        "Topics": [
+          {
+            "Name": "topic.1",
+            "Properties": {
+              "DefaultMessageTimeToLive": "PT1H",
+              "DuplicateDetectionHistoryTimeWindow": "PT20S",
+              "RequiresDuplicateDetection": false
+            },
+            "Subscriptions": [
+              {
+                "Name": "subscription.1",
+                "Properties": {
+                  "DeadLetteringOnMessageExpiration": false,
+                  "DefaultMessageTimeToLive": "PT1H",
+                  "LockDuration": "PT1M",
+                  "MaxDeliveryCount": 10,
+                  "ForwardDeadLetteredMessagesTo": "",
+                  "ForwardTo": "",
+                  "RequiresSession": false
+                },
+                "Rules": [
+                  {
+                    "Name": "app-prop-filter-1",
+                    "Properties": {
+                      "FilterType": "Correlation",
+                      "CorrelationFilter": {
+                        "ContentType": "application/text",
+                        "CorrelationId": "id1",
+                        "Label": "subject1",
+                        "MessageId": "msgid1",
+                        "ReplyTo": "someQueue",
+                        "ReplyToSessionId": "sessionId",
+                        "SessionId": "session1",
+                        "To": "xyz"
+                      }
+                    }
+                  }
+                ]
+              },
+              {
+                "Name": "subscription.2",
+                "Properties": {
+                  "DeadLetteringOnMessageExpiration": false,
+                  "DefaultMessageTimeToLive": "PT1H",
+                  "LockDuration": "PT1M",
+                  "MaxDeliveryCount": 10,
+                  "ForwardDeadLetteredMessagesTo": "",
+                  "ForwardTo": "",
+                  "RequiresSession": false
+                },
+                "Rules": [
+                  {
+                    "Name": "user-prop-filter-1",
+                    "Properties": {
+                      "FilterType": "Correlation",
+                      "CorrelationFilter": {
+                        "Properties": {
+                          "prop3": "value3"
+                        }
+                      }
+                    }
+                  }
+                ]
+              },
+              {
+                "Name": "subscription.3",
+                "Properties": {
+                  "DeadLetteringOnMessageExpiration": false,
+                  "DefaultMessageTimeToLive": "PT1H",
+                  "LockDuration": "PT1M",
+                  "MaxDeliveryCount": 10,
+                  "ForwardDeadLetteredMessagesTo": "",
+                  "ForwardTo": "",
+                  "RequiresSession": false
+                }
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "Logging": {
+      "Type": "File"
+    }
+  }
+}
diff --git a/spring-cloud-azure-servicebus/src/test/resources/application.properties b/spring-cloud-azure-servicebus/src/test/resources/application.properties
diff --git a/spring-cloud-azure-servicebus/src/test/resources/logback-test.xml b/spring-cloud-azure-servicebus/src/test/resources/logback-test.xml
@@ -0,0 +1,18 @@
+<configuration>
+
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <!-- encoders are assigned the type
+             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %logger - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT"/>
+    </root>
+
+    <logger name="org.testcontainers" level="INFO"/>
+    <logger name="com.github.dockerjava" level="WARN"/>
+
+</configuration>