org.junit.Assert

org.apache.lucene.util.LuceneTestCase

org.elasticsearch.test.ESTestCase

@Listeners({ReproduceInfoPrinter.class,LoggingListener.class}) @SuppressSysoutChecks(bugUrl="we log a lot on purpose") @SuppressCodecs({"SimpleText","Memory","CheapBastard","Direct","Compressing","FST50","FSTOrd50","TestBloomFilteredLucenePostings","MockRandom","BlockTreeOrds","LuceneFixedGap","LuceneVarGapFixedInterval","LuceneVarGapDocFreqInterval","Lucene50"}) @SuppressReproduceLine public abstract class ESTestCase extends org.apache.lucene.util.LuceneTestCase

Base testcase for randomized unit testing with Elasticsearch

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

ESTestCase.GeohashGenerator

static class

ESTestCase.TestAnalysis

This cute helper class just holds all analysis building blocks that are used to build IndexAnalyzers.

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

Description

static List<Exception>

checkIndexFailures

MockFSDirectoryService sets this:

protected static org.elasticsearch.common.io.stream.NamedWriteableRegistry

DEFAULT_NAMED_WRITABLE_REGISTRY

static String

DEFAULT_TEST_WORKER_ID

org.junit.rules.RuleChain

failureAndSuccessEvents

static String

FIPS_SYSPROP

protected static List<String>

JAVA_TIMEZONE_IDS

protected static List<String>

JAVA_ZONE_IDS

protected static List<String>

JODA_TIMEZONE_IDS

protected org.apache.logging.log4j.Logger

logger

static int

MIN_PRIVATE_PORT

static String

TEST_WORKER_SYS_PROPERTY

static String

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

Constructor

Description

ESTestCase()
Method Summary

Modifier and Type

Method

Description

void

after()

protected void

afterIfFailed(List<Throwable> errors)

Called when a test fails, supplying the errors it generated.

protected void

afterIfSuccessful()

called after a test is finished, but only if successful

protected void

allowedWarnings(String... allowedWarnings)

Allow the given warnings, but don't require their presence.

static void

assertArrayEquals(StackTraceElement[] expected, StackTraceElement[] actual)

Compares two stack traces, ignoring module (which is not yet serialized)

static void

assertBusy(org.elasticsearch.core.CheckedRunnable<Exception> codeBlock)

Runs the code block for 10 seconds waiting for no assertion to trip.

static void

assertBusy(org.elasticsearch.core.CheckedRunnable<Exception> codeBlock, long maxWaitTime, TimeUnit unit)

Runs the code block for the provided interval, waiting for no assertions to trip.

static void

assertEquals(StackTraceElement expected, StackTraceElement actual)

Compares two stack trace elements, ignoring module (which is not yet serialized)

protected void

assertSettingDeprecationsAndWarnings(String[] settings, String... warnings)

protected void

assertSettingDeprecationsAndWarnings(org.elasticsearch.common.settings.Setting<?>[] settings, String... warnings)

Convenience method to assert warnings for settings deprecations and general deprecation warnings.

protected void

assertWarnings(boolean stripXContentPosition, String... expectedWarnings)

protected void

assertWarnings(String... expectedWarnings)

void

before()

static int

between(int min, int max)

An alias for randomIntBetween(int, int).

org.elasticsearch.common.settings.Settings

buildEnvSettings(org.elasticsearch.common.settings.Settings settings)

static org.elasticsearch.common.transport.TransportAddress

buildNewFakeTransportAddress()

Generates a new transport address using TransportAddress.META_ADDRESS with an incrementing port number.

protected static void

checkStaticState()

static void

clearAdditionalRoles()

protected static <T> T

copyInstance(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.elasticsearch.common.io.stream.Writeable.Writer<T> writer, org.elasticsearch.common.io.stream.Writeable.Reader<T> reader, org.elasticsearch.Version version)

static <T extends org.elasticsearch.common.io.stream.NamedWriteable> T

copyNamedWriteable(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, Class<T> categoryClass)

Create a copy of an original NamedWriteable object by running it through a BytesStreamOutput and reading it in again using a provided Writeable.Reader.

static <T extends org.elasticsearch.common.io.stream.NamedWriteable> T

copyNamedWriteable(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, Class<T> categoryClass, org.elasticsearch.Version version)

Same as copyNamedWriteable(NamedWriteable, NamedWriteableRegistry, Class) but also allows to provide a Version argument which will be used to write and read back the object.

static <T extends org.elasticsearch.common.io.stream.Writeable> T

copyWriteable(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.elasticsearch.common.io.stream.Writeable.Reader<T> reader)

Create a copy of an original Writeable object by running it through a BytesStreamOutput and reading it in again using a provided Writeable.Reader.

static <T extends org.elasticsearch.common.io.stream.Writeable> T

copyWriteable(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.elasticsearch.common.io.stream.Writeable.Reader<T> reader, org.elasticsearch.Version version)

Same as copyWriteable(Writeable, NamedWriteableRegistry, Writeable.Reader) but also allows to provide a Version argument which will be used to write and read back the object.

protected org.elasticsearch.index.analysis.IndexAnalyzers

createDefaultIndexAnalyzers()

Creates an IndexAnalyzers with a single default analyzer

protected org.elasticsearch.common.xcontent.XContentParser

createParser(org.elasticsearch.common.xcontent.NamedXContentRegistry namedXContentRegistry, org.elasticsearch.common.xcontent.XContent xContent, org.elasticsearch.common.bytes.BytesReference data)

