Package org.elasticsearch.test.rest.yaml

Class ESClientYamlSuiteTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.util.LuceneTestCase

org.elasticsearch.test.ESTestCase

org.elasticsearch.test.rest.ESRestTestCase

org.elasticsearch.test.rest.yaml.ESClientYamlSuiteTestCase

public abstract class ESClientYamlSuiteTestCase
extends ESRestTestCase

Runs a suite of yaml tests shared with all the official Elasticsearch clients against against an elasticsearch 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.elasticsearch.test.rest.ESRestTestCase

ESRestTestCase.VersionSensitiveWarningsHandler

Nested classes/interfaces inherited from class org.elasticsearch.test.ESTestCase

ESTestCase.DeprecationWarning, ESTestCase.GeohashGenerator, ESTestCase.TestAnalysis

Nested classes/interfaces inherited from class org.apache.lucene.util.LuceneTestCase

LuceneTestCase.AwaitsFix, LuceneTestCase.BadApple, LuceneTestCase.Monster, LuceneTestCase.Nightly, LuceneTestCase.Slow, LuceneTestCase.SuppressCodecs, LuceneTestCase.SuppressFileSystems, LuceneTestCase.SuppressFsync, LuceneTestCase.SuppressReproduceLine, LuceneTestCase.SuppressSysoutChecks, LuceneTestCase.SuppressTempFileChecks, LuceneTestCase.ThrowingRunnable, LuceneTestCase.Weekly

Field Summary

Fields

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

Fields inherited from class org.elasticsearch.test.rest.ESRestTestCase

CERTIFICATE_AUTHORITIES, CLIENT_CERT_PATH, CLIENT_KEY_PASSWORD, CLIENT_KEY_PATH, CLIENT_PATH_PREFIX, CLIENT_SOCKET_TIMEOUT, TRUSTSTORE_PASSWORD, TRUSTSTORE_PATH

Fields inherited from class org.elasticsearch.test.ESTestCase

checkIndexFailures, DEFAULT_NAMED_WRITABLE_REGISTRY, DEFAULT_TEST_WORKER_ID, failureAndSuccessEvents, FIPS_SYSPROP, IGNORED_TIMEZONE_IDS, JAVA_TIMEZONE_IDS, JAVA_ZONE_IDS, JODA_TIMEZONE_IDS, logger, MIN_PRIVATE_PORT, TEST_WORKER_SYS_PROPERTY, TEST_WORKER_VM_ID

Fields inherited from class org.apache.lucene.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_BADAPPLES, SYSPROP_FAILFAST, SYSPROP_MAXFAILURES, SYSPROP_MONSTER, SYSPROP_NIGHTLY, SYSPROP_SLOW, SYSPROP_WEEKLY, TEST_ASSERTS_ENABLED, TEST_AWAITSFIX, TEST_BADAPPLES, TEST_CODEC, TEST_DIRECTORY, TEST_DOCVALUESFORMAT, TEST_LINE_DOCS_FILE, TEST_MONSTER, TEST_NIGHTLY, TEST_POSTINGSFORMAT, TEST_SLOW, TEST_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ESClientYamlSuiteTestCase(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(String[] testPaths)	Create parameters for this parameterized test.
static Iterable<Object[]>	createParameters(org.elasticsearch.xcontent.NamedXContentRegistry executeableSectionRegistry)	Create parameters for this parameterized test.
static Iterable<Object[]>	createParameters(org.elasticsearch.xcontent.NamedXContentRegistry executeableSectionRegistry, String[] testPaths)	Create parameters for this parameterized test.
protected ClientYamlTestExecutionContext	getAdminExecutionContext()
protected RequestOptions	getCatNodesVersionMasterRequestOptions()
protected final 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, RestClient restClient, List<org.apache.http.HttpHost> hosts, Version esVersion, Version masterVersion, String os)
static void	initializeUseDefaultNumberOfShards()
protected Version	overwriteEsVersion(Version esVersionFromApi)	Allows test suites to return another version then the lowest version returned from the cat node api.
protected boolean	randomizeContentType()
void	test()

