Package org.elasticsearch.test.hamcrest

Class ElasticsearchAssertions

java.lang.Object

org.elasticsearch.test.hamcrest.ElasticsearchAssertions

public class ElasticsearchAssertions
extends Object

Constructor Summary

Constructors

Constructor	Description
ElasticsearchAssertions()

Method Summary

Modifier and Type	Method	Description
static void	assertAcked(org.elasticsearch.action.admin.indices.create.CreateIndexResponse response)	Assert that an index creation was fully acknowledged, meaning that both the index creation cluster state update was successful and that the requisite number of shard copies were started before returning.
static void	assertAcked(org.elasticsearch.action.admin.indices.delete.DeleteIndexRequestBuilder builder)
static void	assertAcked(org.elasticsearch.action.support.master.AcknowledgedRequestBuilder<?,?,?> builder)
static void	assertAcked(org.elasticsearch.action.support.master.AcknowledgedResponse response)
static void	assertAllSuccessful(org.elasticsearch.action.search.SearchResponse response)
static void	assertAllSuccessful(org.elasticsearch.action.support.broadcast.BroadcastResponse response)
static void	assertBlocked(org.elasticsearch.action.ActionRequestBuilder<?,?> builder)	Executes the request and fails if the request has not been blocked.
static void	assertBlocked(org.elasticsearch.action.ActionRequestBuilder<?,?> builder, Integer expectedBlockId)	Executes the request and fails if the request has not been blocked by a specific ClusterBlock.
static void	assertBlocked(org.elasticsearch.action.ActionRequestBuilder<?,?> builder, org.elasticsearch.cluster.block.ClusterBlock expectedBlock)	Executes the request and fails if the request has not been blocked by a specific ClusterBlock.
static void	assertBlocked(org.elasticsearch.action.support.broadcast.BroadcastResponse replicatedBroadcastResponse)	Checks that all shard requests of a replicated broadcast request failed due to a cluster block
static <T extends org.apache.lucene.search.Query> T	assertBooleanSubQuery(org.apache.lucene.search.Query query, Class<T> subqueryType, int i)
static void	assertExists(org.elasticsearch.action.get.GetResponse response)
static void	assertFailures(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder, org.elasticsearch.rest.RestStatus restStatus, org.hamcrest.Matcher<String> reasonMatcher)
static void	assertFailures(org.elasticsearch.action.search.SearchResponse searchResponse)
static void	assertFileExists(Path file)	Check if a file exists
static void	assertFileNotExists(Path file)	Check if a file does not exist
static void	assertFirstHit(org.elasticsearch.action.search.SearchResponse searchResponse, org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)
static void	assertFourthHit(org.elasticsearch.action.search.SearchResponse searchResponse, org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)
static <E extends Throwable> void	assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future, Class<E> exceptionClass)	Run future.actionGet() and check that it throws an exception of the right type
static <E extends Throwable> void	assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future, Class<E> exceptionClass, String extraInfo)	Run future.actionGet() and check that it throws an exception of the right type
static <E extends Throwable> void	assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future, Class<E> exceptionClass, org.elasticsearch.rest.RestStatus status)	Run future.actionGet() and check that it throws an exception of the right type, with a given RestStatus
static <E extends Throwable> void	assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future, Class<E> exceptionClass, org.elasticsearch.rest.RestStatus status, String extraInfo)	Run future.actionGet() and check that it throws an exception of the right type, optionally checking the exception's rest status
static void	assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future, org.elasticsearch.rest.RestStatus status)
static void	assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future, org.elasticsearch.rest.RestStatus status, String extraInfo)
static void	assertHighlight(org.elasticsearch.action.search.SearchResponse resp, int hit, String field, int fragment, int totalFragments, org.hamcrest.Matcher<String> matcher)
static void	assertHighlight(org.elasticsearch.action.search.SearchResponse resp, int hit, String field, int fragment, org.hamcrest.Matcher<String> matcher)
static void	assertHighlight(org.elasticsearch.search.SearchHit hit, String field, int fragment, int totalFragments, org.hamcrest.Matcher<String> matcher)
static void	assertHighlight(org.elasticsearch.search.SearchHit hit, String field, int fragment, org.hamcrest.Matcher<String> matcher)
static void	assertHitCount(org.elasticsearch.action.search.SearchResponse countResponse, long expectedHitCount)
static void	assertIndexTemplateExists(org.elasticsearch.action.admin.indices.template.get.GetIndexTemplatesResponse templatesResponse, String name)	Assert that an index template exists
static void	assertIndexTemplateMissing(org.elasticsearch.action.admin.indices.template.get.GetIndexTemplatesResponse templatesResponse, String name)	Assert that an index template is missing
static void	assertNoFailures(org.elasticsearch.action.bulk.BulkResponse response)
static void	assertNoFailures(org.elasticsearch.action.search.SearchResponse searchResponse)
static void	assertNoFailures(org.elasticsearch.action.support.broadcast.BroadcastResponse response)
static void	assertNoSearchHits(org.elasticsearch.action.search.SearchResponse searchResponse)
static void	assertNotHighlighted(org.elasticsearch.action.search.SearchResponse resp, int hit, String field)
static void	assertNoTimeout(org.elasticsearch.action.admin.cluster.health.ClusterHealthRequestBuilder requestBuilder)
static void	assertNoTimeout(org.elasticsearch.action.admin.cluster.health.ClusterHealthResponse response)
static void	assertOrderedSearchHits(org.elasticsearch.action.search.SearchResponse searchResponse, String... ids)
static <E extends Throwable> void	assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder, Class<E> exceptionClass)	Run the request from a given builder and check that it throws an exception of the right type
static <E extends Throwable> void	assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder, Class<E> exceptionClass, String extraInfo)	Run the request from a given builder and check that it throws an exception of the right type
static <E extends Throwable> void	assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder, Class<E> exceptionClass, org.elasticsearch.rest.RestStatus status)	Run the request from a given builder and check that it throws an exception of the right type, with a given RestStatus
static void	assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder, org.elasticsearch.rest.RestStatus status)
static void	assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder, org.elasticsearch.rest.RestStatus status, String extraInfo)
static void	assertSearchHit(org.elasticsearch.action.search.SearchResponse searchResponse, int number, org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)
static void	assertSearchHits(org.elasticsearch.action.search.SearchResponse searchResponse, String... ids)
static org.elasticsearch.action.search.SearchResponse	assertSearchResponse(org.elasticsearch.action.search.SearchRequestBuilder request)	Applies basic assertions on the SearchResponse.
static org.elasticsearch.action.search.SearchResponse	assertSearchResponse(org.elasticsearch.action.search.SearchResponse response)	Applies basic assertions on the SearchResponse.
static void	assertSecondHit(org.elasticsearch.action.search.SearchResponse searchResponse, org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)
static void	assertSortValues(org.elasticsearch.action.search.SearchResponse searchResponse, Object[]... sortValues)
static void	assertSuggestion(org.elasticsearch.search.suggest.Suggest searchSuggest, int entry, int ord, String key, String text)
static void	assertSuggestion(org.elasticsearch.search.suggest.Suggest searchSuggest, int entry, String key, int size, String... text)	Assert suggestion returns size suggestions and the first are the provided text.
static void	assertSuggestion(org.elasticsearch.search.suggest.Suggest searchSuggest, int entry, String key, String... text)	Assert suggestion returns exactly the provided text.
static void	assertSuggestionPhraseCollateMatchExists(org.elasticsearch.search.suggest.Suggest searchSuggest, String key, int numberOfPhraseExists)
static void	assertSuggestionSize(org.elasticsearch.search.suggest.Suggest searchSuggest, int entry, int size, String key)
static void	assertThirdHit(org.elasticsearch.action.search.SearchResponse searchResponse, org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)
static void	assertToXContentEquivalent(org.elasticsearch.common.bytes.BytesReference expected, org.elasticsearch.common.bytes.BytesReference actual, org.elasticsearch.xcontent.XContentType xContentType)	Asserts that the provided BytesReferences created through ToXContent.toXContent(XContentBuilder, ToXContent.Params) hold the same content.
static void	awaitLatch(CountDownLatch latch, long timeout, TimeUnit unit)	Wait for a latch to countdown and provide a useful error message if it does not Often latches are called as assertTrue(latch.await(1, TimeUnit.SECONDS)); In case of a failure this will just throw an assertion error without any further message
static Function<org.elasticsearch.search.SearchHit,Object>	fieldFromSource(String fieldName)
static String	formatShardStatus(org.elasticsearch.action.search.SearchResponse response)
static String	formatShardStatus(org.elasticsearch.action.support.broadcast.BroadcastResponse response)
static org.hamcrest.Matcher<org.elasticsearch.search.SearchHit>	hasId(String id)
static org.hamcrest.Matcher<org.elasticsearch.search.SearchHit>	hasIndex(String index)
static <T, V> org.hamcrest.core.CombinableMatcher<T>	hasProperty(Function<? super T,? extends V> property, org.hamcrest.Matcher<V> valueMatcher)
static org.hamcrest.Matcher<org.elasticsearch.search.SearchHit>	hasScore(float score)

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchAssertions

