Package org.elasticsearch.test

Class InternalAggregationTestCase<T extends InternalAggregation>

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.elasticsearch.test.ESTestCase

org.elasticsearch.test.AbstractWireTestCase<T>

org.elasticsearch.test.AbstractNamedWriteableTestCase<T>

org.elasticsearch.test.InternalAggregationTestCase<T>

Direct Known Subclasses:

InternalMultiBucketAggregationTestCase, InternalSingleBucketAggregationTestCase

public abstract class InternalAggregationTestCase<T extends InternalAggregation>
extends AbstractNamedWriteableTestCase<T>

Implementors of this test case should be aware that the aggregation under test needs to be registered in the test's namedWriteableRegistry. Core aggregations are registered already, but non-core aggs should override registerPlugin() so that the NamedWriteables can be extracted from the AggregatorSpecs in the plugin (as well as any other custom NamedWriteables)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	InternalAggregationTestCase.BuilderAndToReduce<T>

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

ESTestCase.DeprecationWarning, ESTestCase.GeohashGenerator, ESTestCase.TestAnalysis, ESTestCase.WithoutSecurityManager

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

org.apache.lucene.tests.util.LuceneTestCase.AwaitsFix, org.apache.lucene.tests.util.LuceneTestCase.BadApple, org.apache.lucene.tests.util.LuceneTestCase.Monster, org.apache.lucene.tests.util.LuceneTestCase.Nightly, org.apache.lucene.tests.util.LuceneTestCase.SuppressCodecs, org.apache.lucene.tests.util.LuceneTestCase.SuppressFileSystems, org.apache.lucene.tests.util.LuceneTestCase.SuppressFsync, org.apache.lucene.tests.util.LuceneTestCase.SuppressReproduceLine, org.apache.lucene.tests.util.LuceneTestCase.SuppressSysoutChecks, org.apache.lucene.tests.util.LuceneTestCase.SuppressTempFileChecks, org.apache.lucene.tests.util.LuceneTestCase.ThrowingConsumer<T extends Object>, org.apache.lucene.tests.util.LuceneTestCase.ThrowingRunnable, org.apache.lucene.tests.util.LuceneTestCase.Weekly

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_BUCKETS
protected static final double	TOLERANCE

Fields inherited from class org.elasticsearch.test.AbstractWireTestCase

NUMBER_OF_TEST_RUNS

Fields inherited from class org.elasticsearch.test.ESTestCase

checkIndexFailures, DEFAULT_TEST_WORKER_ID, failureAndSuccessEvents, FIPS_SYSPROP, JAVA_TIMEZONE_IDS, JAVA_ZONE_IDS, logger, MIN_PRIVATE_PORT, TEST_WORKER_SYS_PROPERTY, TEST_WORKER_VM_ID

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

assertsAreEnabled, classRules, DEFAULT_LINE_DOCS_FILE, INFOSTREAM, JENKINS_LARGE_LINE_DOCS_FILE, LEAVE_TEMPORARY, MAYBE_CACHE_POLICY, RANDOM_MULTIPLIER, ruleChain, suiteFailureMarker, SYSPROP_AWAITSFIX, SYSPROP_BADAPPLES, SYSPROP_FAILFAST, SYSPROP_MAXFAILURES, SYSPROP_MONSTER, SYSPROP_NIGHTLY, 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_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Constructor	Description
InternalAggregationTestCase()

Method Summary

