Package org.elasticsearch.test
Class AbstractXContentTestCase<T extends org.elasticsearch.common.xcontent.ToXContent>
java.lang.Object
org.junit.Assert
org.apache.lucene.util.LuceneTestCase
org.elasticsearch.test.ESTestCase
org.elasticsearch.test.AbstractXContentTestCase<T>
- Direct Known Subclasses:
AbstractBroadcastResponseTestCase
public abstract class AbstractXContentTestCase<T extends org.elasticsearch.common.xcontent.ToXContent> extends ESTestCase
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AbstractXContentTestCase.XContentTester<T>
Tests converting to and from xcontent.Nested classes/interfaces inherited from class org.elasticsearch.test.ESTestCase
ESTestCase.GeohashGenerator, ESTestCase.TestAnalysis
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 protected static int
NUMBER_OF_TEST_RUNS
Fields inherited from class org.elasticsearch.test.ESTestCase
checkIndexFailures, DEFAULT_NAMED_WRITABLE_REGISTRY, DEFAULT_TEST_WORKER_ID, failureAndSuccessEvents, FIPS_SYSPROP, 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 Constructor Description AbstractXContentTestCase()
-
Method Summary
Modifier and Type Method Description protected void
assertEqualInstances(T expectedInstance, T newInstance)
protected boolean
assertToXContentEquivalence()
protected abstract T
createTestInstance()
Creates a random test instance to use in the tests.protected abstract T
doParseInstance(org.elasticsearch.common.xcontent.XContentParser parser)
Parses to a new instance using the providedXContentParser
protected java.util.function.Predicate<java.lang.String>
getRandomFieldsExcludeFilter()
Returns a predicate that given the field name indicates whether the field has to be excluded from random fields insertion or notprotected java.lang.String[]
getShuffleFieldsExceptions()
Fields that have to be ignored when shuffling as part of testFromXContentprotected org.elasticsearch.common.xcontent.ToXContent.Params
getToXContentParams()
Params that have to be provided when callingToXContent.toXContent(XContentBuilder, ToXContent.Params)
protected abstract boolean
supportsUnknownFields()
Indicates whether the parser supports unknown fields or not.void
testFromXContent()
Generic test that creates new instance from the test instance and checks both for equality and asserts equality on the two queries.static <T extends org.elasticsearch.common.xcontent.ToXContent>
voidtestFromXContent(int numberOfTestRuns, java.util.function.Supplier<T> instanceSupplier, boolean supportsUnknownFields, java.lang.String[] shuffleFieldsExceptions, java.util.function.Predicate<java.lang.String> randomFieldsExcludeFilter, org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParserFunction, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent, java.util.function.BiConsumer<T,T> assertEqualsConsumer, boolean assertToXContentEquivalence, org.elasticsearch.common.xcontent.ToXContent.Params toXContentParams)
static <T extends org.elasticsearch.common.xcontent.ToXContent>
AbstractXContentTestCase.XContentTester<T>xContentTester(org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParser, java.util.function.Function<org.elasticsearch.common.xcontent.XContentType,T> instanceSupplier, org.elasticsearch.common.xcontent.ToXContent.Params toXContentParams, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent)
static <T> AbstractXContentTestCase.XContentTester<T>
xContentTester(org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParser, java.util.function.Supplier<T> instanceSupplier, org.elasticsearch.common.CheckedBiConsumer<T,org.elasticsearch.common.xcontent.XContentBuilder,java.io.IOException> toXContent, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent)
static <T extends org.elasticsearch.common.xcontent.ToXContent>
AbstractXContentTestCase.XContentTester<T>xContentTester(org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParser, java.util.function.Supplier<T> instanceSupplier, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent)
static <T extends org.elasticsearch.common.xcontent.ToXContent>
AbstractXContentTestCase.XContentTester<T>xContentTester(org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParser, java.util.function.Supplier<T> instanceSupplier, org.elasticsearch.common.xcontent.ToXContent.Params toXContentParams, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent)
Methods inherited from class org.elasticsearch.test.ESTestCase
after, afterIfFailed, afterIfSuccessful, allowedWarnings, assertArrayEquals, assertBusy, assertBusy, assertEquals, 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, filteredWarnings, frequently, generateRandomStringArray, generateRandomStringArray, getBasePort, getDataPath, getPortRange, getSuiteFailureMarker, getTestTransportPlugin, getTestTransportType, inFipsJvm, 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, randomGeohash, randomInt, randomInt, randomIntBetween, randomIp, randomList, randomList, randomLong, randomLongBetween, 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, 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, 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
-
NUMBER_OF_TEST_RUNS
protected static final int NUMBER_OF_TEST_RUNS- See Also:
- Constant Field Values
-
-
Constructor Details
-
AbstractXContentTestCase
public AbstractXContentTestCase()
-
-
Method Details
-
xContentTester
public static <T> AbstractXContentTestCase.XContentTester<T> xContentTester(org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParser, java.util.function.Supplier<T> instanceSupplier, org.elasticsearch.common.CheckedBiConsumer<T,org.elasticsearch.common.xcontent.XContentBuilder,java.io.IOException> toXContent, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent) -
xContentTester
public static <T extends org.elasticsearch.common.xcontent.ToXContent> AbstractXContentTestCase.XContentTester<T> xContentTester(org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParser, java.util.function.Supplier<T> instanceSupplier, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent) -
xContentTester
public static <T extends org.elasticsearch.common.xcontent.ToXContent> AbstractXContentTestCase.XContentTester<T> xContentTester(org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParser, java.util.function.Supplier<T> instanceSupplier, org.elasticsearch.common.xcontent.ToXContent.Params toXContentParams, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent) -
xContentTester
public static <T extends org.elasticsearch.common.xcontent.ToXContent> AbstractXContentTestCase.XContentTester<T> xContentTester(org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParser, java.util.function.Function<org.elasticsearch.common.xcontent.XContentType,T> instanceSupplier, org.elasticsearch.common.xcontent.ToXContent.Params toXContentParams, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent) -
testFromXContent
public static <T extends org.elasticsearch.common.xcontent.ToXContent> void testFromXContent(int numberOfTestRuns, java.util.function.Supplier<T> instanceSupplier, boolean supportsUnknownFields, java.lang.String[] shuffleFieldsExceptions, java.util.function.Predicate<java.lang.String> randomFieldsExcludeFilter, org.elasticsearch.common.CheckedBiFunction<org.elasticsearch.common.xcontent.XContent,org.elasticsearch.common.bytes.BytesReference,org.elasticsearch.common.xcontent.XContentParser,java.io.IOException> createParserFunction, org.elasticsearch.common.CheckedFunction<org.elasticsearch.common.xcontent.XContentParser,T,java.io.IOException> fromXContent, java.util.function.BiConsumer<T,T> assertEqualsConsumer, boolean assertToXContentEquivalence, org.elasticsearch.common.xcontent.ToXContent.Params toXContentParams) throws java.io.IOException- Throws:
java.io.IOException
-
testFromXContent
public final void testFromXContent() throws java.io.IOExceptionGeneric test that creates new instance from the test instance and checks both for equality and asserts equality on the two queries.- Throws:
java.io.IOException
-
createTestInstance
Creates a random test instance to use in the tests. This method will be called multiple times during test execution and should return a different random instance each time it is called. -
doParseInstance
protected abstract T doParseInstance(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOExceptionParses to a new instance using the providedXContentParser
- Throws:
java.io.IOException
-
assertEqualInstances
-
assertToXContentEquivalence
protected boolean assertToXContentEquivalence() -
supportsUnknownFields
protected abstract boolean supportsUnknownFields()Indicates whether the parser supports unknown fields or not. In case it does, such behaviour will be tested by inserting random fields before parsing and checking that they don't make parsing fail. -
getRandomFieldsExcludeFilter
protected java.util.function.Predicate<java.lang.String> getRandomFieldsExcludeFilter()Returns a predicate that given the field name indicates whether the field has to be excluded from random fields insertion or not -
getShuffleFieldsExceptions
protected java.lang.String[] getShuffleFieldsExceptions()Fields that have to be ignored when shuffling as part of testFromXContent -
getToXContentParams
protected org.elasticsearch.common.xcontent.ToXContent.Params getToXContentParams()Params that have to be provided when callingToXContent.toXContent(XContentBuilder, ToXContent.Params)
-