Class RemoteStoreBaseIntegTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.opensearch.test.OpenSearchTestCase

org.opensearch.test.OpenSearchIntegTestCase

org.opensearch.remotestore.RemoteStoreBaseIntegTestCase

Direct Known Subclasses:

RemoteStoreCoreTestCase

public class RemoteStoreBaseIntegTestCase
extends OpenSearchIntegTestCase

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.test.OpenSearchIntegTestCase

OpenSearchIntegTestCase.AssertActionNamePlugin, OpenSearchIntegTestCase.ClusterScope, OpenSearchIntegTestCase.NumShards, OpenSearchIntegTestCase.Scope, OpenSearchIntegTestCase.SuiteScopeTestCase, OpenSearchIntegTestCase.TestSeedPlugin, OpenSearchIntegTestCase.ThirdParty

Nested classes/interfaces inherited from class org.opensearch.test.OpenSearchTestCase

OpenSearchTestCase.AnnotatedFeatureFlagRule, OpenSearchTestCase.GeohashGenerator, OpenSearchTestCase.LockFeatureFlag, OpenSearchTestCase.TestAnalysis

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

org.apache.lucene.tests.util.LuceneTestCase.AwaitsFix, org.apache.lucene.tests.util.LuceneTestCase.Concurrency, org.apache.lucene.tests.util.LuceneTestCase.Monster, org.apache.lucene.tests.util.LuceneTestCase.Nightly, org.apache.lucene.tests.util.LuceneTestCase.SuppressCodecs, org.apache.lucene.tests.util.LuceneTestCase.SuppressFileSystems, org.apache.lucene.tests.util.LuceneTestCase.SuppressFsync, org.apache.lucene.tests.util.LuceneTestCase.SuppressReproduceLine, org.apache.lucene.tests.util.LuceneTestCase.SuppressSysoutChecks, org.apache.lucene.tests.util.LuceneTestCase.SuppressTempFileChecks, org.apache.lucene.tests.util.LuceneTestCase.ThrowingConsumer<T>, org.apache.lucene.tests.util.LuceneTestCase.ThrowingRunnable, org.apache.lucene.tests.util.LuceneTestCase.Weekly

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	asyncUploadMockFsRepo
protected boolean	clusterSettingsSuppliedByTest
protected static final String	MAX_SEQ_NO_REFRESHED_OR_FLUSHED
protected static final String	MAX_SEQ_NO_TOTAL
protected static final String	REFRESHED_OR_FLUSHED_OPERATIONS
protected static final String	REMOTE_ROUTING_TABLE_REPO
protected static int	REPLICA_COUNT
protected static final String	REPOSITORY_2_NAME
protected static final String	REPOSITORY_3_NAME
protected static final String	REPOSITORY_NAME
protected Path	segmentRepoPath
protected static final int	SHARD_COUNT
protected static final String	TOTAL_OPERATIONS
protected Path	translogRepoPath

Fields inherited from class org.opensearch.test.OpenSearchIntegTestCase

CODECS, DEFAULT_MAX_NUM_SHARDS, DEFAULT_MIN_NUM_SHARDS, INDEX_TEST_SEED_SETTING, prefixModeVerificationEnable, REMOTE_BACKED_STORAGE_REPOSITORY_NAME, segmentsPathFixedPrefix, snapshotShardPathFixedPrefix, SUITE_CLUSTER_NODE_PREFIX, SYSPROP_THIRDPARTY, TEST_CLUSTER_NODE_PREFIX, testClusterRule, TESTS_CLUSTER, TESTS_CLUSTER_NAME, TESTS_ENABLE_MOCK_MODULES, translogPathFixedPrefix

Fields inherited from class org.opensearch.test.OpenSearchTestCase

checkIndexFailures, DEFAULT_NAMED_WRITABLE_REGISTRY, DEFAULT_TEST_WORKER_ID, failureAndSuccessEvents, flagLockRule, JAVA_TIMEZONE_IDS, JAVA_ZONE_IDS, JODA_TIMEZONE_IDS, logger, TEST_WORKER_SYS_PROPERTY, TEST_WORKER_VM_ID

