io.failify.execution.single_node

Class SingleNodeRuntimeEngine

java.lang.Object

io.failify.execution.RuntimeEngine

io.failify.execution.single_node.SingleNodeRuntimeEngine

All Implemented Interfaces:

LimitedRuntimeEngine

public class SingleNodeRuntimeEngine
extends RuntimeEngine

Field Summary

Fields inherited from class io.failify.execution.RuntimeEngine

deployment, networkManager, nodeWorkspaceMap, stopped

Constructor Summary

Constructors

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

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
protected 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>	improveEnvironmentVariablesMapForEngine(String nodeName, Map<String,String> environment) This method improves a node's env var map
String	ip(String nodeName)
void	killNode(String nodeName) Kills a node in the deployed environment.
Integer	portMapping(String nodeName, Integer portNumber, PortType portType) Returns the port mapping for a udp/tcp port number in a specific node
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
protected 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.
void	startNode(String nodeName) Starts a node in the deployed environment.
protected void	startNodes() This method should start all of the nodes.
protected void	stopFileSharingService() This method should stop the potentially running file sharing server and unmount shared directories in the nodes (if necessary).
void	stopNode(String nodeName, Integer secondsUntilForcedStop) Stops a node in the deployed environment.
protected 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.

Methods inherited from class io.failify.execution.RuntimeEngine

enforceOrder, enforceOrder, getNodeEnvironmentVariablesMap, getNodeEnvironmentVariablesMap, getNodeExposedPorts, getNodeInitCommand, getNodeStartCommand, getNodeStopCommand, getRuntimeEngine, improveEnvironmentVariablesMap, isStopped, networkPartition, nodeNames, removeNetworkPartition, start, startEventServer, stop, stopEventServer, waitFor, waitFor, waitFor, waitFor

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleNodeRuntimeEngine

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

Method Detail

ip

public 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

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

Description copied from interface: LimitedRuntimeEngine

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

startNodes

protected void startNodes()
                   throws RuntimeEngineException

Description copied from class: RuntimeEngine

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

Specified by:

startNodes in class RuntimeEngine

Throws:

RuntimeEngineException

runCommandInNode

public CommandResults runCommandInNode(String nodeName,
                                       String command)
                                throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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

improveEnvironmentVariablesMapForEngine

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

Description copied from class: RuntimeEngine

This method improves a node's env var map

Specified by:

improveEnvironmentVariablesMapForEngine in class RuntimeEngine

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 String getEventServerIpAddress()
                                  throws RuntimeEngineException

Description copied from class: RuntimeEngine

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

Specified by:

getEventServerIpAddress in class RuntimeEngine

Returns:

the IP address to connect to the event server

Throws:

RuntimeEngineException - if something goes wrong

stopNodes

protected void stopNodes(Boolean kill,
                         Integer secondsUntilForcedStop)

Description copied from class: RuntimeEngine

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

Specified by:

stopNodes in class RuntimeEngine

killNode

public void killNode(String nodeName)
              throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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

public void stopNode(String nodeName,
                     Integer secondsUntilForcedStop)
              throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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

public void startNode(String nodeName)
               throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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

public void restartNode(String nodeName,
                        Integer secondsUntilForcedStop)
                 throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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

public void clockDrift(String nodeName,
                       Integer amount)
                throws RuntimeEngineException

Description copied from interface: LimitedRuntimeEngine

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

startFileSharingService

protected void startFileSharingService()

Description copied from class: RuntimeEngine

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.

Specified by:

startFileSharingService in class RuntimeEngine

stopFileSharingService

protected void stopFileSharingService()

Description copied from class: RuntimeEngine

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

Specified by:

stopFileSharingService in class RuntimeEngine