org.elasticsearch.index.shard

Class IndexShardTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.util.LuceneTestCase

org.elasticsearch.test.ESTestCase

org.elasticsearch.index.shard.IndexShardTestCase

public abstract class IndexShardTestCase
extends ESTestCase

A base class for unit tests that need to create and shutdown IndexShard instances easily, containing utilities for shard creation and recoveries. See {newShard(boolean)} and newStartedShard() for a good starting points

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.test.ESTestCase

ESTestCase.GeohashGenerator, ESTestCase.TestAnalysis

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

Modifier and Type	Field and Description
protected static PeerRecoveryTargetService.RecoveryListener	recoveryListener
protected ThreadPool	threadPool

Fields inherited from class org.elasticsearch.test.ESTestCase

checkIndexFailed, deprecationLogger, 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
IndexShardTestCase()

Method Summary

Modifier and Type	Method and Description
protected void	assertDocCount(IndexShard shard, int docDount)
protected void	assertDocs(IndexShard shard, Uid... uids)
protected void	closeShards(IndexShard... shards)
protected void	closeShards(java.lang.Iterable<IndexShard> shards)
protected Engine.Delete	deleteDoc(IndexShard shard, java.lang.String type, java.lang.String id)
protected void	flushShard(IndexShard shard)
protected void	flushShard(IndexShard shard, boolean force)
protected java.util.Set<Uid>	getShardDocUIDs(IndexShard shard)
protected Engine.Index	indexDoc(IndexShard shard, java.lang.String type, java.lang.String id)
protected Engine.Index	indexDoc(IndexShard shard, java.lang.String type, java.lang.String id, java.lang.String source)
protected Engine.Index	indexDoc(IndexShard shard, java.lang.String type, java.lang.String id, java.lang.String source, XContentType xContentType)
protected IndexShard	newShard(boolean primary) creates a new initializing shard.
protected IndexShard	newShard(ShardId shardId, boolean primary, IndexingOperationListener... listeners) creates a new initializing shard.
protected IndexShard	newShard(ShardId shardId, boolean primary, java.lang.String nodeId, IndexMetaData indexMetaData, IndexSearcherWrapper searcherWrapper) creates a new initializing shard.
protected IndexShard	newShard(ShardRouting shardRouting, IndexingOperationListener... listeners) creates a new initializing shard.
protected IndexShard	newShard(ShardRouting routing, IndexMetaData indexMetaData, IndexingOperationListener... listeners) creates a new initializing shard.
protected IndexShard	newShard(ShardRouting routing, IndexMetaData indexMetaData, IndexSearcherWrapper indexSearcherWrapper, IndexingOperationListener... listeners) creates a new initializing shard.
protected IndexShard	newShard(ShardRouting routing, ShardPath shardPath, IndexMetaData indexMetaData, IndexSearcherWrapper indexSearcherWrapper, IndexingOperationListener... listeners) creates a new initializing shard.
protected IndexShard	newStartedShard() creates a new empyu shard and starts it.
protected IndexShard	newStartedShard(boolean primary) creates a new empty shard and starts it.
protected void	recoverReplica(IndexShard replica, IndexShard primary) recovers a replica from the given primary
protected void	recoverReplica(IndexShard replica, IndexShard primary, java.util.function.BiFunction<IndexShard,DiscoveryNode,RecoveryTarget> targetSupplier, boolean markAsRecovering) Recovers a replica from the give primary, allow the user to supply a custom recovery target.
protected void	recoveryEmptyReplica(IndexShard replica)
protected void	recoveryShardFromStore(IndexShard primary)
protected IndexShard	reinitShard(IndexShard current, IndexingOperationListener... listeners) Takes an existing shard, closes it and and starts a new initialing shard at the same location
protected IndexShard	reinitShard(IndexShard current, ShardRouting routing, IndexingOperationListener... listeners) Takes an existing shard, closes it and and starts a new initialing shard at the same location
void	setUp()
void	tearDown()

Methods inherited from class org.elasticsearch.test.ESTestCase

