MongoDbReplicaSet (mongodb-replica-set 0.4.3 API)

java.lang.Object
- com.github.silaev.mongodb.replicaset.MongoDbReplicaSet

All Implemented Interfaces:: java.lang.AutoCloseable, org.testcontainers.lifecycle.Startable

public class MongoDbReplicaSet
extends java.lang.Object
implements org.testcontainers.lifecycle.Startable, java.lang.AutoCloseable

Constructs a full-featured MongoDB cluster for integration testing, reproducing production issues, learning distributed systems by the example of MongoDB.

Supports Mongo DB version 3.6.14 and up.

Chart shows pattern local and remote docker support for replicaSetNumber

replicaSetNumber local docker host local docker host running tests from inside a container with mapping the Docker socket remote docker daemon availability of an arbiter node

1 + + + -

from 2 to 7 (including) only if adding 127.0.0.1 dockerhost to the OS host file + + +

Chart shows pattern local and remote docker support for replicaSetNumber
replicaSetNumber	local docker host	local docker host running tests from inside a container with mapping the Docker socket	remote docker daemon	availability of an arbiter node
`1`	+	+	+	-
`from 2 to 7 (including)`	only if adding 127.0.0.1 dockerhost to the OS host file	+	+	+

See examples on mongodb-replica-set on github

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MongoDbReplicaSet.MongoDbReplicaSetBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`MongoDbReplicaSet.MongoDbReplicaSetBuilder`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Comparator<MongoSocketAddress>`	`COMPARATOR_MAPPED_PORT`
`static int`	`MAX_VOTING_MEMBERS`
`static java.lang.String`	`RECONFIG_RS_MSG`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MongoDbReplicaSet.MongoDbReplicaSetBuilder`	`builder()`
`void`	`close()`
`void`	`connectNodeToNetwork(MongoNode mongoNode)` Connects a Mongo node (a Docker container) back to its network.
`void`	`connectNodeToNetworkWithForceRemoval(MongoNode mongoNode)` Connects a Mongo node (a Docker container) back to its network.
`void`	`connectNodeToNetworkWithoutRemoval(MongoNode mongoNode)` Connects a Mongo node (a Docker container) back to its network.
`void`	`connectNodeToNetworkWithReconfiguration(MongoNode mongoNode)` Connects a Mongo node (a Docker container) back to its network with forcing a cluster reconfiguration (for instance, in case there is no master in a cluster after some network disconnection).
`void`	`disconnectNodeFromNetwork(MongoNode mongoNode)` Disconnects a Mongo node (a Docker container) from its network.
`boolean`	`getAddArbiter()`
`boolean`	`getAddToxiproxy()`
`MongoNode`	`getArbiterMongoNode(java.util.List<MongoNode> mongoNodes)` Fetches an arbiter node in a list of provided mongo nodes.
`int`	`getAwaitNodeInitAttempts()`
`MongoNode`	`getMasterMongoNode(java.util.List<MongoNode> mongoNodes)` Fetches a master node in a list of provided mongo nodes.
`java.lang.String`	`getMongoDockerImageName()`
`MongoRsStatus`	`getMongoRsStatus()`
`int`	`getReplicaSetNumber()`
`java.lang.String`	`getReplicaSetUrl()`
`java.lang.String`	`getReplicaSetUrl(java.lang.String readPreference)`
`MongoNode`	`getSecondaryMongoNode(java.util.List<MongoNode> mongoNodes)` Fetches any secondary node in a list of provided mongo nodes.
`int`	`getSlaveDelayNumber()`
`int`	`getSlaveDelayTimeout()`
`boolean`	`getUseHostDockerInternal()`
`boolean`	`isEnabled()`
`void`	`killNode(MongoNode mongoNode)` Kills a Mongo node (a Docker container).
`java.lang.String`	`mongoDockerImageName()`
`java.util.stream.Stream<MongoNode>`	`mongoNodes(java.util.List<MongoNode> mongoNodes, ReplicaSetMemberState memberState)`
`java.util.List<ReplicaSetMemberState>`	`nodeStates(java.util.List<MongoNode> mongoNodes)`
`void`	`reconfigureReplSetRemoveDownAndUnknownNodes()` Removes all nodes in Down and Unknown state.
`void`	`reconfigureReplSetToDefaults()` Reconfigures a replica set by setting slaveDelay=0, priority=1 and hidden=false for each node.
`void`	`removeNodeFromReplSetConfig(MongoNode mongoNodeToRemove)` Removes a node from a replica set configuration.
`void`	`removeNodeFromReplSetConfigWithForce(MongoNode mongoNodeToRemove)`
`void`	`start()`
`void`	`startInternal()`
`void`	`stop()`
`void`	`stopNode(MongoNode mongoNode)` Stops a Mongo node (a Docker container).
`void`	`waitForAllMongoNodesUp()` Waits until a replica set has only PRIMARY, ARBITER or SECONDARY nodes.
`void`	`waitForMaster()` Waits for a master node to be present in a cluster.
`void`	`waitForMasterReelection(MongoNode previousMasterMongoNode)` Waits for a reelection in a replica set to completion based on the appearance of a master node that is not equal to a provided previousMasterMongoNode.
`void`	`waitForMongoNodesDown(int nodeNumber)` Waits until a replica set has the nodeNumber of the nodes in the DOWN state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.testcontainers.lifecycle.Startable
getDependencies