Fields inherited from class org.apache.lucene.tests.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_FAILFAST, SYSPROP_MAXFAILURES, SYSPROP_MONSTER, SYSPROP_NIGHTLY, SYSPROP_WEEKLY, TEST_ASSERTS_ENABLED, TEST_AWAITSFIX, TEST_CODEC, TEST_DIRECTORY, TEST_DOCVALUESFORMAT, TEST_LINE_DOCS_FILE, TEST_MONSTER, TEST_NIGHTLY, TEST_POSTINGSFORMAT, TEST_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Constructor	Description
RemoteStoreBaseIntegTestCase()

Method Summary

Modifier and Type	Method	Description
void	assertRemoteStoreRepositoryOnAllNodes(String repositoryName)
org.opensearch.cluster.metadata.RepositoryMetadata	buildRepositoryMetadata(org.opensearch.cluster.node.DiscoveryNode node, String name)
static int	getFileCount(Path path)
protected org.opensearch.index.shard.IndexShard	getIndexShard(String dataNode, String indexName)
protected org.opensearch.index.shard.IndexShard	getIndexShardFromShardId(String dataNode, String indexName, Integer shardId)
protected org.opensearch.action.bulk.BulkResponse	indexBulk(String indexName, int numDocs)
protected Map<String,Long>	indexData(int numberOfIterations, boolean invokeFlush, boolean emptyTranslog, String index)
protected Map<String,Long>	indexData(int numberOfIterations, boolean invokeFlush, String index)
org.opensearch.common.settings.Settings	indexSettings()	Returns a settings object used in OpenSearchIntegTestCase.createIndex(String...) and OpenSearchIntegTestCase.prepareCreate(String) and friends.
protected org.opensearch.action.index.IndexResponse	indexSingleDoc(String indexName)
protected org.opensearch.action.index.IndexResponse	indexSingleDoc(String indexName, boolean forceRefresh)
protected Collection<Class<? extends org.opensearch.plugins.Plugin>>	nodePlugins()	Returns a collection of plugins that should be loaded on each node.
protected org.opensearch.common.settings.Settings	nodeSettings(int nodeOrdinal)	This method is used to obtain settings for the Nth node in the cluster.
protected void	prepareCluster(int numClusterManagerNodes, int numDataOnlyNodes, String indices, int replicaCount, int shardCount)
protected void	prepareCluster(int numClusterManagerNodes, int numDataOnlyNodes, String indices, int replicaCount, int shardCount, org.opensearch.common.settings.Settings settings)
protected void	prepareCluster(int numClusterManagerNodes, int numDataOnlyNodes, org.opensearch.common.settings.Settings settings)
protected org.opensearch.common.settings.Settings	remoteStoreIndexSettings(int numberOfReplicas)
protected org.opensearch.common.settings.Settings	remoteStoreIndexSettings(int numberOfReplicas, int numberOfShards)
protected org.opensearch.common.settings.Settings	remoteStoreIndexSettings(int numberOfReplicas, long totalFieldLimit, int refresh)
protected org.opensearch.common.settings.Settings	remoteStoreRepoSettings()
protected void	restore(boolean restoreAllShards, String... indices)
protected void	setFailRate(String repoName, int value)
void	teardown()

Methods inherited from class org.opensearch.test.OpenSearchIntegTestCase