Create a new XContentParser.

protected org.elasticsearch.common.xcontent.XContentParser

createParser(org.elasticsearch.common.xcontent.XContentBuilder builder)

Create a new XContentParser.

protected org.elasticsearch.common.xcontent.XContentParser

createParser(org.elasticsearch.common.xcontent.XContent xContent, byte[] data)

Create a new XContentParser.

protected org.elasticsearch.common.xcontent.XContentParser

createParser(org.elasticsearch.common.xcontent.XContent xContent, InputStream data)

Create a new XContentParser.

protected org.elasticsearch.common.xcontent.XContentParser

createParser(org.elasticsearch.common.xcontent.XContent xContent, String data)

Create a new XContentParser.

protected org.elasticsearch.common.xcontent.XContentParser

createParser(org.elasticsearch.common.xcontent.XContent xContent, org.elasticsearch.common.bytes.BytesReference data)

Create a new XContentParser.

static ESTestCase.TestAnalysis

createTestAnalysis(org.elasticsearch.index.Index index, org.elasticsearch.common.settings.Settings nodeSettings, org.elasticsearch.common.settings.Settings settings, org.elasticsearch.plugins.AnalysisPlugin... analysisPlugins)

Creates an TestAnalysis with all the default analyzers configured.

static ESTestCase.TestAnalysis

createTestAnalysis(org.elasticsearch.index.Index index, org.elasticsearch.common.settings.Settings settings, org.elasticsearch.plugins.AnalysisPlugin... analysisPlugins)

Creates an TestAnalysis with all the default analyzers configured.

static ESTestCase.TestAnalysis

createTestAnalysis(org.elasticsearch.index.IndexSettings indexSettings, org.elasticsearch.common.settings.Settings nodeSettings, org.elasticsearch.plugins.AnalysisPlugin... analysisPlugins)

Creates an TestAnalysis with all the default analyzers configured.

protected boolean

enableJodaDeprecationWarningsCheck()

protected boolean

enableWarningsCheck()

Whether or not we check after each test whether it has left warnings behind.

void

ensureAllSearchContextsReleased()

void

ensureCheckIndexPassed()

static void

ensureSupportedLocale()

protected List<String>

filteredWarnings()

static boolean

frequently()

The exact opposite of LuceneTestCase.rarely().

static String[]

generateRandomStringArray(int maxArraySize, int stringSize, boolean allowNull)

static String[]

generateRandomStringArray(int maxArraySize, int stringSize, boolean allowNull, boolean allowEmpty)

protected static int

getBasePort()

Path

getDataPath(String relativePath)

Returns a Path pointing to the class path relative resource given as the first argument.

static String

getPortRange()

Returns a unique port range for this JVM starting from the computed base port

static org.apache.lucene.util.TestRuleMarkFailure

getSuiteFailureMarker()

Returns the suite failure marker: internal use only!

static Class<? extends org.elasticsearch.plugins.Plugin>

getTestTransportPlugin()

static String

getTestTransportType()

static boolean

inFipsJvm()

static int

iterations(int min, int max)

Returns a "scaled" number of iterations for loops which can have a variable iteration count.

static <T> void

maybeSet(Consumer<T> consumer, T value)

helper to randomly perform on consumer with value

static org.elasticsearch.script.Script

mockScript(String id)

Create a "mock" script for use either with MockScriptEngine or anywhere where you need a script but don't really care about its contents.

org.elasticsearch.env.Environment

newEnvironment()

org.elasticsearch.env.Environment

newEnvironment(org.elasticsearch.common.settings.Settings settings)

org.elasticsearch.env.NodeEnvironment

newNodeEnvironment()

org.elasticsearch.env.NodeEnvironment

newNodeEnvironment(org.elasticsearch.common.settings.Settings settings)

static String

randomAlphaOfLength(int codeUnits)

static String

randomAlphaOfLengthBetween(int minCodeUnits, int maxCodeUnits)

static <T> T[]

randomArray(int minArraySize, int maxArraySize, IntFunction<T[]> arrayConstructor, Supplier<T> valueConstructor)

static <T> T[]

randomArray(int maxArraySize, IntFunction<T[]> arrayConstructor, Supplier<T> valueConstructor)

static BigInteger

randomBigInteger()

Returns a random BigInteger uniformly distributed over the range 0 to (2^64 - 1) inclusive Currently BigIntegers are only used for unsigned_long field type, where the max value is 2^64 - 1.

static boolean

randomBoolean()

static byte

randomByte()

static byte[]

randomByteArrayOfLength(int size)

Helper method to create a byte array of a given length populated with random byte values

static String

randomDateFormatterPattern()

Generate a random valid date formatter pattern.

static org.joda.time.DateTimeZone

randomDateTimeZone()

generate a random DateTimeZone from the ones available in joda library

static double

randomDouble()

static double

randomDoubleBetween(double start, double end, boolean lowerInclusive)

Returns a double value in the interval [start, end) if lowerInclusive is set to true, (start, end) otherwise.

static float

randomFloat()

static <T> T

randomFrom(Collection<T> collection)

Pick a random object from the given collection.

static <T> T

randomFrom(List<T> list)

Pick a random object from the given list.

static <T> T

randomFrom(Random random, Collection<T> collection)

Pick a random object from the given collection.

static <T> T

randomFrom(Random random, T... array)