after, afterIfFailed, afterIfSuccessful, assertAllIndicesRemovedAndDeletionCompleted, assertArrayEquals, assertBusy, assertBusy, assertEquals, assertPathHasBeenCleared, assertSettingDeprecationsAndWarnings, assertWarnings, awaitBusy, awaitBusy, before, between, checkStaticState, copyWriteable, createParser, createParser, createParser, createParser, createParser, createTestAnalysis, createTestAnalysis, createTestAnalysis, enableWarningsCheck, ensureAllSearchContextsReleased, ensureCheckIndexPassed, frequently, generateRandomStringArray, generateRandomStringArray, getBwcIndicesPath, getDataPath, getSuiteFailureMarker, iterations, maybeSet, mockScript, newNodeEnvironment, newNodeEnvironment, newTestIndicesModule, newTestScriptModule, randomAlphaOfLength, randomAlphaOfLengthBetween, randomBoolean, randomByte, randomDateTimeZone, randomDouble, randomDoubleBetween, randomFloat, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomGeohash, randomInt, randomInt, randomIntBetween, randomLong, randomNonNegativeLong, randomPositiveTimeValue, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomShort, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomTimeValue, randomTimeValue, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomValueOtherThan, randomValueOtherThanMany, resetCheckIndexStatus, restoreContentType, restoreFileSystem, scaledRandomIntBetween, setContentType, setFileSystem, settings, shuffleMap, shuffleXContent, shuffleXContent, spinForAtLeastNMilliseconds, spinForAtLeastOneMillisecond, terminate, terminate, tmpPaths, toShuffledXContent, xContentRegistry

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, assumeWorkingMMapOnWindows, atLeast, atLeast, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, expectThrows, expectThrows, getBaseTempDirForTestClass, getDataInputStream, getOnlyLeafReader, getTestClass, getTestName, hasWorkingMMapOnWindows, 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, assertArrayEquals, assertArrayEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotEquals, assertNotEquals, 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

Field Detail

recoveryListener

protected static final PeerRecoveryTargetService.RecoveryListener recoveryListener

threadPool

protected ThreadPool threadPool

Constructor Detail

IndexShardTestCase

public IndexShardTestCase()

Method Detail

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

newShard

protected IndexShard newShard(boolean primary)
                       throws java.io.IOException

creates a new initializing shard. The shard will have its own unique data path.

Parameters:

primary - indicates whether to a primary shard (ready to recover from an empty store) or a replica (ready to recover from another shard)

Throws:

java.io.IOException

newShard

protected IndexShard newShard(ShardRouting shardRouting,
                              IndexingOperationListener... listeners)
                       throws java.io.IOException

creates a new initializing shard. The shard will have its own unique data path.

Parameters:

shardRouting - the ShardRouting to use for this shard

listeners - an optional set of listeners to add to the shard

Throws:

java.io.IOException

newShard

protected IndexShard newShard(ShardId shardId,
                              boolean primary,
                              IndexingOperationListener... listeners)
                       throws java.io.IOException

creates a new initializing shard. The shard will have its own unique data path.

Parameters:

shardId - the shard id to use

primary - indicates whether to a primary shard (ready to recover from an empty store) or a replica (ready to recover from another shard)

listeners - an optional set of listeners to add to the shard

Throws:

java.io.IOException

newShard

protected IndexShard newShard(ShardId shardId,
                              boolean primary,
                              java.lang.String nodeId,
                              IndexMetaData indexMetaData,
                              @Nullable
                              IndexSearcherWrapper searcherWrapper)
                       throws java.io.IOException

creates a new initializing shard. The shard will will be put in its proper path under the supplied node id.

Parameters:

shardId - the shard id to use

primary - indicates whether to a primary shard (ready to recover from an empty store) or a replica (ready to recover from another shard)

Throws:

java.io.IOException

newShard

protected IndexShard newShard(ShardRouting routing,
                              IndexMetaData indexMetaData,
                              IndexingOperationListener... listeners)
                       throws java.io.IOException

creates a new initializing shard. The shard will will be put in its proper path under the current node id the shard is assigned to.

Parameters:

routing - shard routing to use

indexMetaData - indexMetaData for the shard, including any mapping

listeners - an optional set of listeners to add to the shard

Throws:

java.io.IOException

newShard

protected IndexShard newShard(ShardRouting routing,
                              IndexMetaData indexMetaData,
                              @Nullable
                              IndexSearcherWrapper indexSearcherWrapper,
                              IndexingOperationListener... listeners)
                       throws java.io.IOException

creates a new initializing shard. The shard will will be put in its proper path under the current node id the shard is assigned to.

Parameters:

routing - shard routing to use

indexMetaData - indexMetaData for the shard, including any mapping

indexSearcherWrapper - an optional wrapper to be used during searchers

listeners - an optional set of listeners to add to the shard

Throws:

java.io.IOException

newShard

