Class AbstractSnapshotIntegTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.opensearch.test.OpenSearchTestCase

org.opensearch.test.OpenSearchIntegTestCase

org.opensearch.test.ParameterizedStaticSettingsOpenSearchIntegTestCase

org.opensearch.snapshots.AbstractSnapshotIntegTestCase

public abstract class AbstractSnapshotIntegTestCase
extends ParameterizedStaticSettingsOpenSearchIntegTestCase

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 static final org.opensearch.common.settings.Settings	LARGE_SNAPSHOT_POOL_SETTINGS
protected final org.opensearch.common.settings.Settings	settings
protected static final String	TEST_REMOTE_STORE_REPO_SUFFIX

Fields inherited from class org.opensearch.test.ParameterizedStaticSettingsOpenSearchIntegTestCase

REMOTE_STORE_REPOSITORY_NAME, remoteStoreSettings, replicationSettings

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
AbstractSnapshotIntegTestCase()
AbstractSnapshotIntegTestCase(org.opensearch.common.settings.Settings nodeSettings)

Method Summary

Modifier and Type	Method	Description
protected void	addBwCFailedSnapshot(String repoName, String snapshotName, Map<String,Object> metadata)	Adds a snapshot in state SnapshotState.FAILED to the given repository.
protected boolean	addMockIndexStorePlugin()
void	assertConsistentHistoryInLuceneIndex()
protected void	assertDocCount(String index, long count)
static void	assertFileCount(Path dir, int expectedCount)
void	assertRepoConsistency()
protected static org.opensearch.snapshots.SnapshotInfo	assertSuccessful(org.opensearch.common.action.ActionFuture<org.opensearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse> future)
protected void	awaitClusterManagerFinishRepoOperations()
protected void	awaitClusterState(String viaNode, Predicate<org.opensearch.cluster.ClusterState> statePredicate)
protected void	awaitClusterState(Predicate<org.opensearch.cluster.ClusterState> statePredicate)
protected void	awaitNoMoreRunningOperations()
protected void	awaitNoMoreRunningOperations(String viaNode)
protected void	awaitNumberOfSnapshotsInProgress(int count)
static void	blockAllDataNodes(String repository)
static void	blockClusterManagerFromDeletingIndexNFile(String repositoryName)
static String	blockClusterManagerFromFinalizingSnapshotOnIndexFile(String repositoryName)
static String	blockClusterManagerFromFinalizingSnapshotOnSnapFile(String repositoryName)
static String	blockClusterManagerOnWriteIndexFile(String repositoryName)
static void	blockDataNode(String repository, String nodeName)
static void	blockNodeOnAnyFiles(String repository, String nodeName)
static void	blockNodeOnAnySegmentFile(String repository, String nodeName)
static String	blockNodeWithIndex(String repositoryName, String indexName)
protected org.opensearch.snapshots.SnapshotInfo	createFullSnapshot(String repoName, String snapshotName)
protected void	createIndexWithContent(String indexName)
protected void	createIndexWithContent(String indexName, org.opensearch.common.settings.Settings indexSettings)
protected void	createIndexWithRandomDocs(String indexName, int docCount)
protected void	createRepository(String repoName, String type)
protected void	createRepository(String repoName, String type, Path location)
protected org.opensearch.snapshots.SnapshotInfo	createSnapshot(String repositoryName, String snapshot, List<String> indices)
protected org.opensearch.common.action.ActionFuture<org.opensearch.action.support.clustermanager.AcknowledgedResponse>	deleteSnapshot(String repoName, String snapshotName)
protected org.opensearch.common.action.ActionFuture<org.opensearch.action.support.clustermanager.AcknowledgedResponse>	deleteSnapshotBlockedOnClusterManager(String repoName, String snapshotName)
protected void	disableRepoConsistencyCheck(String reason)
static void	failReadsAllDataNodes(String repository)
protected long	getCountForIndex(String indexName)
static long	getFailureCount(String repository)
protected String[]	getLockFilesInRemoteStore(String remoteStoreIndex, String remoteStoreRepositoryName)
protected org.opensearch.common.settings.Settings	getRemoteStoreBackedIndexSettings()
protected org.opensearch.repositories.RepositoryData	getRepositoryData(String repository)
protected org.opensearch.repositories.RepositoryData	getRepositoryData(org.opensearch.repositories.Repository repository)
protected org.opensearch.common.settings.Settings.Builder	getRepositorySettings(Path location, boolean shallowCopyEnabled)
protected org.opensearch.common.settings.Settings.Builder	getRepositorySettings(Path location, String basePath, boolean shallowCopyEnabled)
protected org.opensearch.snapshots.SnapshotInfo	getSnapshot(String repository, String snapshot)
protected void	indexRandomDocs(String index, int numdocs)
void	indexRandomForConcurrentSearch(String... indices)
protected static org.opensearch.common.settings.Settings.Builder	indexSettingsNoReplicas(int shards)
protected String	initWithSnapshotVersion(String repoName, Path repoPath, org.opensearch.Version version)	Workaround to simulate BwC situation: taking a snapshot without indices here so that we don't create any new version shard generations (the existence of which would short-circuit checks for the repo containing old version snapshots)
protected void	maybeInitWithOldSnapshotVersion(String repoName, Path repoPath)	Randomly write an empty snapshot of an older version to an empty repository to simulate an older repository metadata format.
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.
static int	numberOfFiles(Path dir)
protected org.opensearch.common.settings.Settings.Builder	randomRepositorySettings()
protected void	restoreSnapshot(String repositoryName, String snapshotName, String indexName, String restoredIndexName, org.opensearch.common.settings.Settings indexSettings)
protected org.opensearch.common.settings.Settings.Builder	snapshotRepoSettingsForShallowCopy()
protected org.opensearch.common.settings.Settings.Builder	snapshotRepoSettingsForShallowCopy(Path path)
protected org.opensearch.common.action.ActionFuture<org.opensearch.action.support.clustermanager.AcknowledgedResponse>	startDeleteSnapshot(String repoName, String snapshotName)
protected org.opensearch.common.action.ActionFuture<org.opensearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse>	startFullSnapshot(String repoName, String snapshotName)
protected org.opensearch.common.action.ActionFuture<org.opensearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse>	startFullSnapshot(String repoName, String snapshotName, boolean partial)
protected org.opensearch.common.action.ActionFuture<org.opensearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse>	startFullSnapshotBlockedOnDataNode(String snapshotName, String repoName, String dataNode)
static void	stopNode(String node)
static void	unblockAllDataNodes(String repository)
void	unblockNode(String repository, String node)
protected void	updateClusterState(Function<org.opensearch.cluster.ClusterState, org.opensearch.cluster.ClusterState> updater)
void	verifyNoLeakedListeners()
void	waitForBlock(String node, String repository, org.opensearch.common.unit.TimeValue timeout)
static void	waitForBlockOnAnyDataNode(String repository, org.opensearch.common.unit.TimeValue timeout)
org.opensearch.snapshots.SnapshotInfo	waitForCompletion(String repository, String snapshotName, org.opensearch.common.unit.TimeValue timeout)