public ElasticsearchAssertions()

Method Details

assertAcked

public static void assertAcked(org.elasticsearch.action.support.master.AcknowledgedRequestBuilder<?,?,?> builder)

assertNoTimeout

public static void assertNoTimeout(org.elasticsearch.action.admin.cluster.health.ClusterHealthRequestBuilder requestBuilder)

assertNoTimeout

public static void assertNoTimeout(org.elasticsearch.action.admin.cluster.health.ClusterHealthResponse response)

assertAcked

public static void assertAcked(org.elasticsearch.action.support.master.AcknowledgedResponse response)

assertAcked

public static void assertAcked(org.elasticsearch.action.admin.indices.delete.DeleteIndexRequestBuilder builder)

assertAcked

public static void assertAcked(org.elasticsearch.action.admin.indices.create.CreateIndexResponse response)

Assert that an index creation was fully acknowledged, meaning that both the index creation cluster state update was successful and that the requisite number of shard copies were started before returning.

assertBlocked

public static void assertBlocked(org.elasticsearch.action.ActionRequestBuilder<?,?> builder)

Executes the request and fails if the request has not been blocked.

Parameters:

builder - the request builder

assertBlocked

public static void assertBlocked(org.elasticsearch.action.support.broadcast.BroadcastResponse replicatedBroadcastResponse)

