Class OpenSearchRestTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.opensearch.test.OpenSearchTestCase

org.opensearch.test.rest.OpenSearchRestTestCase

Direct Known Subclasses:

AbstractFullClusterRestartTestCase, JsonLogsIntegTestCase, OpenSearchClientYamlSuiteTestCase

public abstract class OpenSearchRestTestCase
extends OpenSearchTestCase

Superclass for tests that interact with an external test cluster using OpenSearch's RestClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenSearchRestTestCase.VersionSensitiveWarningsHandler	Helper class to check warnings in REST responses with sensitivity to versions used in the target cluster.

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
static final String	CLIENT_PATH_PREFIX
static final String	CLIENT_SOCKET_TIMEOUT
static final String	TRUSTSTORE_PASSWORD
static final String	TRUSTSTORE_PATH

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
OpenSearchRestTestCase()

Method Summary

Modifier and Type	Method	Description
protected static org.opensearch.client.RestClient	adminClient()	Get the client used for test administrative actions.
protected static boolean	aliasExists(String alias)
protected static boolean	aliasExists(String index, String alias)
static org.opensearch.client.RequestOptions	allowTypesRemovalWarnings()	Deprecated. this method is only required while we deprecate types and can be removed in 8.0
void	assertEmptyTranslog(String index)	Asserts that we do not retain any extra translog for the given index (i.e., turn off the translog retention)
void	assertNoFileBasedRecovery(String indexName, Predicate<String> targetNode)	Asserts that replicas on nodes satisfying the targetNode should have perform operation-based recoveries.
protected static void	assertOK(org.opensearch.client.Response response)
protected org.opensearch.client.RestClient	buildClient(org.opensearch.common.settings.Settings settings, org.apache.hc.core5.http.HttpHost[] hosts)
protected org.apache.hc.core5.http.HttpHost	buildHttpHost(String host, int port)	Construct an HttpHost from the given host and port
final void	cleanUpCluster()	Clean up after the test case.
protected static org.opensearch.client.RestClient	client()	Get the client used for ordinary api calls while writing a test
static void	closeClients()
protected static void	closeIndex(String index)
protected static void	configureClient(org.opensearch.client.RestClientBuilder builder, org.opensearch.common.settings.Settings settings)
protected static void	createIndex(String name, org.opensearch.common.settings.Settings settings)
protected static void	createIndex(String name, org.opensearch.common.settings.Settings settings, String mapping)
protected static void	createIndex(String name, org.opensearch.common.settings.Settings settings, String mapping, String aliases)
protected static void	createSnapshot(String repository, String snapshot, boolean waitForCompletion)
protected static void	deleteIndex(String name)
protected void	deleteRepository(String repoName)
static void	ensureGreen(String index)	checks that the specific index is green.
protected static void	ensureHealth(String index, Consumer<org.opensearch.client.Request> requestConsumer)
protected static void	ensureHealth(Consumer<org.opensearch.client.Request> requestConsumer)
protected static void	ensureHealth(org.opensearch.client.RestClient client, String index, Consumer<org.opensearch.client.Request> requestConsumer)
protected static void	ensureNoInitializingShards()	waits until all shard initialization is completed.
void	ensurePeerRecoveryRetentionLeasesRenewedAndSynced(String index)	Peer recovery retention leases are renewed and synced to replicas periodically (every 30 seconds).
static List<Object>	entityAsList(org.opensearch.client.Response response)	Convert the entity from a Response into a list of maps.
static Map<String,Object>	entityAsMap(org.opensearch.client.Response response)	Convert the entity from a Response into a map of maps.
protected static void	expectSoftDeletesWarning(org.opensearch.client.Request request, String indexName)
static org.opensearch.client.RequestOptions	expectVersionSpecificWarnings(Consumer<OpenSearchRestTestCase.VersionSensitiveWarningsHandler> expectationsSetter)
static org.opensearch.client.RequestOptions	expectWarnings(String... warnings)	Creates request options designed to be used when making a call that can return warnings, for example a deprecated request.
static org.opensearch.client.RequestOptions	expectWarningsOnce(String deprecationWarning)	Filters out already asserted warnings and calls expectWarnings method.
void	flush(String index, boolean force)
protected static Map<String,Object>	getAlias(String index, String alias)
protected static Map<String,Object>	getAsMap(String endpoint)
protected final List<org.apache.hc.core5.http.HttpHost>	getClusterHosts()	Get the list of hosts in the cluster.
protected static Map<String,Object>	getIndexSettings(String index)
protected Map<String,Object>	getIndexSettingsAsMap(String index)
protected String	getProtocol()	Override this to switch to testing https.
protected String	getTestRestCluster()
protected static boolean	indexExists(String index)
void	initClient()
protected static org.opensearch.Version	minimumNodeVersion()	Returns the minimum node version among all nodes of the cluster
protected static void	openIndex(String index)
protected boolean	preserveClusterSettings()	Controls whether or not to preserve cluster settings upon completion of the test.
protected boolean	preserveClusterUponCompletion()	Returns whether to preserve the state of the cluster upon completion of this test.
protected boolean	preserveDataStreamsUponCompletion()	Determines if data streams are preserved upon completion of this test.
protected boolean	preserveIndicesUponCompletion()	Returns whether to preserve the indices created during this test on completion of this test.
protected boolean	preserveReposUponCompletion()	Returns whether to preserve the repositories on completion of this test.
protected boolean	preserveSLMPoliciesUponCompletion()	Returns whether to preserve SLM Policies of this test.
protected boolean	preserveSnapshotsUponCompletion()	Returns whether to preserve the snapshots in repositories on completion of this test.
protected boolean	preserveTemplatesUponCompletion()	Controls whether or not to preserve templates upon completion of this test.
protected void	refreshAllIndices()
protected static void	registerRepository(String repository, String type, boolean verify, org.opensearch.common.settings.Settings settings)
protected static Map<String,Object>	responseAsMap(org.opensearch.client.Response response)
protected org.opensearch.common.settings.Settings	restAdminSettings()	Returns the REST client settings used for admin actions like cleaning up after the test has completed.
protected org.opensearch.common.settings.Settings	restClientSettings()	Used to obtain settings for the REST client that is used to send REST requests.
protected static void	restoreSnapshot(String repository, String snapshot, boolean waitForCompletion)
protected void	syncedFlush(String indexName, boolean retryOnConflict)
protected static void	updateIndexSettings(String index, org.opensearch.common.settings.Settings.Builder settings)
protected static void	useIgnoreMultipleMatchingTemplatesWarningsHandler(org.opensearch.client.Request request)
protected boolean	waitForAllSnapshotsWiped()	Returns whether to wait to make absolutely certain that all snapshots have been deleted.
static void	waitForPendingTasks(org.opensearch.client.RestClient adminClient)	Wait for outstanding tasks to complete.
static void	waitForPendingTasks(org.opensearch.client.RestClient adminClient, Predicate<String> taskFilter)	Wait for outstanding tasks to complete.
protected static void	wipeAllIndices()
protected static void	wipeDataStreams()
protected Map<String, List<Map<?,?>>>	wipeSnapshots()	Wipe fs snapshots we created one by one and all repositories so that the next test can create the repositories fresh and they'll start empty.

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, enableWarningsCheck, 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, xContentRegistry

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