Methods inherited from class org.opensearch.test.OpenSearchIntegTestCase

additionalNodePlugins, addMockGeoShapeFieldMapper, addMockHttpTransport, 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, indexSettings, 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

TEST_REMOTE_STORE_REPO_SUFFIX

protected static final String TEST_REMOTE_STORE_REPO_SUFFIX

See Also:

• Constant Field Values

LARGE_SNAPSHOT_POOL_SETTINGS

protected static final org.opensearch.common.settings.Settings LARGE_SNAPSHOT_POOL_SETTINGS

settings

protected final org.opensearch.common.settings.Settings settings

Constructor Details

AbstractSnapshotIntegTestCase

public AbstractSnapshotIntegTestCase(org.opensearch.common.settings.Settings nodeSettings)

AbstractSnapshotIntegTestCase

public AbstractSnapshotIntegTestCase()

Method Details

addMockIndexStorePlugin

protected boolean addMockIndexStorePlugin()

Overrides:

addMockIndexStorePlugin 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 ParameterizedStaticSettingsOpenSearchIntegTestCase

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

assertConsistentHistoryInLuceneIndex

public void assertConsistentHistoryInLuceneIndex()
                                          throws Exception

Throws:

Exception

verifyNoLeakedListeners

public void verifyNoLeakedListeners()
                             throws Exception

Throws:

Exception

assertRepoConsistency

public void assertRepoConsistency()

disableRepoConsistencyCheck

protected void disableRepoConsistencyCheck(String reason)

getRepositoryData

protected org.opensearch.repositories.RepositoryData getRepositoryData(String repository)

getRepositoryData

