Class AbstractFullClusterRestartTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.opensearch.test.OpenSearchTestCase

org.opensearch.test.rest.OpenSearchRestTestCase

org.opensearch.upgrades.AbstractFullClusterRestartTestCase

public abstract class AbstractFullClusterRestartTestCase
extends OpenSearchRestTestCase

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.test.rest.OpenSearchRestTestCase

OpenSearchRestTestCase.VersionSensitiveWarningsHandler

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 inherited from class org.opensearch.test.rest.OpenSearchRestTestCase

CLIENT_PATH_PREFIX, CLIENT_SOCKET_TIMEOUT, TRUSTSTORE_PASSWORD, 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
AbstractFullClusterRestartTestCase()

Method Summary

Modifier and Type	Method	Description
protected static void	assertNoFailures(Map<?,?> response)
protected void	assertTotalHits(int expectedTotalHits, Map<?,?> response)
protected static int	extractTotalHits(Map<?,?> response)
static org.opensearch.Version	getOldClusterVersion()
protected final boolean	isRunningAgainstAncientCluster()
static boolean	isRunningAgainstOldCluster()
protected boolean	preserveClusterSettings()	Controls whether or not to preserve cluster settings upon completion of the 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.

Methods inherited from class org.opensearch.test.rest.OpenSearchRestTestCase

adminClient, aliasExists, aliasExists, allowTypesRemovalWarnings, assertEmptyTranslog, assertNoFileBasedRecovery, assertOK, buildClient, buildHttpHost, cleanUpCluster, client, closeClients, closeIndex, configureClient, createIndex, createIndex, createIndex, createSnapshot, deleteIndex, deleteRepository, ensureGreen, ensureHealth, ensureHealth, ensureHealth, ensureNoInitializingShards, ensurePeerRecoveryRetentionLeasesRenewedAndSynced, entityAsList, entityAsMap, expectSoftDeletesWarning, expectVersionSpecificWarnings, expectWarnings, expectWarningsOnce, flush, getAlias, getAsMap, getClusterHosts, getIndexSettings, getIndexSettingsAsMap, getProtocol, getTestRestCluster, indexExists, initClient, minimumNodeVersion, openIndex, preserveClusterUponCompletion, refreshAllIndices, registerRepository, responseAsMap, restAdminSettings, restClientSettings, restoreSnapshot, syncedFlush, updateIndexSettings, useIgnoreMultipleMatchingTemplatesWarningsHandler, waitForAllSnapshotsWiped, waitForPendingTasks, waitForPendingTasks, wipeAllIndices, wipeDataStreams, wipeSnapshots

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

Constructor Details

AbstractFullClusterRestartTestCase

public AbstractFullClusterRestartTestCase()

Method Details

isRunningAgainstOldCluster

public static boolean isRunningAgainstOldCluster()

isRunningAgainstAncientCluster

protected final boolean isRunningAgainstAncientCluster()

Returns:

true if test is running against an old cluster before that last major, in this case when System.getProperty("tests.is_old_cluster" == true) and oldClusterVersion is before Version.V_2_0_0

getOldClusterVersion

public static org.opensearch.Version getOldClusterVersion()

preserveIndicesUponCompletion

protected boolean preserveIndicesUponCompletion()

Description copied from class: OpenSearchRestTestCase

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).

Overrides:

preserveIndicesUponCompletion in class OpenSearchRestTestCase

preserveSnapshotsUponCompletion

protected boolean preserveSnapshotsUponCompletion()

Description copied from class: OpenSearchRestTestCase

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

Overrides:

preserveSnapshotsUponCompletion in class OpenSearchRestTestCase

preserveReposUponCompletion

protected boolean preserveReposUponCompletion()

Description copied from class: OpenSearchRestTestCase

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

Overrides:

preserveReposUponCompletion in class OpenSearchRestTestCase

preserveTemplatesUponCompletion

protected boolean preserveTemplatesUponCompletion()

Description copied from class: OpenSearchRestTestCase

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

Overrides:

preserveTemplatesUponCompletion in class OpenSearchRestTestCase

Returns:

whether or not to preserve templates

preserveClusterSettings

protected boolean preserveClusterSettings()

Description copied from class: OpenSearchRestTestCase

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

Overrides:

preserveClusterSettings in class OpenSearchRestTestCase

Returns:

true if cluster settings should be preserved and otherwise false

preserveSLMPoliciesUponCompletion

protected boolean preserveSLMPoliciesUponCompletion()

Description copied from class: OpenSearchRestTestCase

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.

Overrides:

preserveSLMPoliciesUponCompletion in class OpenSearchRestTestCase

preserveDataStreamsUponCompletion

protected boolean preserveDataStreamsUponCompletion()

Description copied from class: OpenSearchRestTestCase

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

Overrides:

preserveDataStreamsUponCompletion in class OpenSearchRestTestCase

Returns:

whether or not to preserve data streams

assertNoFailures

protected static void assertNoFailures(Map<?,?> response)

assertTotalHits

protected void assertTotalHits(int expectedTotalHits,
 Map<?,?> response)

extractTotalHits

protected static int extractTotalHits(Map<?,?> response)