Add example for MongoDB containers (#1288)

Author: slu-it

examples/mongodb-container/build.gradle

@@ -0,0 +1,12 @@
+plugins {
+    id 'java'
+}
+
+repositories {
+    jcenter()
+}
+
+dependencies {
+    testImplementation 'org.testcontainers:testcontainers'
+    testImplementation 'junit:junit:4.12'
+}

examples/mongodb-container/src/test/java/org/testcontainers/containers/MongoDbContainer.java

@@ -0,0 +1,53 @@
+package org.testcontainers.containers;
+
+import org.jetbrains.annotations.NotNull;
+
+
+/**
+ * This {@link Container} is based on the official MongoDb ({@code mongo}) image from
+ * <a href="https://hub.docker.com/r/_/mongo/">DockerHub</a>. If you need to use a custom MongoDB
+ * image, you can provide the full image name as well.
+ *
+ * @author Stefan Ludwig
+ */
+public class MongoDbContainer extends GenericContainer<MongoDbContainer> {
+
+    /**
+     * This is the internal port on which MongoDB is running inside the container.
+     * <p>
+     * You can use this constant in case you want to map an explicit public port to it
+     * instead of the default random port. This can be done using methods like
+     * {@link #setPortBindings(java.util.List)}.
+     */
+    public static final int MONGODB_PORT = 27017;
+    public static final String DEFAULT_IMAGE_AND_TAG = "mongo:4.0";
+
+    /**
+     * Creates a new {@link MongoDbContainer} with the {@value DEFAULT_IMAGE_AND_TAG} image.
+     */
+    public MongoDbContainer() {
+        this(DEFAULT_IMAGE_AND_TAG);
+    }
+
+    /**
+     * Creates a new {@link MongoDbContainer} with the given {@code 'image'}.
+     *
+     * @param image the image (e.g. {@value DEFAULT_IMAGE_AND_TAG}) to use
+     */
+    public MongoDbContainer(@NotNull String image) {
+        super(image);
+        addExposedPort(MONGODB_PORT);
+    }
+
+    /**
+     * Returns the actual public port of the internal MongoDB port ({@value MONGODB_PORT}).
+     *
+     * @return the public port of this container
+     * @see #getMappedPort(int)
+     */
+    @NotNull
+    public Integer getPort() {
+        return getMappedPort(MONGODB_PORT);
+    }
+
+}

examples/mongodb-container/src/test/java/org/testcontainers/containers/MongoDbContainerTest.java

@@ -0,0 +1,27 @@
+package org.testcontainers.containers;
+
+import java.io.IOException;
+import java.net.Socket;
+
+import org.junit.Test;
+
+
+public class MongoDbContainerTest {
+
+    @Test
+    public void containerStartsAndPublicPortIsAvailable() {
+        try (MongoDbContainer container = new MongoDbContainer()) {
+            container.start();
+            assertThatPortIsAvailable(container);
+        }
+    }
+
+    private void assertThatPortIsAvailable(MongoDbContainer container) {
+        try {
+            new Socket(container.getContainerIpAddress(), container.getPort());
+        } catch (IOException e) {
+            throw new AssertionError("The expected port " + container.getPort() + " is not available!");
+        }
+    }
+
+}

examples/settings.gradle

@@ -5,6 +5,7 @@ includeBuild '..'
 // explicit include to allow Dependabot to autodiscover subprojects
 include 'disque-job-queue'
 include 'linked-container'
+include 'mongodb-container'
 include 'redis-backed-cache'
 include 'redis-backed-cache-testng'
 include 'selenium-container'