Package org.elasticsearch.test.transport

Class MockTransportService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.transport.TransportService

org.elasticsearch.test.transport.MockTransportService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable

public final class MockTransportService
extends TransportService

A mock transport service that allows to simulate different network topology failures. Internally it maps TransportAddress objects to rules that inject failures. Adding rules for a node is done by adding rules for all bound addresses of a node (and the publish address, if different). Matching requests to rules is based on the transport address associated with the discovery node of the request, namely by DiscoveryNode.getAddress(). This address is usually the publish address of the node but can also be a different one (for example, @see org.elasticsearch.discovery.zen.ping.unicast.UnicastZenPing, which constructs fake DiscoveryNode instances where the publish address is one of the bound addresses).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MockTransportService.ClearableTransport	The delegate transport instances defined in this class mock various kinds of disruption types.
static class	MockTransportService.DelegateTransport	A pure delegate transport.
static class	MockTransportService.TestPlugin
static class	MockTransportService.Tracer

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportService

TransportService.ContextRestoreResponseHandler<T extends TransportResponse>, TransportService.HandshakeResponse

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Fields inherited from class org.elasticsearch.transport.TransportService

clusterName, DIRECT_RESPONSE_PROFILE, HANDSHAKE_ACTION_NAME, NOOP_TRANSPORT_INTERCEPTOR, taskManager, threadPool, TRACE_LOG_EXCLUDE_SETTING, TRACE_LOG_INCLUDE_SETTING, transport

Constructor Summary

Constructors

Constructor	Description
MockTransportService(Settings settings, Transport transport, ThreadPool threadPool, TransportInterceptor interceptor, java.util.function.Function<BoundTransportAddress,DiscoveryNode> localNodeFactory, ClusterSettings clusterSettings, java.util.Set<java.lang.String> taskHeaders)	Build the service.
MockTransportService(Settings settings, Transport transport, ThreadPool threadPool, TransportInterceptor interceptor, ClusterSettings clusterSettings)	Build the service.

Method Summary

Modifier and Type	Method	Description
boolean	addDelegate(TransportAddress transportAddress, MockTransportService.DelegateTransport transport)	Adds a new delegate transport that is used for communication with the given transport address.
boolean	addDelegate(TransportService transportService, MockTransportService.DelegateTransport transport)	Adds a new delegate transport that is used for communication with the given transport service.
void	addFailToSendNoConnectRule(TransportAddress transportAddress)	Adds a rule that will cause every send request to fail, and each new connect since the rule is added to fail as well.
void	addFailToSendNoConnectRule(TransportAddress transportAddress, java.lang.String... blockedActions)	Adds a rule that will cause matching operations to throw ConnectTransportExceptions
void	addFailToSendNoConnectRule(TransportAddress transportAddress, java.util.Set<java.lang.String> blockedActions)	Adds a rule that will cause matching operations to throw ConnectTransportExceptions
void	addFailToSendNoConnectRule(TransportService transportService)	Adds a rule that will cause every send request to fail, and each new connect since the rule is added to fail as well.
void	addFailToSendNoConnectRule(TransportService transportService, java.lang.String... blockedActions)	Adds a rule that will cause matching operations to throw ConnectTransportExceptions
void	addFailToSendNoConnectRule(TransportService transportService, java.util.Set<java.lang.String> blockedActions)	Adds a rule that will cause matching operations to throw ConnectTransportExceptions
void	addTracer(MockTransportService.Tracer tracer)
void	addUnresponsiveRule(TransportAddress transportAddress)	Adds a rule that will cause ignores each send request, simulating an unresponsive node and failing to connect once the rule was added.
void	addUnresponsiveRule(TransportAddress transportAddress, TimeValue duration)	Adds a rule that will cause ignores each send request, simulating an unresponsive node and failing to connect once the rule was added.
void	addUnresponsiveRule(TransportService transportService)	Adds a rule that will cause ignores each send request, simulating an unresponsive node and failing to connect once the rule was added.
void	addUnresponsiveRule(TransportService transportService, TimeValue duration)	Adds a rule that will cause ignores each send request, simulating an unresponsive node and failing to connect once the rule was added.
void	clearAllRules()	Clears all the registered rules.
void	clearRule(TransportAddress transportAddress)	Clears the rule associated with the provided transport address.
void	clearRule(TransportService transportService)	Clears the rule associated with the provided transport service.
void	clearTracers()
static MockTransportService	createNewService(Settings settings, Transport transport, Version version, ThreadPool threadPool, ClusterSettings clusterSettings, java.util.Set<java.lang.String> taskHeaders)
static MockTransportService	createNewService(Settings settings, Version version, ThreadPool threadPool, ClusterSettings clusterSettings)
protected TaskManager	createTaskManager(Settings settings, ThreadPool threadPool, java.util.Set<java.lang.String> taskHeaders)
protected void	doClose()
static TransportAddress[]	extractTransportAddresses(TransportService transportService)
protected java.util.concurrent.ExecutorService	getExecutorService()
DiscoveryNode	getLocalDiscoNode()
Transport	getOriginalTransport()
Transport.Connection	openConnection(DiscoveryNode node, ConnectionProfile profile)
Transport	original()	Returns the original Transport service wrapped by this mock transport service.
boolean	removeTracer(MockTransportService.Tracer tracer)
void	setExecutorName(java.lang.String executorName)
protected boolean	traceEnabled()
protected void	traceReceivedRequest(long requestId, java.lang.String action)
protected void	traceReceivedResponse(long requestId, DiscoveryNode sourceNode, java.lang.String action)
protected void	traceRequestSent(DiscoveryNode node, long requestId, java.lang.String action, TransportRequestOptions options)
protected void	traceResponseSent(long requestId, java.lang.String action)
protected void	traceResponseSent(long requestId, java.lang.String action, java.lang.Exception e)

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from class org.elasticsearch.transport.TransportService

