io.failify.execution

Class RuntimeEngine

java.lang.Object

io.failify.execution.RuntimeEngine

All Implemented Interfaces:

LimitedRuntimeEngine

Direct Known Subclasses:

SingleNodeRuntimeEngine

public abstract class RuntimeEngine
extends Object
implements LimitedRuntimeEngine

Field Summary

Fields

Modifier and Type	Field and Description
protected Deployment	deployment
protected NetworkOperationManager	networkOperationManager
protected NetworkPartitionManager	networkPartitionManager
protected Map<String,Node>	nodeMap
protected Map<String,NodeWorkspace>	nodeWorkspaceMap
protected boolean	stopped

Constructor Summary

Constructors

Constructor and Description
RuntimeEngine(Deployment deployment, Map<String,NodeWorkspace> nodeWorkspaceMap)

Method Summary

Modifier and Type	Method and Description
void	addNewNode(Node node, NodeWorkspace nodeWorkspace)
protected abstract void	createNodeContainer(Node node) This method should create a container based on the given node definition.
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.
protected abstract String	getEventServerIpAddress() This method should find the best IP address for the nodes to connect to the event server based on the current environment
protected Map<String,String>	getNodeEnvironmentVariablesMap(String nodeName)
protected Map<String,String>	getNodeEnvironmentVariablesMap(String nodeName, Map<String,String> environment)
protected Set<ExposedPortDefinition>	getNodeExposedPorts(String nodeName)
protected String	getNodeInitCommand(String nodeName)
protected String	getNodeStartCommand(String nodeName)
protected String	getNodeStopCommand(String nodeName)
static RuntimeEngine	getRuntimeEngine(Deployment deployment, Map<String,NodeWorkspace> nodeWorkspaceMap)
protected Map<String,String>	improveEnvironmentVariablesMap(String nodeName, Map<String,String> environment)
protected abstract Map<String,String>	improveEnvironmentVariablesMapForEngine(String nodeName, Map<String,String> environment) This method improves a node's env var map
boolean	isStopped()
void	networkOperation(String nodeName, NetOp.BuilderBase... netOpBuilders) 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()
void	removeNetworkPartition(NetPart netPart)
void	start(FailifyRunner failifyRunner)
protected void	startEventServer()
protected abstract void	startFileSharingService() This method should start the file sharing service (if any), create the defined shared directory in the deployment definition if they do not exist, and make them available through the sharing service.
protected abstract void	startNodes() This method should start all of the nodes.
void	stop(boolean kill, Integer secondsUntilForcedStop)
protected void	stopEventServer()
protected abstract void	stopFileSharingService() This method should stop the potentially running file sharing server and unmount shared directories in the nodes (if necessary).
protected abstract void	stopNodes(Boolean kill, Integer secondsUntilForcedStop) This method should stop all of the nodes and in case of a failure in stopping something it won't throw any exception, but error logs the exception or a message.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.failify.execution.LimitedRuntimeEngine

clockDrift, ip, killNode, portMapping, restartNode, runCommandInNode, startNode, stopNode

Field Detail

deployment

protected final Deployment deployment

nodeMap

protected Map<String,Node> nodeMap

nodeWorkspaceMap

protected Map<String,NodeWorkspace> nodeWorkspaceMap

stopped

protected boolean stopped

networkPartitionManager

protected final NetworkPartitionManager networkPartitionManager

networkOperationManager

protected final NetworkOperationManager networkOperationManager

Constructor Detail

RuntimeEngine

public RuntimeEngine(Deployment deployment,
                     Map<String,NodeWorkspace> nodeWorkspaceMap)

Method Detail

getRuntimeEngine

public static RuntimeEngine getRuntimeEngine(Deployment deployment,
                                             Map<String,NodeWorkspace> nodeWorkspaceMap)

nodeNames

public Set<String> nodeNames()

Specified by:

nodeNames in interface LimitedRuntimeEngine

Returns:

a set of the deployed node names

isStopped

public boolean isStopped()

start

public void start(FailifyRunner failifyRunner)
           throws RuntimeEngineException

Throws:

RuntimeEngineException

startEventServer

protected void startEventServer()
                         throws RuntimeEngineException

Throws:

RuntimeEngineException

stop

public void stop(boolean kill,
                 Integer secondsUntilForcedStop)

addNewNode

public void addNewNode(Node node,
                       NodeWorkspace nodeWorkspace)
                throws RuntimeEngineException

Throws:

RuntimeEngineException

stopEventServer

protected void stopEventServer()

getNodeEnvironmentVariablesMap

protected Map<String,String> getNodeEnvironmentVariablesMap(String nodeName,
                                                            Map<String,String> environment)

improveEnvironmentVariablesMap

protected Map<String,String> improveEnvironmentVariablesMap(String nodeName,
                                                            Map<String,String> environment)
                                                     throws RuntimeEngineException

Throws:

RuntimeEngineException

getNodeEnvironmentVariablesMap

protected final Map<String,String> getNodeEnvironmentVariablesMap(String nodeName)
                                                           throws RuntimeEngineException