Pick a random object from the given array.

static <T> T

randomFrom(T... array)

Pick a random object from the given array.

static String

randomGeohash(int minPrecision, int maxPrecision)

static int

randomInt()

static int

randomInt(int max)

A random integer from 0..max (inclusive).

static int

randomIntBetween(int min, int max)

A random integer from min to max (inclusive).

protected static InetAddress

randomIp(boolean v4)

static <T> List<T>

randomList(int minListSize, int maxListSize, Supplier<T> valueConstructor)

static <T> List<T>

randomList(int maxListSize, Supplier<T> valueConstructor)

static long

randomLong()

static long

randomLongBetween(long min, long max)

A random long number between min (inclusive) and max (inclusive).

static <K, V> Map<K,V>

randomMap(int minMapSize, int maxMapSize, Supplier<org.elasticsearch.core.Tuple<K,V>> entryConstructor)

long

randomMillisUpToYear9999()

generate a random epoch millis in a range 1 to 9999-12-31T23:59:59.999

static byte

randomNonNegativeByte()

static long

randomNonNegativeLong()

static String

randomPositiveTimeValue()

static String

randomRealisticUnicodeOfCodepointLength(int codePoints)

static String

randomRealisticUnicodeOfCodepointLengthBetween(int minCodePoints, int maxCodePoints)

static String

randomRealisticUnicodeOfLength(int codeUnits)

static String

randomRealisticUnicodeOfLengthBetween(int minCodeUnits, int maxCodeUnits)

static short

randomShort()

static <T> List<T>

randomSubsetOf(int size, Collection<T> collection)

Returns size random values

static <T> List<T>

randomSubsetOf(int size, T... values)

Returns size random values

static <T> List<T>

randomSubsetOf(Collection<T> collection)

Returns a random subset of values (including a potential empty list, or the full original list)

static String

randomTimeValue()

static String

randomTimeValue(int lower, int upper)

static String

randomTimeValue(int lower, int upper, String... suffixes)

static TimeZone

randomTimeZone()

generate a random TimeZone from the ones available in java.util

static String

randomUnicodeOfCodepointLength(int codePoints)

static String

randomUnicodeOfCodepointLengthBetween(int minCodePoints, int maxCodePoints)

static String

randomUnicodeOfLength(int codeUnits)

static String

randomUnicodeOfLengthBetween(int minCodeUnits, int maxCodeUnits)

static <T> Set<T>

randomUnique(Supplier<T> supplier, int targetCount)

Builds a set of unique items.

static <T> T

randomValueOtherThan(T input, Supplier<T> randomSupplier)

helper to get a random value in a certain range that's different from the input

static <T> T

randomValueOtherThanMany(Predicate<T> input, Supplier<T> randomSupplier)

helper to get a random value in a certain range that's different from the input

static ZoneId

randomZone()

generate a random TimeZone from the ones available in java.time

void

removeHeaderWarningAppender()

void

resetCheckIndexStatus()

static void

resetPortCounter()

static void

restoreContentType()

static void

restoreFileSystem()

static int

scaledRandomIntBetween(int min, int max)

Returns a "scaled" random number between min and max (inclusive).

static void

setContentType()

static void

setFileSystem()

void

setHeaderWarningAppender()

static org.elasticsearch.common.settings.Settings.Builder

settings(org.elasticsearch.Version version)

Return consistent index settings for the provided index version.

static LinkedHashMap<String,Object>

shuffleMap(LinkedHashMap<String,Object> map, Set<String> exceptFields)

protected org.elasticsearch.common.xcontent.XContentBuilder

shuffleXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, String... exceptFieldNames)

Randomly shuffles the fields inside objects in the XContentBuilder passed in.

static org.elasticsearch.common.xcontent.XContentBuilder

shuffleXContent(org.elasticsearch.common.xcontent.XContentParser parser, boolean prettyPrint, String... exceptFieldNames)

Randomly shuffles the fields inside objects parsed using the XContentParser passed in.

protected static long

spinForAtLeastNMilliseconds(long ms)

protected static long

spinForAtLeastOneMillisecond()

static boolean

terminate(ExecutorService... services)

static boolean

terminate(org.elasticsearch.threadpool.ThreadPool threadPool)

String[]

tmpPaths()

Returns a random number of temporary paths.

protected org.elasticsearch.common.bytes.BytesReference

toShuffledXContent(org.elasticsearch.common.xcontent.ToXContent toXContent, org.elasticsearch.common.xcontent.XContentType xContentType, org.elasticsearch.common.xcontent.ToXContent.Params params, boolean humanReadable, String... exceptFieldNames)

Returns the bytes that represent the XContent output of the provided ToXContent object, using the provided XContentType.

static boolean

waitUntil(BooleanSupplier breakSupplier)

Periodically execute the supplied function until it returns true, or a timeout is reached.

static boolean

waitUntil(BooleanSupplier breakSupplier, long maxWaitTime, TimeUnit unit)

Periodically execute the supplied function until it returns true, or until the specified maximum wait time has elapsed.

protected org.elasticsearch.common.io.stream.NamedWriteableRegistry

writableRegistry()

The NamedWriteableRegistry to use for this test.

protected org.elasticsearch.common.xcontent.NamedXContentRegistry

xContentRegistry()

The NamedXContentRegistry to use for this test.

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, 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, 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, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- JODA_TIMEZONE_IDS
  
  protected static final List<String> JODA_TIMEZONE_IDS