protected org.opensearch.repositories.RepositoryData getRepositoryData(org.opensearch.repositories.Repository repository)

getFailureCount

public static long getFailureCount(String repository)

assertFileCount

public static void assertFileCount(Path dir,
 int expectedCount)
                            throws IOException

Throws:

IOException

numberOfFiles

public static int numberOfFiles(Path dir)
                         throws IOException

Throws:

IOException

stopNode

public static void stopNode(String node)
                     throws IOException

Throws:

IOException

waitForBlock

public void waitForBlock(String node,
 String repository,
 org.opensearch.common.unit.TimeValue timeout)
                  throws InterruptedException

Throws:

InterruptedException

waitForCompletion

public org.opensearch.snapshots.SnapshotInfo waitForCompletion(String repository,
 String snapshotName,
 org.opensearch.common.unit.TimeValue timeout)
                                                        throws InterruptedException

Throws:

InterruptedException

blockClusterManagerFromFinalizingSnapshotOnIndexFile

public static String blockClusterManagerFromFinalizingSnapshotOnIndexFile(String repositoryName)

blockClusterManagerOnWriteIndexFile

public static String blockClusterManagerOnWriteIndexFile(String repositoryName)

blockClusterManagerFromDeletingIndexNFile

public static void blockClusterManagerFromDeletingIndexNFile(String repositoryName)

blockClusterManagerFromFinalizingSnapshotOnSnapFile

public static String blockClusterManagerFromFinalizingSnapshotOnSnapFile(String repositoryName)

blockNodeWithIndex

public static String blockNodeWithIndex(String repositoryName,
 String indexName)

blockNodeOnAnyFiles

public static void blockNodeOnAnyFiles(String repository,
 String nodeName)

blockNodeOnAnySegmentFile

public static void blockNodeOnAnySegmentFile(String repository,
 String nodeName)

blockDataNode

public static void blockDataNode(String repository,
 String nodeName)

blockAllDataNodes

public static void blockAllDataNodes(String repository)

unblockAllDataNodes

public static void unblockAllDataNodes(String repository)

failReadsAllDataNodes

public static void failReadsAllDataNodes(String repository)

waitForBlockOnAnyDataNode

public static void waitForBlockOnAnyDataNode(String repository,
 org.opensearch.common.unit.TimeValue timeout)
                                      throws InterruptedException

Throws:

InterruptedException

unblockNode

public void unblockNode(String repository,
 String node)

createRepository

protected void createRepository(String repoName,
 String type,
 Path location)

getRepositorySettings

protected org.opensearch.common.settings.Settings.Builder getRepositorySettings(Path location,
 boolean shallowCopyEnabled)

getRepositorySettings

protected org.opensearch.common.settings.Settings.Builder getRepositorySettings(Path location,
 String basePath,
 boolean shallowCopyEnabled)

createRepository

protected void createRepository(String repoName,
 String type)

randomRepositorySettings

protected org.opensearch.common.settings.Settings.Builder randomRepositorySettings()

snapshotRepoSettingsForShallowCopy

protected org.opensearch.common.settings.Settings.Builder snapshotRepoSettingsForShallowCopy()

indexSettingsNoReplicas

protected static org.opensearch.common.settings.Settings.Builder indexSettingsNoReplicas(int shards)

maybeInitWithOldSnapshotVersion

protected void maybeInitWithOldSnapshotVersion(String repoName,
 Path repoPath)
                                        throws IOException

Randomly write an empty snapshot of an older version to an empty repository to simulate an older repository metadata format.

Throws:

IOException

initWithSnapshotVersion

protected String initWithSnapshotVersion(String repoName,
 Path repoPath,
 org.opensearch.Version version)
                                  throws IOException

Workaround to simulate BwC situation: taking a snapshot without indices here so that we don't create any new version shard generations (the existence of which would short-circuit checks for the repo containing old version snapshots)

Throws:

IOException

createFullSnapshot

protected org.opensearch.snapshots.SnapshotInfo createFullSnapshot(String repoName,
 String snapshotName)

createSnapshot

protected org.opensearch.snapshots.SnapshotInfo createSnapshot(String repositoryName,
 String snapshot,
 List<String> indices)

restoreSnapshot

protected void restoreSnapshot(String repositoryName,
 String snapshotName,
 String indexName,
 String restoredIndexName,
 org.opensearch.common.settings.Settings indexSettings)