TRUSTSTORE_PATH

public static final String TRUSTSTORE_PATH

See Also:

• Constant Field Values

TRUSTSTORE_PASSWORD

public static final String TRUSTSTORE_PASSWORD

See Also:

• Constant Field Values

CLIENT_SOCKET_TIMEOUT

public static final String CLIENT_SOCKET_TIMEOUT

See Also:

• Constant Field Values

CLIENT_PATH_PREFIX

public static final String CLIENT_PATH_PREFIX

See Also:

• Constant Field Values

Constructor Details

OpenSearchRestTestCase

public OpenSearchRestTestCase()

Method Details

entityAsMap

public static Map<String,Object> entityAsMap(org.opensearch.client.Response response)
                                      throws IOException

Convert the entity from a Response into a map of maps.

Throws:

IOException

entityAsList

public static List<Object> entityAsList(org.opensearch.client.Response response)
                                 throws IOException

Convert the entity from a Response into a list of maps.

Throws:

IOException

initClient

public void initClient()
                throws IOException

Throws:

IOException

getTestRestCluster

protected String getTestRestCluster()

expectVersionSpecificWarnings

public static org.opensearch.client.RequestOptions expectVersionSpecificWarnings(Consumer<OpenSearchRestTestCase.VersionSensitiveWarningsHandler> expectationsSetter)

