com.jayway.android.robotium.remotecontrol.client

Class AbstractTestRunner

java.lang.Object

android.app.Instrumentation

android.test.InstrumentationTestRunner

com.jayway.android.robotium.remotecontrol.client.AbstractTestRunner

All Implemented Interfaces:

android.test.TestSuiteProvider, CommandListener, DebugListener, NamedListener

Direct Known Subclasses:

RobotiumTestRunner

public abstract class AbstractTestRunner
extends android.test.InstrumentationTestRunner
implements CommandListener, DebugListener

Primary InstrumentationTestRunner used for binding and un-binding TCP Messenger Service.
It contains a MessengerRunner, which is used to handle the messages from 'TCP Messenger'.
When the service is connected, MessengerRunner will be started in a separated thread.

This main thread will wait there until the thread MessengerRunner's termination.
This class implements the interface CommandListener, which describes the actions to do when
receiving a message from 'TCP Messenger'. The subclass of this class should give a concrete
implementation for methods described in CommandListener.

Since:

FEB 04, 2012 (Carl Nagle) Initial version
APR 25, 2013 (LeiWang) Handle message of big size.

Author:

Carl Nagle, SAS Institute, Inc.

See Also:

MessengerService

Nested Class Summary

Nested classes/interfaces inherited from class android.app.Instrumentation

android.app.Instrumentation.ActivityMonitor, android.app.Instrumentation.ActivityResult

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.Object	lock
protected MessengerRunner	messageRunner
(package private) boolean	mIsBound true if we are successfully bound to the TCP Messenger Service.
(package private) java.util.HashMap<java.lang.String,java.util.Vector<ProcessorInterface>>	processorsMap Do we need multiple processors for one target? If not, we may just define the cache as HashMap
static java.lang.String	resource_bind_service
static java.lang.String	resource_service_attached
static java.lang.String	resource_service_disconnect
static java.lang.String	resource_service_release
(package private) boolean	runnerStopped
static java.lang.String	TAG

Fields inherited from class android.test.InstrumentationTestRunner

REPORT_KEY_NAME_CLASS, REPORT_KEY_NAME_TEST, REPORT_KEY_NUM_CURRENT, REPORT_KEY_NUM_TOTAL, REPORT_KEY_STACK, REPORT_VALUE_ID, REPORT_VALUE_RESULT_ERROR, REPORT_VALUE_RESULT_FAILURE, REPORT_VALUE_RESULT_OK, REPORT_VALUE_RESULT_START

Fields inherited from class android.app.Instrumentation

REPORT_KEY_IDENTIFIER, REPORT_KEY_STREAMRESULT

Constructor Summary

Constructors

Constructor and Description
AbstractTestRunner()

Method Summary

Modifier and Type	Method and Description
void	addProcessor(java.lang.String target, ProcessorInterface processor) According to the target, put the processor to a cache
abstract void	afterStart() Called as part of the onCreate(Bundle) initialization after Instrumentation.start().
abstract boolean	beforeStart() Called as part of the onCreate(Bundle) initialization after doBindService() immediately before Instrumentation.start().
void	debug(java.lang.String message)
protected boolean	doBindService() Attempt to force the launch and persistent binding to the separate TCP Messenger Service.
protected boolean	doUnbindService() Unregister and then unbind with the separate TCP Messenger Service.
void	finishInstrumentation()
java.lang.String	getListenerName() Unique name to identify the listener.
java.util.Vector<ProcessorInterface>	getProcessors(java.lang.String target) According to the target, get the processors from a cache
void	handleDispatchProps(java.util.Properties props)
MessageResult	handleEngineShutdown()
boolean	isDebugEnabled()
void	messengerRunnerStopped()
void	onCreate(android.os.Bundle savedInstanceState) Called when the Instrumentation class is first created.
void	onReceiveDebug(java.lang.String message) Receive debug logging requests from the Messenger Service
void	onStart() Called automatically from start().
void	removeProcessor(java.lang.String target, ProcessorInterface processor) Remove the processor from the cache, the processor should belong to 'target'
void	removeProcessors() Be careful when you call this method, which will remove all the processors from cache
void	removeProcessors(java.lang.String target) Be careful when you call this method, which will remove all the processors related to 'target' from cache
boolean	sendServiceResult(java.util.Properties props) Exposes the messageRunner.sendServiceResult(Properties) method.
void	setDebugEnabled(boolean enable)

Methods inherited from class android.test.InstrumentationTestRunner

getAllTests, getAndroidTestRunner, getArguments, getLoader, getTestSuite

Methods inherited from class android.app.Instrumentation

addMonitor, addMonitor, addMonitor, callActivityOnCreate, callActivityOnCreate, callActivityOnDestroy, callActivityOnNewIntent, callActivityOnPause, callActivityOnPostCreate, callActivityOnPostCreate, callActivityOnRestart, callActivityOnRestoreInstanceState, callActivityOnRestoreInstanceState, callActivityOnResume, callActivityOnSaveInstanceState, callActivityOnSaveInstanceState, callActivityOnStart, callActivityOnStop, callActivityOnUserLeaving, callApplicationOnCreate, checkMonitorHit, endPerformanceSnapshot, finish, getAllocCounts, getBinderCounts, getComponentName, getContext, getTargetContext, getUiAutomation, getUiAutomation, invokeContextMenuAction, invokeMenuActionSync, isProfiling, newActivity, newActivity, newApplication, newApplication, onDestroy, onException, removeMonitor, runOnMainSync, sendCharacterSync, sendKeyDownUpSync, sendKeySync, sendPointerSync, sendStatus, sendStringSync, sendTrackballEventSync, setAutomaticPerformanceSnapshots, setInTouchMode, start, startActivitySync, startAllocCounting, startPerformanceSnapshot, startProfiling, stopAllocCounting, stopProfiling, waitForIdle, waitForIdleSync, waitForMonitor, waitForMonitorWithTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.android.messenger.client.CommandListener