createIndexWithRandomDocs

protected void createIndexWithRandomDocs(String indexName,
 int docCount)
                                  throws InterruptedException

Throws:

InterruptedException

indexRandomDocs

protected void indexRandomDocs(String index,
 int numdocs)
                        throws InterruptedException

Throws:

InterruptedException

getRemoteStoreBackedIndexSettings

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

snapshotRepoSettingsForShallowCopy

protected org.opensearch.common.settings.Settings.Builder snapshotRepoSettingsForShallowCopy(Path path)

getCountForIndex

protected long getCountForIndex(String indexName)

assertDocCount

protected void assertDocCount(String index,
 long count)

getLockFilesInRemoteStore

protected String[] getLockFilesInRemoteStore(String remoteStoreIndex,
 String remoteStoreRepositoryName)
                                      throws IOException

Throws:

IOException

addBwCFailedSnapshot

protected void addBwCFailedSnapshot(String repoName,
 String snapshotName,
 Map<String,Object> metadata)
                             throws Exception

Adds a snapshot in state SnapshotState.FAILED to the given repository.

Parameters:

repoName - repository to add snapshot to

snapshotName - name for the new failed snapshot

metadata - snapshot metadata to write (as returned by SnapshotInfo.userMetadata())

Throws:

Exception

awaitNoMoreRunningOperations

protected void awaitNoMoreRunningOperations()
                                     throws Exception

Throws:

Exception

awaitNoMoreRunningOperations

protected void awaitNoMoreRunningOperations(String viaNode)
                                     throws Exception

Throws:

Exception

awaitClusterState

protected void awaitClusterState(Predicate<org.opensearch.cluster.ClusterState> statePredicate)
                          throws Exception

Throws:

Exception

awaitClusterState

protected void awaitClusterState(String viaNode,
 Predicate<org.opensearch.cluster.ClusterState> statePredicate)
                          throws Exception

Throws:

Exception

deleteSnapshotBlockedOnClusterManager

protected org.opensearch.common.action.ActionFuture<org.opensearch.action.support.clustermanager.AcknowledgedResponse> deleteSnapshotBlockedOnClusterManager(String repoName,
 String snapshotName)

deleteSnapshot

protected org.opensearch.common.action.ActionFuture<org.opensearch.action.support.clustermanager.AcknowledgedResponse> deleteSnapshot(String repoName,
 String snapshotName)

startFullSnapshotBlockedOnDataNode

protected org.opensearch.common.action.ActionFuture<org.opensearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse> startFullSnapshotBlockedOnDataNode(String snapshotName,
 String repoName,
 String dataNode)
                                                                                                                                                             throws InterruptedException

Throws:

InterruptedException

startFullSnapshot

protected org.opensearch.common.action.ActionFuture<org.opensearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse> startFullSnapshot(String repoName,
 String snapshotName)

startFullSnapshot

protected org.opensearch.common.action.ActionFuture<org.opensearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse> startFullSnapshot(String repoName,
 String snapshotName,
 boolean partial)

awaitNumberOfSnapshotsInProgress

protected void awaitNumberOfSnapshotsInProgress(int count)
                                         throws Exception

Throws:

Exception

assertSuccessful

protected static org.opensearch.snapshots.SnapshotInfo assertSuccessful(org.opensearch.common.action.ActionFuture<org.opensearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse> future)
                                                                 throws Exception

Throws:

Exception

createIndexWithContent

protected void createIndexWithContent(String indexName)

createIndexWithContent

protected void createIndexWithContent(String indexName,
 org.opensearch.common.settings.Settings indexSettings)

startDeleteSnapshot

protected org.opensearch.common.action.ActionFuture<org.opensearch.action.support.clustermanager.AcknowledgedResponse> startDeleteSnapshot(String repoName,
 String snapshotName)

updateClusterState

protected void updateClusterState(Function<org.opensearch.cluster.ClusterState, org.opensearch.cluster.ClusterState> updater)
                           throws Exception

Throws:

Exception

getSnapshot

protected org.opensearch.snapshots.SnapshotInfo getSnapshot(String repository,
 String snapshot)

awaitClusterManagerFinishRepoOperations

protected void awaitClusterManagerFinishRepoOperations()
                                                throws Exception

Throws:

Exception

indexRandomForConcurrentSearch

public void indexRandomForConcurrentSearch(String... indices)
                                    throws InterruptedException

Throws:

InterruptedException