Package io.debezium.testing.testcontainers

Class MongoDbContainer

java.lang.Object
org.testcontainers.containers.FailureDetectingExternalResource
org.testcontainers.containers.GenericContainer<MongoDbContainer>
io.debezium.testing.testcontainers.MongoDbContainer
All Implemented Interfaces:
AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<MongoDbContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable
public class MongoDbContainer extends org.testcontainers.containers.GenericContainer<MongoDbContainer>
A container for running a single MongoDB mongod or mongos process.

In order to interact with a running container from the host running Docker Desktop using a client driver, the container's network alias (name) must be resolvable from the host. On most systems this will require configuring /etc/hosts to have an entry that maps name to 127.0.0.1. Fixed ports are used on the host and are mapped 1:1 exactly with the container. Random free ports are assigned to minimize the chance of conflicts.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    MongoDbContainer.Address
     
    static final class 
    MongoDbContainer.Builder
     

    Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

    org.testcontainers.containers.Container.ExecResult

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final boolean
    authEnabled
     
    private String
    authSource
     
    private boolean
    authUserEnabled
     
    private final String
    configAddress
     
    private static final String
    CONTAINER_KEYFILE_PATH
     
    private static final org.testcontainers.utility.DockerImageName
    IMAGE_NAME
     
    static final String
    IMAGE_VERSION
    Default should match version.mongo.server in parent pom.xml.
    private static final org.slf4j.Logger
    LOGGER
     
    private final String
    name
     
    private static final org.testcontainers.shaded.com.fasterxml.jackson.databind.ObjectMapper
    OBJECT_MAPPER
     
    private String
    password
     
    private final int
    port
     
    private final PortResolver
    portResolver
     
    private final String
    process
     
    private final String
    replicaSet
     
    private final String
    typeFlag
     
    private String
    username
     

    Fields inherited from class org.testcontainers.containers.GenericContainer

    CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

    Fields inherited from interface org.testcontainers.containers.ContainerState

    STATE_HEALTHY

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    MongoDbContainer(MongoDbContainer.Builder builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    private void
    checkExitCode(org.testcontainers.containers.Container.ExecResult result)
     
    private void
    checkStarted()
     
    static MongoDbContainer.Builder
    configServerNode()
     
    protected void
    configure()
     
    protected void
    containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
     
    protected void
    containerIsStopped(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
     
    void
    createUser(String username, String password, String database, boolean setDefault, String... rolePairs)
     
    private void
    dockerCommand(Function<com.github.dockerjava.api.DockerClient,com.github.dockerjava.api.command.SyncDockerCmd<?>> action)
     
    org.testcontainers.shaded.com.fasterxml.jackson.databind.JsonNode
    eval(String command)
     
    org.testcontainers.containers.Container.ExecResult
    execMongoInContainer(String... command)
     
    org.testcontainers.containers.Container.ExecResult
    execMongoScriptInContainer(org.testcontainers.utility.MountableFile file, String containerPath)
    Uploads given file to container and executes is as mongodb javascript
    MongoDbContainer.Address
    getClientAddress()
    Returns the public address that should be used by clients.
    MongoDbContainer.Address
    getNamedAddress()
    Returns the named-address that is only guaranteed available within the network.
    private String
    getNetworkIp()
     
    void
    initReplicaSet(boolean configServer, MongoDbContainer.Address... Addresses)
    Invokes rs.initiate on the container.
    private static boolean
    isLegacy()
     
    void
    kill()
     
    private String
    mapPairToRole(String pair)
     
    static MongoDbContainer.Builder
    node()
     
    private static org.testcontainers.shaded.com.fasterxml.jackson.databind.JsonNode
    parseResponse(String stdout)
     
    void
    pause()
     
    static MongoDbContainer.Builder
    router(String configAddress)
     
    static MongoDbContainer.Builder
    shardServerNode()
     
    void
    stepDown()
    Invokes rs.stepDown on the container to instruct the primary of the replica set to become the primary.
    void
    unpause()
     

    Methods inherited from class org.testcontainers.containers.GenericContainer

    addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, containerIsCreated, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.testcontainers.containers.Container

    addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

    Methods inherited from interface org.testcontainers.containers.ContainerState

    copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

    Methods inherited from interface org.testcontainers.lifecycle.Startable

    close

  • Field Details

    • LOGGER

      private static final org.slf4j.Logger LOGGER

    • IMAGE_VERSION

      public static final String IMAGE_VERSION
      Default should match version.mongo.server in parent pom.xml.

    • IMAGE_NAME

      private static final org.testcontainers.utility.DockerImageName IMAGE_NAME

    • OBJECT_MAPPER

      private static final org.testcontainers.shaded.com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER

    • CONTAINER_KEYFILE_PATH

      private static final String CONTAINER_KEYFILE_PATH
      See Also:

    • name

      private final String name

    • port

      private final int port

    • replicaSet

      private final String replicaSet

    • portResolver

      private final PortResolver portResolver

    • process

      private final String process

    • typeFlag

      private final String typeFlag

    • configAddress

      private final String configAddress

    • username

      private String username

    • password

      private String password

    • authSource

      private String authSource

    • authUserEnabled

      private boolean authUserEnabled

    • authEnabled

      private final boolean authEnabled

  • Constructor Details

  • Method Details

    • node

      public static MongoDbContainer.Builder node()

    • router

      public static MongoDbContainer.Builder router(String configAddress)

    • configServerNode

      public static MongoDbContainer.Builder configServerNode()

    • shardServerNode

      public static MongoDbContainer.Builder shardServerNode()

    • configure

      protected void configure()
      Overrides:
      configure in class org.testcontainers.containers.GenericContainer<MongoDbContainer>

    • getClientAddress

      public MongoDbContainer.Address getClientAddress()
      Returns the public address that should be used by clients.

      Must be called after GenericContainer.start() since the public address may not be available on all platforms before then.

      Returns:
      the host-addressable address

    • getNamedAddress

      public MongoDbContainer.Address getNamedAddress()
      Returns the named-address that is only guaranteed available within the network.

      Can always be called before GenericContainer.start() safely. Useful for intra-cluster addressing that must be configured before containers are running and the addresses are not available (e.g. in the constructor of a replica set or sharded cluster).

      Returns:
      the name-addressable network address

    • initReplicaSet

      public void initReplicaSet(boolean configServer, MongoDbContainer.Address... Addresses)
      Invokes rs.initiate on the container.
      Parameters:
      configServer - whether this replica set is a used for a sharded cluster's config server.
      Addresses - the list of hostname / port numbers of the set members

    • execMongoScriptInContainer

      public org.testcontainers.containers.Container.ExecResult execMongoScriptInContainer(org.testcontainers.utility.MountableFile file, String containerPath)
      Uploads given file to container and executes is as mongodb javascript
      Parameters:
      file - file to be uploaded
      containerPath - path in the container
      Returns:
      execution result

    • stepDown

      public void stepDown()
      Invokes rs.stepDown on the container to instruct the primary of the replica set to become the primary.

    • kill

      public void kill()

    • pause

      public void pause()

    • unpause

      public void unpause()

    • getNetworkIp

      private String getNetworkIp()

    • dockerCommand

      private void dockerCommand(Function<com.github.dockerjava.api.DockerClient,com.github.dockerjava.api.command.SyncDockerCmd<?>> action)

    • execMongoInContainer

      public org.testcontainers.containers.Container.ExecResult execMongoInContainer(String... command) throws IOException, InterruptedException
      Throws:
      IOException
      InterruptedException

    • eval

      public org.testcontainers.shaded.com.fasterxml.jackson.databind.JsonNode eval(String command)

    • parseResponse

      private static org.testcontainers.shaded.com.fasterxml.jackson.databind.JsonNode parseResponse(String stdout)

    • checkExitCode

      private void checkExitCode(org.testcontainers.containers.Container.ExecResult result)

    • checkStarted

      private void checkStarted()

    • containerIsStarted

      protected void containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
      Overrides:
      containerIsStarted in class org.testcontainers.containers.GenericContainer<MongoDbContainer>

    • createUser

      public void createUser(String username, String password, String database, boolean setDefault, String... rolePairs)
      Parameters:
      username - username
      password - password
      database - database where user is created
      setDefault - if true this user is set as the default for the following in container operations
      rolePairs - either role name or "role:database" pair

    • mapPairToRole

      private String mapPairToRole(String pair)

    • containerIsStopped

      protected void containerIsStopped(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
      Overrides:
      containerIsStopped in class org.testcontainers.containers.GenericContainer<MongoDbContainer>

    • isLegacy

      private static boolean isLegacy()