Package org.elasticsearch.test.rest

Class RestActionTestCase.VerifyingClient

java.lang.Object

org.elasticsearch.client.internal.support.AbstractClient

org.elasticsearch.client.internal.node.NodeClient

org.elasticsearch.test.client.NoOpNodeClient

org.elasticsearch.test.rest.RestActionTestCase.VerifyingClient

All Implemented Interfaces:

Closeable, AutoCloseable, org.elasticsearch.client.internal.Client, org.elasticsearch.client.internal.ElasticsearchClient, org.elasticsearch.core.Releasable

Enclosing class:

RestActionTestCase

public static class RestActionTestCase.VerifyingClient
extends NoOpNodeClient

A mocked NodeClient which can be easily reconfigured to verify arbitrary verification functions, and can be reset to allow reconfiguration partway through a test without having to construct a new object. By default, will throw AssertionError when any execution method is called, unless configured otherwise using setExecuteVerifier(java.util.function.BiFunction<org.elasticsearch.action.ActionType<R>, org.elasticsearch.action.ActionRequest, R>) or setExecuteLocallyVerifier(java.util.function.BiFunction<org.elasticsearch.action.ActionType<?>, org.elasticsearch.action.ActionRequest, org.elasticsearch.action.ActionResponse>).

Field Summary

Fields inherited from class org.elasticsearch.client.internal.support.AbstractClient

logger, settings

Fields inherited from interface org.elasticsearch.client.internal.Client

CLIENT_TYPE_SETTING_S

Constructor Summary

Constructors

Constructor	Description
VerifyingClient(String testName)

Method Summary

Modifier and Type	Method	Description
<Request extends org.elasticsearch.action.ActionRequest, Response extends org.elasticsearch.action.ActionResponse> void	doExecute(org.elasticsearch.action.ActionType<Response> action, Request request, org.elasticsearch.action.ActionListener<Response> listener)
<Request extends org.elasticsearch.action.ActionRequest, Response extends org.elasticsearch.action.ActionResponse> org.elasticsearch.tasks.Task	executeLocally(org.elasticsearch.action.ActionType<Response> action, Request request, org.elasticsearch.action.ActionListener<Response> listener)
<Request extends org.elasticsearch.action.ActionRequest, Response extends org.elasticsearch.action.ActionResponse> org.elasticsearch.tasks.Task	executeLocally(org.elasticsearch.action.ActionType<Response> action, Request request, org.elasticsearch.tasks.TaskListener<Response> listener)
String	getLocalNodeId()
void	reset()	Clears any previously set verifier functions set by setExecuteVerifier(java.util.function.BiFunction<org.elasticsearch.action.ActionType<R>, org.elasticsearch.action.ActionRequest, R>) and/or setExecuteLocallyVerifier(java.util.function.BiFunction<org.elasticsearch.action.ActionType<?>, org.elasticsearch.action.ActionRequest, org.elasticsearch.action.ActionResponse>).
void	setExecuteLocallyVerifier(BiFunction<org.elasticsearch.action.ActionType<?>,org.elasticsearch.action.ActionRequest,org.elasticsearch.action.ActionResponse> verifier)	Sets the function that will be called when executeLocally(ActionType, ActionRequest, TaskListener)is called.
<R extends org.elasticsearch.action.ActionResponse> void	setExecuteVerifier(BiFunction<org.elasticsearch.action.ActionType<R>,org.elasticsearch.action.ActionRequest,R> verifier)	Sets the function that will be called when doExecute(ActionType, ActionRequest, ActionListener) is called.

Methods inherited from class org.elasticsearch.test.client.NoOpNodeClient

close, getExecutionCount, getRemoteClusterClient, initialize

Methods inherited from class org.elasticsearch.client.internal.node.NodeClient

getNamedWriteableRegistry

Methods inherited from class org.elasticsearch.client.internal.support.AbstractClient

admin, bulk, bulk, clearScroll, clearScroll, delete, delete, execute, execute, explain, explain, fieldCaps, fieldCaps, filterWithHeader, get, get, index, index, multiGet, multiGet, multiSearch, multiSearch, multiTermVectors, multiTermVectors, prepareBulk, prepareBulk, prepareClearScroll, prepareDelete, prepareDelete, prepareExplain, prepareFieldCaps, prepareGet, prepareGet, prepareIndex, prepareIndex, prepareMultiGet, prepareMultiSearch, prepareMultiTermVectors, prepareSearch, prepareSearchScroll, prepareTermVectors, prepareTermVectors, prepareUpdate, prepareUpdate, search, search, searchScroll, searchScroll, settings, termVectors, termVectors, threadPool, update, update

Methods inherited from class java.lang.Object

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

Constructor Details

VerifyingClient

public VerifyingClient(String testName)

Method Details

getLocalNodeId

public String getLocalNodeId()

Overrides:

getLocalNodeId in class NoOpNodeClient

reset

public void reset()

Clears any previously set verifier functions set by setExecuteVerifier(java.util.function.BiFunction<org.elasticsearch.action.ActionType<R>, org.elasticsearch.action.ActionRequest, R>) and/or setExecuteLocallyVerifier(java.util.function.BiFunction<org.elasticsearch.action.ActionType<?>, org.elasticsearch.action.ActionRequest, org.elasticsearch.action.ActionResponse>). These functions are replaced with functions which will throw an AssertionError if called.

setExecuteVerifier

public <R extends org.elasticsearch.action.ActionResponse>
void setExecuteVerifier(BiFunction<org.elasticsearch.action.ActionType<R>,org.elasticsearch.action.ActionRequest,R> verifier)

Sets the function that will be called when doExecute(ActionType, ActionRequest, ActionListener) is called. The given function should return a subclass of ActionResponse that is appropriate for the action.

Parameters:

verifier - A function which is called in place of doExecute(ActionType, ActionRequest, ActionListener)

doExecute

public <Request extends org.elasticsearch.action.ActionRequest,
Response extends org.elasticsearch.action.ActionResponse>
void doExecute(org.elasticsearch.action.ActionType<Response> action,
 Request request,
 org.elasticsearch.action.ActionListener<Response> listener)

Overrides:

doExecute in class NoOpNodeClient

setExecuteLocallyVerifier

public void setExecuteLocallyVerifier(BiFunction<org.elasticsearch.action.ActionType<?>,org.elasticsearch.action.ActionRequest,org.elasticsearch.action.ActionResponse> verifier)

Sets the function that will be called when executeLocally(ActionType, ActionRequest, TaskListener)is called. The given function should return either a subclass of ActionResponse or null.

Parameters:

verifier - A function which is called in place of executeLocally(ActionType, ActionRequest, TaskListener)

executeLocally

public <Request extends org.elasticsearch.action.ActionRequest,
Response extends org.elasticsearch.action.ActionResponse>
org.elasticsearch.tasks.Task executeLocally(org.elasticsearch.action.ActionType<Response> action,
 Request request,
 org.elasticsearch.action.ActionListener<Response> listener)

Overrides:

executeLocally in class NoOpNodeClient

executeLocally

public <Request extends org.elasticsearch.action.ActionRequest,
Response extends org.elasticsearch.action.ActionResponse>
org.elasticsearch.tasks.Task executeLocally(org.elasticsearch.action.ActionType<Response> action,
 Request request,
 org.elasticsearch.tasks.TaskListener<Response> listener)

Overrides:

executeLocally in class NoOpNodeClient