- Field Detail
  - MAX_VOTING_MEMBERS
```
public static final int MAX_VOTING_MEMBERS
```
    See Also:
    
    Constant Field Values
  - COMPARATOR_MAPPED_PORT
```
public static final java.util.Comparator<MongoSocketAddress> COMPARATOR_MAPPED_PORT
```
  - RECONFIG_RS_MSG
```
public static final java.lang.String RECONFIG_RS_MSG
```
    See Also:
    
    Constant Field Values
- Method Detail
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface org.testcontainers.lifecycle.Startable
  - getReplicaSetUrl
```
public java.lang.String getReplicaSetUrl()
```
  - getReplicaSetUrl
```
public java.lang.String getReplicaSetUrl(java.lang.String readPreference)
```
  - getMongoRsStatus
```
public MongoRsStatus getMongoRsStatus()
```
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface org.testcontainers.lifecycle.Startable
  - isEnabled
```
public boolean isEnabled()
```
  - mongoDockerImageName
```
public java.lang.String mongoDockerImageName()
```
  - getReplicaSetNumber
```
public int getReplicaSetNumber()
```
  - getAwaitNodeInitAttempts
```
public int getAwaitNodeInitAttempts()
```
  - getMongoDockerImageName
```
public java.lang.String getMongoDockerImageName()
```
  - getAddArbiter
```
public boolean getAddArbiter()
```
  - getAddToxiproxy
```
public boolean getAddToxiproxy()
```
  - getSlaveDelayTimeout
```
public int getSlaveDelayTimeout()
```
  - getSlaveDelayNumber
```
public int getSlaveDelayNumber()
```
  - getUseHostDockerInternal
```
public boolean getUseHostDockerInternal()
```
  - start
```
public void start()
```
    Specified by:
    
    start in interface org.testcontainers.lifecycle.Startable
  - startInternal
```
public void startInternal()
```
  - stopNode
```
public void stopNode(MongoNode mongoNode)
```
    Stops a Mongo node (a Docker container). Does not allow to start or connect a node back.
    
    Parameters:
    
    mongoNode - a node to stop.
    
    See Also:
    
    docker stop
  - killNode
```
public void killNode(MongoNode mongoNode)
```
    Kills a Mongo node (a Docker container).
    
    Parameters:
    
    mongoNode - a node to kill
    
    See Also:
    
    docker kill
  - disconnectNodeFromNetwork
```
public void disconnectNodeFromNetwork(MongoNode mongoNode)
```
    Disconnects a Mongo node (a Docker container) from its network.
    
    Parameters:
    
    mongoNode - a node to disconnect.
    
    See Also:
    
    docker network disconnect
  - connectNodeToNetworkWithReconfiguration
```
public void connectNodeToNetworkWithReconfiguration(MongoNode mongoNode)
```
    Connects a Mongo node (a Docker container) back to its network with forcing a cluster reconfiguration (for instance, in case there is no master in a cluster after some network disconnection). Beware that a container port changes after this operation because of a container restart.
    
    Parameters:
    
    mongoNode - a node to connect.
    
    See Also:
    
    docker network connect
  - connectNodeToNetwork
```
public void connectNodeToNetwork(MongoNode mongoNode)
```
    Connects a Mongo node (a Docker container) back to its network. Generally should be used in case of soft connections (with Toxyproxy).
    
    Parameters:
    
    mongoNode - a node to connect.
  - connectNodeToNetworkWithForceRemoval
```
public void connectNodeToNetworkWithForceRemoval(MongoNode mongoNode)
```
    Connects a Mongo node (a Docker container) back to its network. Generally should be used in case of hard connections (without Toxyproxy). Beware that a container port changes after this operation because of a container restart. Internally removes a disconnected node via forcing reconfiguration.
    
    Parameters:
    
    mongoNode - a node to connect.
  - connectNodeToNetworkWithoutRemoval
