com.jayway.android.robotium.remotecontrol.solo

Class SoloWorker

java.lang.Object

com.jayway.android.robotium.remotecontrol.solo.SoloWorker

All Implemented Interfaces:

DebugListener, NamedListener

Direct Known Subclasses:

Solo

public class SoloWorker
extends java.lang.Object
implements DebugListener

Normally, this class would not be used directly. Use the Solo class, instead. Default abstract usage:

 SoloWorker solo = new SoloWorker();
 solo.setLogsInterface(alog);
 solo.initialize();
 (use the API)
 solo.shutdown();
 

Since:

(LeiWang) Mar 09, 2012 Add methods to turn on/off debug log of protocol/runner. Add method to shutdown remote service on device.
(LeiWang) Mar 09, 2012 Move static method parseStringArrayList() to Message class.

Author:

Carl Nagle, SAS Institute, Inc.

See Also:

Solo


Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Properties	_props
static java.lang.String	CAUSE_SEP ": "
protected SoloRemoteControl	control
static int	default_connect_stimeout How long to wait for a remote connection before issuing timeout.
static int	default_ready_stimeout How long to wait for a READY signal before issuing timeout.
static int	default_result_stimeout How long to wait for a RESULT signal after dispatch before issuing timeout.
static int	default_running_stimeout How long to wait for a RUNNING signal after dispatch before issuing timeout.
static int	default_shutdown_stimeout How long to wait for remote shutdown confirmation after dispatch before aborting the wait.
boolean	doProcessFailure Set this value to false to bypass or ignore default failure processing.
boolean	doProcessSuccess Set this value to false to bypass or ignore default success processing.
static java.io.PrintStream	err Initializes to System.err
static java.lang.String	FAIL_SUFFIX "FAILED"
static java.lang.String	listenername
protected LogsInterface	log
static java.io.PrintStream	out Initializes to System.out
static java.lang.String	PASS_SUFFIX " OK "
java.lang.String	TAG
static int	tcp_delay Average Network TCP transaction latency allowance for sockets communications.

Constructor Summary

Constructors

Constructor and Description
SoloWorker()

Method Summary

Modifier and Type	Method and Description
protected SoloRemoteControl	createRemoteControl() Called internally by the initialize() routine to get the desired instance/subclass of SoloRemoteControl.
protected void	debug(java.lang.String message) Output debug messages to our LogsInterface, or to our out PrintStream if the LogsInterface is not set.
java.lang.String	getListenerName() Unique name to identify the listener.
SoloRemoteControl	getRemoteControl()
void	initialize() Called to initialize RemoteControl communications with a remote client and get it to the Ready state.
void	onReceiveDebug(java.lang.String message) A remote client has sent a Debug message to be logged by the listener.
protected java.util.Properties	prepInstrumentDispatch(java.lang.String command) Prepare a dispatchProps object targeting a remote "instrument" command instead of a remote "solo" command.
protected java.util.Properties	prepSoloDispatch(java.lang.String command) Prepare a dispatchProps object targeting a remote "solo" command instead of a remote "instrument" command.
void	processFailure(java.lang.String action, java.lang.String message) Handle the reporting or logging of action or test failures.
void	processSuccess(java.lang.String action, java.lang.String message) Handle the reporting or logging of action or test success.
void	setControllerPort(int controllerPort) Set the controller port where we will connect for messenger service.
void	setLogsInterface(LogsInterface ilog) Set the LogsInterface to be used by the class instance.
void	setPortForwarding(boolean portForwarding) Set if we will forward 'controller port' to remote messenger service's port.
SoloRemoteControl	setRemoteControl(SoloRemoteControl controller, boolean force) Set the SoloRemoteControl instance to be used by this worker.
void	shutdown() Initial default implementation performs:
boolean	shutdownRemote() Initial default implementation performs:
void	turnProtocolDebug(boolean enableDebug) Turn on/off the protocol's debug message. This MUST be called after invoking initialize()
void	turnRunnerDebug(boolean enableDebug) Turn on/off the runner's debug message. This MUST be called after invoking initialize()

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public final java.lang.String TAG

