Package org.elasticsearch.test

Class ExternalTestCluster

java.lang.Object

org.elasticsearch.test.TestCluster

org.elasticsearch.test.ExternalTestCluster

All Implemented Interfaces:

Closeable, AutoCloseable

public final class ExternalTestCluster
extends TestCluster

External cluster to run the tests against. It is a pure immutable test cluster that allows to send requests to a pre-existing cluster and supports by nature all the needed test operations like wipeIndices etc.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTERNAL_CLUSTER_PREFIX

Fields inherited from class org.elasticsearch.test.TestCluster

random

Constructor Summary

Constructors

Constructor	Description
ExternalTestCluster(Path tempDir, Settings additionalSettings, Collection<Class<? extends Plugin>> pluginClasses, Function<Client,Client> clientWrapper, String clusterName, TransportAddress... transportAddresses)

Method Summary

Modifier and Type	Method	Description
void	afterTest()	This method should be executed during tear down, after each test (but after assertAfterTest)
Client	client()	Returns a client connected to any node in the cluster
void	close()	Closes the current cluster
void	ensureEstimatedStats()	Ensures that any breaker statistics are reset to 0.
Iterable<Client>	getClients()	Returns an Iterable over all clients in this test cluster
String	getClusterName()	Returns the cluster name
NamedWriteableRegistry	getNamedWriteableRegistry()	Returns this clusters NamedWriteableRegistry this is needed to deserialize binary content from this cluster that might include custom named writeables
InetSocketAddress[]	httpAddresses()	Returns the http addresses of the nodes within the cluster.
int	numDataAndMasterNodes()	Returns the number of data and master eligible nodes in the cluster.
int	numDataNodes()	Returns the number of data nodes in the cluster.
int	size()	Returns the number of nodes in the cluster.

Methods inherited from class org.elasticsearch.test.TestCluster

assertAfterTest, beforeIndexDeletion, beforeTest, seed, wipe, wipeAllComponentTemplates, wipeAllComposableIndexTemplates, wipeAllDataStreams, wipeAllTemplates, wipeIndices, wipeRepositories, wipeTemplates

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXTERNAL_CLUSTER_PREFIX

public static final String EXTERNAL_CLUSTER_PREFIX

See Also:

• Constant Field Values

Constructor Details

ExternalTestCluster

public ExternalTestCluster(Path tempDir,
 Settings additionalSettings,
 Collection<Class<? extends Plugin>> pluginClasses,
 Function<Client,Client> clientWrapper,
 String clusterName,
 TransportAddress... transportAddresses)

Method Details

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

client

public Client client()

Description copied from class: TestCluster

Returns a client connected to any node in the cluster

Specified by:

client in class TestCluster

size

public int size()

Description copied from class: TestCluster

Returns the number of nodes in the cluster.

Specified by:

size in class TestCluster

numDataNodes

public int numDataNodes()

Description copied from class: TestCluster

Returns the number of data nodes in the cluster.

Specified by:

numDataNodes in class TestCluster

numDataAndMasterNodes

public int numDataAndMasterNodes()

Description copied from class: TestCluster

Returns the number of data and master eligible nodes in the cluster.

Specified by:

numDataAndMasterNodes 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

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

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

getClients

public Iterable<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 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

getClusterName

public String getClusterName()

Description copied from class: TestCluster

Returns the cluster name

Specified by:

getClusterName in class TestCluster