Modifier and Type	Method	Description
protected abstract void	assertFromXContent(T aggregation, ParsedAggregation parsedAggregation)
static void	assertMultiBucketConsumer(Aggregation agg, MultiBucketConsumerService.MultiBucketConsumer bucketConsumer)
protected abstract void	assertReduced(T reduced, List<T> inputs)
protected void	assertSampled(T sampled, T reduced, SamplingContext samplingContext)
protected final Class<T>	categoryClass()	The type of NamedWriteable to read.
final T	createTestInstance()	Creates a random test instance to use in the tests.
protected abstract T	createTestInstance(String name, Map<String,Object> metadata)
T	createTestInstanceForXContent()
final Map<String,Object>	createTestMetadata()
protected final T	createUnmappedInstance(String name)	Return an instance on an unmapped field.
protected T	createUnmappedInstance(String name, Map<String,Object> metadata)	Return an instance on an unmapped field.
protected void	doAssertReducedMultiBucketConsumer(Aggregation agg, MultiBucketConsumerService.MultiBucketConsumer bucketConsumer)
static AggregationReduceContext.Builder	emptyReduceContextBuilder()	Builds an AggregationReduceContext that is valid but empty.
static AggregationReduceContext.Builder	emptyReduceContextBuilder(AggregatorFactories.Builder aggs)	Builds an AggregationReduceContext that is valid and nearly empty except that it contains the provided builders.
protected Predicate<String>	excludePathsFromXContentInsertion()	Overwrite this in your test if other than the basic xContent paths should be excluded during insertion of random fields
static List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry>	getDefaultNamedXContents()
protected final NamedWriteableRegistry	getNamedWriteableRegistry()	Get the NamedWriteableRegistry to use when de-serializing the object.
protected List<NamedWriteableRegistry.Entry>	getNamedWriteables()	Implementors can override this if they want to provide a custom list of namedWriteables.
protected List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry>	getNamedXContents()
protected final AggregationBuilder	mockBuilder(List<? extends InternalAggregation> results)
static AggregationReduceContext.Builder	mockReduceContext(AggregationBuilder agg)	Builds an AggregationReduceContext to reduce the provided aggregation.
protected ScriptService	mockScriptService()	overwrite in tests that need it
protected <P extends ParsedAggregation> P	parseAndAssert(InternalAggregation aggregation, boolean shuffled, boolean addRandomFields)
static DocValueFormat	randomDateDocValueFormat()	A random DocValueFormat that can be used in aggregations which compute dates.
static DocValueFormat	randomNumericDocValueFormat()	A random DocValueFormat that can be used in aggregations which compute numbers.
protected InternalAggregationTestCase.BuilderAndToReduce<T>	randomResultsToReduce(String name, int size)	Generate a list of inputs to reduce.
protected SearchPlugin	registerPlugin()	If a test needs to register additional aggregation specs for namedWriteable, etc, this method can be overridden by the implementor.
protected boolean	supportsOutOfOrderReduce()	Does this aggregation support reductions when the internal buckets are not in-order
protected boolean	supportsSampling()
final void	testConcurrentToXContent()	Calls ToXContent.toXContent(org.elasticsearch.xcontent.XContentBuilder, org.elasticsearch.xcontent.ToXContent.Params) on many threads and verifies that they produce the same result.
final void	testFromXContent()
final void	testFromXContentWithRandomFields()
void	testReduceRandom()
protected org.elasticsearch.xcontent.NamedXContentRegistry	xContentRegistry()	The NamedXContentRegistry to use for this test.

Methods inherited from class org.elasticsearch.test.AbstractNamedWriteableTestCase

copyInstance

Methods inherited from class org.elasticsearch.test.AbstractWireTestCase

assertEqualInstances, assertSerialization, assertSerialization, concurrentTest, copyInstance, mutateInstance, testConcurrentEquals, testConcurrentHashCode, testConcurrentSerialization, testEqualsAndHashcode, testSerialization, testToString

Methods inherited from class org.elasticsearch.test.ESTestCase