default_connect_stimeout

public static int default_connect_stimeout

How long to wait for a remote connection before issuing timeout. Default 120 seconds.

default_ready_stimeout

public static int default_ready_stimeout

How long to wait for a READY signal before issuing timeout. Default 120 seconds.

default_running_stimeout

public static int default_running_stimeout

How long to wait for a RUNNING signal after dispatch before issuing timeout. Default 60 seconds.

default_result_stimeout

public static int default_result_stimeout

How long to wait for a RESULT signal after dispatch before issuing timeout. Default 120 seconds.

default_shutdown_stimeout

public static int default_shutdown_stimeout

How long to wait for remote shutdown confirmation after dispatch before aborting the wait. Default 7 seconds.

tcp_delay

public static int tcp_delay

Average Network TCP transaction latency allowance for sockets communications. Default 2 seconds.

listenername

public static java.lang.String listenername

out

public static java.io.PrintStream out

Initializes to System.out

err

public static java.io.PrintStream err

Initializes to System.err

log

protected LogsInterface log

control

protected SoloRemoteControl control

CAUSE_SEP

public static java.lang.String CAUSE_SEP

": "

PASS_SUFFIX

public static java.lang.String PASS_SUFFIX

" OK "

FAIL_SUFFIX

public static java.lang.String FAIL_SUFFIX

"FAILED"

doProcessFailure

public boolean doProcessFailure

Set this value to false to bypass or ignore default failure processing. This allows the API caller to handle the failures in their own way.

See Also:

processFailure(String, String)

doProcessSuccess

public boolean doProcessSuccess

Set this value to false to bypass or ignore default success processing. This allows the API caller to handle success in their own way.

See Also:

processSuccess(String, String)

_props

protected java.util.Properties _props

Constructor Detail

SoloWorker

public SoloWorker()

Method Detail

setLogsInterface

public void setLogsInterface(LogsInterface ilog)

Set the LogsInterface to be used by the class instance. This call also attempts to set the ProtocolRunner to use the same LogsInterface.

Parameters:

ilog -

See Also:

LogsInterface

getListenerName

public java.lang.String getListenerName()

Description copied from interface: NamedListener

Unique name to identify the listener.

Specified by:

getListenerName in interface NamedListener

Returns:

name of listener. Might be null.

See Also:

DebugListener

onReceiveDebug

public void onReceiveDebug(java.lang.String message)

Description copied from interface: DebugListener

A remote client has sent a Debug message to be logged by the listener.

Specified by:

onReceiveDebug in interface DebugListener

See Also:

DebugListener

debug

protected void debug(java.lang.String message)

Output debug messages to our LogsInterface, or to our out PrintStream if the LogsInterface is not set.

Parameters:

message -

See Also:

out

createRemoteControl

protected SoloRemoteControl createRemoteControl()

Called internally by the initialize() routine to get the desired instance/subclass of SoloRemoteControl. This routine returns a new instance of a SoloRemoteControl subclass even if we already have a controller set.

Returns:

new SoloRemoteControl(). Subclasses may wish to provide a different subclass of SoloRemoteControl().

getRemoteControl

public SoloRemoteControl getRemoteControl()

Returns:

current SoloRemoteControl subclass or null if not set.

setRemoteControl

public SoloRemoteControl setRemoteControl(SoloRemoteControl controller,
                                          boolean force)

Set the SoloRemoteControl instance to be used by this worker. We will not override an existing controller unless force = true.

Parameters:

controller -

force - true to overwrite an existing controller with a different one, or null.

Returns:

calls getRemoteControl()

initialize

public void initialize()
                throws RemoteException,
                       java.util.concurrent.TimeoutException,
                       ShutdownInvocationException

Called to initialize RemoteControl communications with a remote client and get it to the Ready state. However, the routine only performs this initialization if it is instancing a new remote controller. If the remote controller already exists, then we must assume initialization of that remote control object has opened or will happen elsewhere since it was not instanced by this class. Initial default implementation performs:

 control = createRemoteControll();
 control.addListener(this);
 control.setLogsInterface(log);
 control.start();
 control.waitForRemoteConnected(default_connect_stimeout);
 control.waitForRemoteReady(default_ready_stimeout);
 

