Class BaseCompositeAggregatorTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.opensearch.test.OpenSearchTestCase

org.opensearch.search.aggregations.AggregatorTestCase

org.opensearch.search.aggregations.composite.BaseCompositeAggregatorTestCase

public class BaseCompositeAggregatorTestCase
extends AggregatorTestCase

Base class for the Aggregator Tests which are registered under Composite Aggregation.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.AggregatorTestCase

AggregatorTestCase.CountingAggregator, AggregatorTestCase.InternalAggCardinality

Nested classes/interfaces inherited from class org.opensearch.test.OpenSearchTestCase

OpenSearchTestCase.AnnotatedFeatureFlagRule, OpenSearchTestCase.GeohashGenerator, OpenSearchTestCase.LockFeatureFlag, OpenSearchTestCase.TestAnalysis

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.Concurrency, 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>, org.apache.lucene.tests.util.LuceneTestCase.ThrowingRunnable, org.apache.lucene.tests.util.LuceneTestCase.Weekly

Field Summary

Fields

Modifier and Type	Field	Description
protected static List<org.opensearch.index.mapper.MappedFieldType>	FIELD_TYPES

Fields inherited from class org.opensearch.search.aggregations.AggregatorTestCase

ADD_SORTED_SET_FIELD_INDEXED, ADD_SORTED_SET_FIELD_NOT_INDEXED, valuesSourceRegistry

Fields inherited from class org.opensearch.test.OpenSearchTestCase

checkIndexFailures, DEFAULT_NAMED_WRITABLE_REGISTRY, DEFAULT_TEST_WORKER_ID, failureAndSuccessEvents, flagLockRule, JAVA_TIMEZONE_IDS, JAVA_ZONE_IDS, JODA_TIMEZONE_IDS, logger, 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_FAILFAST, SYSPROP_MAXFAILURES, SYSPROP_MONSTER, SYSPROP_NIGHTLY, SYSPROP_WEEKLY, TEST_ASSERTS_ENABLED, TEST_AWAITSFIX, 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
BaseCompositeAggregatorTestCase()

Method Summary

Modifier and Type	Method	Description
protected void	addToDocument(int id, org.apache.lucene.document.Document doc, Map<String, List<Object>> keys)
protected boolean	addValueToDocument(org.apache.lucene.document.Document doc, String name, Object value)	Override this function to handle any specific type of value you want to add in the document for doing the composite aggregation.
protected static long	asLong(String dateTime)
protected static org.apache.lucene.search.Sort	buildIndexSort(List<org.opensearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder<?>> sources, Map<String, org.opensearch.index.mapper.MappedFieldType> fieldTypes)
protected static Map<String,Object>	createAfterKey(Object... fields)
protected static Map<String, List<Object>>	createDocument(Object... fields)
protected static org.opensearch.index.IndexSettings	createIndexSettings(org.apache.lucene.search.Sort sort)
protected void	executeTestCase(boolean forceMerge, boolean useIndexSort, org.apache.lucene.search.Query query, List<Map<String, List<Object>>> dataset, Supplier<? extends org.opensearch.search.aggregations.AggregationBuilder> create, Consumer<org.opensearch.search.aggregations.bucket.composite.InternalComposite> verify)
protected org.opensearch.index.mapper.MapperService	mapperServiceMock()	sub-tests that need a more complex mock can overwrite this
void	setUp()
protected static org.apache.lucene.search.SortField	sortFieldFrom(org.opensearch.index.mapper.MappedFieldType type)
void	tearDown()
protected void	testSearchCase(List<org.apache.lucene.search.Query> queries, List<Map<String, List<Object>>> dataset, Supplier<org.opensearch.search.aggregations.bucket.composite.CompositeAggregationBuilder> create, Consumer<org.opensearch.search.aggregations.bucket.composite.InternalComposite> verify)

Methods inherited from class org.opensearch.search.aggregations.AggregatorTestCase

afterClose, aggCardinality, createAggBuilderForTypeTest, createAggregator, createAggregator, createAggregator, createAggregator, createAggregator, createAggregator, createAggregatorWithCustomizableSearchContext, createCountingAggregator, createIndexSettings, createSearchContext, createSearchContext, createSearchContextWithStarTreeContext, createStreamAggregator, dateField, doAssertReducedMultiBucketConsumer, doubleField, geoPointField, getFieldAliases, getIndexFieldDataLookup, getMockScriptService, getSearchPlugins, getSupportedValuesSourceTypes, initValuesSourceRegistry, keywordField, longField, maybeWrapReaderEs, newIndexSearcher, queryShardContextMock, rangeField, searchAndReduce, searchAndReduce, searchAndReduce, searchAndReduce, searchAndReduce, searchAndReduce, searchAndReduceCounting, searchAndReduceStarTree, searchAndReduceStarTree, testCase, testSupportedFieldTypes, unsupportedMappedFieldTypes, wrapDirectoryReader, wrapInMockESDirectoryReader

Methods inherited from class org.opensearch.test.OpenSearchTestCase

