+ * @ClusterScope(scope=Scope.TEST)
+ * public class SomeIntegrationTest extends ElasticsearchIntegrationTest {
+ * @Test
+ * public void testMethod() {}
+ * }
+ *
+ *
+ * If no {@link ClusterScope} annotation is present on an integration test the default scope it {@link Scope#GLOBAL}
+ *
+ * A test cluster creates a set of nodes in the background before the test starts. The number of nodes in the cluster is
+ * determined at random and can change across tests. The minimum number of nodes in the shared global cluster is 2.
+ * For other scopes the {@link ClusterScope} allows configuring the initial number of nodes that are created before
+ * the tests start.
+ *
+ *
+ * @ClusterScope(scope=Scope.SUITE, numNodes=3)
+ * public class SomeIntegrationTest extends ElasticsearchIntegrationTest {
+ * @Test
+ * public void testMethod() {}
+ * }
+ *
+ *
+ * Note, the {@link ElasticsearchIntegrationTest} uses randomized settings on a cluster and index level. For instance
+ * each test might use different directory implementation for each test or will return a random client to one of the
+ * nodes in the cluster for each call to {@link #client()}. Test failures might only be reproducible if the correct
+ * system properties are passed to the test execution environment.
+ *
* - * This test wipes all indices before a testcase is executed and uses - * elasticsearch features like allocation filters to ensure an index is - * allocated only on a certain number of nodes. The test doesn't expose explicit - * information about the client or which client is returned, clients might be - * node clients or transport clients and the returned client might be rotated. + * This class supports the following system properties (passed with -Dkey=value to the application) + *
+ * This method uses allocation deciders to filter out certain nodes to allocate the created index on. It defines allocation
+ * rules based on index.routing.allocation.exclude._name.
+ *
+ * This method uses allocation deciders to filter out certain nodes to allocate the created index on. It defines allocation
+ * rules based on index.routing.allocation.exclude._name.
+ *
n nodes using the allocation deciders.
+ * Yet if the shards can't be allocated on any other node shards for this index will remain allocated on
+ * more than n nodes.
+ */
+ public void allowNodes(String index, int n) {
+ assert index != null;
+ cluster().ensureAtLeastNumNodes(n);
ImmutableSettings.Builder builder = ImmutableSettings.builder();
- if (numNodes > 0) {
- getExcludeSettings(index, numNodes, builder);
+ if (n > 0) {
+ getExcludeSettings(index, n, builder);
}
Settings build = builder.build();
if (!build.getAsMap().isEmpty()) {
@@ -345,10 +421,11 @@ public abstract class ElasticsearchIntegrationTest extends ElasticsearchTestCase
}
}
- public CreateIndexRequestBuilder prepareCreate(String index) {
- return client().admin().indices().prepareCreate(index).setSettings(getSettings());
- }
-
+ /**
+ * Ensures the cluster has a green state via the cluster health API. This method will also wait for relocations.
+ * It is useful to ensure that all action on the cluster have finished and all shards that were currently relocating
+ * are now allocated and started.
+ */
public ClusterHealthStatus ensureGreen() {
ClusterHealthResponse actionGet = client().admin().cluster()
.health(Requests.clusterHealthRequest().waitForGreenStatus().waitForEvents(Priority.LANGUID).waitForRelocatingShards(0)).actionGet();
@@ -360,10 +437,17 @@ public abstract class ElasticsearchIntegrationTest extends ElasticsearchTestCase
return actionGet.getStatus();
}
+ /**
+ * Waits for all relocating shards to become active using the cluster health API.
+ */
public ClusterHealthStatus waitForRelocation() {
return waitForRelocation(null);
}
+ /**
+ * Waits for all relocating shards to become active and the cluster has reached the given health status
+ * using the cluster health API.
+ */
public ClusterHealthStatus waitForRelocation(ClusterHealthStatus status) {
ClusterHealthRequest request = Requests.clusterHealthRequest().waitForRelocatingShards(0);
if (status != null) {
@@ -381,6 +465,9 @@ public abstract class ElasticsearchIntegrationTest extends ElasticsearchTestCase
return actionGet.getStatus();
}
+ /**
+ * Ensures the cluster has a yellow state via the cluster health API.
+ */
public ClusterHealthStatus ensureYellow() {
ClusterHealthResponse actionGet = client().admin().cluster()
.health(Requests.clusterHealthRequest().waitForRelocatingShards(0).waitForYellowStatus().waitForEvents(Priority.LANGUID)).actionGet();
@@ -391,33 +478,61 @@ public abstract class ElasticsearchIntegrationTest extends ElasticsearchTestCase
return actionGet.getStatus();
}
- public static String commaString(Iterable+ * client().prepareIndex(index, type).setSource(source).execute().actionGet(); + *+ */ + protected final IndexResponse index(String index, String type, XContentBuilder source) { return client().prepareIndex(index, type).setSource(source).execute().actionGet(); } - protected IndexResponse index(String index, String type, String id, Map
+ * client().prepareIndex(index, type).setSource(source).execute().actionGet(); + *+ */ + protected final IndexResponse index(String index, String type, String id, Map
+ * client().prepareGet(index, type, id).execute().actionGet(); + *+ */ + protected final GetResponse get(String index, String type, String id) { return client().prepareGet(index, type, id).execute().actionGet(); } - protected IndexResponse index(String index, String type, String id, XContentBuilder source) { + /** + * Syntactic sugar for: + *
+ * return client().prepareIndex(index, type, id).setSource(source).execute().actionGet(); + *+ */ + protected final IndexResponse index(String index, String type, String id, XContentBuilder source) { return client().prepareIndex(index, type, id).setSource(source).execute().actionGet(); } - protected IndexResponse index(String index, String type, String id, Object... source) { + /** + * Syntactic sugar for: + *
+ * return client().prepareIndex(index, type, id).setSource(source).execute().actionGet(); + *+ */ + protected final IndexResponse index(String index, String type, String id, Object... source) { return client().prepareIndex(index, type, id).setSource(source).execute().actionGet(); } - protected RefreshResponse refresh() { + /** + * Waits for relocations and refreshes all indices in the cluster. + * @see #waitForRelocation() + */ + protected final RefreshResponse refresh() { waitForRelocation(); // TODO RANDOMIZE with flush? RefreshResponse actionGet = client().admin().indices().prepareRefresh().execute().actionGet(); @@ -425,16 +540,22 @@ public abstract class ElasticsearchIntegrationTest extends ElasticsearchTestCase return actionGet; } - protected void flushAndRefresh() { + /** + * Flushes and refreshes all indices in the cluster + */ + protected final void flushAndRefresh() { flush(true); refresh(); } - protected FlushResponse flush() { + /** + * Flushes all indices in the cluster + */ + protected final FlushResponse flush() { return flush(true); } - protected FlushResponse flush(boolean ignoreNotAllowed) { + private FlushResponse flush(boolean ignoreNotAllowed) { waitForRelocation(); FlushResponse actionGet = client().admin().indices().prepareFlush().execute().actionGet(); if (ignoreNotAllowed) { @@ -447,6 +568,9 @@ public abstract class ElasticsearchIntegrationTest extends ElasticsearchTestCase return actionGet; } + /** + * Waits for all relocations and optimized all indices in the cluster to 1 segment. + */ protected OptimizeResponse optimize() { waitForRelocation(); OptimizeResponse actionGet = client().admin().indices().prepareOptimize().execute().actionGet(); @@ -454,48 +578,29 @@ public abstract class ElasticsearchIntegrationTest extends ElasticsearchTestCase return actionGet; } - protected Set
true iff the given index exists otherwise false
+ */
protected boolean indexExists(String index) {
IndicesExistsResponse actionGet = client().admin().indices().prepareExists(index).execute().actionGet();
return actionGet.isExists();
}
+ /**
+ * Returns a random admin client. This client can either be a node or a transport client pointing to any of
+ * the nodes in the cluster.
+ */
protected AdminClient admin() {
return client().admin();
}
- protected 2 is used./
+ */
int numNodes() default -1;
+
+ /**
+ * Returns the transport client ratio. By default this returns -1 which means a random
+ * ratio in the interval [0..1] is used.
+ */
double transportClientRatio() default -1;
}
private static long clusterSeed() {
- String property = System.getProperty("tests.cluster_seed");
+ String property = System.getProperty(TESTS_CLUSTER_SEED);
if (property == null || property.isEmpty()) {
return System.nanoTime();
}
return SeedUtils.parseSeed(property);
}
-
+
+ /**
+ * Returns the client ratio configured via
+ */
private static double transportClientRatio() {
- String property = System.getProperty("tests.client.ratio");
+ String property = System.getProperty(TESTS_CLIENT_RATIO);
if (property == null || property.isEmpty()) {
return Double.NaN;
}
return Double.parseDouble(property);
}
+ /**
+ * Returns the transport client ratio from the class level annotation or via
+ * {@link System#getProperty(String)} if available. If both are not available this will
+ * return a random ratio in the interval [0..1]
+ */
private double getPerTestTransportClientRatio() {
final ClusterScope annotation = getAnnotation(this.getClass());
double perTestRatio = -1;
diff --git a/src/test/java/org/elasticsearch/test/ElasticsearchLuceneTestCase.java b/src/test/java/org/elasticsearch/test/ElasticsearchLuceneTestCase.java
index 051cbb0aa8d..39d368c1cad 100644
--- a/src/test/java/org/elasticsearch/test/ElasticsearchLuceneTestCase.java
+++ b/src/test/java/org/elasticsearch/test/ElasticsearchLuceneTestCase.java
@@ -27,6 +27,10 @@ import org.apache.lucene.util.LuceneTestCase.SuppressCodecs;
import org.apache.lucene.util.TimeUnits;
import org.elasticsearch.test.junit.listeners.ReproduceInfoPrinter;
+
+/**
+ * Base testcase for lucene based testing. This class should be used if low level lucene features are tested.
+ */
@Listeners({
ReproduceInfoPrinter.class
})
diff --git a/src/test/java/org/elasticsearch/test/ElasticsearchTestCase.java b/src/test/java/org/elasticsearch/test/ElasticsearchTestCase.java
index 4a41b9dee28..b05d1cb53ad 100644
--- a/src/test/java/org/elasticsearch/test/ElasticsearchTestCase.java
+++ b/src/test/java/org/elasticsearch/test/ElasticsearchTestCase.java
@@ -44,6 +44,9 @@ import java.util.*;
import java.util.Map.Entry;
import java.util.concurrent.TimeUnit;
+/**
+ * Base testcase for randomized unit testing with Elasticsearch
+ */
@ThreadLeakFilters(defaultFilters = true, filters = {ElasticsearchThreadFilter.class})
@ThreadLeakScope(Scope.NONE)
@TimeoutSuite(millis = TimeUnits.HOUR) // timeout the suite after 1h and fail the test.
diff --git a/src/test/java/org/elasticsearch/test/ElasticsearchThreadFilter.java b/src/test/java/org/elasticsearch/test/ElasticsearchThreadFilter.java
index b3f939c1df2..857bb69fb65 100644
--- a/src/test/java/org/elasticsearch/test/ElasticsearchThreadFilter.java
+++ b/src/test/java/org/elasticsearch/test/ElasticsearchThreadFilter.java
@@ -21,7 +21,10 @@ package org.elasticsearch.test;
import com.carrotsearch.randomizedtesting.ThreadFilter;
-public class ElasticsearchThreadFilter implements ThreadFilter {
+/**
+ * Simple thread filter for randomized runner
+ */
+public final class ElasticsearchThreadFilter implements ThreadFilter {
@Override
public boolean reject(Thread t) {
return true;
diff --git a/src/test/java/org/elasticsearch/test/ElasticsearchTokenStreamTestCase.java b/src/test/java/org/elasticsearch/test/ElasticsearchTokenStreamTestCase.java
index 0085073729e..01de5f254bd 100644
--- a/src/test/java/org/elasticsearch/test/ElasticsearchTokenStreamTestCase.java
+++ b/src/test/java/org/elasticsearch/test/ElasticsearchTokenStreamTestCase.java
@@ -31,6 +31,11 @@ import org.elasticsearch.test.junit.listeners.ReproduceInfoPrinter;
@ThreadLeakFilters(defaultFilters = true, filters = {ElasticsearchThreadFilter.class})
@ThreadLeakScope(Scope.NONE)
@TimeoutSuite(millis = TimeUnits.HOUR)
+
+/**
+ * Basic test case for token streams. the assertion methods in this class will
+ * run basic checks to enforce correct behavior of the token streams.
+ */
public abstract class ElasticsearchTokenStreamTestCase extends BaseTokenStreamTestCase {
}
diff --git a/src/test/java/org/elasticsearch/test/NodeSettingsSource.java b/src/test/java/org/elasticsearch/test/NodeSettingsSource.java
index b16c55dc873..084086cafde 100644
--- a/src/test/java/org/elasticsearch/test/NodeSettingsSource.java
+++ b/src/test/java/org/elasticsearch/test/NodeSettingsSource.java
@@ -24,7 +24,7 @@ import org.elasticsearch.common.settings.Settings;
import java.util.Map;
-public abstract class NodeSettingsSource {
+abstract class NodeSettingsSource {
public static final NodeSettingsSource EMPTY = new NodeSettingsSource() {
@Override
diff --git a/src/test/java/org/elasticsearch/test/TestCluster.java b/src/test/java/org/elasticsearch/test/TestCluster.java
index 7d47c59259a..cbd12837b9d 100644
--- a/src/test/java/org/elasticsearch/test/TestCluster.java
+++ b/src/test/java/org/elasticsearch/test/TestCluster.java
@@ -19,11 +19,9 @@
package org.elasticsearch.test;
import com.carrotsearch.randomizedtesting.SeedUtils;
-import com.google.common.base.Function;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.Collections2;
-import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterators;
import com.google.common.collect.Sets;
import org.apache.lucene.util.IOUtils;
@@ -31,8 +29,6 @@ import org.elasticsearch.client.Client;
import org.elasticsearch.client.transport.TransportClient;
import org.elasticsearch.cluster.ClusterService;
import org.elasticsearch.cluster.ClusterState;
-import org.elasticsearch.cluster.block.ClusterBlock;
-import org.elasticsearch.cluster.block.ClusterBlockLevel;
import org.elasticsearch.cluster.node.DiscoveryNode;
import org.elasticsearch.cluster.node.DiscoveryNodes;
import org.elasticsearch.cluster.routing.ShardRouting;
@@ -44,9 +40,7 @@ import org.elasticsearch.common.settings.ImmutableSettings;
import org.elasticsearch.common.settings.ImmutableSettings.Builder;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.transport.TransportAddress;
-import org.elasticsearch.common.unit.TimeValue;
import org.elasticsearch.env.NodeEnvironment;
-import org.elasticsearch.gateway.Gateway;
import org.elasticsearch.index.engine.IndexEngineModule;
import org.elasticsearch.node.Node;
import org.elasticsearch.node.internal.InternalNode;
@@ -67,9 +61,20 @@ import static com.google.common.collect.Maps.newTreeMap;
import static org.elasticsearch.common.settings.ImmutableSettings.settingsBuilder;
import static org.elasticsearch.node.NodeBuilder.nodeBuilder;
-public class TestCluster implements Closeable, Iterable+ * The Cluster is bound to a test lifecycle where tests must call {@link #beforeTest(java.util.Random, double)} and + * {@link #afterTest()} to initialize and reset the cluster in order to be more reproducible. The term "more" relates + * to the async nature of Elasticsearch in combination with randomized testing. Once Threads and asynchronous calls + * are involved reproducibility is very limited. This class should only be used through {@link ElasticsearchIntegrationTest}. + *
+ */ +public final class TestCluster implements Iterablen nodes are present in the cluster.
+ * if more nodes than n are present this method will not
+ * stop any of the running nodes.
+ */
+ public synchronized void ensureAtLeastNumNodes(int n) {
int size = nodes.size();
- for (int i = size; i < num; i++) {
- logger.info("increasing cluster size from {} to {}", size, num);
+ for (int i = size; i < n; i++) {
+ logger.info("increasing cluster size from {} to {}", size, n);
NodeAndClient buildNode = buildNode();
buildNode.node().start();
publishNode(buildNode);
}
}
- public synchronized void ensureAtMostNumNodes(int num) {
- if (nodes.size() <= num) {
+ /**
+ * Ensures that at most n are up and running.
+ * If less nodes that n are running this method
+ * will not start any additional nodes.
+ */
+ public synchronized void ensureAtMostNumNodes(int n) {
+ if (nodes.size() <= n) {
return;
}
// prevent killing the master if possible
- final Iteratornull
+ */
public synchronized Client client(final Predicatetrue all data for the node with the given node name will be cleared including
+ * gateways and all index data. Returns false by default.
+ */
public boolean clearData(String nodeName) {
return false;
}
-
+
+
+ /**
+ * If this returns false the node with the given node name will not be restarted. It will be
+ * closed and removed from the cluster. Returns true by default.
+ */
public boolean doRestart(String nodeName) {
return true;
}
-
}
}
diff --git a/src/test/java/org/elasticsearch/update/UpdateTests.java b/src/test/java/org/elasticsearch/update/UpdateTests.java
index ee030fa1e26..0b335e5603f 100644
--- a/src/test/java/org/elasticsearch/update/UpdateTests.java
+++ b/src/test/java/org/elasticsearch/update/UpdateTests.java
@@ -225,39 +225,39 @@ public class UpdateTests extends ElasticsearchIntegrationTest {
assertThrows(client().prepareUpdate("test", "type", "1").setScript("ctx._source.text = 'v2'").setVersion(2).execute(),
VersionConflictEngineException.class);
- run(client().prepareUpdate("test", "type", "1").setScript("ctx._source.text = 'v2'").setVersion(1));
- assertThat(run(client().prepareGet("test", "type", "1")).getVersion(), equalTo(2l));
+ client().prepareUpdate("test", "type", "1").setScript("ctx._source.text = 'v2'").setVersion(1).get();
+ assertThat(client().prepareGet("test", "type", "1").get().getVersion(), equalTo(2l));
// and again with a higher version..
- run(client().prepareUpdate("test", "type", "1").setScript("ctx._source.text = 'v3'").setVersion(2));
+ client().prepareUpdate("test", "type", "1").setScript("ctx._source.text = 'v3'").setVersion(2).get();
- assertThat(run(client().prepareGet("test", "type", "1")).getVersion(), equalTo(3l));
+ assertThat(client().prepareGet("test", "type", "1").get().getVersion(), equalTo(3l));
// after delete
- run(client().prepareDelete("test", "type", "1"));
+ client().prepareDelete("test", "type", "1").get();
assertThrows(client().prepareUpdate("test", "type", "1").setScript("ctx._source.text = 'v2'").setVersion(3).execute(),
DocumentMissingException.class);
// external versioning
- run(client().prepareIndex("test", "type", "2").setSource("text", "value").setVersion(10).setVersionType(VersionType.EXTERNAL));
+ client().prepareIndex("test", "type", "2").setSource("text", "value").setVersion(10).setVersionType(VersionType.EXTERNAL).get();
assertThrows(client().prepareUpdate("test", "type", "2").setScript("ctx._source.text = 'v2'").setVersion(2).setVersionType(VersionType.EXTERNAL).execute(),
VersionConflictEngineException.class);
- run(client().prepareUpdate("test", "type", "2").setScript("ctx._source.text = 'v2'").setVersion(11).setVersionType(VersionType.EXTERNAL));
+ client().prepareUpdate("test", "type", "2").setScript("ctx._source.text = 'v2'").setVersion(11).setVersionType(VersionType.EXTERNAL).get();
- assertThat(run(client().prepareGet("test", "type", "2")).getVersion(), equalTo(11l));
+ assertThat(client().prepareGet("test", "type", "2").get().getVersion(), equalTo(11l));
// upserts - the combination with versions is a bit weird. Test are here to ensure we do not change our behavior unintentionally
// With internal versions, tt means "if object is there with version X, update it or explode. If it is not there, index.
- run(client().prepareUpdate("test", "type", "3").setScript("ctx._source.text = 'v2'").setVersion(10).setUpsert("{ \"text\": \"v0\" }"));
+ client().prepareUpdate("test", "type", "3").setScript("ctx._source.text = 'v2'").setVersion(10).setUpsert("{ \"text\": \"v0\" }").get();
GetResponse get = get("test", "type", "3");
assertThat(get.getVersion(), equalTo(1l));
assertThat((String) get.getSource().get("text"), equalTo("v0"));
// With external versions, it means - if object is there with version lower than X, update it or explode. If it is not there, insert with new version.
- run(client().prepareUpdate("test", "type", "4").setScript("ctx._source.text = 'v2'").
- setVersion(10).setVersionType(VersionType.EXTERNAL).setUpsert("{ \"text\": \"v0\" }"));
+ client().prepareUpdate("test", "type", "4").setScript("ctx._source.text = 'v2'").
+ setVersion(10).setVersionType(VersionType.EXTERNAL).setUpsert("{ \"text\": \"v0\" }").get();
get = get("test", "type", "4");
assertThat(get.getVersion(), equalTo(10l));
assertThat((String) get.getSource().get("text"), equalTo("v0"));
diff --git a/src/test/java/org/elasticsearch/versioning/ConcurrentDocumentOperationTests.java b/src/test/java/org/elasticsearch/versioning/ConcurrentDocumentOperationTests.java
index b66ad9e0308..59db6ea8edb 100644
--- a/src/test/java/org/elasticsearch/versioning/ConcurrentDocumentOperationTests.java
+++ b/src/test/java/org/elasticsearch/versioning/ConcurrentDocumentOperationTests.java
@@ -23,7 +23,7 @@ public class ConcurrentDocumentOperationTests extends ElasticsearchIntegrationTe
logger.info("--> create an index with 1 shard and max replicas based on nodes");
client().admin().indices().prepareCreate("test")
- .setSettings(settingsBuilder().put("index.number_of_shards", 1).put("index.number_of_replicas", cluster().numNodes()-1))
+ .setSettings(settingsBuilder().put("index.number_of_shards", 1).put("index.number_of_replicas", cluster().size()-1))
.execute().actionGet();
logger.info("execute concurrent updates on the same doc");
@@ -54,7 +54,7 @@ public class ConcurrentDocumentOperationTests extends ElasticsearchIntegrationTe
logger.info("done indexing, check all have the same field value");
Map masterSource = client().prepareGet("test", "type1", "1").execute().actionGet().getSourceAsMap();
- for (int i = 0; i < (cluster().numNodes() * 5); i++) {
+ for (int i = 0; i < (cluster().size() * 5); i++) {
assertThat(client().prepareGet("test", "type1", "1").execute().actionGet().getSourceAsMap(), equalTo(masterSource));
}
}