Add ServiceBus Service Connection for Docker Compose and Testcontainers (#44019)

Author: eddumelendez

eng/versioning/external_dependencies.txt

@@ -397,6 +397,8 @@ springboot4_org.testcontainers:junit-jupiter;1.21.3
 springboot4_org.testcontainers:azure;1.21.3
 springboot4_jakarta.annotation:jakarta.annotation-api;3.0.0
 springboot4_ch.qos.logback:logback-classic;1.5.25
+springboot4_org.awaitility:awaitility;4.3.0
+springboot4_com.microsoft.sqlserver:mssql-jdbc;13.2.1.jre11
 # Used for Spring version updates
 springboot4_org.springframework.boot:spring-boot-dependencies;4.0.2
 springboot4_org.springframework.cloud:spring-cloud-dependencies;2025.1.0

sdk/spring/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Release History
 
+## 7.1.0 (Not Released)
+
+### Spring Cloud Azure Autoconfigure
+
+This section includes changes in `spring-cloud-azure-autoconfigure` module.
+
+#### New Features
+
+- Add ConnectionDetails for ServiceBus. [#44019](https://github.com/Azure/azure-sdk-for-java/pull/44019).
+
+### Spring Cloud Azure Docker Compose
+
+This section includes changes in `spring-cloud-azure-docker-compose` module.
+
+#### New Features
+
+- Add ServiceBusDockerComposeConnectionDetailsFactory. [#44019](https://github.com/Azure/azure-sdk-for-java/pull/44019).
+
+### Spring Cloud Azure Test Containers
+
+This section includes changes in `spring-cloud-azure-testcontainers` module.
+
+#### New Features
+
+- Add ServiceBusContainerConnectionDetailsFactory. [#44019](https://github.com/Azure/azure-sdk-for-java/pull/44019).
+
 ## 7.0.0 (2026-02-03)
 - This release is compatible with Spring Boot 4.0.0-4.0.2. (Note: 4.0.x (x>2) should be supported, but they aren't tested with this release.)
 - This release is compatible with Spring Cloud 2025.1.0. (Note: 2025.1.x (x>0) should be supported, but they aren't tested with this release.)

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/AzureServiceBusAutoConfiguration.java

@@ -6,12 +6,10 @@
 import com.azure.messaging.servicebus.ServiceBusClientBuilder;
 import com.azure.spring.cloud.autoconfigure.implementation.AzureServiceConfigurationBase;
 import com.azure.spring.cloud.autoconfigure.implementation.context.properties.AzureGlobalProperties;
-import com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties.AzureServiceBusProperties;
+import com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties.AzureServiceBusPropertiesConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
-import org.springframework.boot.context.properties.ConfigurationProperties;
-import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
 
 /**
@@ -22,22 +20,16 @@
 @ConditionalOnClass(ServiceBusClientBuilder.class)
 @ConditionalOnProperty(value = "spring.cloud.azure.servicebus.enabled", havingValue = "true", matchIfMissing = true)
 @Import({
+    AzureServiceBusPropertiesConfiguration.class,
     AzureServiceBusClientBuilderConfiguration.class,
     AzureServiceBusProducerClientConfiguration.class,
     AzureServiceBusConsumerClientConfiguration.class,
     AzureServiceBusProcessorClientConfiguration.class
 })
 public class AzureServiceBusAutoConfiguration extends AzureServiceConfigurationBase {
 
-
     AzureServiceBusAutoConfiguration(AzureGlobalProperties azureGlobalProperties) {
         super(azureGlobalProperties);
     }
 
-    @Bean
-    @ConfigurationProperties(AzureServiceBusProperties.PREFIX)
-    AzureServiceBusProperties azureServiceBusProperties() {
-        return loadProperties(getAzureGlobalProperties(), new AzureServiceBusProperties());
-    }
-
 }

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/AzureServiceBusClientBuilderConfiguration.java

@@ -4,24 +4,27 @@
 package com.azure.spring.cloud.autoconfigure.implementation.servicebus;
 
 import com.azure.messaging.servicebus.ServiceBusClientBuilder;
-import com.azure.spring.cloud.autoconfigure.implementation.condition.ConditionalOnAnyProperty;
 import com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties.AzureServiceBusProperties;
+import com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties.AzureServiceBusPropertiesConfiguration;
 import com.azure.spring.cloud.core.customizer.AzureServiceClientBuilderCustomizer;
 import com.azure.spring.cloud.core.implementation.util.AzureSpringIdentifier;
 import com.azure.spring.cloud.core.provider.connectionstring.ServiceConnectionStringProvider;
 import com.azure.spring.cloud.core.provider.connectionstring.StaticConnectionStringProvider;
 import com.azure.spring.cloud.core.service.AzureServiceType;
 import com.azure.spring.cloud.service.implementation.servicebus.factory.ServiceBusClientBuilderFactory;
 import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
 
 @Configuration(proxyBeanMethods = false)
+@Import(AzureServiceBusPropertiesConfiguration.class)
 @ConditionalOnClass(ServiceBusClientBuilder.class)
-@ConditionalOnAnyProperty(prefix = "spring.cloud.azure.servicebus", name = { "connection-string", "namespace" })
+@ConditionalOnBean(AzureServiceBusProperties.class)
 class AzureServiceBusClientBuilderConfiguration {
 
     private final AzureServiceBusProperties serviceBusProperties;

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/AzureServiceBusMessagingAutoConfiguration.java

@@ -7,8 +7,8 @@
 import com.azure.messaging.servicebus.ServiceBusClientBuilder;
 import com.azure.messaging.servicebus.ServiceBusMessage;
 import com.azure.messaging.servicebus.ServiceBusReceivedMessage;
-import com.azure.spring.cloud.autoconfigure.implementation.condition.ConditionalOnAnyProperty;
 import com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties.AzureServiceBusProperties;
+import com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties.AzureServiceBusPropertiesConfiguration;
 import com.azure.spring.cloud.core.customizer.AzureServiceClientBuilderCustomizer;
 import com.azure.spring.cloud.core.implementation.credential.resolver.AzureTokenCredentialResolver;
 import com.azure.spring.cloud.core.provider.connectionstring.ServiceConnectionStringProvider;
@@ -58,10 +58,10 @@
 @Configuration(proxyBeanMethods = false)
 @ConditionalOnClass(ServiceBusTemplate.class)
 @ConditionalOnProperty(value = "spring.cloud.azure.servicebus.enabled", havingValue = "true", matchIfMissing = true)
-@ConditionalOnAnyProperty(prefix = "spring.cloud.azure.servicebus", name = { "connection-string", "namespace" })
 @ConditionalOnBean(AzureServiceBusProperties.class)
 @AutoConfigureAfter(AzureServiceBusAutoConfiguration.class)
 @Import({
+    AzureServiceBusPropertiesConfiguration.class,
     AzureServiceBusMessagingAutoConfiguration.ServiceBusTemplateConfiguration.class,
     AzureServiceBusMessagingAutoConfiguration.ProcessorContainerConfiguration.class
 })

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/properties/AzureServiceBusConnectionDetails.java

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties;
+
+import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
+
+public interface AzureServiceBusConnectionDetails extends ConnectionDetails {
+
+    String getConnectionString();
+
+}

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/properties/AzureServiceBusPropertiesConfiguration.java

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties;
+
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Import;
+
+@Import({
+    ConfigurationWithConnectionDetailsBean.class,
+    ConfigurationWithoutConnectionDetailsBean.class,
+})
+@EnableConfigurationProperties
+public class AzureServiceBusPropertiesConfiguration {
+}

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/properties/ConfigurationWithConnectionDetailsBean.java

@@ -0,0 +1,46 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties;
+
+import com.azure.spring.cloud.autoconfigure.implementation.context.properties.AzureGlobalProperties;
+import com.azure.spring.cloud.autoconfigure.implementation.properties.utils.AzureGlobalPropertiesUtils;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
+import org.springframework.boot.context.properties.bind.BindResult;
+import org.springframework.boot.context.properties.bind.Bindable;
+import org.springframework.boot.context.properties.bind.Binder;
+import org.springframework.context.annotation.Bean;
+import org.springframework.core.env.Environment;
+
+@ConditionalOnClass(ConnectionDetails.class)
+@ConditionalOnBean(AzureServiceBusConnectionDetails.class)
+class ConfigurationWithConnectionDetailsBean {
+
+    private final Environment environment;
+    private final AzureGlobalProperties globalProperties;
+    private final AzureServiceBusConnectionDetails connectionDetails;
+
+    ConfigurationWithConnectionDetailsBean(
+        Environment environment,
+        AzureGlobalProperties globalProperties,
+        AzureServiceBusConnectionDetails connectionDetails) {
+        this.environment = environment;
+        this.globalProperties = globalProperties;
+        this.connectionDetails = connectionDetails;
+    }
+
+    @Bean
+    AzureServiceBusProperties azureServiceBusProperties() {
+        AzureServiceBusProperties propertiesLoadFromGlobalProperties =
+            AzureGlobalPropertiesUtils.loadProperties(globalProperties, new AzureServiceBusProperties());
+        BindResult<AzureServiceBusProperties> bindResult = Binder.get(environment)
+            .bind(AzureServiceBusProperties.PREFIX, Bindable.ofInstance(propertiesLoadFromGlobalProperties));
+        AzureServiceBusProperties properties = bindResult.isBound() ? bindResult.get()
+            : propertiesLoadFromGlobalProperties;
+        properties.setConnectionString(connectionDetails.getConnectionString());
+        return properties;
+    }
+
+}

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/properties/ConfigurationWithoutConnectionDetailsBean.java

@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties;
+
+import com.azure.spring.cloud.autoconfigure.implementation.condition.ConditionalOnAnyProperty;
+import com.azure.spring.cloud.autoconfigure.implementation.context.properties.AzureGlobalProperties;
+import com.azure.spring.cloud.autoconfigure.implementation.properties.utils.AzureGlobalPropertiesUtils;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+
+@ConditionalOnMissingBean(type = "com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties.AzureServiceBusConnectionDetails")
+@ConditionalOnProperty(value = "spring.cloud.azure.servicebus.enabled", havingValue = "true", matchIfMissing = true)
+@ConditionalOnAnyProperty(prefix = "spring.cloud.azure.servicebus", name = {"connection-string", "namespace"})
+class ConfigurationWithoutConnectionDetailsBean {
+
+    private final AzureGlobalProperties azureGlobalProperties;
+
+    ConfigurationWithoutConnectionDetailsBean(AzureGlobalProperties azureGlobalProperties) {
+        this.azureGlobalProperties = azureGlobalProperties;
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    @ConfigurationProperties(AzureServiceBusProperties.PREFIX)
+    AzureServiceBusProperties azureServiceBusProperties() {
+        return AzureGlobalPropertiesUtils.loadProperties(azureGlobalProperties, new AzureServiceBusProperties());
+    }
+
+}

sdk/spring/spring-cloud-azure-autoconfigure/src/test/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/AzureServiceBusAutoConfigurationTests.java

@@ -8,6 +8,7 @@
 import com.azure.messaging.servicebus.models.ServiceBusReceiveMode;
 import com.azure.spring.cloud.autoconfigure.implementation.AbstractAzureServiceConfigurationTests;
 import com.azure.spring.cloud.autoconfigure.implementation.context.properties.AzureGlobalProperties;
+import com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties.AzureServiceBusConnectionDetails;
 import com.azure.spring.cloud.autoconfigure.implementation.servicebus.properties.AzureServiceBusProperties;
 import com.azure.spring.cloud.core.properties.profile.AzureEnvironmentProperties;
 import com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider;
@@ -81,7 +82,7 @@ void configureAzureServiceBusPropertiesWithGlobalDefaults() {
         azureProperties.getCredential().setClientSecret("azure-client-secret");
         azureProperties.getRetry().getExponential().setBaseDelay(Duration.ofSeconds(2));
 
-        this.contextRunner
+        this.getMinimalContextRunner()
             .withBean("azureProperties", AzureGlobalProperties.class, () -> azureProperties)
             .withPropertyValues(
                 "spring.cloud.azure.servicebus.credential.client-id=servicebus-client-id",
@@ -104,7 +105,7 @@ void configureServiceBusDomainNameOverrideGlobalDefault() {
         AzureGlobalProperties azureProperties = new AzureGlobalProperties();
         azureProperties.getProfile().setCloudType(AzureProfileOptionsProvider.CloudType.AZURE_US_GOVERNMENT);
 
-        this.contextRunner
+        this.getMinimalContextRunner()
                 .withBean("azureProperties", AzureGlobalProperties.class, () -> azureProperties)
                 .withPropertyValues(
                         "spring.cloud.azure.servicebus.domain-name=servicebus.chinacloudapi.cn"
@@ -120,7 +121,7 @@ void configureServiceBusDomainNameOverrideGlobalDefault() {
 
     @Test
     void configureAmqpTransportTypeShouldApply() {
-        this.contextRunner
+        this.getMinimalContextRunner()
             .withBean("azureProperties", AzureGlobalProperties.class, AzureGlobalProperties::new)
             .withPropertyValues("spring.cloud.azure.servicebus.client.transport-type=AmqpWebSockets")
             .run(context -> {
@@ -132,7 +133,7 @@ void configureAmqpTransportTypeShouldApply() {
 
     @Test
     void configureRetryShouldApply() {
-        this.contextRunner
+        this.getMinimalContextRunner()
             .withBean("azureProperties", AzureGlobalProperties.class, AzureGlobalProperties::new)
             .withPropertyValues(
                 "spring.cloud.azure.servicebus.retry.mode=fixed",
@@ -297,4 +298,20 @@ void consumerSubscriptionNameShouldConfigureConsumerClient() {
                 assertThat(context).hasSingleBean(AzureServiceBusConsumerClientConfiguration.class);
             });
     }
+
+    @Test
+    void connectionDetailsHasHigherPriority() {
+        String connectionString = String.format(CONNECTION_STRING_FORMAT, "property-namespace");
+        this.contextRunner
+            .withPropertyValues(
+                "spring.cloud.azure.servicebus.connection-string=" + connectionString
+            )
+            .withBean(AzureGlobalProperties.class, AzureGlobalProperties::new)
+            .withBean(AzureServiceBusConnectionDetails.class, CustomAzureServiceBusConnectionDetails::new)
+            .run(context -> {
+                assertThat(context).hasSingleBean(AzureServiceBusProperties.class);
+                AzureServiceBusProperties properties = context.getBean(AzureServiceBusProperties.class);
+                assertEquals(CustomAzureServiceBusConnectionDetails.CONNECTION_STRING, properties.getConnectionString());
+            });
+    }
 }