io.failify.execution

Interface LimitedRuntimeEngine

All Known Implementing Classes:

RuntimeEngine, SingleNodeRuntimeEngine

public interface LimitedRuntimeEngine

Method Summary

Modifier and Type	Method and Description
void	clockDrift(String nodeName, Integer amount) Applies a clock drift with the given amount on the given node name
void	enforceOrder(String eventName, FailifyCheckedRunnable action) This method waits indefinitely for the given test case event's dependencies to be marked as satisfied in the event server, executes the given action, and finally, marks the given event name as satisfied in the event server.
void	enforceOrder(String eventName, Integer timeout, FailifyCheckedRunnable action) This method waits for the given test case event's dependencies to be marked as satisfied in the event server, executes the given action, and finally, marks the given event name as satisfied in the event server.
String	ip(String nodeName)
void	killNode(String nodeName) Kills a node in the deployed environment.
void	networkOperation(String nodeName, NetOp.BuilderBase... netOpBuilder) Applies a network operation including network delay and loss addition and removal on a node
void	networkPartition(NetPart netPart) Imposes a network partition based on the given partition scheme in the deployed environment
Set<String>	nodeNames()
Integer	portMapping(String nodeName, Integer portNumber, PortType portType) Returns the port mapping for a udp/tcp port number in a specific node
void	removeNetworkPartition(NetPart netPart)
void	restartNode(String nodeName, Integer secondsUntilForcedStop) Restarts a node in the deployed environment.
CommandResults	runCommandInNode(String nodeName, String command) Executes a shell command in the given node
void	startNode(String nodeName) Starts a node in the deployed environment.
void	stopNode(String nodeName, Integer secondsUntilForcedStop) Stops a node in the deployed environment.
void	waitFor(String eventName) This method waits indefinitely for the given event's dependencies to be marked as satisfied in the event server.
void	waitFor(String eventName, Boolean includeEvent) This method waits indefinitely for the given event's dependencies and the event itself (if desired) to be marked as satisfied in the event server.
void	waitFor(String eventName, Boolean includeEvent, Integer timeout) This method waits for the given event's dependencies and the event itself (if desired) to be marked as satisfied in the event server.
void	waitFor(String eventName, Integer timeout) This method waits for the given event's dependencies to be marked as satisfied in the event server.
void	waitForRunSequenceCompletion() This method waits indefinitely for the run sequence to be enforced completely, and then returns.
void	waitForRunSequenceCompletion(Integer timeout) This method waits for the run sequence to be enforced completely, and then returns.
void	waitForRunSequenceCompletion(Integer timeout, Integer nextEventReceiptTimeout) This method waits for the run sequence to be enforced completely, and then returns.

Method Detail

killNode

void killNode(String nodeName)
       throws RuntimeEngineException

Kills a node in the deployed environment. It won't throw an exception if the node is not running

Parameters:

nodeName - the node name to be killed

Throws:

RuntimeEngineException - is something goes wrong

NodeNotFoundException - if the node doesn't exist

stopNode

void stopNode(String nodeName,
              Integer secondsUntilForcedStop)
       throws RuntimeEngineException

Stops a node in the deployed environment. It won't throw an exception if the node is not running

Parameters:

nodeName - the node name to be Stopped

secondsUntilForcedStop - the number of seconds to wait until forcing a stop

Throws:

RuntimeEngineException - is something goes wrong

NodeNotFoundException - if the node doesn't exist

startNode

void startNode(String nodeName)
        throws RuntimeEngineException

Starts a node in the deployed environment. It won't throw an exception if the node is already started

Parameters:

nodeName - the node name to be started

Throws:

RuntimeEngineException - is something goes wrong

NodeNotFoundException - if the node doesn't exist

restartNode

void restartNode(String nodeName,
                 Integer secondsUntilForcedStop)
          throws RuntimeEngineException

Restarts a node in the deployed environment. It won't throw an exception if the node is not running

Parameters:

nodeName - the node name to be restarted

secondsUntilForcedStop - the number of seconds to wait until forcing a stop

Throws:

RuntimeEngineException - is something goes wrong

NodeNotFoundException - if the node doesn't exist

clockDrift

void clockDrift(String nodeName,
                Integer amount)
         throws RuntimeEngineException

Applies a clock drift with the given amount on the given node name

Parameters:

nodeName - the node name to apply the clock drift on

amount - the positive or negative amount of time offset to apply in milliseconds

Throws:

RuntimeEngineException - is something goes wrong

NodeNotFoundException - if the node doesn't exist

networkPartition

void networkPartition(NetPart netPart)
               throws RuntimeEngineException

Imposes a network partition based on the given partition scheme in the deployed environment

Parameters:

netPart - the desired scheme for the partition. Take a look at NetPart class for more information

Throws:

RuntimeEngineException - if something goes wrong

NodeNotFoundException - if one of partitions includes a node that doesn't exist

networkOperation

void networkOperation(String nodeName,
                      NetOp.BuilderBase... netOpBuilder)
               throws RuntimeEngineException

Applies a network operation including network delay and loss addition and removal on a node

Parameters:

netOpBuilder - the specifics of the network operation. Take a look a NetOp class for more information. NetOp static methods should be used to create objects of this type.

nodeName - the node to apply the network operation on

Throws:

