Create service connections from Testcontainers-managed containers

Building upon the auto-configuration support for service connections,
this commit adds support for deriving connection details from a
Testcontainers-managed container. Several service-specific
annotations have been introduced. These annotations can be used on a
container field to indicate that it is a source of the details for
a service connection.

See gh-34658

Co-Authored-By: Phillip Webb <[email protected]>
Co-Authored-By: Mortitz Halbritter <[email protected]>

Author: 3 people

spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc

@@ -29,11 +29,46 @@ Testcontainers can be used in a Spring Boot test as follows:
 include::code:vanilla/MyIntegrationTests[]
 
 This will start up a docker container running Neo4j (if Docker is running locally) before any of the tests are run.
-In most cases, you will need to configure the application using details from the running container, such as container IP or port.
+In most cases, you will need to configure the application to connect to the service running in the container.
 
-This can be done with a static `@DynamicPropertySource` method that allows adding dynamic property values to the Spring Environment.
 
-include::code:dynamicproperties/MyIntegrationTests[]
+[[howto.testing.testcontainers.service-connections]]
+==== Service Connections
+A service connection is a connection to any remote service.
+Spring Boot's auto-configuration can consume the details of a service connection and use them to establish a connection to a remote service.
+When doing so, the connection details take precedence over any connection-related configuration properties.
+
+When using Testcontainers, connection details can be automatically created for a service running in a container by annotating the container field in the test class.
+
+include::code:MyIntegrationTests[]
+
+Thanks to `@Neo4jServiceConnection`, the above configuration allows Neo4j-related beans in the application to communicate with Neo4j running inside the Testcontainers-managed Docker container.
+This is done by automatically defining a `Neo4jConnectionDetails` bean which is then used by the Neo4j auto-configuration, overriding any connection-related configuration properties.
+
+The following service connection annotations are provided by `spring-boot-test-autoconfigure`:
+
+- `@CassandraServiceConnection`
+- `@CouchbaseServiceConnection`
+- `@ElasticsearchServiceConnection`
+- `@InfluxDbServiceConnection`
+- `@JdbcServiceConnection`
+- `@KafkaServiceConnection`
+- `@MongoServiceConnection`
+- `@Neo4jServiceConnection`
+- `@R2dbcServiceConnection`
+- `@RabbitServiceConnection`
+- `@RedisServiceConnection`
+
+As with the earlier `@Neo4jConnectionDetails` example, each can be used on a container field. Doing so will automatically configure the application to connect to the service running in the container.
+
+
+
+[[howto.testing.testcontainers.dynamic-properties]]
+==== Dynamic Properties
+A slightly more verbose but also more flexible alternative to service connections is `@DynamicPropertySource`.
+A static `@DynamicPropertySource` method allows adding dynamic property values to the Spring Environment.
+
+include::code:/MyIntegrationTests[]
 
 The above configuration allows Neo4j-related beans in the application to communicate with Neo4j running inside the Testcontainers-managed Docker container.
 

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/testcontainers/serviceconnections/MyIntegrationTests.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2012-2023 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.docs.howto.testing.testcontainers.serviceconnections;
+
+import org.junit.jupiter.api.Test;
+import org.testcontainers.containers.Neo4jContainer;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+import org.springframework.boot.test.autoconfigure.neo4j.Neo4jServiceConnection;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+@Testcontainers
+class MyIntegrationTests {
+
+	@Container
+	@Neo4jServiceConnection
+	static Neo4jContainer<?> neo4j = new Neo4jContainer<>("neo4j:4.2");
+
+	@Test
+	void myTest() {
+		// ...
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/testing/testcontainers/serviceconnections/MyIntegrationTests.kt

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2012-2023 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.docs.howto.testing.testcontainers.serviceconnection
+
+import org.junit.jupiter.api.Test
+import org.springframework.boot.test.autoconfigure.neo4j.Neo4jServiceConnection;
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.test.context.DynamicPropertyRegistry
+import org.springframework.test.context.DynamicPropertySource
+import org.testcontainers.containers.Neo4jContainer
+import org.testcontainers.junit.jupiter.Container
+import org.testcontainers.junit.jupiter.Testcontainers
+
+@SpringBootTest
+@Testcontainers
+internal class MyIntegrationTests {
+
+	@Test
+	fun myTest() {
+		// ...
+	}
+
+	companion object {
+
+		@Container
+		@Neo4jServiceConnection
+		var neo4j: Neo4jContainer<*> = Neo4jContainer<Nothing>("neo4j:4.2")
+
+	}
+
+}

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

@@ -60,6 +60,21 @@ dependencies {
 	optional("org.apache.tomcat.embed:tomcat-embed-core")
 	optional("org.mongodb:mongodb-driver-reactivestreams")
 	optional("org.mongodb:mongodb-driver-sync")
+	optional("org.testcontainers:cassandra")
+	optional("org.testcontainers:couchbase")
+	optional("org.testcontainers:elasticsearch")
+	optional("org.testcontainers:influxdb")
+	optional("org.testcontainers:jdbc")
+	optional("org.testcontainers:kafka")
+	optional("org.testcontainers:mariadb")
+	optional("org.testcontainers:mongodb")
+	optional("org.testcontainers:mssqlserver")
+	optional("org.testcontainers:mysql")
+	optional("org.testcontainers:neo4j")
+	optional("org.testcontainers:postgresql")
+	optional("org.testcontainers:rabbitmq")
+	optional("org.testcontainers:r2dbc")
+	optional("org.testcontainers:testcontainers")
 	optional("io.micrometer:micrometer-tracing")
 
 	testImplementation(project(":spring-boot-project:spring-boot-actuator"))
@@ -85,6 +100,7 @@ dependencies {
 	testImplementation("org.eclipse:yasson")
 	testImplementation("org.hibernate.validator:hibernate-validator")
 	testImplementation("org.hsqldb:hsqldb")
+	testImplementation("org.influxdb:influxdb-java")
 	testImplementation("org.jooq:jooq") {
 		exclude group: "javax.xml.bind", module: "jaxb-api"
 	}
@@ -95,15 +111,11 @@ dependencies {
 	testImplementation("org.mockito:mockito-junit-jupiter")
 	testImplementation("org.skyscreamer:jsonassert")
 	testImplementation("org.springframework:spring-core-test")
+	testImplementation("org.springframework.amqp:spring-rabbit")
 	testImplementation("org.springframework.hateoas:spring-hateoas")
+	testImplementation("org.springframework.kafka:spring-kafka")
 	testImplementation("org.springframework.plugin:spring-plugin-core")
-	testImplementation("org.testcontainers:cassandra")
-	testImplementation("org.testcontainers:couchbase")
-	testImplementation("org.testcontainers:elasticsearch")
 	testImplementation("org.testcontainers:junit-jupiter")
-	testImplementation("org.testcontainers:mongodb")
-	testImplementation("org.testcontainers:neo4j")
-	testImplementation("org.testcontainers:testcontainers")
 	testImplementation("org.thymeleaf:thymeleaf")
 }
 

spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/amqp/RabbitContainerConnectionDetailsFactory.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2012-2023 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.amqp;
+
+import java.net.URI;
+import java.util.List;
+
+import org.testcontainers.containers.RabbitMQContainer;
+
+import org.springframework.boot.autoconfigure.amqp.RabbitConnectionDetails;
+import org.springframework.boot.test.autoconfigure.service.connection.ContainerConnectionDetailsFactory;
+import org.springframework.boot.test.autoconfigure.service.connection.ContainerConnectionSource;
+
+/**
+ * {@link ContainerConnectionDetailsFactory} for
+ * {@link RabbitServiceConnection @RabbitServiceConnection}-annotated
+ * {@link RabbitMQContainer} fields.
+ *
+ * @author Moritz Halbritter
+ * @author Andy Wilkinson
+ * @author Phillip Webb
+ */
+class RabbitContainerConnectionDetailsFactory
+		extends ContainerConnectionDetailsFactory<RabbitServiceConnection, RabbitConnectionDetails, RabbitMQContainer> {
+
+	@Override
+	protected RabbitConnectionDetails getContainerConnectionDetails(
+			ContainerConnectionSource<RabbitServiceConnection, RabbitConnectionDetails, RabbitMQContainer> source) {
+		return new RabbitMqContainerConnectionDetails(source);
+	}
+
+	/**
+	 * {@link RabbitConnectionDetails} backed by a {@link ContainerConnectionSource}.
+	 */
+	private static final class RabbitMqContainerConnectionDetails extends ContainerConnectionDetails
+			implements RabbitConnectionDetails {
+
+		private final RabbitMQContainer container;
+
+		private RabbitMqContainerConnectionDetails(
+				ContainerConnectionSource<RabbitServiceConnection, RabbitConnectionDetails, RabbitMQContainer> source) {
+			super(source);
+			this.container = source.getContainer();
+		}
+
+		@Override
+		public String getUsername() {
+			return this.container.getAdminUsername();
+		}
+
+		@Override
+		public String getPassword() {
+			return this.container.getAdminPassword();
+		}
+
+		@Override
+		public String getVirtualHost() {
+			return null;
+		}
+
+		@Override
+		public List<Address> getAddresses() {
+			URI uri = URI.create(this.container.getAmqpUrl());
+			return List.of(new Address(uri.getHost(), uri.getPort()));
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/amqp/RabbitServiceConnection.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2012-2023 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.amqp;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.boot.autoconfigure.amqp.RabbitConnectionDetails;
+import org.springframework.boot.test.autoconfigure.service.connection.ServiceConnection;
+
+/**
+ * Annotation that indicates that a field provides a RabbitMQ service connection.
+ *
+ * @author Moritz Halbritter
+ * @author Andy Wilkinson
+ * @author Phillip Webb
+ * @since 3.1.0
+ * @see RabbitConnectionDetails
+ * @see ServiceConnection
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.FIELD, ElementType.TYPE })
+@ServiceConnection(RabbitConnectionDetails.class)
+public @interface RabbitServiceConnection {
+
+}

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

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2012-2023 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.
+ */
+
+/**
+ * Auto-configuration for using RabbitMQ in tests.
+ */
+package org.springframework.boot.test.autoconfigure.amqp;