additionalNodePlugins, addMockGeoShapeFieldMapper, addMockHttpTransport, addMockIndexStorePlugin, addMockInternalEngine, addMockTelemetryPlugin, addMockTransportService, admin, afterClass, allowNodes, assertAllShardsOnNodes, assertResultsAndLogOnFailure, assertSortedSegments, beforeClass, beforeIndexDeletion, buildRemotePublicationNodeAttributes, buildRemoteStateNodeAttributes, buildRemoteStoreNodeAttributes, buildRemoteStoreNodeAttributes, buildRemoteStoreNodeAttributes, buildTestCluster, clearScroll, client, client, clients, cluster, clusterAdmin, clusterService, createIndex, createIndex, createIndex, createIndex, createRepository, createRepository, dataNodeClient, disableAllocation, disableIndexBlock, enableAllocation, enableIndexBlock, enableWarningsCheck, ensureClusterSizeConsistency, ensureClusterStateCanBeReadByNodeTool, ensureClusterStateConsistency, ensureFullyConnectedCluster, ensureGreen, ensureGreen, ensureGreen, ensureRed, ensureSearchable, ensureStableCluster, ensureStableCluster, ensureStableCluster, ensureStableCluster, ensureYellow, ensureYellowAndNoInitializingShards, excludeTemplates, externalClusterClientSettings, featureFlagSettings, flush, flushAndRefresh, forbidPrivateIndexSettings, forceMerge, forceMerge, getClientWrapper, getClusterState, getIndexShard, getIndexShard, getLatestSegmentInfoVersion, getMockPlugins, getNodeSettings, getNumShards, getRestClient, ignoreExternalCluster, index, index, index, index, index, indexExists, indexRandom, indexRandom, indexRandom, indexRandom, indexRandom, indexRandomForMultipleSlices, internalCluster, isInternalCluster, isMigratingToRemoteStore, isolateClusterManagerDisruption, isSegmentReplicationEnabledForIndex, logClusterState, manageReplicaBalanceSetting, manageReplicaSettingForDefaultReplica, maximumNumberOfReplicas, maximumNumberOfShards, minimumNumberOfReplicas, minimumNumberOfShards, nodeConfigPath, numberOfReplicas, numberOfShards, performRemoteStoreTestAction, prepareCreate, prepareCreate, prepareCreate, prepareCreate, primaryNodeName, primaryNodeName, putRepository, putRepository, putRepository, putRepository, putRepositoryRequestBuilder, putRepositoryWithNoSettingOverrides, randomIndexTemplate, randomRepoPath, randomRepoPath, refresh, refreshAndWaitForReplication, remoteStoreClusterSettings, remoteStoreClusterSettings, remoteStoreClusterSettings, remoteStoreClusterSettings, remoteStoreClusterSettings, replicaNodeName, resolveCustomDataPath, resolveIndex, resolvePath, routingKeyForShard, setClusterReadOnly, setDisruptionScheme, setRandomIndexSettings, setupSuiteScopeCluster, triggerRemoteStateRestore, updateRepository, useRandomReplicationStrategy, waitForDocs, waitForIndexed, waitForRelocation, waitForRelocation, waitForReplication, waitNoPendingTasksOnAll, willSufferDebian8MemoryProblem, xContentRegistry

Methods inherited from class org.opensearch.test.OpenSearchTestCase

after, afterIfFailed, afterIfSuccessful, allowedWarnings, assertArrayEquals, assertBusy, assertBusy, assertBusyWithFixedSleepTime, assertEquals, assertNoDeprecationWarnings, assertSettingDeprecationsAndWarnings, assertSettingDeprecationsAndWarnings, assertWarnings, assertWarnings, before, between, buildEnvSettings, buildNewFakeTransportAddress, checkStaticState, clearAdditionalRoles, copyInstance, copyNamedWriteable, copyNamedWriteable, copyWriteable, copyWriteable, createDefaultIndexAnalyzers, createParser, createParser, createParser, createParser, createParser, createParser, createTestAnalysis, createTestAnalysis, createTestAnalysis, enableJodaDeprecationWarningsCheck, ensureAllSearchContextsReleased, ensureCheckIndexPassed, ensureSupportedLocale, frequently, generateRandomStringArray, generateRandomStringArray, getBasePort, getBasePort, getDataPath, getPortRange, getShardLevelBlobPath, getSuiteFailureMarker, getTestTransportPlugin, getTestTransportType, inFipsJvm, iterations, maybeSet, mockScript, newNodeEnvironment, newNodeEnvironment, persistedStateRegistry, randomAlphaOfLength, randomAlphaOfLengthBetween, randomArray, randomArray, randomBigInteger, randomBoolean, randomByte, randomByteArrayOfLength, randomDateFormatterPattern, randomDateTimeZone, randomDouble, randomDoubleBetween, randomFloat, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomGeohash, randomInt, randomInt, randomIntBetween, randomIp, randomList, randomList, randomLong, randomLongBetween, randomNonNegativeInt, randomNonNegativeLong, randomPositiveTimeValue, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomShort, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomTimeValue, randomTimeValue, randomTimeZone, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomUnsignedLong, randomValueOtherThan, randomValueOtherThanMany, randomZone, remoteIndexSettings, removeHeaderWarningAppender, replaceUnicodeControlCharacters, replaceUnicodeControlCharacters, resetCheckIndexStatus, resetPortCounter, restoreContentType, restoreFileSystem, scaledRandomIntBetween, setContentType, setFileSystem, setHeaderWarningAppender, settings, shuffleMap, shuffleXContent, shuffleXContent, spinForAtLeastNMilliseconds, spinForAtLeastOneMillisecond, tearDown, terminate, terminate, tmpPaths, toShuffledXContent, toShuffledXContent, waitUntil, waitUntil, warmIndexSettings, writableRegistry

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