RuntimeEngineException - if something goes wrong

removeNetworkPartition

void removeNetworkPartition(NetPart netPart)
                     throws RuntimeEngineException

Throws:

RuntimeEngineException

runCommandInNode

CommandResults runCommandInNode(String nodeName,
                                String command)
                         throws RuntimeEngineException

Executes a shell command in the given node

Parameters:

nodeName - the node name to execute the shell command into

command - the command to be executed

Returns:

the command execution results including exit code, stdout and stderr

Throws:

RuntimeEngineException - if something goes wrong

NodeIsNotRunningException - if the node is not running

NodeNotFoundException - if the node doesn't exist

nodeNames

Set<String> nodeNames()

Returns:

a set of the deployed node names

ip

String ip(String nodeName)

Parameters:

nodeName - the node name to find ip address for

Returns:

the ip address of the given node name or null if the node is not found

portMapping

Integer portMapping(String nodeName,
                    Integer portNumber,
                    PortType portType)

Returns the port mapping for a udp/tcp port number in a specific node

Parameters:

nodeName - the node name

portNumber - the source port number

portType - tcp or udp

Returns:

the mapped port number or null if either the node or the desired port mapping is not found

waitFor

void waitFor(String eventName)
      throws RuntimeEngineException

This method waits indefinitely for the given event's dependencies to be marked as satisfied in the event server.

Parameters:

eventName - the event name to wait for

Throws:

RuntimeEngineException - if something goes wrong or the event name is not referred to in the run sequence

waitFor

void waitFor(String eventName,
             Boolean includeEvent)
      throws RuntimeEngineException

This method waits indefinitely for the given event's dependencies and the event itself (if desired) to be marked as satisfied in the event server.

Parameters:

eventName - the event name to wait for

includeEvent - if the wait should include the event itself or not

Throws:

RuntimeEngineException - if something goes wrong or the event name is not referred to in the run sequence

waitFor

void waitFor(String eventName,
             Integer timeout)
      throws RuntimeEngineException,
             TimeoutException

This method waits for the given event's dependencies to be marked as satisfied in the event server. The wait timeouts after the given timeout amount in seconds

Parameters:

eventName - the event name to wait for

timeout - the timeout amount in seconds

Throws:

RuntimeEngineException - if something goes wrong or the event name is not referred to in the run sequence

TimeoutException - if the wait timeouts

waitFor

void waitFor(String eventName,
             Boolean includeEvent,
             Integer timeout)
      throws RuntimeEngineException,
             TimeoutException

This method waits for the given event's dependencies and the event itself (if desired) to be marked as satisfied in the event server. The wait timeouts after the given timeout amount in seconds

Parameters:

eventName - the event name to wait for

includeEvent - if the wait should include the event itself or not

timeout - the timeout amount in seconds

Throws:

RuntimeEngineException - if something goes wrong or the event name is not referred to in the run sequence

TimeoutException - if the wait timeouts

enforceOrder

void enforceOrder(String eventName,
                  FailifyCheckedRunnable action)
           throws RuntimeEngineException

This method waits indefinitely for the given test case event's dependencies to be marked as satisfied in the event server, executes the given action, and finally, marks the given event name as satisfied in the event server.

Parameters:

eventName - the event name to wait for

action - the action to execute after waiting is completed

Throws:

RuntimeEngineException - if something goes wrong or the event name is not referred to in the run sequence or the event is not a test case event

enforceOrder

void enforceOrder(String eventName,
                  Integer timeout,
                  FailifyCheckedRunnable action)
           throws RuntimeEngineException,
                  TimeoutException

This method waits for the given test case event's dependencies to be marked as satisfied in the event server, executes the given action, and finally, marks the given event name as satisfied in the event server. The wait timeouts after the given timeout amount in seconds

Parameters:

eventName - the event name to wait for

timeout - the timeout amount in seconds

action - the action to execute after waiting is completed

Throws:

RuntimeEngineException - if something goes wrong or the event name is not referred to in the run sequence or the event is not a test case event

TimeoutException - if the wait timeouts

waitForRunSequenceCompletion

void waitForRunSequenceCompletion()
                           throws TimeoutException

This method waits indefinitely for the run sequence to be enforced completely, and then returns.

Throws:

TimeoutException - if either type of timeout happens

waitForRunSequenceCompletion

void waitForRunSequenceCompletion(Integer timeout)
                           throws TimeoutException

This method waits for the run sequence to be enforced completely, and then returns. If timeout param is not null, after waiting for the expected amount the method throws an exception.

Parameters:

timeout - the waiting timeout in seconds

Throws:

TimeoutException - if either type of timeout happens

waitForRunSequenceCompletion

void waitForRunSequenceCompletion(Integer timeout,
                                  Integer nextEventReceiptTimeout)
                           throws TimeoutException

This method waits for the run sequence to be enforced completely, and then returns. If desired it is possible to specify two different types of timeout for this method. If timeout param is not null, after waiting for the expected amount the method throws an exception. If nextEventReceiptTimeout is not null, if after the expected amount of time no new event is marked as satisfied in the event server, this method throws an exception

Parameters:

timeout - the waiting timeout in seconds

nextEventReceiptTimeout - the number of seconds to wait until timeout the receipt of the next event in the run sequence

Throws:

TimeoutException - if either type of timeout happens