From 4d4b189cce3af9328861038b7dae954744e4cef2 Mon Sep 17 00:00:00 2001
From: Phillip Webb <phil.webb@broadcom.com>
Date: Wed, 21 Aug 2024 21:04:13 -0700
Subject: [PATCH] Prevent duplicate DynamicPropertyRegistry beans

Remove the Spring Framework registered `DynamicPropertyRegistry` when
using Testcontainers.

See gh-41839
---
 ...tionWithSpringBootTestIntegrationTest.java | 56 +++++++++++++++++++
 ...ainersPropertySourceAutoConfiguration.java | 22 ++++++++
 2 files changed, 78 insertions(+)
 create mode 100644 spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/properties/TestcontainersPropertySourceAutoConfigurationWithSpringBootTestIntegrationTest.java

diff --git a/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/properties/TestcontainersPropertySourceAutoConfigurationWithSpringBootTestIntegrationTest.java b/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/properties/TestcontainersPropertySourceAutoConfigurationWithSpringBootTestIntegrationTest.java
new file mode 100644
index 00000000000..85791e4d439
--- /dev/null
+++ b/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/properties/TestcontainersPropertySourceAutoConfigurationWithSpringBootTestIntegrationTest.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright 2012-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.testcontainers.properties;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.SpringBootConfiguration;
+import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.boot.testcontainers.properties.TestcontainersPropertySourceAutoConfigurationWithSpringBootTestIntegrationTest.TestConfig;
+import org.springframework.context.annotation.Bean;
+import org.springframework.test.context.DynamicPropertyRegistry;
+
+/**
+ * Tests for {@link TestcontainersPropertySourceAutoConfiguration} when combined with
+ * {@link SpringBootTest @SpringBootTest}.
+ *
+ * @author Phillip Webb
+ */
+@SpringBootTest(classes = TestConfig.class)
+class TestcontainersPropertySourceAutoConfigurationWithSpringBootTestIntegrationTest {
+
+	@Test
+	void injectsRegistry() {
+
+	}
+
+	@TestConfiguration
+	@ImportAutoConfiguration(TestcontainersPropertySourceAutoConfiguration.class)
+	@SpringBootConfiguration
+	static class TestConfig {
+
+		@Bean
+		String example(DynamicPropertyRegistry registry) {
+			registry.add("test", () -> "test");
+			return "Hello";
+		}
+
+	}
+
+}
diff --git a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/properties/TestcontainersPropertySourceAutoConfiguration.java b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/properties/TestcontainersPropertySourceAutoConfiguration.java
index e6219f2d2d4..64c1fcaf36f 100644
--- a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/properties/TestcontainersPropertySourceAutoConfiguration.java
+++ b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/properties/TestcontainersPropertySourceAutoConfiguration.java
@@ -16,6 +16,10 @@
 
 package org.springframework.boot.testcontainers.properties;
 
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+import org.springframework.beans.factory.support.DefaultSingletonBeanRegistry;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.context.ConfigurableApplicationContext;
@@ -39,9 +43,27 @@ public class TestcontainersPropertySourceAutoConfiguration {
 	TestcontainersPropertySourceAutoConfiguration() {
 	}
 
+	@Bean
+	static RemoveTestDynamicPropertyRegistryBeanPostProcessor removeTestDynamicPropertyRegistryBeanPostProcessor() {
+		return new RemoveTestDynamicPropertyRegistryBeanPostProcessor();
+	}
+
 	@Bean
 	static DynamicPropertyRegistry dynamicPropertyRegistry(ConfigurableApplicationContext applicationContext) {
 		return TestcontainersPropertySource.attach(applicationContext);
 	}
 
+	static class RemoveTestDynamicPropertyRegistryBeanPostProcessor implements BeanFactoryPostProcessor {
+
+		@Override
+		public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
+			if (beanFactory instanceof DefaultSingletonBeanRegistry singletonBeanRegistry) {
+				singletonBeanRegistry
+					.destroySingleton("org.springframework.test.context.support.DynamicPropertiesContextCustomizer"
+							+ ".dynamicPropertyRegistry");
+			}
+		}
+
+	}
+
 }