addVirusChecker, assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertDoubleUlpEquals, assertFieldInfosEquals, assertFloatUlpEquals, assertNormsEquals, assertPointsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, assertThat, assertThat, asSet, assumeFalse, assumeNoException, assumeTrue, atLeast, atLeast, callStackContains, callStackContains, callStackContainsAnyOf, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, ensureSaneIWCOnNightly, expectThrows, expectThrows, expectThrows, expectThrowsAnyOf, expectThrowsAnyOf, getDataInputStream, getJvmForkArguments, getOnlyLeafReader, getTestClass, getTestName, isTestThread, localeForLanguageTag, maybeChangeLiveIndexWriterConfig, maybeWrapReader, newAlcoholicMergePolicy, newAlcoholicMergePolicy, newBytesRef, newBytesRef, newBytesRef, newBytesRef, newBytesRef, newBytesRef, newDirectory, newDirectory, newDirectory, newDirectory, newDirectory, newField, newField, newFSDirectory, newFSDirectory, newIndexWriterConfig, newIndexWriterConfig, newIndexWriterConfig, newIOContext, newIOContext, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newMaybeVirusCheckingDirectory, newMaybeVirusCheckingFSDirectory, newMergePolicy, newMergePolicy, newMergePolicy, newMockDirectory, newMockDirectory, newMockDirectory, newMockFSDirectory, newMockFSDirectory, newSearcher, newSearcher, newSearcher, newSearcher, newSearcher, newSnapshotIndexWriterConfig, newStringField, newStringField, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, overrideDefaultQueryCache, overrideTestDefaultQueryCache, random, randomLocale, randomTimeZone, randomVectorFormat, rarely, rarely, replaceMaxFailureRule, resetDefaultQueryCache, restoreCPUCoreCount, restoreIndexWriterMaxDocs, runWithRestrictedPermissions, setIndexWriterMaxDocs, setUp, setupCPUCoreCount, setUpExecutorService, shutdownExecutorService, 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, assertThrows, assertThrows, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

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

Field Details

REPOSITORY_NAME

protected static final String REPOSITORY_NAME

See Also:

• Constant Field Values

REPOSITORY_2_NAME

protected static final String REPOSITORY_2_NAME

See Also:

• Constant Field Values

REPOSITORY_3_NAME

protected static final String REPOSITORY_3_NAME

See Also:

• Constant Field Values

REMOTE_ROUTING_TABLE_REPO

protected static final String REMOTE_ROUTING_TABLE_REPO

See Also:

• Constant Field Values

SHARD_COUNT

protected static final int SHARD_COUNT

See Also:

• Constant Field Values

REPLICA_COUNT

protected static int REPLICA_COUNT

TOTAL_OPERATIONS

protected static final String TOTAL_OPERATIONS

See Also:

• Constant Field Values

REFRESHED_OR_FLUSHED_OPERATIONS

protected static final String REFRESHED_OR_FLUSHED_OPERATIONS

See Also:

• Constant Field Values

MAX_SEQ_NO_TOTAL

protected static final String MAX_SEQ_NO_TOTAL

See Also:

• Constant Field Values

MAX_SEQ_NO_REFRESHED_OR_FLUSHED

protected static final String MAX_SEQ_NO_REFRESHED_OR_FLUSHED

See Also:

• Constant Field Values

segmentRepoPath

protected Path segmentRepoPath

translogRepoPath

protected Path translogRepoPath

clusterSettingsSuppliedByTest