Methods inherited from class org.elasticsearch.test.rest.ESRestTestCase

adminClient, aliasExists, aliasExists, allowTypesRemovalWarnings, assertEmptyTranslog, assertNoFileBasedRecovery, assertOK, basicAuthHeaderValue, buildClient, buildHttpHost, cleanUpCluster, client, closeClients, closeIndex, configureClient, createIndex, createIndex, createIndex, createSnapshot, createSnapshot, deleteAllNodeShutdownMetadata, deleteIndex, deleteIndex, deleteRepository, deleteSnapshot, deleteSnapshot, ensureGreen, ensureHealth, ensureHealth, ensureHealth, ensureNoInitializingShards, ensurePeerRecoveryRetentionLeasesRenewedAndSynced, entityAsList, entityAsMap, expectSoftDeletesWarning, expectTranslogRetentionWarning, expectVersionSpecificWarnings, expectWarnings, fieldCaps, flush, getAlias, getAsMap, getClusterHosts, getEnsureGreenTimeout, getHasXPack, getIndexSettings, getIndexSettings, getIndexSettingsAsMap, getProtocol, getTestRestCluster, hasXPack, indexExists, initClient, isNotFoundResponseException, isXPackTemplate, minimumNodeVersion, openIndex, performSyncedFlush, preserveAutoFollowPatternsUponCompletion, preserveClusterSettings, preserveClusterUponCompletion, preserveDataStreamsUponCompletion, preserveILMPoliciesUponCompletion, preserveILMPolicyIds, preserveIndicesUponCompletion, preserveReposUponCompletion, preserveRollupJobsUponCompletion, preserveSearchableSnapshotsIndicesUponCompletion, preserveSLMPoliciesUponCompletion, preserveSnapshotsUponCompletion, preserveTemplatesUponCompletion, refreshAllIndices, registerRepository, registerRepository, responseAsMap, restAdminSettings, restClientSettings, restoreSnapshot, updateIndexSettings, useIgnoreMultipleMatchingTemplatesWarningsHandler, waitForActiveLicense, waitForAllSnapshotsWiped, waitForPendingTasks, waitForPendingTasks, wipeAllIndices, wipeDataStreams, wipeSearchableSnapshotsIndices, wipeSnapshots

Methods inherited from class org.elasticsearch.test.ESTestCase

after, afterIfFailed, afterIfSuccessful, allowedWarnings, assertArrayEquals, assertBusy, assertBusy, assertEquals, assertSettingDeprecationsAndWarnings, assertWarnings, 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, ensureNoWarnings, ensureSupportedLocale, filteredWarnings, frequently, generateRandomStringArray, generateRandomStringArray, getDataPath, getPortRange, getSuiteFailureMarker, getTestTransportPlugin, getTestTransportType, getWorkerBasePort, inFipsJvm, isTurkishLocale, iterations, maybeSet, mockScript, newEnvironment, newEnvironment, newNodeEnvironment, newNodeEnvironment, randomAlphaOfLength, randomAlphaOfLengthBetween, randomArray, randomArray, randomBigInteger, randomBoolean, randomByte, randomByteArrayOfLength, randomDateFormatterPattern, randomDateTimeZone, randomDouble, randomDoubleBetween, randomFloat, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomGeohash, randomInt, randomInt, randomIntBetween, randomIp, randomJodaAndJavaSupportedTimezone, randomList, randomList, randomLong, randomLongBetween, randomMap, randomMillisUpToYear9999, randomNonEmptySubsetOf, randomNonNegativeByte, randomNonNegativeLong, randomPositiveTimeValue, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomShort, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomTimeValue, randomTimeValue, randomTimeZone, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomValueOtherThan, randomValueOtherThanMany, randomZone, removeHeaderWarningAppender, resetCheckIndexStatus, resetPortCounter, restoreContentType, restoreFileSystem, safeAwait, safeAwait, scaledRandomIntBetween, setContentType, setFileSystem, setHeaderWarningAppender, settings, shuffleMap, shuffleXContent, shuffleXContent, spinForAtLeastNMilliseconds, spinForAtLeastOneMillisecond, terminate, terminate, tmpPaths, toShuffledXContent, waitUntil, waitUntil, writableRegistry, xContentRegistry