expectWarnings

public static org.opensearch.client.RequestOptions expectWarnings(String... warnings)

Creates request options designed to be used when making a call that can return warnings, for example a deprecated request. The options will ensure that the given warnings are returned if all nodes are on Version.CURRENT and will allow (but not require) the warnings if any node is running an older version.

Parameters:

warnings - The expected warnings.

expectWarningsOnce

public static org.opensearch.client.RequestOptions expectWarningsOnce(String deprecationWarning)

Filters out already asserted warnings and calls expectWarnings method.

Parameters:

deprecationWarning - expected warning

allowTypesRemovalWarnings

@Deprecated
public static org.opensearch.client.RequestOptions allowTypesRemovalWarnings()

Deprecated.

this method is only required while we deprecate types and can be removed in 8.0

Creates RequestOptions designed to ignore [types removal] warnings but nothing else

buildHttpHost

protected org.apache.hc.core5.http.HttpHost buildHttpHost(String host,
 int port)

Construct an HttpHost from the given host and port

cleanUpCluster

public final void cleanUpCluster()
                          throws Exception

Clean up after the test case.

Throws:

Exception

closeClients

public static void closeClients()
                         throws IOException

Throws:

IOException

client

protected static org.opensearch.client.RestClient client()

Get the client used for ordinary api calls while writing a test

adminClient

protected static org.opensearch.client.RestClient adminClient()

Get the client used for test administrative actions. Do not use this while writing a test. Only use it for cleaning up after tests.

waitForPendingTasks

public static void waitForPendingTasks(org.opensearch.client.RestClient adminClient)
                                throws Exception

Wait for outstanding tasks to complete. The specified admin client is used to check the outstanding tasks and this is done using OpenSearchTestCase.assertBusy(CheckedRunnable) to give a chance to any outstanding tasks to complete.

Parameters:

adminClient - the admin client

Throws:

Exception - if an exception is thrown while checking the outstanding tasks

waitForPendingTasks

public static void waitForPendingTasks(org.opensearch.client.RestClient adminClient,
 Predicate<String> taskFilter)
                                throws Exception

Wait for outstanding tasks to complete. The specified admin client is used to check the outstanding tasks and this is done using OpenSearchTestCase.assertBusy(CheckedRunnable) to give a chance to any outstanding tasks to complete. The specified filter is used to filter out outstanding tasks that are expected to be there.

Parameters:

adminClient - the admin client

taskFilter - predicate used to filter tasks that are expected to be there

Throws:

Exception - if an exception is thrown while checking the outstanding tasks

preserveClusterUponCompletion

protected boolean preserveClusterUponCompletion()

Returns whether to preserve the state of the cluster upon completion of this test. Defaults to false. If true, overrides the value of preserveIndicesUponCompletion(), preserveTemplatesUponCompletion(), preserveReposUponCompletion(), and preserveSnapshotsUponCompletion().

Returns:

true if the state of the cluster should be preserved

preserveIndicesUponCompletion

protected boolean preserveIndicesUponCompletion()

Returns whether to preserve the indices created during this test on completion of this test. Defaults to false. Override this method if indices should be preserved after the test, with the assumption that some other process or test will clean up the indices afterward. This is useful if the data directory and indices need to be preserved between test runs (for example, when testing rolling upgrades).

preserveTemplatesUponCompletion

protected boolean preserveTemplatesUponCompletion()

Controls whether or not to preserve templates upon completion of this test. The default implementation is to delete not preserve templates.