- JAVA_TIMEZONE_IDS
  
  protected static final List<String> JAVA_TIMEZONE_IDS
- JAVA_ZONE_IDS
  
  protected static final List<String> JAVA_ZONE_IDS
- MIN_PRIVATE_PORT
  
  public static final int MIN_PRIVATE_PORT
  
  See Also:
  
  Constant Field Values
- TEST_WORKER_VM_ID
  
  public static final String TEST_WORKER_VM_ID
- TEST_WORKER_SYS_PROPERTY
  
  public static final String TEST_WORKER_SYS_PROPERTY
  
  See Also:
  
  Constant Field Values
- DEFAULT_TEST_WORKER_ID
  
  public static final String DEFAULT_TEST_WORKER_ID
  
  See Also:
  
  Constant Field Values
- FIPS_SYSPROP
  
  public static final String FIPS_SYSPROP
  
  See Also:
  
  Constant Field Values
- logger
  
  protected final org.apache.logging.log4j.Logger logger
- failureAndSuccessEvents
  
  public org.junit.rules.RuleChain failureAndSuccessEvents
- checkIndexFailures
  
  public static final List<Exception> checkIndexFailures
  
  MockFSDirectoryService sets this:
- DEFAULT_NAMED_WRITABLE_REGISTRY
  
  protected static final org.elasticsearch.common.io.stream.NamedWriteableRegistry DEFAULT_NAMED_WRITABLE_REGISTRY
Constructor Details
- ESTestCase
  
  public ESTestCase()
Method Details
- resetPortCounter
  
  public static void resetPortCounter()
- buildNewFakeTransportAddress
  
  public static org.elasticsearch.common.transport.TransportAddress buildNewFakeTransportAddress()
  
  Generates a new transport address using TransportAddress.META_ADDRESS with an incrementing port number. The port number starts at 0 and is reset after each test suite run.
- afterIfFailed
  
  protected void afterIfFailed(List<Throwable> errors)
  
  Called when a test fails, supplying the errors it generated. Not called when the test fails because assumptions are violated.
- afterIfSuccessful
  
  protected void afterIfSuccessful() throws Exception
  
  called after a test is finished, but only if successful
  
  Throws:
  
  Exception
- setFileSystem
  
  public static void setFileSystem() throws Exception
  
  Throws:
  
  Exception
- restoreFileSystem
  
  public static void restoreFileSystem() throws Exception
  
  Throws:
  
  Exception
- setContentType
  
  public static void setContentType() throws Exception
  
  Throws:
  
  Exception
- restoreContentType
  
  public static void restoreContentType()
- ensureSupportedLocale
  
  public static void ensureSupportedLocale()
- setHeaderWarningAppender
  
  public void setHeaderWarningAppender()
- removeHeaderWarningAppender
  
  public void removeHeaderWarningAppender()
- before
  
  public final void before()
- clearAdditionalRoles
  
  public static void clearAdditionalRoles()
- enableWarningsCheck
  
  protected boolean enableWarningsCheck()
  
  Whether or not we check after each test whether it has left warnings behind. That happens if any deprecated feature or syntax was used by the test and the test didn't assert on it using assertWarnings(String...).
- enableJodaDeprecationWarningsCheck
  
  protected boolean enableJodaDeprecationWarningsCheck()
- after
  
  public final void after() throws Exception
  
  Throws:
  
  Exception
- filteredWarnings
  
  protected List<String> filteredWarnings()
- assertSettingDeprecationsAndWarnings
  
  protected final void assertSettingDeprecationsAndWarnings(org.elasticsearch.common.settings.Setting<?>[] settings, String... warnings)
  
  Convenience method to assert warnings for settings deprecations and general deprecation warnings.
  
  Parameters:
  
  settings - the settings that are expected to be deprecated
  
  warnings - other expected general deprecation warnings
- assertSettingDeprecationsAndWarnings
  
  protected final void assertSettingDeprecationsAndWarnings(String[] settings, String... warnings)
- assertWarnings
  
  protected final void assertWarnings(String... expectedWarnings)
- allowedWarnings
  
  protected final void allowedWarnings(String... allowedWarnings)
  
  Allow the given warnings, but don't require their presence.
- assertWarnings
  
  protected final void assertWarnings(boolean stripXContentPosition, String... expectedWarnings)
- checkStaticState
  
  protected static void checkStaticState() throws Exception
  
  Throws:
  
  Exception
- ensureAllSearchContextsReleased
  
  public final void ensureAllSearchContextsReleased() throws Exception
  
  Throws:
  
  Exception
- resetCheckIndexStatus
  
  public final void resetCheckIndexStatus() throws Exception
  
  Throws:
  
  Exception
- ensureCheckIndexPassed
  
  public final void ensureCheckIndexPassed()
- scaledRandomIntBetween
  
  public static int scaledRandomIntBetween(int min, int max)
  
  Returns a "scaled" random number between min and max (inclusive).
  
  See Also:
  
  RandomizedTest.scaledRandomIntBetween(int, int)
- randomIntBetween
  
  public static int randomIntBetween(int min, int max)
  
  A random integer from min to max (inclusive).
  
  See Also:
  
  scaledRandomIntBetween(int, int)
- randomLongBetween
  
  public static long randomLongBetween(long min, long max)
  
  A random long number between min (inclusive) and max (inclusive).
