Add shared MongoDB container for Dev Services

docs/src/main/asciidoc/dev-services.adoc

@@ -88,7 +88,7 @@ include::{generated-dir}/config/quarkus-kubernetes-client-config-group-kubernete
 
 The MongoDB Dev Service will be enabled when the `quarkus-mongodb-client` extension is present in your application, and
 the server address has not been explicitly configured. More information can be found in the
-xref:mongodb.adoc#dev-services[MongoDB Guide].
+xref:mongodb-dev-services.adoc[MongoDB Guide].
 
 include::{generated-dir}/config/quarkus-mongodb-config-group-dev-services-build-time-config.adoc[opts=optional, leveloffset=+1]
 

docs/src/main/asciidoc/mongodb-dev-services.adoc

@@ -0,0 +1,30 @@
+////
+This guide is maintained in the main Quarkus repository
+and pull requests should be submitted there:
+https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
+////
+= Dev Services for MongoDB
+
+Quarkus supports a feature called Dev Services that allows you to create various datasources without any config. In the case of MongoDB this support extends to the default MongoDB connection.
+What that means practically, is that if you have not configured `quarkus.mongodb.connection-string`, Quarkus will automatically start a MongoDB container when running tests or in dev mode,
+and automatically configure the connection.
+
+MongoDB Dev Services is based on link:https://www.testcontainers.org/modules/databases/mongodb/[Testcontainers MongoDB module] that will start a single node replicaset.
+
+When running the production version of the application, the MongoDB connection need to be configured as normal, so if you want to include a production database config in your
+`application.properties` and continue to use Dev Services we recommend that you use the `%prod.` profile to define your MongoDB settings.
+
+
+== Shared server
+
+Most of the time you need to share the server between applications.
+Dev Services for MongoDB implements a _service discovery_ mechanism for your multiple Quarkus applications running in _dev_ mode to share a single server.
+
+NOTE: Dev Services for MongoDB starts the container with the `quarkus-dev-service-mongodb` label which is used to identify the container.
+
+If you need multiple (shared) servers, you can configure the `quarkus.mongodb.devservices.service-name` attribute and indicate the server name.
+It looks for a container with the same value, or starts a new one if none can be found.
+The default service name is `mongodb`.
+
+Sharing is enabled by default in dev mode, but disabled in test mode.
+You can disable the sharing with `quarkus.mongodb.devservices.shared=false`.

docs/src/main/asciidoc/mongodb.adoc

@@ -241,18 +241,9 @@ WARNING: By default, Quarkus will restrict the use of JNDI within an application
 Because the `mongo+srv` protocol often used to connect to MongoDB requires JNDI, this protection is automatically disabled when using the MongoDB client extension.
 
 [[dev-services]]
-=== Dev Services (Configuration Free Databases)
+=== Use the MongoDB Dev Services
 
-Quarkus supports a feature called Dev Services that allows you to create various datasources without any config. In the case of MongoDB this support extends to the default MongoDB connection.
-What that means practically, is that if you have not configured `quarkus.mongodb.connection-string`, Quarkus will automatically start a MongoDB container when running tests or in dev mode,
-and automatically configure the connection.
-
-MongoDB Dev Services is based on link:https://www.testcontainers.org/modules/databases/mongodb/[Testcontainers MongoDB module] that will start a single node replicaset.
-
-When running the production version of the application, the MongoDB connection need to be configured as normal, so if you want to include a production database config in your
-`application.properties` and continue to use Dev Services we recommend that you use the `%prod.` profile to define your MongoDB settings.
-
-include::{generated-dir}/config/quarkus-mongodb-config-group-dev-services-build-time-config.adoc[opts=optional, leveloffset=+1]
+See xref:mongodb-dev-services.adoc[MongoDB Dev Services].
 
 == Multiple MongoDB Clients
 

extensions/mongodb-client/deployment/src/main/java/io/quarkus/mongodb/deployment/DevServicesBuildTimeConfig.java

