Class OpenSearchClientYamlSuiteTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.opensearch.test.OpenSearchTestCase

org.opensearch.test.rest.OpenSearchRestTestCase

org.opensearch.test.rest.yaml.OpenSearchClientYamlSuiteTestCase

public abstract class OpenSearchClientYamlSuiteTestCase
extends OpenSearchRestTestCase

Runs a suite of yaml tests shared with all the official OpenSearch clients against an opensearch cluster.

The suite timeout is extended to account for projects with a large number of tests.

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

Modifier and Type	Field	Description
static final String	REST_TESTS_DENYLIST	Property that allows to denylist some of the REST tests based on a comma separated list of globs e.g.
static final String	REST_TESTS_DENYLIST_ADDITIONS	We use tests.rest.denylist in build files to denylist tests; this property enables a user to add additional denylisted tests on top of the tests denylisted in the build.
static final String	REST_TESTS_SUITE	Property that allows to control which REST tests get run.

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

Modifier	Constructor	Description
protected	OpenSearchClientYamlSuiteTestCase(ClientYamlTestCandidate testCandidate)

Method Summary

Modifier and Type	Method	Description
static void	closeClient()
static Iterable<Object[]>	createParameters()	Create parameters for this parameterized test.
static Iterable<Object[]>	createParameters(org.opensearch.core.xcontent.NamedXContentRegistry executeableSectionRegistry)	Create parameters for this parameterized test.
protected ClientYamlTestExecutionContext	getAdminExecutionContext()
protected org.opensearch.client.RequestOptions	getCatNodesVersionClusterManagerRequestOptions()
protected final org.opensearch.client.RestClientBuilder	getClientBuilderWithSniffedHosts()	Sniff the cluster for host metadata and return a RestClientBuilder for a client with that metadata.
void	initAndResetContext()
protected ClientYamlTestClient	initClientYamlTestClient(ClientYamlSuiteRestSpec restSpec, org.opensearch.client.RestClient restClient, List<org.apache.hc.core5.http.HttpHost> hosts, org.opensearch.Version esVersion, org.opensearch.Version clusterManagerVersion)
static void	initializeUseDefaultNumberOfShards()
protected boolean	randomizeContentType()
void	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, preserveClusterSettings, preserveClusterUponCompletion, preserveDataStreamsUponCompletion, preserveIndicesUponCompletion, preserveReposUponCompletion, preserveSLMPoliciesUponCompletion, preserveSnapshotsUponCompletion, preserveTemplatesUponCompletion, 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

Field Details

REST_TESTS_SUITE

public static final String REST_TESTS_SUITE

Property that allows to control which REST tests get run. Supports comma separated list of tests or directories that contain tests e.g. -Dtests.rest.suite=index,get,create/10_with_id

See Also:

• Constant Field Values

REST_TESTS_DENYLIST

public static final String REST_TESTS_DENYLIST

Property that allows to denylist some of the REST tests based on a comma separated list of globs e.g. "-Dtests.rest.denylist=get/10_basic/*"

See Also:

• Constant Field Values

REST_TESTS_DENYLIST_ADDITIONS

public static final String REST_TESTS_DENYLIST_ADDITIONS

We use tests.rest.denylist in build files to denylist tests; this property enables a user to add additional denylisted tests on top of the tests denylisted in the build.

See Also:

• Constant Field Values

Constructor Details

OpenSearchClientYamlSuiteTestCase

protected OpenSearchClientYamlSuiteTestCase(ClientYamlTestCandidate testCandidate)

Method Details

initializeUseDefaultNumberOfShards

public static void initializeUseDefaultNumberOfShards()

initAndResetContext

public void initAndResetContext()
                         throws Exception

Throws:

Exception

initClientYamlTestClient

protected ClientYamlTestClient initClientYamlTestClient(ClientYamlSuiteRestSpec restSpec,
 org.opensearch.client.RestClient restClient,
 List<org.apache.hc.core5.http.HttpHost> hosts,
 org.opensearch.Version esVersion,
 org.opensearch.Version clusterManagerVersion)

closeClient

public static void closeClient()
                        throws IOException

Throws:

IOException

createParameters

public static Iterable<Object[]> createParameters()
                                           throws Exception

Create parameters for this parameterized test. Uses the list of executable sections defined in ExecutableSection.

Throws:

Exception

createParameters

public static Iterable<Object[]> createParameters(org.opensearch.core.xcontent.NamedXContentRegistry executeableSectionRegistry)
                                           throws Exception

Create parameters for this parameterized test.

Throws:

Exception

getAdminExecutionContext

protected ClientYamlTestExecutionContext getAdminExecutionContext()

getCatNodesVersionClusterManagerRequestOptions

protected org.opensearch.client.RequestOptions getCatNodesVersionClusterManagerRequestOptions()

test

public void test()
          throws IOException

Throws:

IOException

randomizeContentType

protected boolean randomizeContentType()

getClientBuilderWithSniffedHosts

protected final org.opensearch.client.RestClientBuilder getClientBuilderWithSniffedHosts()
                                                                                  throws IOException

Sniff the cluster for host metadata and return a RestClientBuilder for a client with that metadata.

Throws:

IOException