- iterations
  
  public static int iterations(int min, int max)
  
  Returns a "scaled" number of iterations for loops which can have a variable iteration count. This method is effectively an alias to scaledRandomIntBetween(int, int).
- between
  
  public static int between(int min, int max)
  
  An alias for randomIntBetween(int, int).
  
  See Also:
  
  scaledRandomIntBetween(int, int)
- frequently
  
  public static boolean frequently()
  
  The exact opposite of LuceneTestCase.rarely().
- randomBoolean
  
  public static boolean randomBoolean()
- randomByte
  
  public static byte randomByte()
- randomNonNegativeByte
  
  public static byte randomNonNegativeByte()
- randomByteArrayOfLength
  
  public static byte[] randomByteArrayOfLength(int size)
  
  Helper method to create a byte array of a given length populated with random byte values
  
  See Also:
  
  randomByte()
- randomShort
  
  public static short randomShort()
- randomInt
  
  public static int randomInt()
- randomNonNegativeLong
  
  public static long randomNonNegativeLong()
  
  Returns:
  
  a long between 0 and Long.MAX_VALUE (inclusive) chosen uniformly at random.
- randomFloat
  
  public static float randomFloat()
- randomDouble
  
  public static double randomDouble()
- randomDoubleBetween
  
  public static double randomDoubleBetween(double start, double end, boolean lowerInclusive)
  
  Returns a double value in the interval [start, end) if lowerInclusive is set to true, (start, end) otherwise.
  
  Parameters:
  
  start - lower bound of interval to draw uniformly distributed random numbers from
  
  end - upper bound
  
  lowerInclusive - whether or not to include lower end of the interval
- randomLong
  
  public static long randomLong()
- randomBigInteger
  
  public static BigInteger randomBigInteger()
  
  Returns a random BigInteger uniformly distributed over the range 0 to (2^64 - 1) inclusive Currently BigIntegers are only used for unsigned_long field type, where the max value is 2^64 - 1. Modify this random generator if a wider range for BigIntegers is necessary.
  
  Returns:
  
  a random bigInteger in the range [0 ; 2^64 - 1]
- randomInt
  
  public static int randomInt(int max)
  
  A random integer from 0..max (inclusive).
- randomFrom
  
  @SafeVarargs public static <T> T randomFrom(T... array)
  
  Pick a random object from the given array. The array must not be empty.
- randomFrom
  
  @SafeVarargs public static <T> T randomFrom(Random random, T... array)
  
  Pick a random object from the given array. The array must not be empty.
- randomFrom
  
  public static <T> T randomFrom(List<T> list)
  
  Pick a random object from the given list.
- randomFrom
  
  public static <T> T randomFrom(Collection<T> collection)
  
  Pick a random object from the given collection.
- randomFrom
  
  public static <T> T randomFrom(Random random, Collection<T> collection)
  
  Pick a random object from the given collection.
- randomAlphaOfLengthBetween
  
  public static String randomAlphaOfLengthBetween(int minCodeUnits, int maxCodeUnits)
- randomAlphaOfLength
  
  public static String randomAlphaOfLength(int codeUnits)
- randomUnicodeOfLengthBetween
  
  public static String randomUnicodeOfLengthBetween(int minCodeUnits, int maxCodeUnits)
- randomUnicodeOfLength
  
  public static String randomUnicodeOfLength(int codeUnits)
- randomUnicodeOfCodepointLengthBetween
  
  public static String randomUnicodeOfCodepointLengthBetween(int minCodePoints, int maxCodePoints)
- randomUnicodeOfCodepointLength
  
  public static String randomUnicodeOfCodepointLength(int codePoints)
- randomRealisticUnicodeOfLengthBetween
  
  public static String randomRealisticUnicodeOfLengthBetween(int minCodeUnits, int maxCodeUnits)
- randomRealisticUnicodeOfLength
  
  public static String randomRealisticUnicodeOfLength(int codeUnits)
- randomRealisticUnicodeOfCodepointLengthBetween
  
  public static String randomRealisticUnicodeOfCodepointLengthBetween(int minCodePoints, int maxCodePoints)
- randomRealisticUnicodeOfCodepointLength
  
  public static String randomRealisticUnicodeOfCodepointLength(int codePoints)
- generateRandomStringArray
  
  public static String[] generateRandomStringArray(int maxArraySize, int stringSize, boolean allowNull, boolean allowEmpty)
  
  Parameters:
  
  maxArraySize - The maximum number of elements in the random array
  
  stringSize - The length of each String in the array
  
  allowNull - Whether the returned array may be null
  
  allowEmpty - Whether the returned array may be empty (have zero elements)
- generateRandomStringArray
  
  public static String[] generateRandomStringArray(int maxArraySize, int stringSize, boolean allowNull)
- randomArray
  
  public static <T> T[] randomArray(int maxArraySize, IntFunction<T[]> arrayConstructor, Supplier<T> valueConstructor)
- randomArray
  
  public static <T> T[] randomArray(int minArraySize, int maxArraySize, IntFunction<T[]> arrayConstructor, Supplier<T> valueConstructor)
- randomList
  
  public static <T> List<T> randomList(int maxListSize, Supplier<T> valueConstructor)
- randomList
  
  public static <T> List<T> randomList(int minListSize, int maxListSize, Supplier<T> valueConstructor)
- randomMap
  
  public static <K, V> Map<K,V> randomMap(int minMapSize, int maxMapSize, Supplier<org.elasticsearch.core.Tuple<K,V>> entryConstructor)