@@ -12,7 +12,7 @@ public class DevServicesBuildTimeConfig {
     /**
      * If DevServices has been explicitly enabled or disabled. DevServices is generally enabled
      * by default, unless there is an existing configuration present.
-     *
+     * <p>
      * When DevServices is enabled Quarkus will attempt to automatically configure and start
      * a database when running in Dev or Test mode.
      */
@@ -45,4 +45,30 @@ public class DevServicesBuildTimeConfig {
     @ConfigItem
     public Map<String, String> containerEnv;
 
+    /**
+     * Indicates if the MongoDB server managed by Quarkus Dev Services is shared.
+     * When shared, Quarkus looks for running containers using label-based service discovery.
+     * If a matching container is found, it is used, and so a second one is not started.
+     * Otherwise, Dev Services for MongoDB starts a new container.
+     * <p>
+     * The discovery uses the {@code quarkus-dev-service-mongodb} label.
+     * The value is configured using the {@code service-name} property.
+     * <p>
+     * Container sharing is only used in dev mode.
+     */
+    @ConfigItem(defaultValue = "true")
+    public boolean shared;
+
+    /**
+     * The value of the {@code quarkus-dev-service-mongodb} label attached to the started container.
+     * This property is used when {@code shared} is set to {@code true}.
+     * In this case, before starting a container, Dev Services for MongoDB looks for a container with the
+     * {@code quarkus-dev-service-mongodb} label
+     * set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it
+     * starts a new container with the {@code quarkus-dev-service-mongodb} label set to the specified value.
+     * <p>
+     */
+    @ConfigItem(defaultValue = "mongodb")
+    public String serviceName;
+
 }

extensions/mongodb-client/deployment/src/main/java/io/quarkus/mongodb/deployment/DevServicesMongoProcessor.java

@@ -9,8 +9,8 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Objects;
 import java.util.Optional;
+import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
 import org.eclipse.microprofile.config.ConfigProvider;
@@ -36,7 +36,9 @@
 import io.quarkus.deployment.dev.devservices.GlobalDevServicesConfig;
 import io.quarkus.deployment.logging.LoggingSetupBuildItem;
 import io.quarkus.devservices.common.ConfigureUtil;
+import io.quarkus.devservices.common.ContainerLocator;
 import io.quarkus.mongodb.runtime.MongodbConfig;
+import io.quarkus.runtime.LaunchMode;
 import io.quarkus.runtime.configuration.ConfigUtils;
 
 @BuildSteps(onlyIfNot = IsNormal.class, onlyIf = GlobalDevServicesConfig.Enabled.class)
@@ -48,6 +50,18 @@ public class DevServicesMongoProcessor {
     static volatile Map<String, CapturedProperties> capturedProperties;
     static volatile boolean first = true;
 
+    private static final String MONGO_SCHEME = "mongodb://";
+
+    private static final int MONGO_EXPOSED_PORT = 27017;
+
+    /**
+     * Label to add to shared Dev Service for Mongo running in containers.
+     * This allows other applications to discover the running service and use it instead of starting a new instance.
+     */
+    private static final String DEV_SERVICE_LABEL = "quarkus-dev-service-mongo";
+
+    private static final ContainerLocator MONGO_CONTAINER_LOCATOR = new ContainerLocator(DEV_SERVICE_LABEL, MONGO_EXPOSED_PORT);
+
     @BuildStep
     public List<DevServicesResultBuildItem> startMongo(List<MongoConnectionNameBuildItem> mongoConnections,
             DockerStatusBuildItem dockerStatusBuildItem,
@@ -94,7 +108,8 @@ public List<DevServicesResultBuildItem> startMongo(List<MongoConnectionNameBuild
                     loggingSetupBuildItem);
             try {
                 devService = startMongo(dockerStatusBuildItem, connectionName, currentCapturedProperties.get(connectionName),
-                        !devServicesSharedNetworkBuildItem.isEmpty(), globalDevServicesConfig.timeout);
+                        !devServicesSharedNetworkBuildItem.isEmpty(), globalDevServicesConfig.timeout,
+                        launchMode.getLaunchMode());
                 if (devService == null) {
                     compressor.closeAndDumpCaptured();
                 } else {
@@ -134,7 +149,8 @@ public void run() {
     }
 
     private RunningDevService startMongo(DockerStatusBuildItem dockerStatusBuildItem, String connectionName,
-            CapturedProperties capturedProperties, boolean useSharedNetwork, Optional<Duration> timeout) {
+            CapturedProperties capturedProperties, boolean useSharedNetwork, Optional<Duration> timeout,
+            LaunchMode launchMode) {
         if (!capturedProperties.devServicesEnabled) {
             // explicitly disabled
             log.debug("Not starting devservices for " + (isDefault(connectionName) ? "default datasource" : connectionName)
@@ -159,28 +175,51 @@ private RunningDevService startMongo(DockerStatusBuildItem dockerStatusBuildItem
                     + " or get a working docker instance");
             return null;
         }
-        MongoDBContainer mongoDBContainer;
-        if (capturedProperties.imageName != null) {
-            mongoDBContainer = new QuarkusMongoDBContainer(
-                    DockerImageName.parse(capturedProperties.imageName).asCompatibleSubstituteFor("mongo"),
-                    capturedProperties.fixedExposedPort, useSharedNetwork);
-        } else {
-            mongoDBContainer = new QuarkusMongoDBContainer(capturedProperties.fixedExposedPort, useSharedNetwork);
-        }
-        timeout.ifPresent(mongoDBContainer::withStartupTimeout);
-        mongoDBContainer.withEnv(capturedProperties.containerEnv);
-        mongoDBContainer.start();
-        Optional<String> databaseName = ConfigProvider.getConfig().getOptionalValue(configPrefix + "database", String.class);
-        String effectiveURL = databaseName.map(mongoDBContainer::getReplicaSetUrl).orElse(mongoDBContainer.getReplicaSetUrl());
+
+        Supplier<RunningDevService> defaultMongoServerSupplier = () -> {
+            MongoDBContainer mongoDBContainer;
+            if (capturedProperties.imageName != null) {
+                mongoDBContainer = new QuarkusMongoDBContainer(
+                        DockerImageName.parse(capturedProperties.imageName).asCompatibleSubstituteFor("mongo"),
+                        capturedProperties.fixedExposedPort, useSharedNetwork);
+            } else {
+                mongoDBContainer = new QuarkusMongoDBContainer(capturedProperties.fixedExposedPort, useSharedNetwork);
+            }
+            timeout.ifPresent(mongoDBContainer::withStartupTimeout);
+            mongoDBContainer.withEnv(capturedProperties.containerEnv);
+            mongoDBContainer.start();
+            final String effectiveUrl = getEffectiveUrl(configPrefix, mongoDBContainer.getHost(),
+                    mongoDBContainer.getMappedPort(MONGO_EXPOSED_PORT), capturedProperties);
+            return new RunningDevService(Feature.MONGODB_CLIENT.getName(), mongoDBContainer.getContainerId(),
+                    mongoDBContainer::close, getConfigPrefix(connectionName) + "connection-string", effectiveUrl);
+        };
+
+        return MONGO_CONTAINER_LOCATOR
+                .locateContainer(capturedProperties.serviceName(), capturedProperties.shared(), launchMode)
+                .map(containerAddress -> {
+                    final String effectiveUrl = getEffectiveUrl(configPrefix, containerAddress.getHost(),
+                            containerAddress.getPort(), capturedProperties);
+
+                    return new RunningDevService(Feature.MONGODB_CLIENT.getName(), containerAddress.getId(),
+                            null, getConfigPrefix(connectionName) + "connection-string", effectiveUrl);
+                })
+                .orElseGet(defaultMongoServerSupplier);
+    }
+
+    private String getEffectiveUrl(String configPrefix, String host, int port, CapturedProperties capturedProperties) {
+        final String databaseName = ConfigProvider.getConfig()
+                .getOptionalValue(configPrefix + "database", String.class)
+                .orElse("test");
+        String effectiveUrl = String.format("%s%s:%d/%s", MONGO_SCHEME, host, port, databaseName);
         if ((capturedProperties.connectionProperties != null) && !capturedProperties.connectionProperties.isEmpty()) {
-            effectiveURL = effectiveURL + "?"
+            effectiveUrl = effectiveUrl + "?"
                     + URLEncodedUtils.format(
                             capturedProperties.connectionProperties.entrySet().stream()
-                                    .map(e -> new BasicNameValuePair(e.getKey(), e.getValue())).collect(Collectors.toList()),
+                                    .map(e -> new BasicNameValuePair(e.getKey(), e.getValue()))
+                                    .collect(Collectors.toList()),
                             StandardCharsets.UTF_8);
         }
-        return new RunningDevService(Feature.MONGODB_CLIENT.getName(), mongoDBContainer.getContainerId(),
-                mongoDBContainer::close, getConfigPrefix(connectionName) + "connection-string", effectiveURL);
+        return effectiveUrl;
     }
 
     private String getConfigPrefix(String connectionName) {
@@ -210,48 +249,15 @@ private CapturedProperties captureProperties(String connectionName, MongoClientB
         boolean devServicesEnabled = devServicesConfig.enabled.orElse(true);
         return new CapturedProperties(databaseName, connectionString, devServicesEnabled,
                 devServicesConfig.imageName.orElseGet(() -> ConfigureUtil.getDefaultImageNameFor("mongo")),
-                devServicesConfig.port.orElse(null), devServicesConfig.properties, devServicesConfig.containerEnv);
+                devServicesConfig.port.orElse(null), devServicesConfig.properties, devServicesConfig.containerEnv,
+                devServicesConfig.shared, devServicesConfig.serviceName);
     }
 
-    private static final class CapturedProperties {
-        private final String database;
-        private final String connectionString;
-        private final boolean devServicesEnabled;
-        private final String imageName;
-        private final Integer fixedExposedPort;
-        private final Map<String, String> connectionProperties;
-        private final Map<String, String> containerEnv;
-
-        public CapturedProperties(String database, String connectionString, boolean devServicesEnabled, String imageName,
-                Integer fixedExposedPort, Map<String, String> connectionProperties, Map<String, String> containerEnv) {
-            this.database = database;
-            this.connectionString = connectionString;
-            this.devServicesEnabled = devServicesEnabled;
-            this.imageName = imageName;
-            this.fixedExposedPort = fixedExposedPort;
-            this.connectionProperties = connectionProperties;
-            this.containerEnv = containerEnv;
-        }
+    private record CapturedProperties(String database, String connectionString, boolean devServicesEnabled,
+            String imageName, Integer fixedExposedPort,
+            Map<String, String> connectionProperties, Map<String, String> containerEnv,
+            boolean shared, String serviceName) {
 
-        @Override
-        public boolean equals(Object o) {
-            if (this == o)
-                return true;
-            if (o == null || getClass() != o.getClass())
-                return false;
-            CapturedProperties that = (CapturedProperties) o;
-            return devServicesEnabled == that.devServicesEnabled && Objects.equals(database, that.database)
-                    && Objects.equals(connectionString, that.connectionString) && Objects.equals(imageName, that.imageName)
-                    && Objects.equals(fixedExposedPort, that.fixedExposedPort)
-                    && Objects.equals(connectionProperties, that.connectionProperties)
-                    && Objects.equals(containerEnv, that.containerEnv);
-        }
-
-        @Override
-        public int hashCode() {
-            return Objects.hash(database, connectionString, devServicesEnabled, imageName, fixedExposedPort,
-                    connectionProperties, containerEnv);
-        }
     }
 
     private static final class QuarkusMongoDBContainer extends MongoDBContainer {