protected IndexShard newShard(ShardRouting routing,
                              ShardPath shardPath,
                              IndexMetaData indexMetaData,
                              @Nullable
                              IndexSearcherWrapper indexSearcherWrapper,
                              IndexingOperationListener... listeners)
                       throws java.io.IOException

creates a new initializing shard.

Parameters:

routing - shard routing to use

shardPath - path to use for shard data

indexMetaData - indexMetaData for the shard, including any mapping

indexSearcherWrapper - an optional wrapper to be used during searchers

listeners - an optional set of listeners to add to the shard

Throws:

java.io.IOException

reinitShard

protected IndexShard reinitShard(IndexShard current,
                                 IndexingOperationListener... listeners)
                          throws java.io.IOException

Takes an existing shard, closes it and and starts a new initialing shard at the same location

Parameters:

listeners - new listerns to use for the newly created shard

Throws:

java.io.IOException

reinitShard

protected IndexShard reinitShard(IndexShard current,
                                 ShardRouting routing,
                                 IndexingOperationListener... listeners)
                          throws java.io.IOException

Takes an existing shard, closes it and and starts a new initialing shard at the same location

Parameters:

routing - the shard routing to use for the newly created shard.

listeners - new listerns to use for the newly created shard

Throws:

java.io.IOException

newStartedShard

protected IndexShard newStartedShard()
                              throws java.io.IOException

creates a new empyu shard and starts it. The shard will be either a replica or a primary.

Throws:

java.io.IOException

newStartedShard

protected IndexShard newStartedShard(boolean primary)
                              throws java.io.IOException

creates a new empty shard and starts it.

Parameters:

primary - controls whether the shard will be a primary or a replica.

Throws:

java.io.IOException

closeShards

protected void closeShards(IndexShard... shards)
                    throws java.io.IOException

Throws:

java.io.IOException

closeShards

protected void closeShards(java.lang.Iterable<IndexShard> shards)
                    throws java.io.IOException

Throws:

java.io.IOException

recoveryShardFromStore

protected void recoveryShardFromStore(IndexShard primary)
                               throws java.io.IOException

Throws:

java.io.IOException

recoveryEmptyReplica

protected void recoveryEmptyReplica(IndexShard replica)
                             throws java.io.IOException

Throws:

java.io.IOException

recoverReplica

protected void recoverReplica(IndexShard replica,
                              IndexShard primary)
                       throws java.io.IOException

recovers a replica from the given primary

Throws:

java.io.IOException

recoverReplica

protected void recoverReplica(IndexShard replica,
                              IndexShard primary,
                              java.util.function.BiFunction<IndexShard,DiscoveryNode,RecoveryTarget> targetSupplier,
                              boolean markAsRecovering)
                       throws java.io.IOException

Recovers a replica from the give primary, allow the user to supply a custom recovery target. A typical usage of a custome recovery target is to assert things in the various stages of recovery

Parameters:

markAsRecovering - set to false if you have already marked the replica as recovering

Throws:

java.io.IOException

getShardDocUIDs

protected java.util.Set<Uid> getShardDocUIDs(IndexShard shard)
                                      throws java.io.IOException

Throws:

java.io.IOException

assertDocCount

protected void assertDocCount(IndexShard shard,
                              int docDount)
                       throws java.io.IOException

Throws:

java.io.IOException

assertDocs

protected void assertDocs(IndexShard shard,
                          Uid... uids)
                   throws java.io.IOException

Throws:

java.io.IOException

indexDoc

protected Engine.Index indexDoc(IndexShard shard,
                                java.lang.String type,
                                java.lang.String id)
                         throws java.io.IOException

Throws:

java.io.IOException

indexDoc

protected Engine.Index indexDoc(IndexShard shard,
                                java.lang.String type,
                                java.lang.String id,
                                java.lang.String source)
                         throws java.io.IOException

Throws:

java.io.IOException

indexDoc

protected Engine.Index indexDoc(IndexShard shard,
                                java.lang.String type,
                                java.lang.String id,
                                java.lang.String source,
                                XContentType xContentType)
                         throws java.io.IOException

Throws:

java.io.IOException

deleteDoc

protected Engine.Delete deleteDoc(IndexShard shard,
                                  java.lang.String type,
                                  java.lang.String id)
                           throws java.io.IOException

Throws:

java.io.IOException

flushShard

protected void flushShard(IndexShard shard)

flushShard

protected void flushShard(IndexShard shard,
                          boolean force)