Throws:

RemoteException - -- if there is a problem with RemoteControl initialization.

java.util.concurrent.TimeoutException - -- if the initialization and remote connection does not complete in timeout period.

ShutdownInvocationException - -- if the remote client unexpectedly performs a shutdown.

See Also:

setRemoteControl(SoloRemoteControl, boolean), SoloRemoteControl.waitForRemoteReady(int), SoloRemoteControl.setLogsInterface(LogsInterface)

setControllerPort

public void setControllerPort(int controllerPort)

Set the controller port where we will connect for messenger service.

Parameters:

controllerPort -

setPortForwarding

public void setPortForwarding(boolean portForwarding)

Set if we will forward 'controller port' to remote messenger service's port.

Parameters:

portForwarding -

turnRunnerDebug

public void turnRunnerDebug(boolean enableDebug)

Turn on/off the runner's debug message.
This MUST be called after invoking initialize()

Parameters:

enableDebug -

turnProtocolDebug

public void turnProtocolDebug(boolean enableDebug)

Turn on/off the protocol's debug message.
This MUST be called after invoking initialize()

Parameters:

enableDebug -

processFailure

public void processFailure(java.lang.String action,
                           java.lang.String message)

Handle the reporting or logging of action or test failures.

This is enabled by default. Callers can override default failure processing by setting doProcessFailure = false.

This implementation uses the LogsInterface that should be provided at or immediately following the creation of the Class instance. Subclasses may wish to use true jUnit reporting or other mechanisms.

If the LogsInterface call throws an Exception for any reason--including a NullPointerException because it was never provided or initialized--the implementation will log to our err PrintStream with the following format: cause +": "+ message

Parameters:

cause - -- Normally, the action or id of the call that generated the failure.

message - -- The failure message provided for that action or id. If the message is null the implementation will use FAIL_SUFFIX.

See Also:

LogsInterface.fail(String, String), FAIL_SUFFIX

processSuccess

public void processSuccess(java.lang.String action,
                           java.lang.String message)

Handle the reporting or logging of action or test success.

This is enabled by default. A truer jUnit experience can be achieved by setting doHandleSuccess = false.

This implementation uses the LogsInterface that should be provided at or immediately following the creation of the Class instance. Subclasses may wish to use true jUnit reporting or other mechanisms.

If the LogsInterface call throws an Exception for any reason--including a NullPointerException because it was never provided or initialized--the implementation will log to our out PrintStream with the following format: cause +": "+ message

Parameters:

cause - -- Normally, the action or id of the call that generated the success.

message - -- The success message provided for that action or id, if any. This can be null. If the message is null this implementation will use PASS_SUFFIX.

See Also:

#doHandleSuccess, LogsInterface.pass(String, String), PASS_SUFFIX

shutdown

public void shutdown()

Initial default implementation performs:

 control.shutdown();
 This will stop the SoloRemoteControlRunner on the computer side.
 

Note: If you want to stop the remote service on the device side,
you should call shutdownRemote(), and you MUST call it before
calling this shutdown() method.

See Also:

SoloRemoteControl.shutdown(), shutdownRemote()

shutdownRemote

public boolean shutdownRemote()

Initial default implementation performs:

 control.performRemoteShutdown(int,int,int);
 

Note: This method will stop the remote service on the device side,
you MUST call it before calling shutdown() method.

See Also:

SoloRemoteControl.performRemoteShutdown(int, int, int), shutdown()

prepInstrumentDispatch

protected java.util.Properties prepInstrumentDispatch(java.lang.String command)

Prepare a dispatchProps object targeting a remote "instrument" command instead of a remote "solo" command.

Parameters:

command -

Returns:

Properties ready to be populated with command-specific parameters.

prepSoloDispatch

protected java.util.Properties prepSoloDispatch(java.lang.String command)

Prepare a dispatchProps object targeting a remote "solo" command instead of a remote "instrument" command.

Parameters:

command -

Returns:

Properties ready to be populated with command-specific parameters.