Class InternalTestCluster

java.lang.Object
org.opensearch.test.TestCluster
org.opensearch.test.InternalTestCluster
All Implemented Interfaces:
Closeable, AutoCloseable
public final class InternalTestCluster extends TestCluster
InternalTestCluster manages a set of JVM private nodes and allows convenient access to them. The cluster supports randomized configuration such that nodes started in the cluster will automatically load asserting services tracking resources like file handles or open searchers.

The Cluster is bound to a test lifecycle where tests must call beforeTest(java.util.Random) and afterTest() to initialize and reset the cluster in order to be more reproducible. The term "more" relates to the async nature of OpenSearch in combination with randomized testing. Once Threads and asynchronous calls are involved reproducibility is very limited. This class should only be used through OpenSearchIntegTestCase.

  • Field Details

  • Constructor Details

    • InternalTestCluster

      public InternalTestCluster(long clusterSeed, Path baseDir, boolean randomlyAddDedicatedClusterManagers, boolean autoManageClusterManagerNodes, int minNumDataNodes, int maxNumDataNodes, String clusterName, NodeConfigurationSource nodeConfigurationSource, int numClientNodes, String nodePrefix, Collection<Class<? extends org.opensearch.plugins.Plugin>> mockPlugins, Function<org.opensearch.transport.client.Client, org.opensearch.transport.client.Client> clientWrapper)

    • InternalTestCluster

      public InternalTestCluster(long clusterSeed, Path baseDir, boolean randomlyAddDedicatedClusterManagers, boolean autoManageClusterManagerNodes, int minNumDataNodes, int maxNumDataNodes, String clusterName, NodeConfigurationSource nodeConfigurationSource, int numClientNodes, String nodePrefix, Collection<Class<? extends org.opensearch.plugins.Plugin>> mockPlugins, Function<org.opensearch.transport.client.Client, org.opensearch.transport.client.Client> clientWrapper, boolean forbidPrivateIndexSettings)

  • Method Details

    • setBootstrapClusterManagerNodeIndex

      public void setBootstrapClusterManagerNodeIndex(int bootstrapClusterManagerNodeIndex)
      Sets bootstrapClusterManagerNodeIndex to the given value, see bootstrapClusterManagerNodeWithSpecifiedIndex(List) for the description of how this field is used. It's only possible to change bootstrapClusterManagerNodeIndex value if autoManageClusterManagerNodes is false.

    • getClusterName

      public String getClusterName()
      Description copied from class: TestCluster
      Returns the cluster name
      Specified by:
      getClusterName in class TestCluster

    • getNodeNames

      public String[] getNodeNames()

    • getPlugins

      public Collection<Class<? extends org.opensearch.plugins.Plugin>> getPlugins()

    • clusterName

      public static String clusterName(String prefix, long clusterSeed)

    • ensureAtLeastNumDataNodes

      public void ensureAtLeastNumDataNodes(int n)
      Ensures that at least n data nodes are present in the cluster. if more nodes than n are present this method will not stop any of the running nodes.

    • ensureAtLeastNumWarmNodes

      public void ensureAtLeastNumWarmNodes(int n)
      Ensures that at least n warm nodes are present in the cluster. if more nodes than n are present this method will not stop any of the running nodes.

    • ensureAtLeastNumWarmAndDataNodes

      public void ensureAtLeastNumWarmAndDataNodes(int n)
      Ensures that at least n data-warm nodes are present in the cluster. if more nodes than n are present this method will not stop any of the running nodes.

    • ensureAtMostNumDataNodes

      public void ensureAtMostNumDataNodes(int n) throws IOException
      Ensures that at most n are up and running. If less nodes that n are running this method will not start any additional nodes.
      Throws:
      IOException

    • client

      public org.opensearch.transport.client.Client client()
      Description copied from class: TestCluster
      Returns a client connected to any node in the cluster
      Specified by:
      client in class TestCluster

    • dataNodeClient

      public org.opensearch.transport.client.Client dataNodeClient()
      Returns a node client to a data node in the cluster. Note: use this with care tests should not rely on a certain nodes client.

    • clusterManagerClient

      public org.opensearch.transport.client.Client clusterManagerClient()
      Returns a node client to the current cluster-manager node. Note: use this with care tests should not rely on a certain nodes client.

    • nonClusterManagerClient

      public org.opensearch.transport.client.Client nonClusterManagerClient()
      Returns a node client to random node but not the cluster-manager. This method will fail if no non-cluster-manager client is available.

    • coordOnlyNodeClient

      public org.opensearch.transport.client.Client coordOnlyNodeClient()
      Returns a client to a coordinating only node

    • startCoordinatingOnlyNode

      public String startCoordinatingOnlyNode(org.opensearch.common.settings.Settings settings)

    • client

      public org.opensearch.transport.client.Client client(String nodeName)
      Returns a node client to a given node.

    • smartClient

      public org.opensearch.transport.client.Client smartClient()
      Returns a "smart" node client to a random node in the cluster

    • close

      public void close() throws IOException
      Description copied from class: TestCluster
      Closes the current cluster
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class TestCluster
      Throws:
      IOException

    • beforeTest

      public void beforeTest(Random random) throws IOException, InterruptedException
      Description copied from class: TestCluster
      This method should be executed before each test to reset the cluster to its initial state.
      Overrides:
      beforeTest in class TestCluster
      Throws:
      IOException
      InterruptedException

    • validateClusterFormed

      public void validateClusterFormed()
      ensure a cluster is formed with all published nodes.

    • afterTest

      public void afterTest()
      Description copied from class: TestCluster
      This method should be executed during tear down, after each test (but after assertAfterTest)
      Specified by:
      afterTest in class TestCluster

    • beforeIndexDeletion

      public void beforeIndexDeletion() throws Exception
      Description copied from class: TestCluster
      Assertions that should run before the cluster is wiped should be called in this method
      Overrides:
      beforeIndexDeletion in class TestCluster
      Throws:
      Exception

    • assertConsistentHistoryBetweenTranslogAndLuceneIndex

      public void assertConsistentHistoryBetweenTranslogAndLuceneIndex() throws IOException
      Asserts that the document history in Lucene index is consistent with Translog's on every index shard of the cluster. This assertion might be expensive, thus we prefer not to execute on every test but only interesting tests.
      Throws:
      IOException

    • assertNoInFlightDocsInEngine

      public void assertNoInFlightDocsInEngine() throws Exception
      Throws:
      Exception

    • assertSeqNos

      public void assertSeqNos() throws Exception
      Throws:
      Exception

    • assertSameDocIdsOnShards

      public void assertSameDocIdsOnShards() throws Exception
      Asserts that all shards with the same shardId should have document Ids.
      Throws:
      Exception

    • wipePendingDataDirectories

      public void wipePendingDataDirectories()

    • clusterService

      public org.opensearch.cluster.service.ClusterService clusterService()
      Returns a reference to a random node's ClusterService

    • clusterService

      public org.opensearch.cluster.service.ClusterService clusterService(@Nullable String node)
      Returns a reference to a node's ClusterService. If the given node is null, a random node will be selected.

    • getInstances

      public <T> Iterable<T> getInstances(Class<T> clazz)
      Returns an Iterable to all instances for the given class >T< across all nodes in the cluster.

    • getDataNodeInstances

      public <T> Iterable<T> getDataNodeInstances(Class<T> clazz)
      Returns an Iterable to all instances for the given class >T< across all data nodes in the cluster.

    • getCurrentClusterManagerNodeInstance

      public <T> T getCurrentClusterManagerNodeInstance(Class<T> clazz)

    • getDataOrClusterManagerNodeInstances

      public <T> Iterable<T> getDataOrClusterManagerNodeInstances(Class<T> clazz)
      Returns an Iterable to all instances for the given class >T< across all data and cluster-manager nodes in the cluster.

    • getInstance

      public <T> T getInstance(Class<T> clazz, String node)
      Returns a reference to the given nodes instances of the given class >T<

    • getDataNodeInstance

      public <T> T getDataNodeInstance(Class<T> clazz)

    • getClusterManagerNodeInstance

      public <T> T getClusterManagerNodeInstance(Class<T> clazz)

    • getInstance

      public <T> T getInstance(Class<T> clazz)
      Returns a reference to a random nodes instances of the given class >T<

    • dataPathSettings

      public org.opensearch.common.settings.Settings dataPathSettings(String node)

    • size

      public int size()
      Description copied from class: TestCluster
      Returns the number of nodes in the cluster.
      Specified by:
      size in class TestCluster

    • httpAddresses

      public InetSocketAddress[] httpAddresses()
      Description copied from class: TestCluster
      Returns the http addresses of the nodes within the cluster. Can be used to run REST tests against the test cluster.
      Specified by:
      httpAddresses in class TestCluster

    • stopRandomWarmNode

      public boolean stopRandomWarmNode() throws IOException
      Stops a random warm node in the cluster. Returns true if a node was found to stop, false otherwise.
      Throws:
      IOException

    • stopRandomDataNode

      public boolean stopRandomDataNode() throws IOException
      Stops a random data node in the cluster. Returns true if a node was found to stop, false otherwise.
      Throws:
      IOException

    • stopRandomNode

      public void stopRandomNode(Predicate<org.opensearch.common.settings.Settings> filter) throws IOException
      Stops a random node in the cluster that applies to the given filter. Does nothing if none of the nodes match the filter.
      Throws:
      IOException

    • stopCurrentClusterManagerNode

      public void stopCurrentClusterManagerNode() throws IOException
      Stops the current cluster-manager node forcefully.
      Throws:
      IOException

    • stopRandomNodeNotCurrentClusterManager

      public void stopRandomNodeNotCurrentClusterManager() throws IOException
      Stops any of the current nodes but not the cluster-manager node.
      Throws:
      IOException

    • stopAllNodes

      public void stopAllNodes()
      Stops all running nodes in cluster

    • resetCluster

      public void resetCluster()
      Replace all nodes by stopping all current node and starting new node. Used for remote store test cases, where remote state is restored.

    • restartRandomDataNode

      public void restartRandomDataNode() throws Exception
      Restarts a random data node in the cluster
      Throws:
      Exception

    • restartRandomDataNode

      public void restartRandomDataNode(InternalTestCluster.RestartCallback callback) throws Exception
      Restarts a random data node in the cluster and calls the callback during restart.
      Throws:
      Exception

    • restartNode

      public void restartNode(String nodeName) throws Exception
      Restarts a node.
      Throws:
      Exception

    • restartNode

      public void restartNode(String nodeName, InternalTestCluster.RestartCallback callback) throws Exception
      Restarts a node and calls the callback during restart.
      Throws:
      Exception

    • fullRestart

      public void fullRestart() throws Exception
      Restarts all nodes in the cluster. It first stops all nodes and then restarts all the nodes again.
      Throws:
      Exception

    • rollingRestart

      public void rollingRestart(InternalTestCluster.RestartCallback callback) throws Exception
      Restarts all nodes in a rolling restart fashion ie. only restarts on node a time.
      Throws:
      Exception

    • fullRestart

      public void fullRestart(InternalTestCluster.RestartCallback callback) throws Exception
      Restarts all nodes in the cluster. It first stops all nodes and then restarts all the nodes again.
      Throws:
      Exception

    • getClusterManagerNames

      public Set<String> getClusterManagerNames()
      Returns the name of all the cluster managers in the cluster

    • getClusterManagerName

      public String getClusterManagerName()
      Returns the name of the current cluster-manager node in the cluster.

    • getClusterManagerName

      public String getClusterManagerName(@Nullable String viaNode)
      Returns the name of the current cluster-manager node in the cluster and executes the request via the node specified in the viaNode parameter. If viaNode isn't specified a random node will be picked to the send the request to.

    • getDataNodeNames

      public Set<String> getDataNodeNames()

    • nodesInclude

      public Set<String> nodesInclude(String index)
      Returns a set of nodes that have at least one shard of the given index.

    • startNode

      public String startNode()
      Starts a node with default settings and returns its name.

    • startNode

      public String startNode(org.opensearch.common.settings.Settings.Builder settings)
      Starts a node with the given settings builder and returns its name.

    • startNode

      public String startNode(org.opensearch.common.settings.Settings settings)
      Starts a node with the given settings and returns its name.

    • startNodes

      public List<String> startNodes(int numOfNodes)
      Starts multiple nodes with default settings and returns their names

    • startNodes

      public List<String> startNodes(int numOfNodes, org.opensearch.common.settings.Settings settings)
      Starts multiple nodes with the given settings and returns their names

    • startNodes

      public List<String> startNodes(int numOfNodes, org.opensearch.common.settings.Settings settings, Boolean waitForNodeJoin)
      Starts multiple nodes with the given settings and returns their names

    • startNodes

      public List<String> startNodes(org.opensearch.common.settings.Settings... extraSettings)
      Starts multiple nodes with the given settings and returns their names

    • startNodes

      public List<String> startNodes(Boolean waitForNodeJoin, org.opensearch.common.settings.Settings... extraSettings)
      Starts multiple nodes with the given settings and returns their names

    • startClusterManagerOnlyNodes

      public List<String> startClusterManagerOnlyNodes(int numNodes)

    • startClusterManagerOnlyNodes

      public List<String> startClusterManagerOnlyNodes(int numNodes, org.opensearch.common.settings.Settings settings)

    • startDataAndWarmNodes

      public List<String> startDataAndWarmNodes(int numNodes)

    • startDataAndWarmNodes

      public List<String> startDataAndWarmNodes(int numNodes, org.opensearch.common.settings.Settings settings)

    • startSearchOnlyNodes

      public List<String> startSearchOnlyNodes(int numNodes)

    • startSearchOnlyNodes

      public List<String> startSearchOnlyNodes(int numNodes, org.opensearch.common.settings.Settings settings)

    • startSearchOnlyNode

      public String startSearchOnlyNode()

    • startSearchOnlyNode

      public String startSearchOnlyNode(org.opensearch.common.settings.Settings settings)

    • startDataOnlyNodes

      public List<String> startDataOnlyNodes(int numNodes)

    • startDataOnlyNodes

      public List<String> startDataOnlyNodes(int numNodes, org.opensearch.common.settings.Settings settings)

    • startDataOnlyNodes

      public List<String> startDataOnlyNodes(int numNodes, org.opensearch.common.settings.Settings settings, Boolean ignoreNodeJoin)

    • startWarmOnlyNodes

      public List<String> startWarmOnlyNodes(int numNodes)

    • startWarmOnlyNodes

      public List<String> startWarmOnlyNodes(int numNodes, org.opensearch.common.settings.Settings settings)

    • startClusterManagerOnlyNode

      public String startClusterManagerOnlyNode()

    • startClusterManagerOnlyNode

      public String startClusterManagerOnlyNode(org.opensearch.common.settings.Settings settings)

    • startDataOnlyNode

      public String startDataOnlyNode()

    • startDataOnlyNode

      public String startDataOnlyNode(org.opensearch.common.settings.Settings settings)

    • closeNonSharedNodes

      public void closeNonSharedNodes(boolean wipeData) throws IOException
      Throws:
      IOException

    • numDataNodes

      public int numDataNodes()
      Description copied from class: TestCluster
      Returns the number of data nodes in the cluster.
      Specified by:
      numDataNodes in class TestCluster

    • numWarmNodes

      public int numWarmNodes()

    • numWarmAndDataNodes

      public int numWarmAndDataNodes()

    • numDataAndClusterManagerNodes

      public int numDataAndClusterManagerNodes()
      Description copied from class: TestCluster
      Returns the number of data and cluster-manager eligible nodes in the cluster.
      Specified by:
      numDataAndClusterManagerNodes in class TestCluster

    • numClusterManagerNodes

      public int numClusterManagerNodes()

    • setDisruptionScheme

      public void setDisruptionScheme(ServiceDisruptionScheme scheme)

    • clearDisruptionScheme

      public void clearDisruptionScheme()

    • clearDisruptionScheme

      public void clearDisruptionScheme(boolean ensureHealthyCluster)

    • getClients

      public Iterable<org.opensearch.transport.client.Client> getClients()
      Description copied from class: TestCluster
      Returns an Iterable over all clients in this test cluster
      Specified by:
      getClients in class TestCluster

    • getNamedWriteableRegistry

      public org.opensearch.core.common.io.stream.NamedWriteableRegistry getNamedWriteableRegistry()
      Description copied from class: TestCluster
      Returns this clusters NamedWriteableRegistry this is needed to deserialize binary content from this cluster that might include custom named writeables
      Specified by:
      getNamedWriteableRegistry in class TestCluster

    • nameFilter

      public static Predicate<org.opensearch.common.settings.Settings> nameFilter(String... nodeNames)
      Returns a predicate that only accepts settings of nodes with one of the given names.

    • getDefaultSettings

      public org.opensearch.common.settings.Settings getDefaultSettings()

    • ensureEstimatedStats

      public void ensureEstimatedStats()
      Description copied from class: TestCluster
      Ensures that any breaker statistics are reset to 0.

      The implementation is specific to the test cluster, because the act of checking some breaker stats can increase them.

      Specified by:
      ensureEstimatedStats in class TestCluster

    • assertAfterTest

      public void assertAfterTest() throws Exception
      Description copied from class: TestCluster
      This method checks all the things that need to be checked after each test
      Overrides:
      assertAfterTest in class TestCluster
      Throws:
      Exception

    • assertRequestsFinished

      public void assertRequestsFinished()