Checks that all shard requests of a replicated broadcast request failed due to a cluster block

Parameters:

replicatedBroadcastResponse - the response that should only contain failed shard responses

assertBlocked

public static void assertBlocked(org.elasticsearch.action.ActionRequestBuilder<?,?> builder,
 @Nullable
 Integer expectedBlockId)

Executes the request and fails if the request has not been blocked by a specific ClusterBlock.

Parameters:

builder - the request builder

expectedBlockId - the expected block id

assertBlocked

public static void assertBlocked(org.elasticsearch.action.ActionRequestBuilder<?,?> builder,
 @Nullable
 org.elasticsearch.cluster.block.ClusterBlock expectedBlock)

Executes the request and fails if the request has not been blocked by a specific ClusterBlock.

Parameters:

builder - the request builder

expectedBlock - the expected block

formatShardStatus

public static String formatShardStatus(org.elasticsearch.action.support.broadcast.BroadcastResponse response)

formatShardStatus

public static String formatShardStatus(org.elasticsearch.action.search.SearchResponse response)

assertNoSearchHits

public static void assertNoSearchHits(org.elasticsearch.action.search.SearchResponse searchResponse)

assertSearchHits

public static void assertSearchHits(org.elasticsearch.action.search.SearchResponse searchResponse,
 String... ids)

assertSortValues

public static void assertSortValues(org.elasticsearch.action.search.SearchResponse searchResponse,
 Object[]... sortValues)

assertOrderedSearchHits

public static void assertOrderedSearchHits(org.elasticsearch.action.search.SearchResponse searchResponse,
 String... ids)

assertHitCount

public static void assertHitCount(org.elasticsearch.action.search.SearchResponse countResponse,
 long expectedHitCount)

assertExists

public static void assertExists(org.elasticsearch.action.get.GetResponse response)

assertFirstHit

public static void assertFirstHit(org.elasticsearch.action.search.SearchResponse searchResponse,
 org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)

assertSecondHit

public static void assertSecondHit(org.elasticsearch.action.search.SearchResponse searchResponse,
 org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)

assertThirdHit

