GH-3839: Migrate MongoDB tests to Testcontainers

Fixes #3839

* Create a new base interface for Mongo container-based tests
* Migrate all tests to JUnit5
* Remove obsolete classes related to JUnit4 Mongo rule
* Fix code style & readability here and there, a few Sonar issues
* Fix failing test `validateWithConfiguredPollerFlow`
* * This test was failing with Mongo error
`$and/$or/$nor must be a nonempty array`. The cause was too small
polling ratio of the update query, the consecutive read queries
failed as no 'Oleg' document was in collection after ~100 ms.

Couple of changes after the pull request review:
* Get back the blank lines in test classes
* Get back the blank lines for some inner classes
* Eliminate bad renaming consequences
* Remove a couple of garbage todos
* Couple of places with code cleanup

Author: oxcafedead

spring-integration-mongodb/src/test/java/org/springframework/integration/mongodb/rules/MongoDbAvailableTests.java renamed to spring-integration-mongodb/src/test/java/org/springframework/integration/mongodb/MongoDbContainerTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2021 the original author or authors.
+ * Copyright 2020-2022 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.
@@ -14,14 +14,16 @@
  * limitations under the License.
  */
 
-package org.springframework.integration.mongodb.rules;
+package org.springframework.integration.mongodb;
 
 import java.time.Duration;
 
 import org.bson.Document;
 import org.bson.UuidRepresentation;
 import org.bson.conversions.Bson;
-import org.junit.Rule;
+import org.junit.jupiter.api.BeforeAll;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.junit.jupiter.Testcontainers;
 
 import org.springframework.dao.DataAccessException;
 import org.springframework.data.annotation.Id;
@@ -40,50 +42,64 @@
 import org.springframework.integration.mongodb.outbound.MessageCollectionCallback;
 import org.springframework.messaging.Message;
 
+import com.mongodb.ConnectionString;
 import com.mongodb.MongoClientSettings;
 import com.mongodb.MongoException;
 import com.mongodb.client.MongoClients;
 import com.mongodb.client.MongoCollection;
 
-
 /**
- * Convenience base class that enables unit test methods to rely upon the {@link MongoDbAvailable} annotation.
+ * The base contract for all tests requiring a MongoDb connection.
+ * The Testcontainers 'reuse' option must be disabled, so, Ryuk container is started
+ * and will clean all the containers up from this test suite after JVM exit.
+ * Since the Redis container instance is shared via static property, it is going to be
+ * started only once per JVM, therefore the target Docker container is reused automatically.
  *
  * @author Oleg Zhurakousky
  * @author Xavier Padro
  * @author Artem Bilan
  * @author David Turanski
+ * @author Artem Vozhdayenko
  *
- * @since 2.1
+ * @since 6.0
  */
