org.elasticsearch.test

Class ESSingleNodeTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.util.LuceneTestCase

org.elasticsearch.test.ESTestCase

org.elasticsearch.test.ESSingleNodeTestCase

public abstract class ESSingleNodeTestCase
extends ESTestCase

A test that keep a singleton node started for all tests that can be used to get references to Guice injectors in unit tests.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.LuceneTestCase

org.apache.lucene.util.LuceneTestCase.AwaitsFix, org.apache.lucene.util.LuceneTestCase.BadApple, org.apache.lucene.util.LuceneTestCase.Monster, org.apache.lucene.util.LuceneTestCase.Nightly, org.apache.lucene.util.LuceneTestCase.Slow, org.apache.lucene.util.LuceneTestCase.SuppressCodecs, org.apache.lucene.util.LuceneTestCase.SuppressFileSystems, org.apache.lucene.util.LuceneTestCase.SuppressFsync, org.apache.lucene.util.LuceneTestCase.SuppressReproduceLine, org.apache.lucene.util.LuceneTestCase.SuppressSysoutChecks, org.apache.lucene.util.LuceneTestCase.SuppressTempFileChecks, org.apache.lucene.util.LuceneTestCase.ThrowingRunnable, org.apache.lucene.util.LuceneTestCase.Weekly

Field Summary

Fields inherited from class org.elasticsearch.test.ESTestCase

checkIndexFailed, failureAndSuccessEvents, logger

Fields inherited from class org.apache.lucene.util.LuceneTestCase

assertsAreEnabled, classRules, DEFAULT_LINE_DOCS_FILE, INFOSTREAM, JENKINS_LARGE_LINE_DOCS_FILE, LEAVE_TEMPORARY, MAYBE_CACHE_POLICY, RANDOM_MULTIPLIER, ruleChain, suiteFailureMarker, SYSPROP_AWAITSFIX, SYSPROP_BADAPPLES, SYSPROP_FAILFAST, SYSPROP_MAXFAILURES, SYSPROP_MONSTER, SYSPROP_NIGHTLY, SYSPROP_SLOW, SYSPROP_WEEKLY, TEST_ASSERTS_ENABLED, TEST_AWAITSFIX, TEST_CODEC, TEST_DIRECTORY, TEST_DOCVALUESFORMAT, TEST_LINE_DOCS_FILE, TEST_NIGHTLY, TEST_POSTINGSFORMAT, TEST_SLOW, TEST_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Constructor and Description
ESSingleNodeTestCase()

Method Summary

Modifier and Type	Method and Description
org.elasticsearch.client.Client	client() Returns a client to the single-node cluster.
protected org.elasticsearch.index.IndexService	createIndex(java.lang.String index) Create a new index on the singleton node with empty index settings.
protected org.elasticsearch.index.IndexService	createIndex(java.lang.String index, org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder createIndexRequestBuilder)
protected org.elasticsearch.index.IndexService	createIndex(java.lang.String index, org.elasticsearch.common.settings.Settings settings) Create a new index on the singleton node with the provided index settings.
protected org.elasticsearch.index.IndexService	createIndex(java.lang.String index, org.elasticsearch.common.settings.Settings settings, java.lang.String type, java.lang.Object... mappings) Create a new index on the singleton node with the provided index settings.
protected org.elasticsearch.index.IndexService	createIndex(java.lang.String index, org.elasticsearch.common.settings.Settings settings, java.lang.String type, org.elasticsearch.common.xcontent.XContentBuilder mappings) Create a new index on the singleton node with the provided index settings.
protected org.elasticsearch.search.internal.SearchContext	createSearchContext(org.elasticsearch.index.IndexService indexService) Create a new search context.
org.elasticsearch.cluster.health.ClusterHealthStatus	ensureGreen(java.lang.String... indices) Ensures the cluster has a green state via the cluster health API.
org.elasticsearch.cluster.health.ClusterHealthStatus	ensureGreen(org.elasticsearch.common.unit.TimeValue timeout, java.lang.String... indices) Ensures the cluster has a green state via the cluster health API.
protected <T> T	getInstanceFromNode(java.lang.Class<T> clazz) Get an instance for a particular class using the injector of the singleton node.
protected java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>>	getPlugins() The plugin classes that should be added to the node.
protected org.elasticsearch.node.Node	node() Return a reference to the singleton node.
java.lang.String	nodeName() Returns the single test nodes name.
protected org.elasticsearch.common.settings.Settings	nodeSettings() Additional settings to add when creating the node.
protected java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>>	pluginList(java.lang.Class<? extends org.elasticsearch.plugins.Plugin>... plugins) Helper method to create list of plugins without specifying generic types.
protected boolean	resetNodeAfterTest() This method returns true if the node that is used in the background should be reset after each test.
org.elasticsearch.index.Index	resolveIndex(java.lang.String index)
void	setUp()
static void	setUpClass()
protected void	startNode()
protected static void	stopNode()
void	tearDown()
static void	tearDownClass()

Methods inherited from class org.elasticsearch.test.ESTestCase

afterIfFailed, afterIfSuccessful, assertAllIndicesRemovedAndDeletionCompleted, assertArrayEquals, assertBusy, assertBusy, assertEquals, assertionsEnabled, assertPathHasBeenCleared, awaitBusy, awaitBusy, between, createAnalysisService, createAnalysisService, createAnalysisService, ensureAllSearchContextsReleased, ensureCheckIndexPassed, ensureCleanedUp, frequently, generateRandomStringArray, generateRandomStringArray, getBwcIndicesPath, getDataPath, getSuiteFailureMarker, iterations, maybeSet, newNodeEnvironment, newNodeEnvironment, newTestScriptModule, randomAsciiOfLength, randomAsciiOfLengthBetween, randomBoolean, randomByte, randomDateTimeZone, randomDouble, randomDoubleBetween, randomFloat, randomFrom, randomFrom, randomFrom, randomInt, randomInt, randomIntBetween, randomLong, randomPositiveTimeValue, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomShort, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomValueOtherThan, randomValueOtherThanMany, resetCheckIndexStatus, restoreContentType, restoreFileSystem, scaledRandomIntBetween, setContentType, setFileSystem, settings, shuffleXContent, spinForAtLeastOneMillisecond, terminate, terminate, tmpPaths

