Class OpenSearchMockAPIBasedRepositoryIntegTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.opensearch.test.OpenSearchTestCase

org.opensearch.test.OpenSearchIntegTestCase

org.opensearch.repositories.blobstore.OpenSearchBlobStoreRepositoryIntegTestCase

org.opensearch.repositories.blobstore.OpenSearchMockAPIBasedRepositoryIntegTestCase

@SuppressFileSystems({"WindowsFS","ExtrasFS"})
public abstract class OpenSearchMockAPIBasedRepositoryIntegTestCase
extends OpenSearchBlobStoreRepositoryIntegTestCase

Integration tests for BlobStoreRepository implementations rely on mock APIs that emulate cloud-based services.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	OpenSearchMockAPIBasedRepositoryIntegTestCase.BlobStoreHttpHandler	A HttpHandler that allows to list stored blobs
static interface	OpenSearchMockAPIBasedRepositoryIntegTestCase.DelegatingHttpHandler
protected static class	OpenSearchMockAPIBasedRepositoryIntegTestCase.ErroneousHttpHandler	HTTP handler that injects random service errors
static class	OpenSearchMockAPIBasedRepositoryIntegTestCase.HttpStatsCollectorHandler	HTTP handler that allows collect request stats per request type.

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 Map<String, HttpHandler>	handlers

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

Method Summary

Modifier and Type	Method	Description
protected abstract HttpHandler	createErroneousHttpHandler(HttpHandler delegate)
protected abstract Map<String, HttpHandler>	createHttpHandlers()
protected static void	drainInputStream(InputStream inputStream)	Consumes and closes the given InputStream
protected Map<String,Long>	getMockRequestCounts()
protected static String	httpServerUrl()
void	setUpHttpServer()
static void	startHttpServer()
static void	stopHttpServer()
void	tearDownHttpServer()
void	testRequestStats()
void	testSnapshotWithLargeSegmentFiles()	Test the snapshot and restore of an index which has large segments files.
static OpenSearchMockAPIBasedRepositoryIntegTestCase.DelegatingHttpHandler	wrap(HttpHandler handler, org.apache.logging.log4j.Logger logger)	Wrap a HttpHandler to log any thrown exception using the given Logger.

Methods inherited from class org.opensearch.repositories.blobstore.OpenSearchBlobStoreRepositoryIntegTestCase

addRandomDocuments, assertSuccessfulRestore, assertSuccessfulSnapshot, createRepository, createRepository, getRepositoryData, newBlobStore, randomBytes, randomName, readBlobFully, repositorySettings, repositoryType, testContainerCreationAndDeletion, testDeleteBlobs, testIndicesDeletedFromRepository, testList, testMultipleSnapshotAndRollback, testReadNonExistingPath, testReadRange, testSnapshotAndRestore, testWriteRead, writeBlob, writeBlob, writeRandomBlob

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, indexSettings, internalCluster, isInternalCluster, isMigratingToRemoteStore, isolateClusterManagerDisruption, isSegmentReplicationEnabledForIndex, logClusterState, manageReplicaBalanceSetting, manageReplicaSettingForDefaultReplica, maximumNumberOfReplicas, maximumNumberOfShards, minimumNumberOfReplicas, minimumNumberOfShards, nodeConfigPath, nodePlugins, nodeSettings, 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

handlers

protected Map<String, HttpHandler> handlers

Constructor Details

OpenSearchMockAPIBasedRepositoryIntegTestCase

public OpenSearchMockAPIBasedRepositoryIntegTestCase()

Method Details

startHttpServer

public static void startHttpServer()
                            throws Exception

Throws:

Exception

setUpHttpServer

public void setUpHttpServer()

stopHttpServer

public static void stopHttpServer()

tearDownHttpServer

public void tearDownHttpServer()

createHttpHandlers

protected abstract Map<String, HttpHandler> createHttpHandlers()

createErroneousHttpHandler

protected abstract HttpHandler createErroneousHttpHandler(HttpHandler delegate)

testSnapshotWithLargeSegmentFiles

public void testSnapshotWithLargeSegmentFiles()
                                       throws Exception

Test the snapshot and restore of an index which has large segments files.

Throws:

Exception

testRequestStats

public void testRequestStats()
                      throws Exception

Throws:

Exception

getMockRequestCounts

protected Map<String,Long> getMockRequestCounts()

httpServerUrl

protected static String httpServerUrl()

drainInputStream

protected static void drainInputStream(InputStream inputStream)
                                throws IOException

Consumes and closes the given InputStream

Throws:

IOException

wrap

public static OpenSearchMockAPIBasedRepositoryIntegTestCase.DelegatingHttpHandler wrap(HttpHandler handler,
 org.apache.logging.log4j.Logger logger)

Wrap a HttpHandler to log any thrown exception using the given Logger.