Skip to content

Commit d49b37a

Browse files
committed
Merge pull request #45310 from blancqua
* gh-45310: Polish "Add @Serviceconnection support for MongoDBAtlasLocalContainer" Add @Serviceconnection support for MongoDBAtlasLocalContainer Closes gh-45310
2 parents 887b064 + f8dbcef commit d49b37a

File tree

9 files changed

+176
-17
lines changed

9 files changed

+176
-17
lines changed

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/testcontainers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ The following service connection factories are provided in the `spring-boot-test
150150
| Containers of type javadoc:{url-testcontainers-jdbc-javadoc}/org.testcontainers.containers.JdbcDatabaseContainer[]
151151

152152
| javadoc:org.springframework.boot.autoconfigure.mongo.MongoConnectionDetails[]
153-
| Containers of type javadoc:{url-testcontainers-mongodb-javadoc}/org.testcontainers.containers.MongoDBContainer[]
153+
| Containers of type javadoc:{url-testcontainers-mongodb-javadoc}/org.testcontainers.containers.MongoDBContainer[] or javadoc:{url-testcontainers-mongodb-javadoc}/org.testcontainers.mongodb.MongoDBAtlasLocalContainer[]
154154

155155
| javadoc:org.springframework.boot.neo4j.autoconfigure.Neo4jConnectionDetails[]
156156
| Containers of type javadoc:{url-testcontainers-neo4j-javadoc}/org.testcontainers.containers.Neo4jContainer[]

spring-boot-project/spring-boot-mongodb/build.gradle

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ dependencies {
4242
dockerTestImplementation(project(":spring-boot-project:spring-boot-test"))
4343
dockerTestImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support-docker"))
4444
dockerTestImplementation(testFixtures(project(":spring-boot-project:spring-boot-docker-compose")))
45+
dockerTestImplementation("org.testcontainers:junit-jupiter")
46+
dockerTestImplementation("org.mongodb:mongodb-driver-sync")
4547

4648
testImplementation(project(":spring-boot-project:spring-boot-test"))
4749
testImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support"))
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/*
2+
* Copyright 2012-present the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.mongodb.testcontainers;
18+
19+
import com.mongodb.client.MongoClient;
20+
import com.mongodb.client.MongoClients;
21+
import org.junit.jupiter.api.Test;
22+
import org.testcontainers.junit.jupiter.Container;
23+
import org.testcontainers.junit.jupiter.Testcontainers;
24+
import org.testcontainers.mongodb.MongoDBAtlasLocalContainer;
25+
26+
import org.springframework.beans.factory.annotation.Autowired;
27+
import org.springframework.boot.mongodb.autoconfigure.MongoConnectionDetails;
28+
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
29+
import org.springframework.boot.testsupport.container.TestImage;
30+
import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
31+
32+
import static org.assertj.core.api.Assertions.assertThat;
33+
34+
/**
35+
* Integration tests for {@link MongoDbAtlasLocalContainerConnectionDetailsFactory}.
36+
*
37+
* @author Andy Wilkinson
38+
*/
39+
@SpringJUnitConfig
40+
@Testcontainers(disabledWithoutDocker = true)
41+
class MongoDbAtlasLocalContainerConnectionDetailsFactoryIntegrationTests {
42+
43+
@Container
44+
@ServiceConnection
45+
static final MongoDBAtlasLocalContainer mongoDb = TestImage.container(MongoDBAtlasLocalContainer.class);
46+
47+
@Autowired(required = false)
48+
private MongoConnectionDetails connectionDetails;
49+
50+
@Test
51+
void connectionCanBeMadeToContainer() {
52+
assertThat(this.connectionDetails).isNotNull();
53+
MongoClient client = MongoClients.create(this.connectionDetails.getConnectionString());
54+
assertThat(client.listDatabaseNames()).containsExactly("admin", "config", "local");
55+
}
56+
57+
}
Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-present the original author or authors.
2+
* Copyright 2012-2025 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,8 +16,10 @@
1616

1717
package org.springframework.boot.mongodb.testcontainers;
1818

19+
import java.util.function.Function;
20+
1921
import com.mongodb.ConnectionString;
20-
import org.testcontainers.containers.MongoDBContainer;
22+
import org.testcontainers.containers.GenericContainer;
2123

2224
import org.springframework.boot.mongodb.autoconfigure.MongoConnectionDetails;
2325
import org.springframework.boot.ssl.SslBundle;
@@ -26,38 +28,48 @@
2628
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
2729

2830
/**
29-
* {@link ContainerConnectionDetailsFactory} to create {@link MongoConnectionDetails} from
30-
* a {@link ServiceConnection @ServiceConnection}-annotated {@link MongoDBContainer}.
31+
* Abstract {@link ContainerConnectionDetailsFactory} to create
32+
* {@link MongoConnectionDetails} from a
33+
* {@link ServiceConnection @ServiceConnection}-annotated MongoDB container.
3134
*
35+
* @param <T> type of MongoDB container supported by the factory
3236
* @author Moritz Halbritter
3337
* @author Andy Wilkinson
3438
* @author Phillip Webb
39+
* @author Wouter Blancquaert
3540
*/
36-
class MongoContainerConnectionDetailsFactory
37-
extends ContainerConnectionDetailsFactory<MongoDBContainer, MongoConnectionDetails> {
41+
abstract class AbstractMongoContainerConnectionDetailsFactory<T extends GenericContainer<T>>
42+
extends ContainerConnectionDetailsFactory<T, MongoConnectionDetails> {
43+
44+
private final Function<T, String> connectionStringFunction;
3845

39-
MongoContainerConnectionDetailsFactory() {
46+
AbstractMongoContainerConnectionDetailsFactory(Function<T, String> connectionStringFunction) {
4047
super(ANY_CONNECTION_NAME, "com.mongodb.ConnectionString");
48+
this.connectionStringFunction = connectionStringFunction;
4149
}
4250

4351
@Override
44-
protected MongoConnectionDetails getContainerConnectionDetails(ContainerConnectionSource<MongoDBContainer> source) {
45-
return new MongoContainerConnectionDetails(source);
52+
protected MongoConnectionDetails getContainerConnectionDetails(ContainerConnectionSource<T> source) {
53+
return new MongoContainerConnectionDetails<>(source, this.connectionStringFunction);
4654
}
4755

4856
/**
4957
* {@link MongoConnectionDetails} backed by a {@link ContainerConnectionSource}.
5058
*/
51-
private static final class MongoContainerConnectionDetails extends ContainerConnectionDetails<MongoDBContainer>
52-
implements MongoConnectionDetails {
59+
private static final class MongoContainerConnectionDetails<T extends GenericContainer<T>>
60+
extends ContainerConnectionDetails<T> implements MongoConnectionDetails {
61+
62+
private final Function<T, String> connectionStringFunction;
5363

54-
private MongoContainerConnectionDetails(ContainerConnectionSource<MongoDBContainer> source) {
64+
private MongoContainerConnectionDetails(ContainerConnectionSource<T> source,
65+
Function<T, String> connectionStringFunction) {
5566
super(source);
67+
this.connectionStringFunction = connectionStringFunction;
5668
}
5769

5870
@Override
5971
public ConnectionString getConnectionString() {
60-
return new ConnectionString(getContainer().getReplicaSetUrl());
72+
return new ConnectionString(this.connectionStringFunction.apply(getContainer()));
6173
}
6274

6375
@Override
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/*
2+
* Copyright 2012-2025 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.mongodb.testcontainers;
18+
19+
import org.testcontainers.mongodb.MongoDBAtlasLocalContainer;
20+
21+
import org.springframework.boot.mongodb.autoconfigure.MongoConnectionDetails;
22+
import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory;
23+
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
24+
25+
/**
26+
* {@link ContainerConnectionDetailsFactory} to create {@link MongoConnectionDetails} from
27+
* a {@link ServiceConnection @ServiceConnection}-annotated
28+
* {@link MongoDBAtlasLocalContainer}.
29+
*
30+
* @author Wouter Blancquaert
31+
*/
32+
class MongoDbAtlasLocalContainerConnectionDetailsFactory
33+
extends AbstractMongoContainerConnectionDetailsFactory<MongoDBAtlasLocalContainer> {
34+
35+
MongoDbAtlasLocalContainerConnectionDetailsFactory() {
36+
super(MongoDBAtlasLocalContainer::getDatabaseConnectionString);
37+
}
38+
39+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/*
2+
* Copyright 2012-present the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.mongodb.testcontainers;
18+
19+
import org.testcontainers.containers.MongoDBContainer;
20+
21+
import org.springframework.boot.mongodb.autoconfigure.MongoConnectionDetails;
22+
import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory;
23+
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
24+
25+
/**
26+
* {@link ContainerConnectionDetailsFactory} to create {@link MongoConnectionDetails} from
27+
* a {@link ServiceConnection @ServiceConnection}-annotated {@link MongoDBContainer}.
28+
*
29+
* @author Moritz Halbritter
30+
* @author Andy Wilkinson
31+
* @author Phillip Webb
32+
*/
33+
class MongoDbContainerConnectionDetailsFactory
34+
extends AbstractMongoContainerConnectionDetailsFactory<MongoDBContainer> {
35+
36+
MongoDbContainerConnectionDetailsFactory() {
37+
super(MongoDBContainer::getReplicaSetUrl);
38+
}
39+
40+
}
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Connection Details Factories
22
org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactory=\
33
org.springframework.boot.mongodb.docker.compose.MongoDockerComposeConnectionDetailsFactory,\
4-
org.springframework.boot.mongodb.testcontainers.MongoContainerConnectionDetailsFactory
4+
org.springframework.boot.mongodb.testcontainers.MongoDbAtlasLocalContainerConnectionDetailsFactory,\
5+
org.springframework.boot.mongodb.testcontainers.MongoDbContainerConnectionDetailsFactory
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@
2626
import static org.assertj.core.api.Assertions.assertThat;
2727

2828
/**
29-
* Tests for {@link MongoContainerConnectionDetailsFactory}.
29+
* Tests for {@link AbstractMongoContainerConnectionDetailsFactory}.
3030
*
3131
* @author Moritz Halbritter
3232
*/
33-
class MongoContainerConnectionDetailsFactoryTests {
33+
class AbstractMongoContainerConnectionDetailsFactoryTests {
3434

3535
@Test
3636
void shouldRegisterHints() {

spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/TestImage.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
import org.testcontainers.grafana.LgtmStackContainer;
4141
import org.testcontainers.kafka.ConfluentKafkaContainer;
4242
import org.testcontainers.ldap.LLdapContainer;
43+
import org.testcontainers.mongodb.MongoDBAtlasLocalContainer;
4344
import org.testcontainers.redpanda.RedpandaContainer;
4445
import org.testcontainers.utility.DockerImageName;
4546

@@ -157,6 +158,13 @@ public enum TestImage {
157158
(container) -> ((MongoDBContainer) container).withStartupAttempts(5)
158159
.withStartupTimeout(Duration.ofMinutes(5))),
159160

161+
/**
162+
* A container image suitable for testing MongoDB Atlas.
163+
*/
164+
MONGODB_ATLAS("mongodb/mongodb-atlas-local", "8.0.4", () -> MongoDBAtlasLocalContainer.class,
165+
(container) -> ((MongoDBAtlasLocalContainer) container).withStartupAttempts(5)
166+
.withStartupTimeout(Duration.ofMinutes(5))),
167+
160168
/**
161169
* A container image suitable for testing MySQL.
162170
*/

0 commit comments

Comments
 (0)