public static void assertThirdHit(org.elasticsearch.action.search.SearchResponse searchResponse,
 org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)

assertFourthHit

public static void assertFourthHit(org.elasticsearch.action.search.SearchResponse searchResponse,
 org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)

assertSearchHit

public static void assertSearchHit(org.elasticsearch.action.search.SearchResponse searchResponse,
 int number,
 org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> matcher)

assertNoFailures

public static void assertNoFailures(org.elasticsearch.action.search.SearchResponse searchResponse)

assertFailures

public static void assertFailures(org.elasticsearch.action.search.SearchResponse searchResponse)

assertNoFailures

public static void assertNoFailures(org.elasticsearch.action.bulk.BulkResponse response)

assertFailures

public static void assertFailures(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder,
 org.elasticsearch.rest.RestStatus restStatus,
 org.hamcrest.Matcher<String> reasonMatcher)

assertNoFailures

public static void assertNoFailures(org.elasticsearch.action.support.broadcast.BroadcastResponse response)

assertAllSuccessful

public static void assertAllSuccessful(org.elasticsearch.action.support.broadcast.BroadcastResponse response)

assertAllSuccessful

public static void assertAllSuccessful(org.elasticsearch.action.search.SearchResponse response)

assertHighlight

public static void assertHighlight(org.elasticsearch.action.search.SearchResponse resp,
 int hit,
 String field,
 int fragment,
 org.hamcrest.Matcher<String> matcher)

assertHighlight

public static void assertHighlight(org.elasticsearch.action.search.SearchResponse resp,
 int hit,
 String field,
 int fragment,
 int totalFragments,
 org.hamcrest.Matcher<String> matcher)

assertHighlight

public static void assertHighlight(org.elasticsearch.search.SearchHit hit,
 String field,
 int fragment,
 org.hamcrest.Matcher<String> matcher)

assertHighlight

public static void assertHighlight(org.elasticsearch.search.SearchHit hit,
 String field,
 int fragment,
 int totalFragments,
 org.hamcrest.Matcher<String> matcher)

assertNotHighlighted

public static void assertNotHighlighted(org.elasticsearch.action.search.SearchResponse resp,
 int hit,
 String field)

assertSuggestionSize

public static void assertSuggestionSize(org.elasticsearch.search.suggest.Suggest searchSuggest,
 int entry,
 int size,
 String key)

assertSuggestionPhraseCollateMatchExists

public static void assertSuggestionPhraseCollateMatchExists(org.elasticsearch.search.suggest.Suggest searchSuggest,
 String key,
 int numberOfPhraseExists)

assertSuggestion

public static void assertSuggestion(org.elasticsearch.search.suggest.Suggest searchSuggest,
 int entry,
 int ord,
 String key,
 String text)

assertSuggestion

public static void assertSuggestion(org.elasticsearch.search.suggest.Suggest searchSuggest,
 int entry,
 String key,
 String... text)

Assert suggestion returns exactly the provided text.

assertSuggestion

public static void assertSuggestion(org.elasticsearch.search.suggest.Suggest searchSuggest,
 int entry,
 String key,
 int size,
 String... text)

Assert suggestion returns size suggestions and the first are the provided text.

assertIndexTemplateMissing

public static void assertIndexTemplateMissing(org.elasticsearch.action.admin.indices.template.get.GetIndexTemplatesResponse templatesResponse,
 String name)

Assert that an index template is missing

assertIndexTemplateExists

public static void assertIndexTemplateExists(org.elasticsearch.action.admin.indices.template.get.GetIndexTemplatesResponse templatesResponse,
 String name)

Assert that an index template exists

hasId

public static org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> hasId(String id)

hasIndex

public static org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> hasIndex(String index)

hasScore

public static org.hamcrest.Matcher<org.elasticsearch.search.SearchHit> hasScore(float score)

hasProperty

public static <T,
V>
org.hamcrest.core.CombinableMatcher<T> hasProperty(Function<? super T,? extends V> property,
 org.hamcrest.Matcher<V> valueMatcher)

fieldFromSource

public static Function<org.elasticsearch.search.SearchHit,Object> fieldFromSource(String fieldName)

assertBooleanSubQuery

public static <T extends org.apache.lucene.search.Query>
T assertBooleanSubQuery(org.apache.lucene.search.Query query,
 Class<T> subqueryType,
 int i)

