org.elasticsearch.test.rest

Class ESRestTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.util.LuceneTestCase

org.elasticsearch.test.ESTestCase

org.elasticsearch.test.rest.ESRestTestCase

public abstract class ESRestTestCase
extends ESTestCase

Runs the clients test suite against an elasticsearch cluster.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REST_LOAD_PACKAGED_TESTS
static java.lang.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 java.lang.String	REST_TESTS_SPEC Property that allows to control where the REST spec files need to be loaded from
static java.lang.String	REST_TESTS_SUITE Property that allows to control which REST tests get run.
static java.lang.String	REST_TESTS_VALIDATE_SPEC Property that allows to control whether spec validation is enabled or not (default true).

Fields inherited from class org.elasticsearch.test.ESTestCase

checkIndexFailed, failureAndSuccessEvents, logger

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_CODEC, TEST_DIRECTORY, TEST_DOCVALUESFORMAT, TEST_LINE_DOCS_FILE, TEST_NIGHTLY, TEST_POSTINGSFORMAT, TEST_SLOW, TEST_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Constructor and Description
ESRestTestCase(RestTestCandidate testCandidate)

Method Summary

Modifier and Type	Method and Description
protected void	afterIfFailed(java.util.List<java.lang.Throwable> errors) Called when a test fails, supplying the errors it generated.
static void	close()
static java.lang.Iterable<java.lang.Object[]>	createParameters(int id, int count)
protected RestTestExecutionContext	getAdminExecutionContext()
static void	initExecutionContext()
void	logIfThereAreRunningTasks() Logs a message if there are still running tasks.
void	reset()
protected org.elasticsearch.common.settings.Settings	restAdminSettings() Returns the REST client settings used for admin actions like cleaning up after the test has completed.
protected org.elasticsearch.common.settings.Settings	restClientSettings() Used to obtain settings for the REST client that is used to send REST requests.
java.util.Set<java.lang.String>	runningTasks(RestTestResponse response)
void	test()
void	wipeCluster()

Methods inherited from class org.elasticsearch.test.ESTestCase

afterIfSuccessful, assertAllIndicesRemovedAndDeletionCompleted, assertArrayEquals, assertBusy, assertBusy, assertEquals, assertionsEnabled, assertPathHasBeenCleared, awaitBusy, awaitBusy, between, createAnalysisService, createAnalysisService, createAnalysisService, ensureAllSearchContextsReleased, ensureCheckIndexPassed, ensureCleanedUp, frequently, generateRandomStringArray, generateRandomStringArray, getBwcIndicesPath, getDataPath, getSuiteFailureMarker, iterations, maybeSet, newNodeEnvironment, newNodeEnvironment, newTestScriptModule, randomAsciiOfLength, randomAsciiOfLengthBetween, randomBoolean, randomByte, randomDateTimeZone, randomDouble, randomDoubleBetween, randomFloat, randomFrom, randomFrom, randomFrom, randomInt, randomInt, randomIntBetween, randomLong, randomPositiveTimeValue, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomShort, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomValueOtherThan, randomValueOtherThanMany, resetCheckIndexStatus, restoreContentType, restoreFileSystem, scaledRandomIntBetween, setContentType, setFileSystem, settings, shuffleXContent, spinForAtLeastOneMillisecond, terminate, terminate, tmpPaths

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

addVirusChecker, assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertFieldInfosEquals, assertFieldsEquals, assertFieldStatisticsEquals, assertNormsEquals, assertPointsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, asSet, assumeFalse, assumeNoException, assumeTrue, atLeast, atLeast, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, expectThrows, getBaseTempDirForTestClass, getDataInputStream, getOnlyLeafReader, getTestClass, getTestName, isTestThread, localeForLanguageTag, maybeChangeLiveIndexWriterConfig, maybeWrapReader, newAlcoholicMergePolicy, newAlcoholicMergePolicy, newDirectory, newDirectory, newDirectory, newDirectory, newDirectory, newField, newField, newFSDirectory, newFSDirectory, newIndexWriterConfig, newIndexWriterConfig, newIndexWriterConfig, newIOContext, newIOContext, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newMaybeVirusCheckingDirectory, newMaybeVirusCheckingFSDirectory, newMergePolicy, newMergePolicy, newMockDirectory, newMockDirectory, newMockDirectory, newMockFSDirectory, newMockFSDirectory, 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, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REST_TESTS_SUITE

public static final java.lang.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 java.lang.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_VALIDATE_SPEC

public static final java.lang.String REST_TESTS_VALIDATE_SPEC

Property that allows to control whether spec validation is enabled or not (default true).

See Also:

Constant Field Values

REST_TESTS_SPEC

public static final java.lang.String REST_TESTS_SPEC

Property that allows to control where the REST spec files need to be loaded from

See Also:

Constant Field Values

REST_LOAD_PACKAGED_TESTS

public static final java.lang.String REST_LOAD_PACKAGED_TESTS

See Also:

Constant Field Values

Constructor Detail

ESRestTestCase

public ESRestTestCase(RestTestCandidate testCandidate)

Method Detail

afterIfFailed

protected void afterIfFailed(java.util.List<java.lang.Throwable> errors)

Description copied from class: ESTestCase

Called when a test fails, supplying the errors it generated. Not called when the test fails because assumptions are violated.

Overrides:

afterIfFailed in class ESTestCase

createParameters

public static java.lang.Iterable<java.lang.Object[]> createParameters(int id,
                                                                      int count)
                                                               throws java.io.IOException,
                                                                      RestTestParseException

Throws:

java.io.IOException

RestTestParseException

initExecutionContext

public static void initExecutionContext()
                                 throws java.io.IOException

Throws:

java.io.IOException

getAdminExecutionContext

protected RestTestExecutionContext getAdminExecutionContext()

wipeCluster

public void wipeCluster()
                 throws java.lang.Exception

Throws:

java.lang.Exception

logIfThereAreRunningTasks

public void logIfThereAreRunningTasks()
                               throws java.lang.InterruptedException,
                                      java.io.IOException

Logs a message if there are still running tasks. The reasoning is that any tasks still running are state the is trying to bleed into other tests.

Throws:

java.lang.InterruptedException

java.io.IOException

close

public static void close()

restClientSettings

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

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

restAdminSettings

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

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

reset

public void reset()
           throws java.io.IOException

Throws:

java.io.IOException

test

public void test()
          throws java.io.IOException

Throws:

java.io.IOException

runningTasks

public java.util.Set<java.lang.String> runningTasks(RestTestResponse response)
                                             throws java.io.IOException

Throws:

java.io.IOException