handleDispatchFile, handleMessage, handleRemoteShutdown, handleServerConnected, handleServerDisconnected, handleServerShutdown

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

resource_service_attached

public static final java.lang.String resource_service_attached

See Also:

Constant Field Values

resource_service_disconnect

public static final java.lang.String resource_service_disconnect

See Also:

Constant Field Values

resource_service_release

public static final java.lang.String resource_service_release

See Also:

Constant Field Values

resource_bind_service

public static final java.lang.String resource_bind_service

See Also:

Constant Field Values

messageRunner

protected MessengerRunner messageRunner

lock

java.lang.Object lock

runnerStopped

boolean runnerStopped

processorsMap

java.util.HashMap<java.lang.String,java.util.Vector<ProcessorInterface>> processorsMap

Do we need multiple processors for one target? If not, we may just define the cache as HashMap

mIsBound

boolean mIsBound

true if we are successfully bound to the TCP Messenger Service. false if we have disconnected ourselves from the service.

CAUTION: The Instrumentation thread monitors this to determine if the thread should exit.

Constructor Detail

AbstractTestRunner

public AbstractTestRunner()

Method Detail

sendServiceResult

public boolean sendServiceResult(java.util.Properties props)

Exposes the messageRunner.sendServiceResult(Properties) method.

setDebugEnabled

public void setDebugEnabled(boolean enable)

isDebugEnabled

public boolean isDebugEnabled()

debug

public void debug(java.lang.String message)

onReceiveDebug

public void onReceiveDebug(java.lang.String message)

Receive debug logging requests from the Messenger Service

Specified by:

onReceiveDebug in interface DebugListener

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

Called when the Instrumentation class is first created. Here we launch and bind to the TCP Messenger Service and then attempt to deduce the target Application we are going to be testing.

We do this through the following sequence of execution:

1. doBindService()
2. beforeStart()
3. Instrumentation.start()
4. afterStart()

Overrides:

onCreate in class android.test.InstrumentationTestRunner

beforeStart

public abstract boolean beforeStart()

Called as part of the onCreate(Bundle) initialization after doBindService() immediately before Instrumentation.start().

Allows subclasses to do any additional setup prior to starting the Instrumentation Thread as part of the onCreate call.

Returns:

true to continue normal operation. false to abort and NOT call start().

afterStart

public abstract void afterStart()

Called as part of the onCreate(Bundle) initialization after Instrumentation.start().

Allows subclasses to do any additional setup after the Instrumentation Thread has been started as part of the onCreate call.

onStart

public void onStart()

Called automatically from start().

Overrides:

onStart in class android.test.InstrumentationTestRunner

See Also:

Instrumentation.start()

finishInstrumentation

public void finishInstrumentation()

messengerRunnerStopped

public void messengerRunnerStopped()

Specified by:

messengerRunnerStopped in interface CommandListener

doBindService

protected boolean doBindService()

Attempt to force the launch and persistent binding to the separate TCP Messenger Service. A successful binding will set mIsBound true which will cause our instrumentation to loop until this is reset to false.

doUnbindService

protected boolean doUnbindService()

Unregister and then unbind with the separate TCP Messenger Service. This will set reset our mIsBound boolean to false which will allow our instrumentation thread to shutdown.

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.

handleEngineShutdown

public MessageResult handleEngineShutdown()

Specified by:

handleEngineShutdown in interface CommandListener

addProcessor

public void addProcessor(java.lang.String target,
                         ProcessorInterface processor)

According to the target, put the processor to a cache

Parameters:

target - The key with which the processors are stored in cache

processor - The processor to be stored in cache

getProcessors

public java.util.Vector<ProcessorInterface> getProcessors(java.lang.String target)

According to the target, get the processors from a cache

Parameters:

target - The key with which the processors are stored in cache

Returns:

a Vector containing 0 or more ProcessorInterface objects.

removeProcessors

public void removeProcessors()

Be careful when you call this method, which will remove all the processors from cache

removeProcessors

public void removeProcessors(java.lang.String target)

Be careful when you call this method, which will remove all the processors related to 'target' from cache

Parameters:

target - The key with which the processors are stored in cache

removeProcessor

public void removeProcessor(java.lang.String target,
                            ProcessorInterface processor)

Remove the processor from the cache, the processor should belong to 'target'

Parameters:

target - The key with which the processors are stored in cache

processor - The processor to be removed from cache

handleDispatchProps

public void handleDispatchProps(java.util.Properties props)

Specified by:

handleDispatchProps in interface CommandListener

Parameters:

props - A Properties object, contains the input parameters including command, target etc.
To get the command, target, use the key defined in SoloMessage, such as KEY_COMMAND,KEY_TARGET
It also serves as the output for result:
To set the result, use the key defined in SoloMessage, such as KEY_REMOTERESULTCODE
KEY_REMOTERESULTINFO, KEY_ISREMOTERESULT etc.

See Also:

Message, Message, SoloMessage