Returns:

whether or not to preserve templates

preserveDataStreamsUponCompletion

protected boolean preserveDataStreamsUponCompletion()

Determines if data streams are preserved upon completion of this test. The default implementation wipes data streams.

Returns:

whether or not to preserve data streams

preserveClusterSettings

protected boolean preserveClusterSettings()

Controls whether or not to preserve cluster settings upon completion of the test. The default implementation is to remove all cluster settings.

Returns:

true if cluster settings should be preserved and otherwise false

preserveReposUponCompletion

protected boolean preserveReposUponCompletion()

Returns whether to preserve the repositories on completion of this test. Defaults to not preserving repos. See also preserveSnapshotsUponCompletion().

preserveSnapshotsUponCompletion

protected boolean preserveSnapshotsUponCompletion()

Returns whether to preserve the snapshots in repositories on completion of this test. Defaults to not preserving snapshots. Only works for fs repositories.

preserveSLMPoliciesUponCompletion

protected boolean preserveSLMPoliciesUponCompletion()

Returns whether to preserve SLM Policies of this test. Defaults to not preserving them. Only runs at all if xpack is installed on the cluster being tested.

waitForAllSnapshotsWiped

protected boolean waitForAllSnapshotsWiped()

Returns whether to wait to make absolutely certain that all snapshots have been deleted.

wipeAllIndices

protected static void wipeAllIndices()
                              throws IOException

Throws:

IOException

wipeDataStreams

protected static void wipeDataStreams()
                               throws IOException

Throws:

IOException

wipeSnapshots

protected Map<String, List<Map<?,?>>> wipeSnapshots()
                                             throws IOException

Wipe fs snapshots we created one by one and all repositories so that the next test can create the repositories fresh and they'll start empty. There isn't an API to delete all snapshots. There is an API to delete all snapshot repositories but that leaves all of the snapshots intact in the repository.

Returns:

Map of repository name to list of snapshots found in unfinished state

Throws:

IOException

deleteRepository

protected void deleteRepository(String repoName)
                         throws IOException

Throws:

IOException

refreshAllIndices

protected void refreshAllIndices()
                          throws IOException

Throws:

IOException

restClientSettings

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

Used to obtain settings for the REST client that is used to send REST requests.

restAdminSettings

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

Returns the REST client settings used for admin actions like cleaning up after the test has completed.

getClusterHosts

protected final List<org.apache.hc.core5.http.HttpHost> getClusterHosts()

Get the list of hosts in the cluster.

getProtocol

protected String getProtocol()

Override this to switch to testing https.

buildClient

protected org.opensearch.client.RestClient buildClient(org.opensearch.common.settings.Settings settings,
 org.apache.hc.core5.http.HttpHost[] hosts)
                                                throws IOException

Throws:

IOException

configureClient

protected static void configureClient(org.opensearch.client.RestClientBuilder builder,
 org.opensearch.common.settings.Settings settings)
                               throws IOException

Throws:

IOException

assertOK

protected static void assertOK(org.opensearch.client.Response response)

ensureGreen

public static void ensureGreen(String index)
                        throws IOException

checks that the specific index is green. we force a selection of an index as the tests share a cluster and often leave indices in an non green state

Parameters:

index - index to test for

Throws:

IOException

ensureHealth

protected static void ensureHealth(Consumer<org.opensearch.client.Request> requestConsumer)
                            throws IOException

Throws:

IOException

ensureHealth

protected static void ensureHealth(String index,
 Consumer<org.opensearch.client.Request> requestConsumer)
                            throws IOException

Throws:

IOException

ensureHealth

protected static void ensureHealth(org.opensearch.client.RestClient client,
 String index,
 Consumer<org.opensearch.client.Request> requestConsumer)
                            throws IOException

Throws:

IOException

ensureNoInitializingShards

protected static void ensureNoInitializingShards()
                                          throws IOException

waits until all shard initialization is completed. This is a handy alternative to ensureGreen as it relates to all shards in the cluster and doesn't require to know how many nodes/replica there are.

