Package org.elasticsearch.test

Class NodeShutdownTestUtils

java.lang.Object

org.elasticsearch.test.NodeShutdownTestUtils

public class NodeShutdownTestUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
NodeShutdownTestUtils()

Method Summary

Modifier and Type	Method	Description
static void	clearShutdownMetadata(ClusterService clusterService)	Synchronously removes all node shutdown metadata from the cluster state, replacing it with NodesShutdownMetadata.EMPTY.
static void	flushMasterQueue(ClusterService clusterService, ActionListener<Void> listener)	Submits a no-op cluster state update at Priority.LANGUID to drain all pending master tasks, then notifies listener once it is processed.
static void	putShutdownForRemovalMetadata(String nodeName, ClusterService clusterService)	Synchronously marks the given node for shutdown, randomly choosing among REMOVE and SIGTERM.
static void	putShutdownForRemovalMetadata(ClusterService clusterService, String nodeName, ActionListener<Void> listener)	Asynchronously marks the given node for shutdown, randomly choosing among REMOVE and SIGTERM, then flushes the master queue.
static void	putShutdownMetadata(String nodeName, ClusterService clusterService, EnumSet<SingleNodeShutdownMetadata.Type> candidateShutdownTypes)	Synchronously marks the given node for shutdown, randomly choosing from candidateShutdownTypes.
static void	putShutdownMetadata(ClusterService clusterService, String nodeName, ActionListener<Void> listener, EnumSet<SingleNodeShutdownMetadata.Type> candidateShutdownTypes)	Asynchronously marks the given node for shutdown, randomly choosing from candidateShutdownTypes, then flushes the master queue.
static void	putShutdownMetadata(ClusterService clusterService, SingleNodeShutdownMetadata.Builder shutdownMetadataBuilder, String nodeName, ActionListener<Void> listener)	Updates the cluster state to mark a node for shutdown by adding or updating its shutdown metadata.

Methods inherited from class java.lang.Object

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

Constructor Details

NodeShutdownTestUtils

public NodeShutdownTestUtils()

Method Details

putShutdownForRemovalMetadata

public static void putShutdownForRemovalMetadata(String nodeName,
 ClusterService clusterService)

Synchronously marks the given node for shutdown, randomly choosing among REMOVE and SIGTERM. Blocks until the cluster state update and master-queue flush complete.

See Also:

• to specify a custom set of shutdown types

putShutdownForRemovalMetadata

public static void putShutdownForRemovalMetadata(ClusterService clusterService,
 String nodeName,
 ActionListener<Void> listener)

Asynchronously marks the given node for shutdown, randomly choosing among REMOVE and SIGTERM, then flushes the master queue. Notifies listener on completion.

See Also:

• to specify a custom set of shutdown types

putShutdownMetadata

public static void putShutdownMetadata(String nodeName,
 ClusterService clusterService,
 EnumSet<SingleNodeShutdownMetadata.Type> candidateShutdownTypes)

Synchronously marks the given node for shutdown, randomly choosing from candidateShutdownTypes. Blocks until the cluster state update and master-queue flush complete.

putShutdownMetadata

public static void putShutdownMetadata(ClusterService clusterService,
 String nodeName,
 ActionListener<Void> listener,
 EnumSet<SingleNodeShutdownMetadata.Type> candidateShutdownTypes)

Asynchronously marks the given node for shutdown, randomly choosing from candidateShutdownTypes, then flushes the master queue. Notifies listener on completion.

REPLACE is intentionally excluded from all default sets because it requires specifying a replacement node.

putShutdownMetadata

public static void putShutdownMetadata(ClusterService clusterService,
 SingleNodeShutdownMetadata.Builder shutdownMetadataBuilder,
 String nodeName,
 ActionListener<Void> listener)

Updates the cluster state to mark a node for shutdown by adding or updating its shutdown metadata. Must be cleared at the end of the test by calling clearShutdownMetadata(ClusterService)

This method submits an unbatched state update task to the provided ClusterService, which sets the shutdown metadata for the specified node. The metadata is built using the provided SingleNodeShutdownMetadata.Builder. Upon completion, the provided ActionListener is notified.

NB: If using ESIntegTestCase.Scope.SUITE, at the beginning of each test, the test cluster is reset. Therefore, node names can be reused between tests if they manually start nodes. When a test adds shutdown metadata for its manually started node, it must be cleared at the end of the test by calling clearShutdownMetadata(ClusterService). Otherwise, the subsequent test can start a node with the same name which is still shutting down and cannot accept shards which leads to create index timeout.

NB If using ESIntegTestCase.Scope.TEST, the test cluster exists only for the duration of the test, and so calling clearShutdownMetadata(ClusterService) is not strictly required.

Parameters:

clusterService - the ClusterService used to submit the state update task

shutdownMetadataBuilder - the builder for the node's shutdown metadata

nodeName - the name of the node to mark for shutdown

listener - the ActionListener to be notified when the operation completes or fails

flushMasterQueue

public static void flushMasterQueue(ClusterService clusterService,
 ActionListener<Void> listener)

Submits a no-op cluster state update at Priority.LANGUID to drain all pending master tasks, then notifies listener once it is processed.

clearShutdownMetadata

public static void clearShutdownMetadata(ClusterService clusterService)

Synchronously removes all node shutdown metadata from the cluster state, replacing it with NodesShutdownMetadata.EMPTY. Must be called at the end of any test that used putShutdownMetadata(java.lang.String, org.elasticsearch.cluster.service.ClusterService, java.util.EnumSet<org.elasticsearch.cluster.metadata.SingleNodeShutdownMetadata.Type>) or putShutdownForRemovalMetadata(String, ClusterService) when running under ESIntegTestCase.Scope.SUITE.