- randomTimeValue
  
  public static String randomTimeValue(int lower, int upper, String... suffixes)
- randomTimeValue
  
  public static String randomTimeValue(int lower, int upper)
- randomTimeValue
  
  public static String randomTimeValue()
- randomPositiveTimeValue
  
  public static String randomPositiveTimeValue()
- randomDateTimeZone
  
  public static org.joda.time.DateTimeZone randomDateTimeZone()
  
  generate a random DateTimeZone from the ones available in joda library
- randomMillisUpToYear9999
  
  public long randomMillisUpToYear9999()
  
  generate a random epoch millis in a range 1 to 9999-12-31T23:59:59.999
- randomTimeZone
  
  public static TimeZone randomTimeZone()
  
  generate a random TimeZone from the ones available in java.util
- randomZone
  
  public static ZoneId randomZone()
  
  generate a random TimeZone from the ones available in java.time
- randomDateFormatterPattern
  
  public static String randomDateFormatterPattern()
  
  Generate a random valid date formatter pattern.
- maybeSet
  
  public static <T> void maybeSet(Consumer<T> consumer, T value)
  
  helper to randomly perform on consumer with value
- randomValueOtherThan
  
  public static <T> T randomValueOtherThan(T input, Supplier<T> randomSupplier)
  
  helper to get a random value in a certain range that's different from the input
- randomValueOtherThanMany
  
  public static <T> T randomValueOtherThanMany(Predicate<T> input, Supplier<T> randomSupplier)
  
  helper to get a random value in a certain range that's different from the input
- assertBusy
  
  public static void assertBusy(org.elasticsearch.core.CheckedRunnable<Exception> codeBlock) throws Exception
  
  Runs the code block for 10 seconds waiting for no assertion to trip.
  
  Throws:
  
  Exception
- assertBusy
  
  public static void assertBusy(org.elasticsearch.core.CheckedRunnable<Exception> codeBlock, long maxWaitTime, TimeUnit unit) throws Exception
  
  Runs the code block for the provided interval, waiting for no assertions to trip.
  
  Throws:
  
  Exception
- waitUntil
  
  public static boolean waitUntil(BooleanSupplier breakSupplier) throws InterruptedException
  
  Periodically execute the supplied function until it returns true, or a timeout is reached. This version uses a timeout of 10 seconds. If at all possible, use assertBusy(CheckedRunnable) instead.
  
  Parameters:
  
  breakSupplier - determines whether to return immediately or continue waiting.
  
  Returns:
  
  the last value returned by breakSupplier
  
  Throws:
  
  InterruptedException - if any sleep calls were interrupted.
- waitUntil
  
  public static boolean waitUntil(BooleanSupplier breakSupplier, long maxWaitTime, TimeUnit unit) throws InterruptedException
  
  Periodically execute the supplied function until it returns true, or until the specified maximum wait time has elapsed. If at all possible, use assertBusy(CheckedRunnable) instead.
  
  Parameters:
  
  breakSupplier - determines whether to return immediately or continue waiting.
  
  maxWaitTime - the maximum amount of time to wait
  
  unit - the unit of tie for maxWaitTime
  
  Returns:
  
  the last value returned by breakSupplier
  
  Throws:
  
  InterruptedException - if any sleep calls were interrupted.
- terminate
  
  public static boolean terminate(ExecutorService... services)
- terminate
  
  public static boolean terminate(org.elasticsearch.threadpool.ThreadPool threadPool)
- getDataPath
  
  public Path getDataPath(String relativePath)
  
  Returns a Path pointing to the class path relative resource given as the first argument. In contrast to getClass().getResource(...).getFile() this method will not return URL encoded paths if the parent path contains spaces or other non-standard characters.
  
  Overrides:
  
  getDataPath in class org.apache.lucene.util.LuceneTestCase
- tmpPaths
  
  public String[] tmpPaths()
  
  Returns a random number of temporary paths.
- newNodeEnvironment
  
  public org.elasticsearch.env.NodeEnvironment newNodeEnvironment() throws IOException
  
  Throws:
  
  IOException
- buildEnvSettings
  
  public org.elasticsearch.common.settings.Settings buildEnvSettings(org.elasticsearch.common.settings.Settings settings)
- newNodeEnvironment
  
  public org.elasticsearch.env.NodeEnvironment newNodeEnvironment(org.elasticsearch.common.settings.Settings settings) throws IOException
  
  Throws:
  
  IOException
- newEnvironment
  
  public org.elasticsearch.env.Environment newEnvironment()
- newEnvironment
  
  public org.elasticsearch.env.Environment newEnvironment(org.elasticsearch.common.settings.Settings settings)
- settings
  
  public static org.elasticsearch.common.settings.Settings.Builder settings(org.elasticsearch.Version version)
  
  Return consistent index settings for the provided index version.
- randomSubsetOf
  
  public static <T> List<T> randomSubsetOf(int size, T... values)
  
  Returns size random values
- randomSubsetOf
  
  public static <T> List<T> randomSubsetOf(Collection<T> collection)
  
  Returns a random subset of values (including a potential empty list, or the full original list)
- randomSubsetOf
  
  public static <T> List<T> randomSubsetOf(int size, Collection<T> collection)
  
  Returns size random values