Methods inherited from class org.apache.lucene.util.LuceneTestCase

addVirusChecker, assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertFieldInfosEquals, assertNormsEquals, assertPointsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, asSet, assumeFalse, assumeNoException, assumeTrue, assumeWorkingMMapOnWindows, atLeast, atLeast, callStackContains, callStackContains, callStackContainsAnyOf, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, ensureSaneIWCOnNightly, expectThrows, expectThrows, expectThrows, expectThrowsAnyOf, expectThrowsAnyOf, getBaseTempDirForTestClass, getDataInputStream, getOnlyLeafReader, getTestClass, getTestName, hasWorkingMMapOnWindows, 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, newStringField, newStringField, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, overrideDefaultQueryCache, overrideTestDefaultQueryCache, random, randomLocale, randomTimeZone, rarely, rarely, replaceMaxFailureRule, resetDefaultQueryCache, restoreCPUCoreCount, restoreIndexWriterMaxDocs, restoreSpins, runWithRestrictedPermissions, setIndexWriterMaxDocs, setUp, setupCPUCoreCount, setupSpins, slowFileExists, tearDown, 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, assertThat, assertThat, 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_BLACKLIST

public static final String REST_TESTS_BLACKLIST

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

See Also:

• Constant Field Values

REST_TESTS_BLACKLIST_ADDITIONS

public static final String REST_TESTS_BLACKLIST_ADDITIONS

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

See Also:

• Constant Field Values

Constructor Details

ESClientYamlSuiteTestCase

protected ESClientYamlSuiteTestCase(ClientYamlTestCandidate testCandidate)

Method Details

initializeUseDefaultNumberOfShards

public static void initializeUseDefaultNumberOfShards()

initAndResetContext

public void initAndResetContext()
                         throws Exception

Throws:

Exception

overwriteEsVersion

protected Version overwriteEsVersion(Version esVersionFromApi)

Allows test suites to return another version then the lowest version returned from the cat node api. For example, in rolling upgrade bwc tests, the version of the old cluster should be used, and if the cluster is fully upgraded then the cat api doesn't return the version of the old cluster. These tests provide the es version via system property.

initClientYamlTestClient

protected ClientYamlTestClient initClientYamlTestClient(ClientYamlSuiteRestSpec restSpec,
 RestClient restClient,
 List<org.apache.http.HttpHost> hosts,
 Version esVersion,
 Version masterVersion,
 String os)

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.elasticsearch.xcontent.NamedXContentRegistry executeableSectionRegistry)
                                           throws Exception

Create parameters for this parameterized test.

Throws:

Exception

createParameters

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

Create parameters for this parameterized test.

Throws:

Exception

createParameters

public static Iterable<Object[]> createParameters(org.elasticsearch.xcontent.NamedXContentRegistry executeableSectionRegistry,
 String[] testPaths)
                                           throws Exception

Create parameters for this parameterized test.

Parameters:

executeableSectionRegistry - registry of executable sections

testPaths - list of paths to explicitly search for tests. If null then include all tests in root path.

Returns:

list of test candidates.

Throws:

Exception

getAdminExecutionContext

protected ClientYamlTestExecutionContext getAdminExecutionContext()

getCatNodesVersionMasterRequestOptions

protected RequestOptions getCatNodesVersionMasterRequestOptions()

test

public void test()
          throws IOException

Throws:

IOException

randomizeContentType

protected boolean randomizeContentType()

getClientBuilderWithSniffedHosts

protected final RestClientBuilder getClientBuilderWithSniffedHosts()
                                                            throws IOException

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

Throws:

IOException