Move MongoDB health support into spring-boot-mongodb

Previously the MongoDB health indicates used Spring Data's templates
(imperative and reactive) to access MongoDB. This prevented health
information from being available in apps using Mongo's Java Driver
directly.

This commit updates the health indicates so that they no longer
depend upon Spring Data MongoDB and instead using MongoDB's Java
Driver directly. As they no longer depend on Spring Data MongoDB,
the indicators have also moved from spring-boot-data-mongodb to
spring-boot-mongodb.

Closes gh-47051

Author: wilkinsona

module/spring-boot-data-mongodb/build.gradle

@@ -19,7 +19,6 @@ plugins {
 	id "org.springframework.boot.auto-configuration"
 	id "org.springframework.boot.configuration-properties"
 	id "org.springframework.boot.deployed"
-	id "org.springframework.boot.docker-test"
 	id "org.springframework.boot.optional-dependencies"
 }
 
@@ -35,18 +34,10 @@ dependencies {
 	compileOnly("com.google.code.findbugs:jsr305")
 
 	optional(project(":core:spring-boot-autoconfigure"))
-	optional(project(":module:spring-boot-health"))
 	optional(project(":module:spring-boot-reactor"))
 	optional("org.mongodb:mongodb-driver-reactivestreams")
 	optional("org.mongodb:mongodb-driver-sync")
 
-	dockerTestImplementation(project(":core:spring-boot-test"))
-	dockerTestImplementation(project(":test-support:spring-boot-docker-test-support"))
-	dockerTestImplementation("ch.qos.logback:logback-classic")
-	dockerTestImplementation("org.junit.jupiter:junit-jupiter")
-	dockerTestImplementation("org.testcontainers:junit-jupiter")
-	dockerTestImplementation("org.testcontainers:mongodb")
-
 	testCompileOnly("com.fasterxml.jackson.core:jackson-annotations")
 
 	testImplementation(project(":core:spring-boot-test"))

module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/health/MongoReactiveHealthIndicator.java

@@ -2,5 +2,3 @@ org.springframework.boot.data.mongodb.autoconfigure.MongoDataAutoConfiguration
 org.springframework.boot.data.mongodb.autoconfigure.MongoReactiveDataAutoConfiguration
 org.springframework.boot.data.mongodb.autoconfigure.MongoReactiveRepositoriesAutoConfiguration
 org.springframework.boot.data.mongodb.autoconfigure.MongoRepositoriesAutoConfiguration
-org.springframework.boot.data.mongodb.autoconfigure.health.MongoHealthContributorAutoConfiguration
-org.springframework.boot.data.mongodb.autoconfigure.health.MongoReactiveHealthContributorAutoConfiguration

module/spring-boot-data-mongodb/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -33,6 +33,7 @@ dependencies {
 	optional(project(":core:spring-boot-autoconfigure"))
 	optional(project(":core:spring-boot-docker-compose"))
 	optional(project(":core:spring-boot-testcontainers"))
+	optional(project(":module:spring-boot-health"))
 	optional(project(":module:spring-boot-micrometer-metrics"))
 	optional(project(":module:spring-boot-reactor"))
 	optional("io.netty:netty-transport")
@@ -49,6 +50,7 @@ dependencies {
 	testImplementation(project(":core:spring-boot-test"))
 	testImplementation(project(":test-support:spring-boot-test-support"))
 	testImplementation(testFixtures(project(":core:spring-boot-testcontainers")))
+	testImplementation("io.projectreactor:reactor-test")
 	testImplementation("org.springframework.data:spring-data-mongodb")
 
 	testRuntimeOnly("ch.qos.logback:logback-classic")

module/spring-boot-mongodb/build.gradle

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.data.mongodb.health;
+package org.springframework.boot.mongodb.health;
 
 import com.mongodb.ConnectionString;
 import com.mongodb.MongoClientSettings;
@@ -23,6 +23,7 @@
 import com.mongodb.ServerApiVersion;
 import com.mongodb.client.MongoClient;
 import com.mongodb.client.MongoClients;
+import org.assertj.core.api.InstanceOfAssertFactories;
 import org.junit.jupiter.api.Test;
 import org.testcontainers.containers.MongoDBContainer;
 import org.testcontainers.junit.jupiter.Container;
@@ -31,7 +32,6 @@
 import org.springframework.boot.health.contributor.Health;
 import org.springframework.boot.health.contributor.Status;
 import org.springframework.boot.testsupport.container.TestImage;
-import org.springframework.data.mongodb.core.MongoTemplate;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -49,13 +49,21 @@ class MongoHealthIndicatorIntegrationTests {
 	@Test
 	void standardApi() {
 		Health health = mongoHealth();
-		assertThat(health.getStatus()).isEqualTo(Status.UP);
+		assertHealth(health);
 	}
 
 	@Test
 	void strictV1Api() {
 		Health health = mongoHealth(ServerApi.builder().strict(true).version(ServerApiVersion.V1).build());
+		assertHealth(health);
+	}
+
+	private void assertHealth(Health health) {
 		assertThat(health.getStatus()).isEqualTo(Status.UP);
+		assertThat(health.getDetails()).containsKey("maxWireVersion");
+		assertThat(health.getDetails()).hasEntrySatisfying("databases",
+				(databases) -> assertThat(databases).asInstanceOf(InstanceOfAssertFactories.LIST)
+					.containsExactlyInAnyOrder("local", "admin", "config"));
 	}
 
 	private Health mongoHealth() {
@@ -70,7 +78,7 @@ private Health mongoHealth(ServerApi serverApi) {
 		}
 		MongoClientSettings settings = settingsBuilder.build();
 		MongoClient mongoClient = MongoClients.create(settings);
-		MongoHealthIndicator healthIndicator = new MongoHealthIndicator(new MongoTemplate(mongoClient, "db"));
+		MongoHealthIndicator healthIndicator = new MongoHealthIndicator(mongoClient);
 		return healthIndicator.health(true);
 	}
 

…ongoHealthIndicatorIntegrationTests.java …ongoHealthIndicatorIntegrationTests.javamodule/spring-boot-data-mongodb/src/dockerTest/java/org/springframework/boot/data/mongodb/health/MongoHealthIndicatorIntegrationTests.java renamed to module/spring-boot-mongodb/src/dockerTest/java/org/springframework/boot/mongodb/health/MongoHealthIndicatorIntegrationTests.java module/spring-boot-data-mongodb/src/dockerTest/java/org/springframework/boot/data/mongodb/health/MongoHealthIndicatorIntegrationTests.java renamed to module/spring-boot-mongodb/src/dockerTest/java/org/springframework/boot/mongodb/health/MongoHealthIndicatorIntegrationTests.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.data.mongodb.health;
+package org.springframework.boot.mongodb.health;
 
 import java.time.Duration;
 
@@ -25,6 +25,7 @@
 import com.mongodb.ServerApiVersion;
 import com.mongodb.reactivestreams.client.MongoClient;
 import com.mongodb.reactivestreams.client.MongoClients;
+import org.assertj.core.api.InstanceOfAssertFactories;
 import org.junit.jupiter.api.Test;
 import org.testcontainers.containers.MongoDBContainer;
 import org.testcontainers.junit.jupiter.Container;
@@ -33,7 +34,6 @@
 import org.springframework.boot.health.contributor.Health;
 import org.springframework.boot.health.contributor.Status;
 import org.springframework.boot.testsupport.container.TestImage;
-import org.springframework.data.mongodb.core.ReactiveMongoTemplate;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -51,13 +51,13 @@ class MongoReactiveHealthIndicatorIntegrationTests {
 	@Test
 	void standardApi() {
 		Health health = mongoHealth();
-		assertThat(health.getStatus()).isEqualTo(Status.UP);
+		assertHealth(health);
 	}
 
 	@Test
 	void strictV1Api() {
 		Health health = mongoHealth(ServerApi.builder().strict(true).version(ServerApiVersion.V1).build());
-		assertThat(health.getStatus()).isEqualTo(Status.UP);
+		assertHealth(health);
 	}
 
 	private Health mongoHealth() {
@@ -72,9 +72,16 @@ private Health mongoHealth(ServerApi serverApi) {
 		}
 		MongoClientSettings settings = settingsBuilder.build();
 		MongoClient mongoClient = MongoClients.create(settings);
-		MongoReactiveHealthIndicator healthIndicator = new MongoReactiveHealthIndicator(
-				new ReactiveMongoTemplate(mongoClient, "db"));
+		MongoReactiveHealthIndicator healthIndicator = new MongoReactiveHealthIndicator(mongoClient);
 		return healthIndicator.health(true).block(Duration.ofSeconds(30));
 	}
 
+	private void assertHealth(Health health) {
+		assertThat(health.getStatus()).isEqualTo(Status.UP);
+		assertThat(health.getDetails()).containsKey("maxWireVersion");
+		assertThat(health.getDetails()).hasEntrySatisfying("databases",
+				(databases) -> assertThat(databases).asInstanceOf(InstanceOfAssertFactories.LIST)
+					.containsExactlyInAnyOrder("local", "admin", "config"));
+	}
+
 }

…tiveHealthIndicatorIntegrationTests.java …tiveHealthIndicatorIntegrationTests.javamodule/spring-boot-data-mongodb/src/dockerTest/java/org/springframework/boot/data/mongodb/health/MongoReactiveHealthIndicatorIntegrationTests.java renamed to module/spring-boot-mongodb/src/dockerTest/java/org/springframework/boot/mongodb/health/MongoReactiveHealthIndicatorIntegrationTests.java module/spring-boot-data-mongodb/src/dockerTest/java/org/springframework/boot/data/mongodb/health/MongoReactiveHealthIndicatorIntegrationTests.java renamed to module/spring-boot-mongodb/src/dockerTest/java/org/springframework/boot/mongodb/health/MongoReactiveHealthIndicatorIntegrationTests.java

@@ -14,36 +14,35 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.data.mongodb.autoconfigure.health;
+package org.springframework.boot.mongodb.autoconfigure.health;
+
+import com.mongodb.client.MongoClient;
 
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.data.mongodb.autoconfigure.MongoDataAutoConfiguration;
-import org.springframework.boot.data.mongodb.health.MongoHealthIndicator;
 import org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration;
 import org.springframework.boot.health.autoconfigure.contributor.ConditionalOnEnabledHealthIndicator;
 import org.springframework.boot.health.contributor.HealthContributor;
 import org.springframework.boot.mongodb.autoconfigure.MongoAutoConfiguration;
+import org.springframework.boot.mongodb.health.MongoHealthIndicator;
 import org.springframework.context.annotation.Bean;
-import org.springframework.data.mongodb.core.MongoTemplate;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for {@link MongoHealthIndicator}.
  *
  * @author Stephane Nicoll
  * @since 4.0.0
  */
-@AutoConfiguration(after = { MongoReactiveHealthContributorAutoConfiguration.class, MongoDataAutoConfiguration.class,
-		MongoAutoConfiguration.class })
-@ConditionalOnClass({ MongoTemplate.class, MongoHealthIndicator.class, ConditionalOnEnabledHealthIndicator.class })
-@ConditionalOnBean(MongoTemplate.class)
+@AutoConfiguration(after = { MongoReactiveHealthContributorAutoConfiguration.class, MongoAutoConfiguration.class })
+@ConditionalOnClass({ MongoClient.class, MongoHealthIndicator.class, ConditionalOnEnabledHealthIndicator.class })
+@ConditionalOnBean(MongoClient.class)
 @ConditionalOnEnabledHealthIndicator("mongodb")
 public final class MongoHealthContributorAutoConfiguration
-		extends CompositeHealthContributorConfiguration<MongoHealthIndicator, MongoTemplate> {
+		extends CompositeHealthContributorConfiguration<MongoHealthIndicator, MongoClient> {
 
 	MongoHealthContributorAutoConfiguration() {
 		super(MongoHealthIndicator::new);
@@ -52,7 +51,7 @@ public final class MongoHealthContributorAutoConfiguration
 	@Bean
 	@ConditionalOnMissingBean(name = { "mongoHealthIndicator", "mongoHealthContributor" })
 	HealthContributor mongoHealthContributor(ConfigurableListableBeanFactory beanFactory) {
-		return createContributor(beanFactory, MongoTemplate.class);
+		return createContributor(beanFactory, MongoClient.class);
 	}
 
 }

…oHealthContributorAutoConfiguration.java …oHealthContributorAutoConfiguration.javamodule/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfiguration.java renamed to module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/health/MongoHealthContributorAutoConfiguration.java module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfiguration.java renamed to module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/health/MongoHealthContributorAutoConfiguration.java

@@ -14,8 +14,9 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.data.mongodb.autoconfigure.health;
+package org.springframework.boot.mongodb.autoconfigure.health;
 
+import com.mongodb.reactivestreams.client.MongoClient;
 import reactor.core.publisher.Flux;
 
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
@@ -24,13 +25,12 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.data.mongodb.autoconfigure.MongoReactiveDataAutoConfiguration;
-import org.springframework.boot.data.mongodb.health.MongoReactiveHealthIndicator;
 import org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration;
 import org.springframework.boot.health.autoconfigure.contributor.ConditionalOnEnabledHealthIndicator;
 import org.springframework.boot.health.contributor.ReactiveHealthContributor;
+import org.springframework.boot.mongodb.autoconfigure.MongoReactiveAutoConfiguration;
+import org.springframework.boot.mongodb.health.MongoReactiveHealthIndicator;
 import org.springframework.context.annotation.Bean;
-import org.springframework.data.mongodb.core.ReactiveMongoTemplate;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for
@@ -39,13 +39,13 @@
  * @author Stephane Nicoll
  * @since 4.0.0
  */
-@AutoConfiguration(after = MongoReactiveDataAutoConfiguration.class)
-@ConditionalOnClass({ ReactiveMongoTemplate.class, Flux.class, MongoReactiveHealthIndicator.class,
+@AutoConfiguration(after = MongoReactiveAutoConfiguration.class)
+@ConditionalOnClass({ MongoClient.class, Flux.class, MongoReactiveHealthIndicator.class,
 		ConditionalOnEnabledHealthIndicator.class })
-@ConditionalOnBean(ReactiveMongoTemplate.class)
+@ConditionalOnBean(MongoClient.class)
 @ConditionalOnEnabledHealthIndicator("mongodb")
 public final class MongoReactiveHealthContributorAutoConfiguration
-		extends CompositeReactiveHealthContributorConfiguration<MongoReactiveHealthIndicator, ReactiveMongoTemplate> {
+		extends CompositeReactiveHealthContributorConfiguration<MongoReactiveHealthIndicator, MongoClient> {
 
 	MongoReactiveHealthContributorAutoConfiguration() {
 		super(MongoReactiveHealthIndicator::new);
@@ -54,7 +54,7 @@ public final class MongoReactiveHealthContributorAutoConfiguration
 	@Bean
 	@ConditionalOnMissingBean(name = { "mongoHealthIndicator", "mongoHealthContributor" })
 	ReactiveHealthContributor mongoHealthContributor(ConfigurableListableBeanFactory beanFactory) {
-		return createContributor(beanFactory, ReactiveMongoTemplate.class);
+		return createContributor(beanFactory, MongoClient.class);
 	}
 
 }

…eHealthContributorAutoConfiguration.java …eHealthContributorAutoConfiguration.javamodule/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfiguration.java renamed to module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfiguration.java module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfiguration.java renamed to module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfiguration.java

@@ -18,6 +18,6 @@
  * Auto-configuration for Spring Data MongoDB health.
  */
 @NullMarked
-package org.springframework.boot.data.mongodb.autoconfigure.health;
+package org.springframework.boot.mongodb.autoconfigure.health;
 
 import org.jspecify.annotations.NullMarked;

…b/autoconfigure/health/package-info.java …b/autoconfigure/health/package-info.javamodule/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/package-info.java renamed to module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/health/package-info.java module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/package-info.java renamed to module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/health/package-info.java

@@ -14,37 +14,51 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.data.mongodb.health;
+package org.springframework.boot.mongodb.health;
 
+import java.util.ArrayList;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+
+import com.mongodb.client.MongoClient;
 import org.bson.Document;
 
 import org.springframework.boot.health.contributor.AbstractHealthIndicator;
 import org.springframework.boot.health.contributor.Health;
 import org.springframework.boot.health.contributor.HealthIndicator;
-import org.springframework.data.mongodb.core.MongoTemplate;
 import org.springframework.util.Assert;
 
 /**
  * Simple implementation of a {@link HealthIndicator} returning status information for
- * Mongo data stores.
+ * MongoDB.
  *
  * @author Christian Dupuis
  * @since 4.0.0
  */
 public class MongoHealthIndicator extends AbstractHealthIndicator {
 
-	private final MongoTemplate mongoTemplate;
+	private static final Document HELLO_COMMAND = Document.parse("{ hello: 1 }");
+
+	private final MongoClient mongoClient;
 
-	public MongoHealthIndicator(MongoTemplate mongoTemplate) {
+	public MongoHealthIndicator(MongoClient mongoClient) {
 		super("MongoDB health check failed");
-		Assert.notNull(mongoTemplate, "'mongoTemplate' must not be null");
-		this.mongoTemplate = mongoTemplate;
+		Assert.notNull(mongoClient, "'mongoClient' must not be null");
+		this.mongoClient = mongoClient;
 	}
 
 	@Override
 	protected void doHealthCheck(Health.Builder builder) throws Exception {
-		Document result = this.mongoTemplate.executeCommand("{ hello: 1 }");
-		builder.up().withDetail("maxWireVersion", result.getInteger("maxWireVersion"));
+		Map<String, Object> details = new LinkedHashMap<>();
+		List<String> databases = new ArrayList<>();
+		details.put("databases", databases);
+		this.mongoClient.listDatabaseNames().forEach((database) -> {
+			Document result = this.mongoClient.getDatabase(database).runCommand(HELLO_COMMAND);
+			databases.add(database);
+			details.putIfAbsent("maxWireVersion", result.getInteger("maxWireVersion"));
+		});
+		builder.up().withDetails(details);
 	}
 
 }