assertRequestBuilderThrows

public static <E extends Throwable> void assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder,
 Class<E> exceptionClass)

Run the request from a given builder and check that it throws an exception of the right type

assertRequestBuilderThrows

public static <E extends Throwable> void assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder,
 Class<E> exceptionClass,
 org.elasticsearch.rest.RestStatus status)

Run the request from a given builder and check that it throws an exception of the right type, with a given RestStatus

assertRequestBuilderThrows

public static <E extends Throwable> void assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder,
 Class<E> exceptionClass,
 String extraInfo)

Run the request from a given builder and check that it throws an exception of the right type

Parameters:

extraInfo - extra information to add to the failure message

assertFutureThrows

public static <E extends Throwable> void assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future,
 Class<E> exceptionClass)

Run future.actionGet() and check that it throws an exception of the right type

assertFutureThrows

public static <E extends Throwable> void assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future,
 Class<E> exceptionClass,
 org.elasticsearch.rest.RestStatus status)

Run future.actionGet() and check that it throws an exception of the right type, with a given RestStatus

assertFutureThrows

public static <E extends Throwable> void assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future,
 Class<E> exceptionClass,
 String extraInfo)

Run future.actionGet() and check that it throws an exception of the right type

Parameters:

extraInfo - extra information to add to the failure message

assertFutureThrows

public static <E extends Throwable> void assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future,
 Class<E> exceptionClass,
 @Nullable
 org.elasticsearch.rest.RestStatus status,
 @Nullable
 String extraInfo)

Run future.actionGet() and check that it throws an exception of the right type, optionally checking the exception's rest status

Parameters:

exceptionClass - expected exception class

status - RestStatus to check for. Can be null to disable the check

extraInfo - extra information to add to the failure message. Can be null.

assertRequestBuilderThrows

public static void assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder,
 org.elasticsearch.rest.RestStatus status)

assertRequestBuilderThrows

public static void assertRequestBuilderThrows(org.elasticsearch.action.ActionRequestBuilder<?,?> builder,
 org.elasticsearch.rest.RestStatus status,
 String extraInfo)

assertFutureThrows

public static void assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future,
 org.elasticsearch.rest.RestStatus status)

assertFutureThrows

public static void assertFutureThrows(org.elasticsearch.action.ActionFuture<?> future,
 org.elasticsearch.rest.RestStatus status,
 String extraInfo)

assertSearchResponse

public static org.elasticsearch.action.search.SearchResponse assertSearchResponse(org.elasticsearch.action.search.SearchRequestBuilder request)

Applies basic assertions on the SearchResponse. This method checks if all shards were successful, if any of the shards threw an exception and if the response is serializable.

assertSearchResponse

public static org.elasticsearch.action.search.SearchResponse assertSearchResponse(org.elasticsearch.action.search.SearchResponse response)

Applies basic assertions on the SearchResponse. This method checks if all shards were successful, if any of the shards threw an exception and if the response is serializable.

assertFileExists

public static void assertFileExists(Path file)

Check if a file exists

assertFileNotExists

public static void assertFileNotExists(Path file)

Check if a file does not exist

assertToXContentEquivalent

public static void assertToXContentEquivalent(org.elasticsearch.common.bytes.BytesReference expected,
 org.elasticsearch.common.bytes.BytesReference actual,
 org.elasticsearch.xcontent.XContentType xContentType)
                                       throws IOException

Asserts that the provided BytesReferences created through ToXContent.toXContent(XContentBuilder, ToXContent.Params) hold the same content. The comparison is done by parsing both into a map and comparing those two, so that keys ordering doesn't matter. Also binary values (byte[]) are properly compared through arrays comparisons.

Throws:

IOException

awaitLatch

public static void awaitLatch(CountDownLatch latch,
 long timeout,
 TimeUnit unit)
                       throws InterruptedException

Wait for a latch to countdown and provide a useful error message if it does not Often latches are called as assertTrue(latch.await(1, TimeUnit.SECONDS)); In case of a failure this will just throw an assertion error without any further message

Parameters:

latch - The latch to wait for

timeout - The value of the timeout

unit - The unit of the timeout

Throws:

InterruptedException - An exception if the waiting is interrupted