- randomUnique
  
  public static <T> Set<T> randomUnique(Supplier<T> supplier, int targetCount)
  
  Builds a set of unique items. Usually you'll get the requested count but you might get less than that number if the supplier returns lots of repeats. Make sure that the items properly implement equals and hashcode.
- randomGeohash
  
  public static String randomGeohash(int minPrecision, int maxPrecision)
- getTestTransportType
  
  public static String getTestTransportType()
- getTestTransportPlugin
  
  public static Class<? extends org.elasticsearch.plugins.Plugin> getTestTransportPlugin()
- toShuffledXContent
  
  protected final org.elasticsearch.common.bytes.BytesReference toShuffledXContent(org.elasticsearch.common.xcontent.ToXContent toXContent, org.elasticsearch.common.xcontent.XContentType xContentType, org.elasticsearch.common.xcontent.ToXContent.Params params, boolean humanReadable, String... exceptFieldNames) throws IOException
  
  Returns the bytes that represent the XContent output of the provided ToXContent object, using the provided XContentType. Wraps the output into a new anonymous object according to the value returned by the ToXContent.isFragment() method returns. Shuffles the keys to make sure that parsing never relies on keys ordering.
  
  Throws:
  
  IOException
- shuffleXContent
  
  protected final org.elasticsearch.common.xcontent.XContentBuilder shuffleXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, String... exceptFieldNames) throws IOException
  
  Randomly shuffles the fields inside objects in the XContentBuilder passed in. Recursively goes through inner objects and also shuffles them. Exceptions for this recursive shuffling behavior can be made by passing in the names of fields which internally should stay untouched.
  
  Throws:
  
  IOException
- shuffleXContent
  
  public static org.elasticsearch.common.xcontent.XContentBuilder shuffleXContent(org.elasticsearch.common.xcontent.XContentParser parser, boolean prettyPrint, String... exceptFieldNames) throws IOException
  
  Randomly shuffles the fields inside objects parsed using the XContentParser passed in. Recursively goes through inner objects and also shuffles them. Exceptions for this recursive shuffling behavior can be made by passing in the names of fields which internally should stay untouched.
  
  Throws:
  
  IOException
- shuffleMap
  
  public static LinkedHashMap<String,Object> shuffleMap(LinkedHashMap<String,Object> map, Set<String> exceptFields)