-public abstract class MongoDbAvailableTests {
-
-	@Rule
-	public MongoDbAvailableRule mongoDbAvailableRule = new MongoDbAvailableRule();
-
-	public static final MongoDatabaseFactory MONGO_DATABASE_FACTORY =
-			new SimpleMongoClientDatabaseFactory(
-					MongoClients.create(
-							MongoClientSettings.builder().uuidRepresentation(UuidRepresentation.STANDARD).build()),
-					"test");
-
-	public static final ReactiveMongoDatabaseFactory REACTIVE_MONGO_DATABASE_FACTORY =
-			new SimpleReactiveMongoDatabaseFactory(
-					com.mongodb.reactivestreams.client.MongoClients.create(
-							MongoClientSettings.builder().uuidRepresentation(UuidRepresentation.STANDARD).build()),
-					"test");
-
-	protected MongoDatabaseFactory prepareMongoFactory(String... additionalCollectionsToDrop) {
-		cleanupCollections(MONGO_DATABASE_FACTORY, additionalCollectionsToDrop);
-		return MONGO_DATABASE_FACTORY;
+@Testcontainers(disabledWithoutDocker = true)
+public interface MongoDbContainerTest {
+
+	GenericContainer<?> MONGO_CONTAINER = new GenericContainer<>("mongo:5.0.9")
+			.withExposedPorts(27017);
+
+	@BeforeAll
+	static void startContainer() {
+		MONGO_CONTAINER.start();
+	}
+
+	static MongoDatabaseFactory createMongoDbFactory() {
+		return new SimpleMongoClientDatabaseFactory(MongoClients.create(getMongoClientSettings()), "test");
+	}
+
+	static ReactiveMongoDatabaseFactory createReactiveMongoDbFactory() {
+		return new SimpleReactiveMongoDatabaseFactory(
+				com.mongodb.reactivestreams.client.MongoClients.create(getMongoClientSettings()),
+				"test");
+	}
+
+	private static MongoClientSettings getMongoClientSettings() {
+		return MongoClientSettings.builder()
+				.applyConnectionString(new ConnectionString(
+						"mongodb://localhost:" + MONGO_CONTAINER.getFirstMappedPort()))
+				.uuidRepresentation(UuidRepresentation.STANDARD).build();
+	}
+
+	static void prepareMongoData(MongoDatabaseFactory mongoDatabaseFactory, String... additionalCollectionsToDrop) {
+		cleanupCollections(mongoDatabaseFactory, additionalCollectionsToDrop);
 	}
 
-	protected ReactiveMongoDatabaseFactory prepareReactiveMongoFactory(String... additionalCollectionsToDrop) {
-		cleanupCollections(REACTIVE_MONGO_DATABASE_FACTORY, additionalCollectionsToDrop);
-		return REACTIVE_MONGO_DATABASE_FACTORY;
+	static void prepareReactiveMongoData(ReactiveMongoDatabaseFactory mongoDatabaseFactory, String... additionalCollectionsToDrop) {
+		cleanupCollections(mongoDatabaseFactory, additionalCollectionsToDrop);
 	}
 
-	protected void cleanupCollections(ReactiveMongoDatabaseFactory mongoDbFactory,
+	static void cleanupCollections(ReactiveMongoDatabaseFactory mongoDbFactory,
 			String... additionalCollectionsToDrop) {
 
 		ReactiveMongoTemplate template = new ReactiveMongoTemplate(mongoDbFactory);
@@ -95,7 +111,7 @@ protected void cleanupCollections(ReactiveMongoDatabaseFactory mongoDbFactory,
 		}
 	}
 
-	protected void cleanupCollections(MongoDatabaseFactory mongoDbFactory, String... additionalCollectionsToDrop) {
+	static void cleanupCollections(MongoDatabaseFactory mongoDbFactory, String... additionalCollectionsToDrop) {
 		MongoTemplate template = new MongoTemplate(mongoDbFactory);
 		template.dropCollection("messages");
 		template.dropCollection("configurableStoreMessages");
@@ -105,7 +121,7 @@ protected void cleanupCollections(MongoDatabaseFactory mongoDbFactory, String...
 		}
 	}
 
-	protected Person createPerson() {
+	static Person createPerson() {
 		Address address = new Address();
 		address.setCity("Philadelphia");
 		address.setStreet("2121 Rawn street");
@@ -117,7 +133,7 @@ protected Person createPerson() {
 		return person;
 	}
 
-	protected Person createPerson(String name) {
+	static Person createPerson(String name) {
 		Address address = new Address();
 		address.setCity("Philadelphia");
 		address.setStreet("2121 Rawn street");
@@ -129,7 +145,7 @@ protected Person createPerson(String name) {
 		return person;
 	}
 
-	public static class Person {
+	class Person {
 
 		@Id
 		private String id;
@@ -156,7 +172,7 @@ public void setName(String name) {
 
 	}
 
-	public static class Address {
+	class Address {
 
 		private String street;
 
@@ -190,7 +206,7 @@ public void setState(String state) {
 
 	}
 
-	public static class TestMongoConverter extends MappingMongoConverter {
+	class TestMongoConverter extends MappingMongoConverter {
 
 		public TestMongoConverter(
 				MongoDatabaseFactory mongoDbFactory,
@@ -211,7 +227,7 @@ public <S> S read(Class<S> clazz, Bson source) {
 
 	}
 
-	public static class ReactiveTestMongoConverter extends MappingMongoConverter {
+	class ReactiveTestMongoConverter extends MappingMongoConverter {
 
 		public ReactiveTestMongoConverter(
 				ReactiveMongoDatabaseFactory mongoDbFactory,
@@ -232,7 +248,7 @@ public <S> S read(Class<S> clazz, Bson source) {
 
 	}
 
-	public static class TestCollectionCallback implements MessageCollectionCallback<Long> {
+	class TestCollectionCallback implements MessageCollectionCallback<Long> {
 
 		@Override
 		public Long doInCollection(MongoCollection<Document> collection, Message<?> message)

spring-integration-mongodb/src/test/java/org/springframework/integration/mongodb/config/MongoDbInboundChannelAdapterIntegrationTests-context.xml

@@ -3,40 +3,39 @@
 	   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	   xmlns:int="http://www.springframework.org/schema/integration"
 	   xmlns:int-mongodb="http://www.springframework.org/schema/integration/mongodb"
-	   xmlns:mongo="http://www.springframework.org/schema/data/mongo"
 	   xmlns:tx="http://www.springframework.org/schema/tx"
-	   xsi:schemaLocation="http://www.springframework.org/schema/data/mongo https://www.springframework.org/schema/data/mongo/spring-mongo.xsd
-		http://www.springframework.org/schema/integration https://www.springframework.org/schema/integration/spring-integration.xsd
+	   xsi:schemaLocation="http://www.springframework.org/schema/integration https://www.springframework.org/schema/integration/spring-integration.xsd
 		http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
 		http://www.springframework.org/schema/integration/mongodb https://www.springframework.org/schema/integration/mongodb/spring-integration-mongodb.xsd
 		http://www.springframework.org/schema/tx https://www.springframework.org/schema/tx/spring-tx.xsd">
 
-	<mongo:db-factory id="mongoDbFactory" dbname="test" />
+	<bean id="mongoDbFactory" class="org.springframework.integration.mongodb.MongoDbContainerTest"
+		  factory-method="createMongoDbFactory"/>
 
 	<int-mongodb:inbound-channel-adapter id="mongoInboundAdapter"
 										 channel="replyChannel"
 										 query="{'name' : 'Bob'}"
 										 entity-class="java.lang.Object"
 										 auto-startup="false">
-		<int:poller fixed-delay="100" />
+		<int:poller fixed-delay="100"/>
 	</int-mongodb:inbound-channel-adapter>
 
 	<int-mongodb:inbound-channel-adapter id="mongoInboundAdapterNamedFactory"
 										 mongodb-factory="mongoDbFactory"
 										 channel="replyChannel"
 										 query="{'name' : 'Bob'}"
 										 auto-startup="false">
-		<int:poller fixed-delay="5000" />
+		<int:poller fixed-delay="5000"/>
 	</int-mongodb:inbound-channel-adapter>
 
 	<int-mongodb:inbound-channel-adapter id="mongoInboundAdapterWithTemplate"
 										 channel="replyChannel"
 										 mongo-template="mongoDbTemplate"
 										 query="{'name' : 'Bob'}"
 										 expect-single-result="true"
-										 entity-class="org.springframework.integration.mongodb.rules.MongoDbAvailableTests.Person"
+										 entity-class="org.springframework.integration.mongodb.MongoDbContainerTest.Person"
 										 auto-startup="false">
-		<int:poller fixed-delay="5000" />
+		<int:poller fixed-delay="5000"/>
 	</int-mongodb:inbound-channel-adapter>
 
 	<int-mongodb:inbound-channel-adapter id="mongoInboundAdapterWithNamedCollection"
@@ -46,7 +45,7 @@
 										 query="{'name' : 'Bob'}"
 										 entity-class="java.lang.Object"
 										 auto-startup="false">
-		<int:poller fixed-delay="5000" />
+		<int:poller fixed-delay="5000"/>
 	</int-mongodb:inbound-channel-adapter>
 	<int-mongodb:inbound-channel-adapter id="mongoInboundAdapterWithStringQueryExpression"
 										 channel="replyChannel"
@@ -55,7 +54,7 @@
 										 query-expression="new String('{''name'' : ''Bob''}')"
 										 entity-class="java.lang.Object"
 										 auto-startup="false">
-		<int:poller fixed-rate="5000" />
+		<int:poller fixed-rate="5000"/>
 	</int-mongodb:inbound-channel-adapter>
 
 	<int-mongodb:inbound-channel-adapter id="mongoInboundAdapterWithQueryExpression"
@@ -65,7 +64,7 @@
 										 query-expression="new BasicQuery('{''name'' : ''Bob''}').limit(1)"
 										 entity-class="java.lang.Object"
 										 auto-startup="false">
-		<int:poller fixed-rate="5000" />
+		<int:poller fixed-rate="5000"/>
 	</int-mongodb:inbound-channel-adapter>
 
 	<int-mongodb:inbound-channel-adapter id="mongoInboundAdapterWithNamedCollectionExpression"
@@ -75,7 +74,7 @@
 										 query="{'name' : 'Bob'}"
 										 entity-class="java.lang.Object"
 										 auto-startup="false">
-		<int:poller fixed-delay="5000" />
+		<int:poller fixed-delay="5000"/>
 	</int-mongodb:inbound-channel-adapter>
 
 	<int-mongodb:inbound-channel-adapter id="inboundAdapterWithOnSuccessDisposition"
@@ -84,12 +83,12 @@
 										 auto-startup="false">
 
 		<int:poller fixed-delay="200" max-messages-per-poll="1">
-			<int:advice-chain  synchronization-factory="syncFactory">
+			<int:advice-chain synchronization-factory="syncFactory">
 				<bean
-						class="org.springframework.integration.mongodb.config.MongoDbInboundChannelAdapterIntegrationTests.TestMessageSourceAdvice" />
+						class="org.springframework.integration.mongodb.config.MongoDbInboundChannelAdapterIntegrationTests.TestMessageSourceAdvice"/>
 				<tx:advice>
 					<tx:attributes>
-						<tx:method name="*" />
+						<tx:method name="*"/>
 					</tx:attributes>
 				</tx:advice>
 			</int:advice-chain>
@@ -102,7 +101,7 @@
 	</int:transaction-synchronization-factory>
 
 	<int:channel id="afterCommitChannel">
-		<int:queue />
+		<int:queue/>
 	</int:channel>
 
 	<int-mongodb:inbound-channel-adapter id="mongoInboundAdapterWithConverter"
@@ -111,28 +110,28 @@
 										 entity-class="java.lang.Object"
 										 mongo-converter="mongoConverter"
 										 auto-startup="false">
-		<int:poller fixed-delay="100" />
+		<int:poller fixed-delay="100"/>
 	</int-mongodb:inbound-channel-adapter>
 
 	<bean id="documentCleaner"
-		  class="org.springframework.integration.mongodb.config.MongoDbInboundChannelAdapterIntegrationTests.DocumentCleaner" />
+		  class="org.springframework.integration.mongodb.config.MongoDbInboundChannelAdapterIntegrationTests.DocumentCleaner"/>
 
 	<bean id="mongoDbTemplate" class="org.springframework.data.mongodb.core.MongoTemplate">
-		<constructor-arg ref="mongoDbFactory" />
+		<constructor-arg ref="mongoDbFactory"/>
 	</bean>
 
 	<bean id="mongoConverter"
-		  class="org.springframework.integration.mongodb.rules.MongoDbAvailableTests.TestMongoConverter">
-		<constructor-arg ref="mongoDbFactory" />
+		  class="org.springframework.integration.mongodb.MongoDbContainerTest.TestMongoConverter">
+		<constructor-arg ref="mongoDbFactory"/>
 		<constructor-arg>
-			<bean class="org.springframework.data.mongodb.core.mapping.MongoMappingContext" />
+			<bean class="org.springframework.data.mongodb.core.mapping.MongoMappingContext"/>
 		</constructor-arg>
 	</bean>
 
 	<int:channel id="replyChannel">
-		<int:queue />
+		<int:queue/>
 	</int:channel>
 
-	<bean id="transactionManager" class="org.springframework.integration.transaction.PseudoTransactionManager" />
+	<bean id="transactionManager" class="org.springframework.integration.transaction.PseudoTransactionManager"/>
 
 </beans>