Methods inherited from class org.apache.lucene.util.LuceneTestCase

addVirusChecker, assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertFieldInfosEquals, assertFieldsEquals, assertFieldStatisticsEquals, assertNormsEquals, assertPointsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, asSet, assumeFalse, assumeNoException, assumeTrue, atLeast, atLeast, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, expectThrows, getBaseTempDirForTestClass, getDataInputStream, getOnlyLeafReader, getTestClass, getTestName, isTestThread, localeForLanguageTag, maybeChangeLiveIndexWriterConfig, maybeWrapReader, newAlcoholicMergePolicy, newAlcoholicMergePolicy, newDirectory, newDirectory, newDirectory, newDirectory, newDirectory, newField, newField, newFSDirectory, newFSDirectory, newIndexWriterConfig, newIndexWriterConfig, newIndexWriterConfig, newIOContext, newIOContext, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newMaybeVirusCheckingDirectory, newMaybeVirusCheckingFSDirectory, newMergePolicy, newMergePolicy, newMockDirectory, newMockDirectory, newMockDirectory, newMockFSDirectory, newMockFSDirectory, newSearcher, newSearcher, newSearcher, newStringField, newStringField, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, overrideDefaultQueryCache, overrideTestDefaultQueryCache, random, randomLocale, randomTimeZone, rarely, rarely, replaceMaxFailureRule, resetDefaultQueryCache, restoreCPUCoreCount, restoreIndexWriterMaxDocs, restoreSpins, runWithRestrictedPermissions, setIndexWriterMaxDocs, setupCPUCoreCount, setupSpins, slowFileExists, usually, usually, wrapReader

Methods inherited from class org.junit.Assert

assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

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

Constructor Detail

ESSingleNodeTestCase

public ESSingleNodeTestCase()

Method Detail

startNode

protected void startNode()

stopNode

protected static void stopNode()
                        throws java.io.IOException

Throws:

java.io.IOException

setUp

public void setUp()
           throws java.lang.Exception

Overrides:

setUp in class org.apache.lucene.util.LuceneTestCase

Throws:

java.lang.Exception

tearDown

public void tearDown()
              throws java.lang.Exception

Overrides:

tearDown in class org.apache.lucene.util.LuceneTestCase

Throws:

java.lang.Exception

setUpClass

public static void setUpClass()
                       throws java.lang.Exception

Throws:

java.lang.Exception

tearDownClass

public static void tearDownClass()
                          throws java.io.IOException

Throws:

java.io.IOException

resetNodeAfterTest

protected boolean resetNodeAfterTest()

This method returns true if the node that is used in the background should be reset after each test. This is useful if the test changes the cluster state metadata etc. The default is false.

getPlugins

protected java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>> getPlugins()

The plugin classes that should be added to the node.

pluginList

@SafeVarargs
protected final java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>> pluginList(java.lang.Class<? extends org.elasticsearch.plugins.Plugin>... plugins)

Helper method to create list of plugins without specifying generic types.

nodeSettings

protected org.elasticsearch.common.settings.Settings nodeSettings()

Additional settings to add when creating the node. Also allows overriding the default settings.

client

public org.elasticsearch.client.Client client()

Returns a client to the single-node cluster.

nodeName

public java.lang.String nodeName()

Returns the single test nodes name.

node

protected org.elasticsearch.node.Node node()

Return a reference to the singleton node.

getInstanceFromNode

protected <T> T getInstanceFromNode(java.lang.Class<T> clazz)

Get an instance for a particular class using the injector of the singleton node.

createIndex

protected org.elasticsearch.index.IndexService createIndex(java.lang.String index)

Create a new index on the singleton node with empty index settings.

createIndex

protected org.elasticsearch.index.IndexService createIndex(java.lang.String index,
                                                           org.elasticsearch.common.settings.Settings settings)

Create a new index on the singleton node with the provided index settings.

createIndex

protected org.elasticsearch.index.IndexService createIndex(java.lang.String index,
                                                           org.elasticsearch.common.settings.Settings settings,
                                                           java.lang.String type,
                                                           org.elasticsearch.common.xcontent.XContentBuilder mappings)

Create a new index on the singleton node with the provided index settings.

createIndex

protected org.elasticsearch.index.IndexService createIndex(java.lang.String index,
                                                           org.elasticsearch.common.settings.Settings settings,
                                                           java.lang.String type,
                                                           java.lang.Object... mappings)

Create a new index on the singleton node with the provided index settings.

createIndex

protected org.elasticsearch.index.IndexService createIndex(java.lang.String index,
                                                           org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder createIndexRequestBuilder)

resolveIndex

public org.elasticsearch.index.Index resolveIndex(java.lang.String index)

createSearchContext

protected org.elasticsearch.search.internal.SearchContext createSearchContext(org.elasticsearch.index.IndexService indexService)

Create a new search context.

ensureGreen

public org.elasticsearch.cluster.health.ClusterHealthStatus ensureGreen(java.lang.String... indices)

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.

ensureGreen

public org.elasticsearch.cluster.health.ClusterHealthStatus ensureGreen(org.elasticsearch.common.unit.TimeValue timeout,
                                                                        java.lang.String... indices)

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.

Parameters:

timeout - time out value to set on ClusterHealthRequest