Package org.elasticsearch.test

Class InternalAggregationTestCase<T extends org.elasticsearch.search.aggregations.InternalAggregation>

java.lang.Object
org.junit.Assert
org.apache.lucene.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 org.elasticsearch.search.aggregations.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)

  • Field Details

  • Constructor Details

    • InternalAggregationTestCase

      public InternalAggregationTestCase()

  • Method Details

    • emptyReduceContextBuilder

      public static org.elasticsearch.search.aggregations.InternalAggregation.ReduceContextBuilder emptyReduceContextBuilder()
      Builds an InternalAggregation.ReduceContextBuilder that is valid but empty.

    • emptyReduceContextBuilder

      public static org.elasticsearch.search.aggregations.InternalAggregation.ReduceContextBuilder emptyReduceContextBuilder​(org.elasticsearch.search.aggregations.pipeline.PipelineAggregator.PipelineTree pipelineTree)
      Builds an InternalAggregation.ReduceContextBuilder that is valid and nearly empty except that it contain PipelineAggregators.

    • getDefaultNamedXContents

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

    • getNamedXContents

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

    • xContentRegistry

      protected org.elasticsearch.common.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 org.elasticsearch.common.io.stream.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 org.elasticsearch.search.aggregations.InternalAggregation>

    • getNamedWriteables

      protected List<org.elasticsearch.common.io.stream.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 org.elasticsearch.plugins.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 org.elasticsearch.search.aggregations.InternalAggregation>

    • randomResultsToReduce

      protected List<T> randomResultsToReduce​(String name, int size)
      Generate a list of inputs to reduce. Defaults to calling createTestInstance(String) and createUnmappedInstance(String) but should be overridden if it isn't realistic to reduce test instances.

    • testReduceRandom

      public void testReduceRandom() throws IOException
      Throws:
      IOException

    • doAssertReducedMultiBucketConsumer

      protected void doAssertReducedMultiBucketConsumer​(org.elasticsearch.search.aggregations.Aggregation agg, org.elasticsearch.search.aggregations.MultiBucketConsumerService.MultiBucketConsumer bucketConsumer)

    • mockScriptService

      protected org.elasticsearch.script.ScriptService mockScriptService()
      overwrite in tests that need it

    • assertReduced

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

    • 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 org.elasticsearch.search.aggregations.InternalAggregation>

    • 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

    • testMergePipelineTreeForBWCSerialization

      public void testMergePipelineTreeForBWCSerialization()

    • testMergePipelineTreeTwice

      public void testMergePipelineTreeTwice()

    • randomPipelineTree

      public static org.elasticsearch.search.aggregations.pipeline.PipelineAggregator.PipelineTree randomPipelineTree​(org.elasticsearch.search.aggregations.InternalAggregation aggregation)

    • randomPipelineAggregators

      public static List<org.elasticsearch.search.aggregations.pipeline.PipelineAggregator> randomPipelineAggregators()

    • assertFromXContent

      protected abstract void assertFromXContent​(T aggregation, org.elasticsearch.search.aggregations.ParsedAggregation parsedAggregation) throws IOException
      Throws:
      IOException

    • parseAndAssert

      protected <P extends org.elasticsearch.search.aggregations.ParsedAggregation> P parseAndAssert​(org.elasticsearch.search.aggregations.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 org.elasticsearch.search.DocValueFormat randomNumericDocValueFormat()
      Returns:
      a random DocValueFormat that can be used in aggregations which compute numbers.

    • assertMultiBucketConsumer

      public static void assertMultiBucketConsumer​(org.elasticsearch.search.aggregations.Aggregation agg, org.elasticsearch.search.aggregations.MultiBucketConsumerService.MultiBucketConsumer bucketConsumer)