Polish "Add @ServiceConnection support for MongoDBAtlasLocalContainer"

See gh-45310
This commit is contained in:
Andy Wilkinson 2025-07-02 15:39:12 +01:00
parent aa06c0d02a
commit f8dbcef977
10 changed files with 78 additions and 52 deletions

View File

@ -150,7 +150,7 @@ The following service connection factories are provided in the `spring-boot-test
| Containers of type javadoc:{url-testcontainers-jdbc-javadoc}/org.testcontainers.containers.JdbcDatabaseContainer[] | Containers of type javadoc:{url-testcontainers-jdbc-javadoc}/org.testcontainers.containers.JdbcDatabaseContainer[]
| javadoc:org.springframework.boot.autoconfigure.mongo.MongoConnectionDetails[] | javadoc:org.springframework.boot.autoconfigure.mongo.MongoConnectionDetails[]
| Containers of type javadoc:{url-testcontainers-mongodb-javadoc}/org.testcontainers.containers.MongoDBContainer[] | Containers of type javadoc:{url-testcontainers-mongodb-javadoc}/org.testcontainers.containers.MongoDBContainer[] or javadoc:{url-testcontainers-mongodb-javadoc}/org.testcontainers.mongodb.MongoDBAtlasLocalContainer[]
| javadoc:org.springframework.boot.neo4j.autoconfigure.Neo4jConnectionDetails[] | javadoc:org.springframework.boot.neo4j.autoconfigure.Neo4jConnectionDetails[]
| Containers of type javadoc:{url-testcontainers-neo4j-javadoc}/org.testcontainers.containers.Neo4jContainer[] | Containers of type javadoc:{url-testcontainers-neo4j-javadoc}/org.testcontainers.containers.Neo4jContainer[]

View File

@ -42,6 +42,8 @@ dependencies {
dockerTestImplementation(project(":spring-boot-project:spring-boot-test")) dockerTestImplementation(project(":spring-boot-project:spring-boot-test"))
dockerTestImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support-docker")) dockerTestImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support-docker"))
dockerTestImplementation(testFixtures(project(":spring-boot-project:spring-boot-docker-compose"))) dockerTestImplementation(testFixtures(project(":spring-boot-project:spring-boot-docker-compose")))
dockerTestImplementation("org.testcontainers:junit-jupiter")
dockerTestImplementation("org.mongodb:mongodb-driver-sync")
testImplementation(project(":spring-boot-project:spring-boot-test")) testImplementation(project(":spring-boot-project:spring-boot-test"))
testImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support")) testImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support"))

View File

@ -0,0 +1,57 @@
/*
* Copyright 2012-present 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.mongodb.testcontainers;
import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoClients;
import org.junit.jupiter.api.Test;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.mongodb.MongoDBAtlasLocalContainer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.mongodb.autoconfigure.MongoConnectionDetails;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
import org.springframework.boot.testsupport.container.TestImage;
import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Integration tests for {@link MongoDbAtlasLocalContainerConnectionDetailsFactory}.
*
* @author Andy Wilkinson
*/
@SpringJUnitConfig
@Testcontainers(disabledWithoutDocker = true)
class MongoDbAtlasLocalContainerConnectionDetailsFactoryIntegrationTests {
@Container
@ServiceConnection
static final MongoDBAtlasLocalContainer mongoDb = TestImage.container(MongoDBAtlasLocalContainer.class);
@Autowired(required = false)
private MongoConnectionDetails connectionDetails;
@Test
void connectionCanBeMadeToContainer() {
assertThat(this.connectionDetails).isNotNull();
MongoClient client = MongoClients.create(this.connectionDetails.getConnectionString());
assertThat(client.listDatabaseNames()).containsExactly("admin", "config", "local");
}
}

View File

@ -30,8 +30,9 @@ import org.springframework.boot.testcontainers.service.connection.ServiceConnect
/** /**
* Abstract {@link ContainerConnectionDetailsFactory} to create * Abstract {@link ContainerConnectionDetailsFactory} to create
* {@link MongoConnectionDetails} from a * {@link MongoConnectionDetails} from a
* {@link ServiceConnection @ServiceConnection}-annotated {@link T}. * {@link ServiceConnection @ServiceConnection}-annotated MongoDB container.
* *
* @param <T> type of MongoDB container supported by the factory
* @author Moritz Halbritter * @author Moritz Halbritter
* @author Andy Wilkinson * @author Andy Wilkinson
* @author Phillip Webb * @author Phillip Webb

View File

@ -29,10 +29,10 @@ import org.springframework.boot.testcontainers.service.connection.ServiceConnect
* *
* @author Wouter Blancquaert * @author Wouter Blancquaert
*/ */
class MongoAtlasContainerConnectionDetailsFactory class MongoDbAtlasLocalContainerConnectionDetailsFactory
extends AbstractMongoContainerConnectionDetailsFactory<MongoDBAtlasLocalContainer> { extends AbstractMongoContainerConnectionDetailsFactory<MongoDBAtlasLocalContainer> {
MongoAtlasContainerConnectionDetailsFactory() { MongoDbAtlasLocalContainerConnectionDetailsFactory() {
super(MongoDBAtlasLocalContainer::getDatabaseConnectionString); super(MongoDBAtlasLocalContainer::getDatabaseConnectionString);
} }

View File

@ -19,7 +19,6 @@ package org.springframework.boot.mongodb.testcontainers;
import org.testcontainers.containers.MongoDBContainer; import org.testcontainers.containers.MongoDBContainer;
import org.springframework.boot.mongodb.autoconfigure.MongoConnectionDetails; import org.springframework.boot.mongodb.autoconfigure.MongoConnectionDetails;
import org.springframework.boot.ssl.SslBundle;
import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory; import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection; import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
@ -31,10 +30,10 @@ import org.springframework.boot.testcontainers.service.connection.ServiceConnect
* @author Andy Wilkinson * @author Andy Wilkinson
* @author Phillip Webb * @author Phillip Webb
*/ */
class MongoContainerConnectionDetailsFactory class MongoDbContainerConnectionDetailsFactory
extends AbstractMongoContainerConnectionDetailsFactory<MongoDBContainer> { extends AbstractMongoContainerConnectionDetailsFactory<MongoDBContainer> {
MongoContainerConnectionDetailsFactory() { MongoDbContainerConnectionDetailsFactory() {
super(MongoDBContainer::getReplicaSetUrl); super(MongoDBContainer::getReplicaSetUrl);
} }

View File

@ -1,5 +1,5 @@
# Connection Details Factories # Connection Details Factories
org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactory=\ org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactory=\
org.springframework.boot.mongodb.docker.compose.MongoDockerComposeConnectionDetailsFactory,\ org.springframework.boot.mongodb.docker.compose.MongoDockerComposeConnectionDetailsFactory,\
org.springframework.boot.mongodb.testcontainers.MongoAtlasContainerConnectionDetailsFactory,\ org.springframework.boot.mongodb.testcontainers.MongoDbAtlasLocalContainerConnectionDetailsFactory,\
org.springframework.boot.mongodb.testcontainers.MongoContainerConnectionDetailsFactory org.springframework.boot.mongodb.testcontainers.MongoDbContainerConnectionDetailsFactory

View File

@ -26,11 +26,11 @@ import org.springframework.boot.testcontainers.service.connection.ContainerConne
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
/** /**
* Tests for {@link MongoContainerConnectionDetailsFactory}. * Tests for {@link AbstractMongoContainerConnectionDetailsFactory}.
* *
* @author Moritz Halbritter * @author Moritz Halbritter
*/ */
class MongoContainerConnectionDetailsFactoryTests { class AbstractMongoContainerConnectionDetailsFactoryTests {
@Test @Test
void shouldRegisterHints() { void shouldRegisterHints() {

View File

@ -1,41 +0,0 @@
/*
* Copyright 2012-2025 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.service.connection.mongo;
import com.mongodb.ConnectionString;
import org.junit.jupiter.api.Test;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.predicate.RuntimeHintsPredicates;
import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactoryHints;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link MongoAtlasContainerConnectionDetailsFactoryTests}.
*
* @author Wouter Blancquaert
*/
class MongoAtlasContainerConnectionDetailsFactoryTests {
@Test
void shouldRegisterHints() {
RuntimeHints hints = ContainerConnectionDetailsFactoryHints.getRegisteredHints(getClass().getClassLoader());
assertThat(RuntimeHintsPredicates.reflection().onType(ConnectionString.class)).accepts(hints);
}
}

View File

@ -40,6 +40,7 @@ import org.testcontainers.elasticsearch.ElasticsearchContainer;
import org.testcontainers.grafana.LgtmStackContainer; import org.testcontainers.grafana.LgtmStackContainer;
import org.testcontainers.kafka.ConfluentKafkaContainer; import org.testcontainers.kafka.ConfluentKafkaContainer;
import org.testcontainers.ldap.LLdapContainer; import org.testcontainers.ldap.LLdapContainer;
import org.testcontainers.mongodb.MongoDBAtlasLocalContainer;
import org.testcontainers.redpanda.RedpandaContainer; import org.testcontainers.redpanda.RedpandaContainer;
import org.testcontainers.utility.DockerImageName; import org.testcontainers.utility.DockerImageName;
@ -157,6 +158,13 @@ public enum TestImage {
(container) -> ((MongoDBContainer) container).withStartupAttempts(5) (container) -> ((MongoDBContainer) container).withStartupAttempts(5)
.withStartupTimeout(Duration.ofMinutes(5))), .withStartupTimeout(Duration.ofMinutes(5))),
/**
* A container image suitable for testing MongoDB Atlas.
*/
MONGODB_ATLAS("mongodb/mongodb-atlas-local", "8.0.4", () -> MongoDBAtlasLocalContainer.class,
(container) -> ((MongoDBAtlasLocalContainer) container).withStartupAttempts(5)
.withStartupTimeout(Duration.ofMinutes(5))),
/** /**
* A container image suitable for testing MySQL. * A container image suitable for testing MySQL.
*/ */