after, afterIfFailed, afterIfSuccessful, assertArrayEquals, assertBusy, assertBusy, assertCriticalWarnings, assertEquals, assertSettingDeprecationsAndWarnings, assertWarnings, assertWarnings, before, between, buildEnvSettings, buildNewFakeTransportAddress, checkStaticState, compatibleMediaType, copyInstance, copyNamedWriteable, copyNamedWriteable, copyWriteable, copyWriteable, createDefaultIndexAnalyzers, createParser, createParser, createParser, createParser, createParser, createParser, createParserWithCompatibilityFor, createTestAnalysis, createTestAnalysis, createTestAnalysis, enableWarningsCheck, ensureAllSearchContextsReleased, ensureCheckIndexPassed, ensureNoWarnings, ensureSupportedLocale, filteredWarnings, frequently, generateRandomStringArray, generateRandomStringArray, getDataPath, getPortRange, getSuiteFailureMarker, getTestTransportPlugin, getTestTransportType, getWorkerBasePort, indexSettings, indexSettings, inFipsJvm, isTurkishLocale, iterations, maybeRestoreClassSecurityManager, maybeSet, maybeStashClassSecurityManager, mockScript, newEnvironment, newEnvironment, newNodeEnvironment, newNodeEnvironment, parserConfig, randomAlphaOfLength, randomAlphaOfLengthBetween, randomArray, randomArray, randomBigInteger, randomBoolean, randomByte, randomByteArrayOfLength, randomByteSizeValue, randomBytesReference, randomCompatibleMediaType, randomDateFormatterPattern, randomDouble, randomDoubleBetween, randomDoubles, randomDoubles, randomFloat, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomGeohash, randomIdentifier, randomInt, randomInt, randomIntBetween, randomInts, randomInts, randomIp, randomList, randomList, randomLong, randomLongBetween, randomLongs, randomLongs, randomMap, randomMillisUpToYear9999, randomNonEmptySubsetOf, randomNonNegativeByte, randomNonNegativeInt, randomNonNegativeLong, randomPositiveTimeValue, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomSet, randomShort, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomTimeValue, randomTimeValue, randomTimeZone, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomValueOtherThan, randomValueOtherThanMany, randomVendorType, randomZone, removeHeaderWarningAppender, resetCheckIndexStatus, resetPortCounter, restoreContentType, restoreFileSystem, safeAwait, safeAwait, safeSleep, scaledRandomIntBetween, secureRandom, secureRandom, secureRandomFips, secureRandomFips, secureRandomNonFips, secureRandomNonFips, setContentType, setFileSystem, setHeaderWarningAppender, settings, shuffledList, shuffleMap, shuffleXContent, shuffleXContent, skipTestWaitingForLuceneFix, spinForAtLeastNMilliseconds, spinForAtLeastOneMillisecond, terminate, terminate, tmpPaths, toShuffledXContent, waitUntil, waitUntil, writableRegistry

Methods inherited from class org.apache.lucene.tests.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, getDataInputStream, getJvmForkArguments, 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, runWithRestrictedPermissions, setIndexWriterMaxDocs, setUp, setupCPUCoreCount, 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

DEFAULT_MAX_BUCKETS

public static final int DEFAULT_MAX_BUCKETS

See Also:

• Constant Field Values

TOLERANCE

protected static final double TOLERANCE

See Also:

• Constant Field Values

Constructor Details

InternalAggregationTestCase

public InternalAggregationTestCase()

Method Details

emptyReduceContextBuilder

public static AggregationReduceContext.Builder emptyReduceContextBuilder()

Builds an AggregationReduceContext that is valid but empty.

emptyReduceContextBuilder

public static AggregationReduceContext.Builder emptyReduceContextBuilder(AggregatorFactories.Builder aggs)

Builds an AggregationReduceContext that is valid and nearly empty except that it contains the provided builders.

mockReduceContext

public static AggregationReduceContext.Builder mockReduceContext(AggregationBuilder agg)

Builds an AggregationReduceContext to reduce the provided aggregation.

getDefaultNamedXContents

public static List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry> getDefaultNamedXContents()

getNamedXContents

protected List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry> getNamedXContents()

xContentRegistry

protected org.elasticsearch.xcontent.NamedXContentRegistry xContentRegistry()

Description copied from class: ESTestCase

The NamedXContentRegistry to use for this test. Subclasses should override and use liberally.

Overrides:

xContentRegistry in class ESTestCase

getNamedWriteableRegistry

protected final NamedWriteableRegistry getNamedWriteableRegistry()

Description copied from class: AbstractWireTestCase

Get the NamedWriteableRegistry to use when de-serializing the object. Override this method if you need to register NamedWriteables for the test object to de-serialize. By default this will return a NamedWriteableRegistry with no registered NamedWriteables

Specified by:

getNamedWriteableRegistry in class AbstractNamedWriteableTestCase<T extends InternalAggregation>

getNamedWriteables

protected List<NamedWriteableRegistry.Entry> getNamedWriteables()