Throws:

RuntimeEngineException

getNodeExposedPorts

protected Set<ExposedPortDefinition> getNodeExposedPorts(String nodeName)

getNodeInitCommand

protected String getNodeInitCommand(String nodeName)

getNodeStartCommand

protected String getNodeStartCommand(String nodeName)

getNodeStopCommand

protected String getNodeStopCommand(String nodeName)

waitFor

public void waitFor(String eventName)
             throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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

Specified by:

waitFor in interface LimitedRuntimeEngine

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

public void waitFor(String eventName,
                    Boolean includeEvent)
             throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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.

Specified by:

waitFor in interface LimitedRuntimeEngine

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

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

Description copied from interface: LimitedRuntimeEngine

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

Specified by:

waitFor in interface LimitedRuntimeEngine

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

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

Description copied from interface: LimitedRuntimeEngine

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

Specified by:

waitFor in interface LimitedRuntimeEngine

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

public void enforceOrder(String eventName,
                         FailifyCheckedRunnable action)
                  throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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.

Specified by:

enforceOrder in interface LimitedRuntimeEngine

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

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

Description copied from interface: LimitedRuntimeEngine

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

Specified by:

enforceOrder in interface LimitedRuntimeEngine

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

public void waitForRunSequenceCompletion()
                                  throws TimeoutException

Description copied from interface: LimitedRuntimeEngine

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

Specified by:

waitForRunSequenceCompletion in interface LimitedRuntimeEngine

Throws:

TimeoutException - if either type of timeout happens

waitForRunSequenceCompletion

public void waitForRunSequenceCompletion(Integer timeout)
                                  throws TimeoutException

Description copied from interface: LimitedRuntimeEngine

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.

Specified by:

waitForRunSequenceCompletion in interface LimitedRuntimeEngine

Parameters:

timeout - the waiting timeout in seconds

Throws:

TimeoutException - if either type of timeout happens

waitForRunSequenceCompletion

public void waitForRunSequenceCompletion(Integer timeout,
                                         Integer nextEventReceiptTimeout)
                                  throws TimeoutException

Description copied from interface: LimitedRuntimeEngine

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

Specified by:

waitForRunSequenceCompletion in interface LimitedRuntimeEngine

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

networkPartition

public void networkPartition(NetPart netPart)
                      throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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

Specified by:

networkPartition in interface LimitedRuntimeEngine

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

removeNetworkPartition

public void removeNetworkPartition(NetPart netPart)
                            throws RuntimeEngineException

Specified by:

removeNetworkPartition in interface LimitedRuntimeEngine

Throws:

RuntimeEngineException

networkOperation

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

Description copied from interface: LimitedRuntimeEngine

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

Specified by:

networkOperation in interface LimitedRuntimeEngine

Parameters:

nodeName - the node to apply the network operation on

netOpBuilders - 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.

Throws:

RuntimeEngineException - if something goes wrong

improveEnvironmentVariablesMapForEngine

protected abstract Map<String,String> improveEnvironmentVariablesMapForEngine(String nodeName,
                                                                              Map<String,String> environment)
                                                                       throws RuntimeEngineException

This method improves a node's env var map

Parameters:

nodeName - the corresponding node to be improved

environment - the current environment of the node

Returns:

the improved environment for the node

Throws:

RuntimeEngineException - if something goes wrong

getEventServerIpAddress

protected abstract String getEventServerIpAddress()
                                           throws RuntimeEngineException

This method should find the best IP address for the nodes to connect to the event server based on the current environment

Returns:

the IP address to connect to the event server

Throws:

RuntimeEngineException - if something goes wrong

createNodeContainer

protected abstract void createNodeContainer(Node node)
                                     throws RuntimeEngineException

This method should create a container based on the given node definition.

Parameters:

node - the node definition to create a container upon

Throws:

RuntimeEngineException - if something goes wrong

startNodes

protected abstract void startNodes()
                            throws RuntimeEngineException

This method should start all of the nodes. In case of a problem in startup of a node, all of the started nodes should be stopped and a RuntimeEngine Exception should be thrown

Throws:

RuntimeEngineException

stopNodes

protected abstract void stopNodes(Boolean kill,
                                  Integer secondsUntilForcedStop)

This method should stop all of the nodes and in case of a failure in stopping something it won't throw any exception, but error logs the exception or a message. This method should only be called when stopping the runtime engine

startFileSharingService

protected abstract void startFileSharingService()
                                         throws RuntimeEngineException

This method should start the file sharing service (if any), create the defined shared directory in the deployment definition if they do not exist, and make them available through the sharing service. Mounting in the nodes (if necessary) should be done later when starting the nodes.

Throws:

RuntimeEngineException - if some error happens when creating the shared directory for the nodes

stopFileSharingService

protected abstract void stopFileSharingService()

This method should stop the potentially running file sharing server and unmount shared directories in the nodes (if necessary). In case of a failure in stopping something it won't throw any exception, but error logs the exception or a message. This method should only be called when stopping the runtime engine