acceptIncomingRequests, addConnectionListener, addressesFromString, boundAddress, connectToNode, connectToNode, disconnectFromNode, doStart, doStop, getConnection, getLocalAddresses, getLocalNode, getRemoteClusterService, getRequestHandler, getTaskManager, getThreadPool, handshake, handshake, info, nodeConnected, onNodeDisconnected, onResponseReceived, registerRequestHandler, registerRequestHandler, registerRequestHandler, registerRequestHandler, removeConnectionListener, sendChildRequest, sendChildRequest, sendChildRequest, sendRequest, sendRequest, sendRequest, stats, submitRequest, submitRequest, traceUnresolvedResponse

Constructor Detail

MockTransportService

public MockTransportService(Settings settings,
                            Transport transport,
                            ThreadPool threadPool,
                            TransportInterceptor interceptor,
                            @Nullable
                            ClusterSettings clusterSettings)

Build the service.

Parameters:

clusterSettings - if non null the TransportService will register with the ClusterSettings for settings updates for TransportService.TRACE_LOG_EXCLUDE_SETTING and TransportService.TRACE_LOG_INCLUDE_SETTING.

MockTransportService

public MockTransportService(Settings settings,
                            Transport transport,
                            ThreadPool threadPool,
                            TransportInterceptor interceptor,
                            java.util.function.Function<BoundTransportAddress,DiscoveryNode> localNodeFactory,
                            @Nullable
                            ClusterSettings clusterSettings,
                            java.util.Set<java.lang.String> taskHeaders)

Build the service.

Parameters:

clusterSettings - if non null the TransportService will register with the ClusterSettings for settings updates for TransportService.TRACE_LOG_EXCLUDE_SETTING and TransportService.TRACE_LOG_INCLUDE_SETTING.

Method Detail

createNewService

public static MockTransportService createNewService(Settings settings,
                                                    Version version,
                                                    ThreadPool threadPool,
                                                    @Nullable
                                                    ClusterSettings clusterSettings)

createNewService

public static MockTransportService createNewService(Settings settings,
                                                    Transport transport,
                                                    Version version,
                                                    ThreadPool threadPool,
                                                    @Nullable
                                                    ClusterSettings clusterSettings,
                                                    java.util.Set<java.lang.String> taskHeaders)

extractTransportAddresses

public static TransportAddress[] extractTransportAddresses(TransportService transportService)

createTaskManager

protected TaskManager createTaskManager(Settings settings,
                                        ThreadPool threadPool,
                                        java.util.Set<java.lang.String> taskHeaders)

Overrides:

createTaskManager in class TransportService

setExecutorName

public void setExecutorName(java.lang.String executorName)

getExecutorService

protected java.util.concurrent.ExecutorService getExecutorService()

Overrides:

getExecutorService in class TransportService

clearAllRules

public void clearAllRules()

Clears all the registered rules.

clearRule

public void clearRule(TransportService transportService)

Clears the rule associated with the provided transport service.

clearRule

public void clearRule(TransportAddress transportAddress)

Clears the rule associated with the provided transport address.