Implementors can override this if they want to provide a custom list of namedWriteables. If the implementor _just_ wants to register in namedWriteables provided by a plugin, prefer overriding registerPlugin() instead because that route handles the automatic conversion of AggSpecs into namedWriteables.

registerPlugin

protected SearchPlugin registerPlugin()

If a test needs to register additional aggregation specs for namedWriteable, etc, this method can be overridden by the implementor.

createTestInstance

protected abstract T createTestInstance(String name,
 Map<String,Object> metadata)

createUnmappedInstance

protected T createUnmappedInstance(String name,
 Map<String,Object> metadata)

Return an instance on an unmapped field.

categoryClass

protected final Class<T> categoryClass()

Description copied from class: AbstractNamedWriteableTestCase

The type of NamedWriteable to read.

Specified by:

categoryClass in class AbstractNamedWriteableTestCase<T extends InternalAggregation>

randomResultsToReduce

protected InternalAggregationTestCase.BuilderAndToReduce<T> randomResultsToReduce(String name,
 int size)

Generate a list of inputs to reduce. Defaults to calling createTestInstance(String) and createUnmappedInstance(String) and mockBuilder(List) but should be overridden if it isn't realistic to reduce test instances against mocked builders.

mockBuilder

protected final AggregationBuilder mockBuilder(List<? extends InternalAggregation> results)

supportsOutOfOrderReduce

protected boolean supportsOutOfOrderReduce()

Does this aggregation support reductions when the internal buckets are not in-order

testReduceRandom

public void testReduceRandom()
                      throws IOException

Throws:

IOException

doAssertReducedMultiBucketConsumer

protected void doAssertReducedMultiBucketConsumer(Aggregation agg,
 MultiBucketConsumerService.MultiBucketConsumer bucketConsumer)

mockScriptService

protected ScriptService mockScriptService()

overwrite in tests that need it

assertReduced

protected abstract void assertReduced(T reduced,
 List<T> inputs)

assertSampled

protected void assertSampled(T sampled,
 T reduced,
 SamplingContext samplingContext)

createTestInstance

public final T createTestInstance()

Description copied from class: AbstractWireTestCase

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.

Specified by:

createTestInstance in class AbstractWireTestCase<T extends InternalAggregation>

supportsSampling

protected boolean supportsSampling()

createTestMetadata

public final Map<String,Object> createTestMetadata()

createUnmappedInstance

protected final T createUnmappedInstance(String name)

Return an instance on an unmapped field.

createTestInstanceForXContent

public T createTestInstanceForXContent()

testFromXContent

public final void testFromXContent()
                            throws IOException

Throws:

IOException

testFromXContentWithRandomFields

public final void testFromXContentWithRandomFields()
                                            throws IOException

Throws:

IOException

assertFromXContent

protected abstract void assertFromXContent(T aggregation,
 ParsedAggregation parsedAggregation)
                                    throws IOException

Throws:

IOException

testConcurrentToXContent

public final void testConcurrentToXContent()
                                    throws IOException,
InterruptedException,
ExecutionException

Calls ToXContent.toXContent(org.elasticsearch.xcontent.XContentBuilder, org.elasticsearch.xcontent.ToXContent.Params) on many threads and verifies that they produce the same result. Async search sometimes does this to aggregation responses and, in general, we think it's reasonable for everything that can convert itself to json to be able to do so concurrently.

Throws:

IOException

InterruptedException

ExecutionException

parseAndAssert

protected <P extends ParsedAggregation> P parseAndAssert(InternalAggregation aggregation,
 boolean shuffled,
 boolean addRandomFields)
                                                  throws IOException

Throws:

IOException

excludePathsFromXContentInsertion

protected Predicate<String> excludePathsFromXContentInsertion()

Overwrite this in your test if other than the basic xContent paths should be excluded during insertion of random fields

randomNumericDocValueFormat

public static DocValueFormat randomNumericDocValueFormat()

A random DocValueFormat that can be used in aggregations which compute numbers.

randomDateDocValueFormat

public static DocValueFormat randomDateDocValueFormat()

A random DocValueFormat that can be used in aggregations which compute dates.

assertMultiBucketConsumer

public static void assertMultiBucketConsumer(Aggregation agg,
 MultiBucketConsumerService.MultiBucketConsumer bucketConsumer)