Package org.opensearch.search.aggregations

Class BasePipelineAggregationTestCase<AF extends org.opensearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<AF>>

java.lang.Object

org.junit.Assert

org.apache.lucene.util.LuceneTestCase

org.opensearch.test.OpenSearchTestCase

org.opensearch.search.aggregations.BasePipelineAggregationTestCase<AF>

public abstract class BasePipelineAggregationTestCase<AF extends org.opensearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<AF>>
extends OpenSearchTestCase

Nested Class Summary

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

OpenSearchTestCase.GeohashGenerator, OpenSearchTestCase.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 java.lang.String	BOOLEAN_FIELD_NAME
protected static java.lang.String	DATE_FIELD_NAME
protected static java.lang.String	DOUBLE_FIELD_NAME
protected static java.lang.String	INT_FIELD_NAME
protected static java.lang.String	STRING_FIELD_NAME

Fields inherited from class org.opensearch.test.OpenSearchTestCase

checkIndexFailures, DEFAULT_NAMED_WRITABLE_REGISTRY, DEFAULT_TEST_WORKER_ID, failureAndSuccessEvents, FIPS_SYSPROP, 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.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
BasePipelineAggregationTestCase()

Method Summary

Modifier and Type	Method	Description
protected java.util.List<org.opensearch.common.xcontent.NamedXContentRegistry.Entry>	additionalNamedContents()	Any extra named xcontents required not registered by SearchModule
protected java.util.List<org.opensearch.common.io.stream.NamedWriteableRegistry.Entry>	additionalNamedWriteables()	Any extra named writeables required not registered by SearchModule
protected abstract AF	createTestAggregatorFactory()
protected java.lang.String[]	getCurrentTypes()
protected java.lang.String[]	getRandomTypes()
protected org.opensearch.search.aggregations.PipelineAggregationBuilder	parse(org.opensearch.common.xcontent.XContentParser parser)
protected java.util.List<org.opensearch.plugins.SearchPlugin>	plugins()	Plugins to add to the test.
java.lang.String	randomNumericField()
void	setUp()	Setup for the whole base test class.
void	testEqualsAndHashcode()
void	testFromXContent()	Generic test that creates new AggregatorFactory from the test AggregatorFactory and checks both for equality and asserts equality on the two queries.
void	testSerialization()	Test serialization and deserialization of the test AggregatorFactory.
protected java.lang.String	validate(java.util.Collection<org.opensearch.search.aggregations.AggregationBuilder> siblingAggregations, AF builder)	Helper for testing validation.
protected java.lang.String	validate(java.util.Collection<org.opensearch.search.aggregations.AggregationBuilder> siblingAggregations, java.util.Collection<org.opensearch.search.aggregations.PipelineAggregationBuilder> siblingPipelineAggregations, AF builder)	Helper for testing validation.
protected java.lang.String	validate(org.opensearch.search.aggregations.AggregationBuilder parent, AF builder)	Helper for testing validation.
protected java.lang.String	validate(org.opensearch.search.aggregations.PipelineAggregationBuilder.ValidationContext context, AF builder)	Helper for testing validation.
protected org.opensearch.common.xcontent.NamedXContentRegistry	xContentRegistry()	The NamedXContentRegistry to use for this test.

Methods inherited from class org.opensearch.test.OpenSearchTestCase

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, frequently, generateRandomStringArray, generateRandomStringArray, getBasePort, getDataPath, getPortRange, getSuiteFailureMarker, getTestTransportPlugin, getTestTransportType, inFipsJvm, iterations, maybeSet, mockScript, 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, 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

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, 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, restoreSpins, runWithRestrictedPermissions, setIndexWriterMaxDocs, 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

STRING_FIELD_NAME

protected static final java.lang.String STRING_FIELD_NAME

See Also:

Constant Field Values

INT_FIELD_NAME

protected static final java.lang.String INT_FIELD_NAME

See Also:

Constant Field Values

DOUBLE_FIELD_NAME

protected static final java.lang.String DOUBLE_FIELD_NAME

See Also:

Constant Field Values

BOOLEAN_FIELD_NAME

protected static final java.lang.String BOOLEAN_FIELD_NAME

See Also:

Constant Field Values

DATE_FIELD_NAME

protected static final java.lang.String DATE_FIELD_NAME

See Also:

Constant Field Values

Constructor Details

BasePipelineAggregationTestCase

public BasePipelineAggregationTestCase()

Method Details

getCurrentTypes

protected java.lang.String[] getCurrentTypes()

createTestAggregatorFactory

protected abstract AF createTestAggregatorFactory()

setUp

public void setUp() throws java.lang.Exception

Setup for the whole base test class.

Overrides:

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

Throws:

java.lang.Exception

plugins

protected java.util.List<org.opensearch.plugins.SearchPlugin> plugins()

Plugins to add to the test.

additionalNamedWriteables

protected java.util.List<org.opensearch.common.io.stream.NamedWriteableRegistry.Entry> additionalNamedWriteables()

Any extra named writeables required not registered by SearchModule

additionalNamedContents

protected java.util.List<org.opensearch.common.xcontent.NamedXContentRegistry.Entry> additionalNamedContents()

Any extra named xcontents required not registered by SearchModule

testFromXContent

public void testFromXContent() throws java.io.IOException

Generic test that creates new AggregatorFactory from the test AggregatorFactory and checks both for equality and asserts equality on the two queries.

Throws:

java.io.IOException

parse

protected org.opensearch.search.aggregations.PipelineAggregationBuilder parse(org.opensearch.common.xcontent.XContentParser parser) throws java.io.IOException

Throws:

java.io.IOException

testSerialization

public void testSerialization() throws java.io.IOException

Test serialization and deserialization of the test AggregatorFactory.

Throws:

java.io.IOException

testEqualsAndHashcode

public void testEqualsAndHashcode() throws java.io.IOException

Throws:

java.io.IOException

getRandomTypes

protected java.lang.String[] getRandomTypes()

randomNumericField

public java.lang.String randomNumericField()

xContentRegistry

protected org.opensearch.common.xcontent.NamedXContentRegistry xContentRegistry()

Description copied from class: OpenSearchTestCase

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

Overrides:

xContentRegistry in class OpenSearchTestCase

validate

protected java.lang.String validate(org.opensearch.search.aggregations.AggregationBuilder parent, AF builder)

Helper for testing validation.

validate

protected java.lang.String validate(java.util.Collection<org.opensearch.search.aggregations.AggregationBuilder> siblingAggregations, AF builder)

Helper for testing validation.

validate

protected java.lang.String validate(java.util.Collection<org.opensearch.search.aggregations.AggregationBuilder> siblingAggregations, java.util.Collection<org.opensearch.search.aggregations.PipelineAggregationBuilder> siblingPipelineAggregations, AF builder)

Helper for testing validation.

validate

protected java.lang.String validate(org.opensearch.search.aggregations.PipelineAggregationBuilder.ValidationContext context, AF builder)

Helper for testing validation.