original

public Transport original()

Returns the original Transport service wrapped by this mock transport service.

addFailToSendNoConnectRule

public void addFailToSendNoConnectRule(TransportService transportService)

Adds a rule that will cause every send request to fail, and each new connect since the rule is added to fail as well.

addFailToSendNoConnectRule

public void addFailToSendNoConnectRule(TransportAddress transportAddress)

Adds a rule that will cause every send request to fail, and each new connect since the rule is added to fail as well.

addFailToSendNoConnectRule

public void addFailToSendNoConnectRule(TransportService transportService,
                                       java.lang.String... blockedActions)

Adds a rule that will cause matching operations to throw ConnectTransportExceptions

addFailToSendNoConnectRule

public void addFailToSendNoConnectRule(TransportAddress transportAddress,
                                       java.lang.String... blockedActions)

Adds a rule that will cause matching operations to throw ConnectTransportExceptions

addFailToSendNoConnectRule

public void addFailToSendNoConnectRule(TransportService transportService,
                                       java.util.Set<java.lang.String> blockedActions)

Adds a rule that will cause matching operations to throw ConnectTransportExceptions

addFailToSendNoConnectRule

public void addFailToSendNoConnectRule(TransportAddress transportAddress,
                                       java.util.Set<java.lang.String> blockedActions)

Adds a rule that will cause matching operations to throw ConnectTransportExceptions

addUnresponsiveRule

public void addUnresponsiveRule(TransportService transportService)

Adds a rule that will cause ignores each send request, simulating an unresponsive node and failing to connect once the rule was added.

addUnresponsiveRule

public void addUnresponsiveRule(TransportAddress transportAddress)

Adds a rule that will cause ignores each send request, simulating an unresponsive node and failing to connect once the rule was added.

addUnresponsiveRule

public void addUnresponsiveRule(TransportService transportService,
                                TimeValue duration)

Adds a rule that will cause ignores each send request, simulating an unresponsive node and failing to connect once the rule was added.

Parameters:

duration - the amount of time to delay sending and connecting.

addUnresponsiveRule

public void addUnresponsiveRule(TransportAddress transportAddress,
                                TimeValue duration)

Adds a rule that will cause ignores each send request, simulating an unresponsive node and failing to connect once the rule was added.

Parameters:

duration - the amount of time to delay sending and connecting.

addDelegate

public boolean addDelegate(TransportService transportService,
                           MockTransportService.DelegateTransport transport)

Adds a new delegate transport that is used for communication with the given transport service.

Returns:

true iff no other delegate was registered for any of the addresses bound by transport service.

addDelegate

public boolean addDelegate(TransportAddress transportAddress,
                           MockTransportService.DelegateTransport transport)

Adds a new delegate transport that is used for communication with the given transport address.

Returns:

true iff no other delegate was registered for this address before.

addTracer

public void addTracer(MockTransportService.Tracer tracer)

removeTracer

public boolean removeTracer(MockTransportService.Tracer tracer)

clearTracers

public void clearTracers()

traceEnabled

protected boolean traceEnabled()

Overrides:

traceEnabled in class TransportService

traceReceivedRequest

protected void traceReceivedRequest(long requestId,
                                    java.lang.String action)

Overrides:

traceReceivedRequest in class TransportService

traceResponseSent

protected void traceResponseSent(long requestId,
                                 java.lang.String action)

Overrides:

traceResponseSent in class TransportService

traceResponseSent

protected void traceResponseSent(long requestId,
                                 java.lang.String action,
                                 java.lang.Exception e)

Overrides:

traceResponseSent in class TransportService

traceReceivedResponse

protected void traceReceivedResponse(long requestId,
                                     DiscoveryNode sourceNode,
                                     java.lang.String action)

Overrides:

traceReceivedResponse in class TransportService

traceRequestSent

protected void traceRequestSent(DiscoveryNode node,
                                long requestId,
                                java.lang.String action,
                                TransportRequestOptions options)

Overrides:

traceRequestSent in class TransportService

getOriginalTransport

public Transport getOriginalTransport()

openConnection

public Transport.Connection openConnection(DiscoveryNode node,
                                           ConnectionProfile profile)
                                    throws java.io.IOException

Overrides:

openConnection in class TransportService

Throws:

java.io.IOException

doClose

protected void doClose()
                throws java.io.IOException

Overrides:

doClose in class TransportService

Throws:

java.io.IOException

getLocalDiscoNode

public DiscoveryNode getLocalDiscoNode()