Throws:

IOException

createIndex

protected static void createIndex(String name,
 org.opensearch.common.settings.Settings settings)
                           throws IOException

Throws:

IOException

createIndex

protected static void createIndex(String name,
 org.opensearch.common.settings.Settings settings,
 String mapping)
                           throws IOException

Throws:

IOException

createIndex

protected static void createIndex(String name,
 org.opensearch.common.settings.Settings settings,
 String mapping,
 String aliases)
                           throws IOException

Throws:

IOException

deleteIndex

protected static void deleteIndex(String name)
                           throws IOException

Throws:

IOException

updateIndexSettings

protected static void updateIndexSettings(String index,
 org.opensearch.common.settings.Settings.Builder settings)
                                   throws IOException

Throws:

IOException

expectSoftDeletesWarning

protected static void expectSoftDeletesWarning(org.opensearch.client.Request request,
 String indexName)

getIndexSettings

protected static Map<String,Object> getIndexSettings(String index)
                                              throws IOException

Throws:

IOException

getIndexSettingsAsMap

protected Map<String,Object> getIndexSettingsAsMap(String index)
                                            throws IOException

Throws:

IOException

indexExists

protected static boolean indexExists(String index)
                              throws IOException

Throws:

IOException

closeIndex

protected static void closeIndex(String index)
                          throws IOException

Throws:

IOException

openIndex

protected static void openIndex(String index)
                         throws IOException

Throws:

IOException

aliasExists

protected static boolean aliasExists(String alias)
                              throws IOException

Throws:

IOException

aliasExists

protected static boolean aliasExists(String index,
 String alias)
                              throws IOException

Throws:

IOException

getAlias

protected static Map<String,Object> getAlias(String index,
 String alias)
                                      throws IOException

Throws:

IOException

getAsMap

protected static Map<String,Object> getAsMap(String endpoint)
                                      throws IOException

Throws:

IOException

responseAsMap

protected static Map<String,Object> responseAsMap(org.opensearch.client.Response response)
                                           throws IOException

Throws:

IOException

registerRepository

protected static void registerRepository(String repository,
 String type,
 boolean verify,
 org.opensearch.common.settings.Settings settings)
                                  throws IOException

Throws:

IOException

createSnapshot

protected static void createSnapshot(String repository,
 String snapshot,
 boolean waitForCompletion)
                              throws IOException

Throws:

IOException

restoreSnapshot

protected static void restoreSnapshot(String repository,
 String snapshot,
 boolean waitForCompletion)
                               throws IOException

Throws:

IOException

flush

public void flush(String index,
 boolean force)
           throws IOException

Throws:

IOException

assertNoFileBasedRecovery

public void assertNoFileBasedRecovery(String indexName,
 Predicate<String> targetNode)
                               throws IOException

Asserts that replicas on nodes satisfying the targetNode should have perform operation-based recoveries.

Throws:

IOException

assertEmptyTranslog

public void assertEmptyTranslog(String index)
                         throws Exception

Asserts that we do not retain any extra translog for the given index (i.e., turn off the translog retention)

Throws:

Exception

ensurePeerRecoveryRetentionLeasesRenewedAndSynced

public void ensurePeerRecoveryRetentionLeasesRenewedAndSynced(String index)
                                                       throws Exception

Peer recovery retention leases are renewed and synced to replicas periodically (every 30 seconds). This ensures that we have renewed every PRRL to the global checkpoint of the corresponding copy and properly synced to all copies.

Throws:

Exception

minimumNodeVersion

protected static org.opensearch.Version minimumNodeVersion()
                                                    throws IOException

Returns the minimum node version among all nodes of the cluster

Throws:

IOException

syncedFlush

protected void syncedFlush(String indexName,
 boolean retryOnConflict)
                    throws Exception

Throws:

Exception

useIgnoreMultipleMatchingTemplatesWarningsHandler

protected static void useIgnoreMultipleMatchingTemplatesWarningsHandler(org.opensearch.client.Request request)
                                                                 throws IOException

Throws:

IOException