Package org.elasticsearch.test

Class ESSingleNodeTestCase

java.lang.Object
org.junit.Assert
org.apache.lucene.tests.util.LuceneTestCase
org.elasticsearch.test.ESTestCase
org.elasticsearch.test.ESSingleNodeTestCase
Direct Known Subclasses:
AbstractThirdPartyRepositoryTestCase, BasePointShapeQueryTestCase
public abstract class ESSingleNodeTestCase extends ESTestCase
A test that keep a singleton node started for all tests that can be used to get references to Guice injectors in unit tests.

  • Constructor Details

    • ESSingleNodeTestCase

      public ESSingleNodeTestCase()

  • Method Details

    • startNode

      protected void startNode(long seed) throws Exception
      Throws:
      Exception

    • 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 org.apache.lucene.tests.util.LuceneTestCase
      Throws:
      Exception

    • setUpClass

      public static void setUpClass() throws Exception
      Throws:
      Exception

    • tearDownClass

      public static void tearDownClass() throws Exception
      Throws:
      Exception

    • resetNodeAfterTest

      protected boolean resetNodeAfterTest()
      This method returns true if the node that is used in the background should be reset after each test. This is useful if the test changes the cluster state metadata etc. The default is false.

    • getPlugins

      protected Collection<Class<? extends Plugin>> getPlugins()
      The plugin classes that should be added to the node.

    • pluginList

      @SafeVarargs protected final Collection<Class<? extends Plugin>> pluginList(Class<? extends Plugin>... plugins)
      Helper method to create list of plugins without specifying generic types.

    • nodeSettings

      protected Settings nodeSettings()
      Additional settings to add when creating the node. Also allows overriding the default settings.

    • addMockHttpTransport

      protected boolean addMockHttpTransport()
      True if a dummy http transport should be used, or false if the real http transport should be used.

    • filteredWarnings

      protected List<String> filteredWarnings()
      Overrides:
      filteredWarnings in class ESTestCase

    • client

      public Client client()
      Returns a client to the single-node cluster.

    • safeExecute

      public <T extends ActionResponse> T safeExecute(ActionType<T> action, ActionRequest request)
      Execute the given ActionRequest using the given ActionType and the default node client, wait for it to complete with a timeout of ESTestCase.SAFE_AWAIT_TIMEOUT, and then return the result. An exceptional response, timeout or interrupt triggers a test failure.

    • admin

      protected AdminClient admin()
      Returns an admin client.

    • indicesAdmin

      protected IndicesAdminClient indicesAdmin()
      Returns an indices admin client.

    • clusterAdmin

      protected ClusterAdminClient clusterAdmin()
      Returns a cluster admin client.

    • wrapClient

      public Client wrapClient(Client client)

    • node

      protected Node node()
      Return a reference to the singleton node.

    • getInstanceFromNode

      protected <T> T getInstanceFromNode(Class<T> clazz)
      Get an instance for a particular class using the injector of the singleton node.

    • createIndex

      protected IndexService createIndex(String index)
      Create a new index on the singleton node with empty index settings.

    • createIndex

      protected IndexService createIndex(String index, Settings settings)
      Create a new index on the singleton node with the provided index settings.

    • createIndex

      protected IndexService createIndex(String index, Settings settings, org.elasticsearch.xcontent.XContentBuilder mappings)
      Create a new index on the singleton node with the provided index settings.

    • createIndex

      protected IndexService createIndex(String index, Settings settings, String type, String... mappings)
      Create a new index on the singleton node with the provided index settings.

    • createIndex

      protected IndexService createIndex(String index, CreateIndexRequestBuilder createIndexRequestBuilder)

    • resolveIndex

      public Index resolveIndex(String index)

    • prepareIndex

      protected IndexRequestBuilder prepareIndex(String index)

    • createSearchContext

      protected SearchContext createSearchContext(IndexService indexService)
      Create a new search context.

    • ensureGreen

      public ClusterHealthStatus ensureGreen(String... indices)
      Ensures the cluster has a green state via the cluster health API. This method will also wait for relocations. It is useful to ensure that all action on the cluster have finished and all shards that were currently relocating are now allocated and started.

    • ensureGreen

      public ClusterHealthStatus ensureGreen(org.elasticsearch.core.TimeValue timeout, String... indices)
      Ensures the cluster has a green state via the cluster health API. This method will also wait for relocations. It is useful to ensure that all action on the cluster have finished and all shards that were currently relocating are now allocated and started.
      Parameters:
      timeout - time out value to set on ClusterHealthRequest

    • 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

    • forbidPrivateIndexSettings

      protected boolean forbidPrivateIndexSettings()

    • ensureNoInitializingShards

      protected void ensureNoInitializingShards()
      waits until all shard initialization is completed. inspired by ESRestTestCase

    • ensureAllFreeContextActionsAreConsumed

      protected void ensureAllFreeContextActionsAreConsumed() throws Exception
      waits until all free_context actions have been handled by the generic thread pool
      Throws:
      Exception

    • enableConcurrentSearch

      protected boolean enableConcurrentSearch()
      Whether we'd like to enable inter-segment search concurrency and increase the likelihood of leveraging it, by creating multiple slices with a low amount of documents in them, which would not be allowed in production. Default is true, can be disabled if it causes problems in specific tests.

    • awaitIndexShardCloseAsyncTasks

      protected void awaitIndexShardCloseAsyncTasks()

    • putJsonPipeline

      protected final void putJsonPipeline(String id, String jsonString)
      Create an ingest pipeline with the given ID and body, using the default client().
      Parameters:
      id - The pipeline id.
      jsonString - The body of the PutPipelineRequest as a JSON-formatted String.

    • putJsonPipeline

      protected final void putJsonPipeline(String id, org.elasticsearch.xcontent.ToXContentFragment toXContent) throws IOException
      Create an ingest pipeline with the given ID and body, using the default client().
      Parameters:
      id - The pipeline id.
      toXContent - The body of the PutPipelineRequest as a ToXContentFragment.
      Throws:
      IOException

    • deletePipeline

      protected final void deletePipeline(String id)
      Delete the ingest pipeline with the given id, the default client().