Ensure @AutoConfigureTestDatabase does not replace test databases

Update `@AutoConfigureTestDatabase` support so that by default test
databases are not replaced.

Fixes gh-35253

Author: philwebb

buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitectureCheck.java

@@ -168,21 +168,23 @@ private ArchRule allBeanFactoryPostProcessorBeanMethodsShouldBeStaticAndHaveNoPa
 			.and()
 			.haveRawReturnType(
 					Predicates.assignableTo("org.springframework.beans.factory.config.BeanFactoryPostProcessor"))
-			.should(haveNoParameters())
+			.should(onlyInjectEnvironment())
 			.andShould()
 			.beStatic()
 			.allowEmptyShould(true);
 	}
 
-	private ArchCondition<JavaMethod> haveNoParameters() {
-		return new ArchCondition<>("have no parameters") {
+	private ArchCondition<JavaMethod> onlyInjectEnvironment() {
+		return new ArchCondition<>("only inject Environment") {
 
 			@Override
 			public void check(JavaMethod item, ConditionEvents events) {
 				List<JavaParameter> parameters = item.getParameters();
-				if (!parameters.isEmpty()) {
-					events
-						.add(SimpleConditionEvent.violated(item, item.getDescription() + " should have no parameters"));
+				for (JavaParameter parameter : parameters) {
+					if (!"org.springframework.core.env.Environment".equals(parameter.getType().getName())) {
+						events.add(SimpleConditionEvent.violated(item,
+								item.getDescription() + " should only inject Environment"));
+					}
 				}
 			}
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/container/ContainerImageMetadata.java

@@ -0,0 +1,66 @@
+/*
+ * 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.autoconfigure.container;
+
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.core.AttributeAccessor;
+
+/**
+ * Metadata about a container image that can be added to an {@link AttributeAccessor}.
+ * Primarily designed to be attached to {@link BeanDefinition BeanDefinitions} created in
+ * support of Testcontainers or Docker Compose.
+ *
+ * @param imageName the contaimer image name or {@code null} if the image name is not yet
+ * known
+ * @author Phillip Webb
+ * @since 3.4.0
+ */
+public record ContainerImageMetadata(String imageName) {
+
+	static final String NAME = ContainerImageMetadata.class.getName();
+
+	/**
+	 * Add this container image metadata to the given attributes.
+	 * @param attributes the attributes to add the metadata to
+	 */
+	public void addTo(AttributeAccessor attributes) {
+		if (attributes != null) {
+			attributes.setAttribute(NAME, this);
+		}
+	}
+
+	/**
+	 * Return {@code true} if {@link ContainerImageMetadata} has been added to the given
+	 * attributes.
+	 * @param attributes the attributes to check
+	 * @return if metadata is present
+	 */
+	public static boolean isPresent(AttributeAccessor attributes) {
+		return getFrom(attributes) != null;
+	}
+
+	/**
+	 * Return {@link ContainerImageMetadata} from the given attributes or {@code null} if
+	 * no metadata has been added.
+	 * @param attributes the attributes
+	 * @return the metadata or {@code null}
+	 */
+	public static ContainerImageMetadata getFrom(AttributeAccessor attributes) {
+		return (attributes != null) ? (ContainerImageMetadata) attributes.getAttribute(NAME) : null;
+	}
+
+}

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/container/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * 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.
+ */
+
+/**
+ * Support classes related to auto-configuration involving containers.
+ */
+package org.springframework.boot.autoconfigure.container;

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/container/ContainerImageMetadataTests.java

@@ -0,0 +1,82 @@
+/*
+ * 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.autoconfigure.container;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.core.AttributeAccessor;
+import org.springframework.core.AttributeAccessorSupport;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link ContainerImageMetadata}.
+ *
+ * @author Phillip Webb
+ */
+class ContainerImageMetadataTests {
+
+	private ContainerImageMetadata metadata = new ContainerImageMetadata("test");
+
+	private AttributeAccessor attributes = new AttributeAccessorSupport() {
+
+	};
+
+	@Test
+	void addToWhenAttributesIsNullDoesNothing() {
+		this.metadata.addTo(null);
+	}
+
+	@Test
+	void addToAddsMetadata() {
+		this.metadata.addTo(this.attributes);
+		assertThat(this.attributes.getAttribute(ContainerImageMetadata.NAME)).isSameAs(this.metadata);
+	}
+
+	@Test
+	void isPresentWhenPresentReturnsTrue() {
+		this.metadata.addTo(this.attributes);
+		assertThat(ContainerImageMetadata.isPresent(this.attributes)).isTrue();
+	}
+
+	@Test
+	void isPresentWhenNotPresentReturnsFalse() {
+		assertThat(ContainerImageMetadata.isPresent(this.attributes)).isFalse();
+	}
+
+	@Test
+	void isPresentWhenNullAttributesReturnsFalse() {
+		assertThat(ContainerImageMetadata.isPresent(null)).isFalse();
+	}
+
+	@Test
+	void getFromWhenPresentReturnsMetadata() {
+		this.metadata.addTo(this.attributes);
+		assertThat(ContainerImageMetadata.getFrom(this.attributes)).isSameAs(this.metadata);
+	}
+
+	@Test
+	void getFromWhenNotPresentReturnsNull() {
+		assertThat(ContainerImageMetadata.getFrom(this.attributes)).isNull();
+	}
+
+	@Test
+	void getFromWhenNullAttributesReturnsNull() {
+		assertThat(ContainerImageMetadata.getFrom(null)).isNull();
+	}
+
+}

spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/DockerComposeServiceConnectionsApplicationListener.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * 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.
@@ -24,6 +24,7 @@
 
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.RootBeanDefinition;
+import org.springframework.boot.autoconfigure.container.ContainerImageMetadata;
 import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
 import org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactories;
 import org.springframework.boot.docker.compose.core.RunningService;
@@ -77,10 +78,13 @@ private void registerConnectionDetails(BeanDefinitionRegistry registry, List<Run
 	@SuppressWarnings("unchecked")
 	private <T> void register(BeanDefinitionRegistry registry, RunningService runningService,
 			Class<?> connectionDetailsType, ConnectionDetails connectionDetails) {
+		ContainerImageMetadata containerMetadata = new ContainerImageMetadata(runningService.image().toString());
 		String beanName = getBeanName(runningService, connectionDetailsType);
 		Class<T> beanType = (Class<T>) connectionDetails.getClass();
 		Supplier<T> beanSupplier = () -> (T) connectionDetails;
-		registry.registerBeanDefinition(beanName, new RootBeanDefinition(beanType, beanSupplier));
+		RootBeanDefinition beanDefinition = new RootBeanDefinition(beanType, beanSupplier);
+		containerMetadata.addTo(beanDefinition);
+		registry.registerBeanDefinition(beanName, beanDefinition);
 	}
 
 	private String getBeanName(RunningService runningService, Class<?> connectionDetailsType) {

spring-boot-project/spring-boot-test-autoconfigure/build.gradle

@@ -13,18 +13,23 @@ dependencies {
 	api(project(":spring-boot-project:spring-boot-test"))
 	api(project(":spring-boot-project:spring-boot-autoconfigure"))
 
+	dockerTestImplementation(project(":spring-boot-project:spring-boot-docker-compose"))
 	dockerTestImplementation(project(":spring-boot-project:spring-boot-testcontainers"))
 	dockerTestImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support-docker"))
+	dockerTestImplementation("com.zaxxer:HikariCP")
 	dockerTestImplementation("io.projectreactor:reactor-test")
 	dockerTestImplementation("com.redis:testcontainers-redis")
+	dockerTestImplementation("com.h2database:h2")
 	dockerTestImplementation("org.assertj:assertj-core")
 	dockerTestImplementation("org.junit.jupiter:junit-jupiter")
+	dockerTestImplementation("org.postgresql:postgresql")
 	dockerTestImplementation("org.testcontainers:cassandra")
 	dockerTestImplementation("org.testcontainers:couchbase")
 	dockerTestImplementation("org.testcontainers:elasticsearch")
 	dockerTestImplementation("org.testcontainers:junit-jupiter")
 	dockerTestImplementation("org.testcontainers:mongodb")
 	dockerTestImplementation("org.testcontainers:neo4j")
+	dockerTestImplementation("org.testcontainers:postgresql")
 	dockerTestImplementation("org.testcontainers:testcontainers")
 
 	dockerTestRuntimeOnly("io.lettuce:lettuce-core")

spring-boot-project/spring-boot-test-autoconfigure/src/dockerTest/java/org/springframework/boot/test/autoconfigure/jdbc/AutoConfigureTestDatabaseDockerComposeIntegrationTests.java

@@ -0,0 +1,95 @@
+/*
+ * 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.test.autoconfigure.jdbc;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import javax.sql.DataSource;
+
+import com.zaxxer.hikari.HikariDataSource;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
+import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
+import org.springframework.boot.test.autoconfigure.OverrideAutoConfiguration;
+import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabaseDockerComposeIntegrationTests.SetupDockerCompose;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.testsupport.container.DisabledIfDockerUnavailable;
+import org.springframework.boot.testsupport.container.TestImage;
+import org.springframework.context.ApplicationContextInitializer;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.support.TestPropertySourceUtils;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Integration tests for {@link AutoConfigureTestDatabase} with Docker Compose.
+ *
+ * @author Phillip Webb
+ */
+@SpringBootTest
+@ContextConfiguration(initializers = SetupDockerCompose.class)
+@AutoConfigureTestDatabase
+@OverrideAutoConfiguration(enabled = false)
+@DisabledIfDockerUnavailable
+class AutoConfigureTestDatabaseDockerComposeIntegrationTests {
+
+	@Autowired
+	private DataSource dataSource;
+
+	@Test
+	void dataSourceIsNotReplaced() {
+		assertThat(this.dataSource).isInstanceOf(HikariDataSource.class).isNotInstanceOf(EmbeddedDatabase.class);
+	}
+
+	@Configuration
+	@ImportAutoConfiguration(DataSourceAutoConfiguration.class)
+	static class Config {
+
+	}
+
+	static class SetupDockerCompose implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+
+		@Override
+		public void initialize(ConfigurableApplicationContext applicationContext) {
+			try {
+				Path composeFile = Files.createTempFile("", "-postgres-compose");
+				String composeFileContent = new ClassPathResource("postgres-compose.yaml")
+					.getContentAsString(StandardCharsets.UTF_8)
+					.replace("{imageName}", TestImage.POSTGRESQL.toString());
+				Files.writeString(composeFile, composeFileContent);
+				TestPropertySourceUtils.addInlinedPropertiesToEnvironment(applicationContext,
+						"spring.docker.compose.skip.in-tests=false", "spring.docker.compose.stop.command=down",
+						"spring.docker.compose.file=" + composeFile.toAbsolutePath().toString());
+			}
+			catch (IOException ex) {
+				throw new UncheckedIOException(ex);
+			}
+		}
+
+	}
+
+}