- copyWriteable
  
  public static <T extends org.elasticsearch.common.io.stream.Writeable> T copyWriteable(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.elasticsearch.common.io.stream.Writeable.Reader<T> reader) throws IOException
  
  Create a copy of an original Writeable object by running it through a BytesStreamOutput and reading it in again using a provided Writeable.Reader. The stream that is wrapped around the StreamInput potentially need to use a NamedWriteableRegistry, so this needs to be provided too (although it can be empty if the object that is streamed doesn't contain any NamedWriteable objects itself.
  
  Throws:
  
  IOException
- copyWriteable
  
  public static <T extends org.elasticsearch.common.io.stream.Writeable> T copyWriteable(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.elasticsearch.common.io.stream.Writeable.Reader<T> reader, org.elasticsearch.Version version) throws IOException
  
  Same as copyWriteable(Writeable, NamedWriteableRegistry, Writeable.Reader) but also allows to provide a Version argument which will be used to write and read back the object.
  
  Throws:
  
  IOException
- copyNamedWriteable
  
  public static <T extends org.elasticsearch.common.io.stream.NamedWriteable> T copyNamedWriteable(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, Class<T> categoryClass) throws IOException
  
  Create a copy of an original NamedWriteable object by running it through a BytesStreamOutput and reading it in again using a provided Writeable.Reader.
  
  Throws:
  
  IOException
- copyNamedWriteable
  
  public static <T extends org.elasticsearch.common.io.stream.NamedWriteable> T copyNamedWriteable(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, Class<T> categoryClass, org.elasticsearch.Version version) throws IOException
  
  Same as copyNamedWriteable(NamedWriteable, NamedWriteableRegistry, Class) but also allows to provide a Version argument which will be used to write and read back the object.
  
  Throws:
  
  IOException
- copyInstance
  
  protected static <T> T copyInstance(T original, org.elasticsearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.elasticsearch.common.io.stream.Writeable.Writer<T> writer, org.elasticsearch.common.io.stream.Writeable.Reader<T> reader, org.elasticsearch.Version version) throws IOException
  
  Throws:
  
  IOException
- createParser
  
  protected final org.elasticsearch.common.xcontent.XContentParser createParser(org.elasticsearch.common.xcontent.XContentBuilder builder) throws IOException
  
  Create a new XContentParser.
  
  Throws:
  
  IOException
- createParser
  
  protected final org.elasticsearch.common.xcontent.XContentParser createParser(org.elasticsearch.common.xcontent.XContent xContent, String data) throws IOException
  
  Create a new XContentParser.
  
  Throws:
  
  IOException
- createParser
  
  protected final org.elasticsearch.common.xcontent.XContentParser createParser(org.elasticsearch.common.xcontent.XContent xContent, InputStream data) throws IOException
  
  Create a new XContentParser.
  
  Throws:
  
  IOException
- createParser
  
  protected final org.elasticsearch.common.xcontent.XContentParser createParser(org.elasticsearch.common.xcontent.XContent xContent, byte[] data) throws IOException
  
  Create a new XContentParser.
  
  Throws:
  
  IOException
- createParser
  
  protected final org.elasticsearch.common.xcontent.XContentParser createParser(org.elasticsearch.common.xcontent.XContent xContent, org.elasticsearch.common.bytes.BytesReference data) throws IOException
  
  Create a new XContentParser.
  
  Throws:
  
  IOException
- createParser
  
  protected final org.elasticsearch.common.xcontent.XContentParser createParser(org.elasticsearch.common.xcontent.NamedXContentRegistry namedXContentRegistry, org.elasticsearch.common.xcontent.XContent xContent, org.elasticsearch.common.bytes.BytesReference data) throws IOException
  
  Create a new XContentParser.
  
  Throws:
  
  IOException
- xContentRegistry
  
  protected org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry()
  
  The NamedXContentRegistry to use for this test. Subclasses should override and use liberally.
- writableRegistry
  
  protected org.elasticsearch.common.io.stream.NamedWriteableRegistry writableRegistry()
  
  The NamedWriteableRegistry to use for this test. Subclasses should override and use liberally.
- mockScript
  
  public static org.elasticsearch.script.Script mockScript(String id)
  
  Create a "mock" script for use either with MockScriptEngine or anywhere where you need a script but don't really care about its contents.
- getSuiteFailureMarker
  
  public static org.apache.lucene.util.TestRuleMarkFailure getSuiteFailureMarker()
  
  Returns the suite failure marker: internal use only!
- assertArrayEquals
  
  public static void assertArrayEquals(StackTraceElement[] expected, StackTraceElement[] actual)
  
  Compares two stack traces, ignoring module (which is not yet serialized)
- assertEquals
  
  public static void assertEquals(StackTraceElement expected, StackTraceElement actual)
  
  Compares two stack trace elements, ignoring module (which is not yet serialized)
- spinForAtLeastOneMillisecond
  
  protected static long spinForAtLeastOneMillisecond()
- spinForAtLeastNMilliseconds
  
  protected static long spinForAtLeastNMilliseconds(long ms)
- createDefaultIndexAnalyzers
  
  protected org.elasticsearch.index.analysis.IndexAnalyzers createDefaultIndexAnalyzers()
  
  Creates an IndexAnalyzers with a single default analyzer
- createTestAnalysis
  
  public static ESTestCase.TestAnalysis createTestAnalysis(org.elasticsearch.index.Index index, org.elasticsearch.common.settings.Settings settings, org.elasticsearch.plugins.AnalysisPlugin... analysisPlugins) throws IOException
  
  Creates an TestAnalysis with all the default analyzers configured.
  
  Throws:
  
  IOException
- createTestAnalysis
  
  public static ESTestCase.TestAnalysis createTestAnalysis(org.elasticsearch.index.Index index, org.elasticsearch.common.settings.Settings nodeSettings, org.elasticsearch.common.settings.Settings settings, org.elasticsearch.plugins.AnalysisPlugin... analysisPlugins) throws IOException
  
  Creates an TestAnalysis with all the default analyzers configured.
  
  Throws:
  
  IOException
- createTestAnalysis
  
  public static ESTestCase.TestAnalysis createTestAnalysis(org.elasticsearch.index.IndexSettings indexSettings, org.elasticsearch.common.settings.Settings nodeSettings, org.elasticsearch.plugins.AnalysisPlugin... analysisPlugins) throws IOException
  
  Creates an TestAnalysis with all the default analyzers configured.
  
  Throws:
  
  IOException
- inFipsJvm
  
  public static boolean inFipsJvm()
- getPortRange
  
  public static String getPortRange()
  
  Returns a unique port range for this JVM starting from the computed base port
- getBasePort
  
  protected static int getBasePort()
- randomIp
  
  protected static InetAddress randomIp(boolean v4)

Class ESTestCase

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class org.junit.Assert

Methods inherited from class java.lang.Object

Field Details

JODA_TIMEZONE_IDS

JAVA_TIMEZONE_IDS

JAVA_ZONE_IDS

MIN_PRIVATE_PORT

TEST_WORKER_VM_ID

TEST_WORKER_SYS_PROPERTY

DEFAULT_TEST_WORKER_ID

FIPS_SYSPROP

logger

failureAndSuccessEvents

checkIndexFailures

DEFAULT_NAMED_WRITABLE_REGISTRY

Constructor Details

ESTestCase

Method Details

resetPortCounter

buildNewFakeTransportAddress

afterIfFailed

afterIfSuccessful

setFileSystem

restoreFileSystem

setContentType

restoreContentType

ensureSupportedLocale

setHeaderWarningAppender

removeHeaderWarningAppender

before

clearAdditionalRoles

enableWarningsCheck

enableJodaDeprecationWarningsCheck

after

filteredWarnings

assertSettingDeprecationsAndWarnings

assertSettingDeprecationsAndWarnings

assertWarnings

allowedWarnings

assertWarnings

checkStaticState

ensureAllSearchContextsReleased

resetCheckIndexStatus

ensureCheckIndexPassed

scaledRandomIntBetween

randomIntBetween

randomLongBetween

iterations

between

frequently

randomBoolean

randomByte

randomNonNegativeByte

randomByteArrayOfLength

randomShort

randomInt

randomNonNegativeLong

randomFloat

randomDouble

randomDoubleBetween

randomLong

randomBigInteger

randomInt

randomFrom

randomFrom

randomFrom

randomFrom

randomFrom

randomAlphaOfLengthBetween

randomAlphaOfLength

randomUnicodeOfLengthBetween

randomUnicodeOfLength