protected boolean clusterSettingsSuppliedByTest

asyncUploadMockFsRepo

protected boolean asyncUploadMockFsRepo

Constructor Details

RemoteStoreBaseIntegTestCase

public RemoteStoreBaseIntegTestCase()

Method Details

indexData

protected Map<String,Long> indexData(int numberOfIterations,
 boolean invokeFlush,
 String index)

indexData

protected Map<String,Long> indexData(int numberOfIterations,
 boolean invokeFlush,
 boolean emptyTranslog,
 String index)

nodePlugins

protected Collection<Class<? extends org.opensearch.plugins.Plugin>> nodePlugins()

Description copied from class: OpenSearchIntegTestCase

Returns a collection of plugins that should be loaded on each node.

Overrides:

nodePlugins in class OpenSearchIntegTestCase

nodeSettings

protected org.opensearch.common.settings.Settings nodeSettings(int nodeOrdinal)

Description copied from class: OpenSearchIntegTestCase

This method is used to obtain settings for the Nth node in the cluster. Nodes in this cluster are associated with an ordinal number such that nodes can be started with specific configurations. This method might be called multiple times with the same ordinal and is expected to return the same value for each invocation. In other words subclasses must ensure this method is idempotent.

Overrides:

nodeSettings in class OpenSearchIntegTestCase

remoteStoreRepoSettings

protected org.opensearch.common.settings.Settings remoteStoreRepoSettings()

setFailRate

protected void setFailRate(String repoName,
 int value)
                    throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

indexSettings

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

Description copied from class: OpenSearchIntegTestCase

Returns a settings object used in OpenSearchIntegTestCase.createIndex(String...) and OpenSearchIntegTestCase.prepareCreate(String) and friends. This method can be overwritten by subclasses to set defaults for the indices that are created by the test. By default it returns a settings object that sets a random number of shards. Number of shards and replicas can be controlled through specific methods.

Overrides:

indexSettings in class OpenSearchIntegTestCase

indexSingleDoc

protected org.opensearch.action.index.IndexResponse indexSingleDoc(String indexName)

indexSingleDoc

protected org.opensearch.action.index.IndexResponse indexSingleDoc(String indexName,
 boolean forceRefresh)

indexBulk

protected org.opensearch.action.bulk.BulkResponse indexBulk(String indexName,
 int numDocs)

remoteStoreIndexSettings

protected org.opensearch.common.settings.Settings remoteStoreIndexSettings(int numberOfReplicas,
 int numberOfShards)

remoteStoreIndexSettings

protected org.opensearch.common.settings.Settings remoteStoreIndexSettings(int numberOfReplicas)

remoteStoreIndexSettings

protected org.opensearch.common.settings.Settings remoteStoreIndexSettings(int numberOfReplicas,
 long totalFieldLimit,
 int refresh)

teardown

public void teardown()

buildRepositoryMetadata

public org.opensearch.cluster.metadata.RepositoryMetadata buildRepositoryMetadata(org.opensearch.cluster.node.DiscoveryNode node,
 String name)

assertRemoteStoreRepositoryOnAllNodes

public void assertRemoteStoreRepositoryOnAllNodes(String repositoryName)

getFileCount

public static int getFileCount(Path path)
                        throws IOException

Throws:

IOException

getIndexShard

protected org.opensearch.index.shard.IndexShard getIndexShard(String dataNode,
 String indexName)
                                                       throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

getIndexShardFromShardId

protected org.opensearch.index.shard.IndexShard getIndexShardFromShardId(String dataNode,
 String indexName,
 Integer shardId)
                                                                  throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

restore

protected void restore(boolean restoreAllShards,
 String... indices)

prepareCluster

protected void prepareCluster(int numClusterManagerNodes,
 int numDataOnlyNodes,
 String indices,
 int replicaCount,
 int shardCount)

prepareCluster

protected void prepareCluster(int numClusterManagerNodes,
 int numDataOnlyNodes,
 String indices,
 int replicaCount,
 int shardCount,
 org.opensearch.common.settings.Settings settings)

prepareCluster

protected void prepareCluster(int numClusterManagerNodes,
 int numDataOnlyNodes,
 org.opensearch.common.settings.Settings settings)