after, afterIfFailed, afterIfSuccessful, allowedWarnings, assertArrayEquals, assertBusy, assertBusy, assertBusyWithFixedSleepTime, assertEquals, assertNoDeprecationWarnings, 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, frequently, generateRandomStringArray, generateRandomStringArray, getBasePort, getBasePort, getDataPath, getPortRange, getShardLevelBlobPath, getSuiteFailureMarker, getTestTransportPlugin, getTestTransportType, inFipsJvm, iterations, maybeSet, mockScript, newNodeEnvironment, newNodeEnvironment, persistedStateRegistry, 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, randomNonNegativeInt, randomNonNegativeLong, randomPositiveTimeValue, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomShort, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomTimeValue, randomTimeValue, randomTimeZone, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomUnsignedLong, randomValueOtherThan, randomValueOtherThanMany, randomZone, remoteIndexSettings, removeHeaderWarningAppender, replaceUnicodeControlCharacters, replaceUnicodeControlCharacters, resetCheckIndexStatus, resetPortCounter, restoreContentType, restoreFileSystem, scaledRandomIntBetween, setContentType, setFileSystem, setHeaderWarningAppender, settings, shuffleMap, shuffleXContent, shuffleXContent, spinForAtLeastNMilliseconds, spinForAtLeastOneMillisecond, terminate, terminate, tmpPaths, toShuffledXContent, toShuffledXContent, waitUntil, waitUntil, warmIndexSettings, writableRegistry, xContentRegistry

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

addVirusChecker, assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertDoubleUlpEquals, assertFieldInfosEquals, assertFloatUlpEquals, assertNormsEquals, assertPointsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, assertThat, assertThat, asSet, assumeFalse, assumeNoException, assumeTrue, 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, 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, newSearcher, newSnapshotIndexWriterConfig, newStringField, newStringField, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, overrideDefaultQueryCache, overrideTestDefaultQueryCache, random, randomLocale, randomTimeZone, randomVectorFormat, rarely, rarely, replaceMaxFailureRule, resetDefaultQueryCache, restoreCPUCoreCount, restoreIndexWriterMaxDocs, runWithRestrictedPermissions, setIndexWriterMaxDocs, setupCPUCoreCount, setUpExecutorService, shutdownExecutorService, slowFileExists, 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, assertThrows, assertThrows, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

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

Field Details

FIELD_TYPES

protected static List<org.opensearch.index.mapper.MappedFieldType> FIELD_TYPES

Constructor Details

BaseCompositeAggregatorTestCase

public BaseCompositeAggregatorTestCase()

Method Details

setUp

public void setUp()
           throws Exception

Overrides:

setUp in class org.apache.lucene.tests.util.LuceneTestCase

Throws:

Exception

tearDown

public void tearDown()
              throws Exception

Overrides:

tearDown in class OpenSearchTestCase

Throws:

Exception

mapperServiceMock

protected org.opensearch.index.mapper.MapperService mapperServiceMock()

Description copied from class: AggregatorTestCase

sub-tests that need a more complex mock can overwrite this

Overrides:

mapperServiceMock in class AggregatorTestCase

createDocument

protected static Map<String, List<Object>> createDocument(Object... fields)

testSearchCase

protected void testSearchCase(List<org.apache.lucene.search.Query> queries,
 List<Map<String, List<Object>>> dataset,
 Supplier<org.opensearch.search.aggregations.bucket.composite.CompositeAggregationBuilder> create,
 Consumer<org.opensearch.search.aggregations.bucket.composite.InternalComposite> verify)
                       throws IOException

Throws:

IOException

executeTestCase

protected void executeTestCase(boolean forceMerge,
 boolean useIndexSort,
 org.apache.lucene.search.Query query,
 List<Map<String, List<Object>>> dataset,
 Supplier<? extends org.opensearch.search.aggregations.AggregationBuilder> create,
 Consumer<org.opensearch.search.aggregations.bucket.composite.InternalComposite> verify)
                        throws IOException

Throws:

IOException

addToDocument

protected void addToDocument(int id,
 org.apache.lucene.document.Document doc,
 Map<String, List<Object>> keys)

addValueToDocument

protected boolean addValueToDocument(org.apache.lucene.document.Document doc,
 String name,
 Object value)

Override this function to handle any specific type of value you want to add in the document for doing the composite aggregation. If you have added another Composite Aggregation Type then you must override this function so that your field value can be added in the document correctly.

Parameters:

doc - Document

name - String Field Name

value - Object Field value

Returns:

boolean true or false, based on if value is added or not

buildIndexSort

protected static org.apache.lucene.search.Sort buildIndexSort(List<org.opensearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder<?>> sources,
 Map<String, org.opensearch.index.mapper.MappedFieldType> fieldTypes)

sortFieldFrom

protected static org.apache.lucene.search.SortField sortFieldFrom(org.opensearch.index.mapper.MappedFieldType type)

createIndexSettings

protected static org.opensearch.index.IndexSettings createIndexSettings(org.apache.lucene.search.Sort sort)

createAfterKey

protected static Map<String,Object> createAfterKey(Object... fields)

asLong

protected static long asLong(String dateTime)