```
public void connectNodeToNetworkWithoutRemoval(MongoNode mongoNode)
```
    Connects a Mongo node (a Docker container) back to its network. Generally should be used in case of hard connections (without Toxyproxy). Beware that a container port changes after this operation because of a container restart. Internally removes a disconnected node via rs.remove.
    
    Parameters:
    
    mongoNode - a node to connect.
  - reconfigureReplSetRemoveDownAndUnknownNodes
```
public void reconfigureReplSetRemoveDownAndUnknownNodes()
```
    Removes all nodes in Down and Unknown state.
  - reconfigureReplSetToDefaults
```
public void reconfigureReplSetToDefaults()
```
    Reconfigures a replica set by setting slaveDelay=0, priority=1 and hidden=false for each node.
  - removeNodeFromReplSetConfig
```
public void removeNodeFromReplSetConfig(MongoNode mongoNodeToRemove)
```
    Removes a node from a replica set configuration.
    
    Parameters:
    
    mongoNodeToRemove - a node to remove from a replica set.
    
    See Also:
    
    mongodb remove from a replica set
  - removeNodeFromReplSetConfigWithForce
```
public void removeNodeFromReplSetConfigWithForce(MongoNode mongoNodeToRemove)
```
  - waitForMasterReelection
```
public void waitForMasterReelection(MongoNode previousMasterMongoNode)
```
    Waits for a reelection in a replica set to completion based on the appearance of a master node that is not equal to a provided previousMasterMongoNode.
    
    Parameters:
    
    previousMasterMongoNode - a node that is not supposed to become a new master elected.
  - waitForMaster
```
public void waitForMaster()
```
    Waits for a master node to be present in a cluster.
  - waitForAllMongoNodesUp
```
public void waitForAllMongoNodesUp()
```
    Waits until a replica set has only PRIMARY, ARBITER or SECONDARY nodes.
  - waitForMongoNodesDown
```
public void waitForMongoNodesDown(int nodeNumber)
```
    Waits until a replica set has the nodeNumber of the nodes in the DOWN state.
    
    Parameters:
    
    nodeNumber - a number of nodes in the DOWN state to wait for.
  - getArbiterMongoNode
```
public MongoNode getArbiterMongoNode(java.util.List<MongoNode> mongoNodes)
```
    Fetches an arbiter node in a list of provided mongo nodes.
    
    Parameters:
    
    mongoNodes - a list in which to search for a master node.
    
    Returns:
    
    MongoNode representing an arbiter node in a replica set.
  - getMasterMongoNode
```
public MongoNode getMasterMongoNode(java.util.List<MongoNode> mongoNodes)
```
    Fetches a master node in a list of provided mongo nodes.
    
    Parameters:
    
    mongoNodes - a list in which to search for a master node.
    
    Returns:
    
    MongoNode representing a master node in a replica set.
  - getSecondaryMongoNode
```
public MongoNode getSecondaryMongoNode(java.util.List<MongoNode> mongoNodes)
```
    Fetches any secondary node in a list of provided mongo nodes.
    
    Parameters:
    
    mongoNodes - a list in which to search for a master node.
    
    Returns:
    
    MongoNode representing a secondary node in a replica set.
  - mongoNodes
```
public java.util.stream.Stream<MongoNode> mongoNodes(java.util.List<MongoNode> mongoNodes,
                                                     ReplicaSetMemberState memberState)
```
  - nodeStates
```
public java.util.List<ReplicaSetMemberState> nodeStates(java.util.List<MongoNode> mongoNodes)
```
  - builder
```
public static MongoDbReplicaSet.MongoDbReplicaSetBuilder builder()
```

Class MongoDbReplicaSet

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.testcontainers.lifecycle.Startable

Field Detail

MAX_VOTING_MEMBERS

COMPARATOR_MAPPED_PORT

RECONFIG_RS_MSG

Method Detail

close

getReplicaSetUrl

getReplicaSetUrl

getMongoRsStatus

stop

isEnabled

mongoDockerImageName

getReplicaSetNumber

getAwaitNodeInitAttempts

getMongoDockerImageName

getAddArbiter

getAddToxiproxy

getSlaveDelayTimeout

getSlaveDelayNumber

getUseHostDockerInternal

start

startInternal

stopNode

killNode

disconnectNodeFromNetwork

connectNodeToNetworkWithReconfiguration

connectNodeToNetwork

connectNodeToNetworkWithForceRemoval

connectNodeToNetworkWithoutRemoval

reconfigureReplSetRemoveDownAndUnknownNodes

reconfigureReplSetToDefaults

removeNodeFromReplSetConfig

removeNodeFromReplSetConfigWithForce

waitForMasterReelection

waitForMaster

waitForAllMongoNodesUp

waitForMongoNodesDown

getArbiterMongoNode

getMasterMongoNode

getSecondaryMongoNode

mongoNodes

nodeStates

builder