com.jayway.android.robotium.remotecontrol.client

Class RobotiumTestRunner

java.lang.Object

android.app.Instrumentation

android.test.InstrumentationTestRunner

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

com.jayway.android.robotium.remotecontrol.client.RobotiumTestRunner

All Implemented Interfaces:

android.test.TestSuiteProvider, CommandListener, DebugListener, NamedListener

Direct Known Subclasses:

DSAFSTestRunner

public class RobotiumTestRunner
extends AbstractTestRunner

Primary InstrumentationTestRunner used for remote controlled Android Automation in associated with a TCP Messenger Service.

This is the InstrumentationTestRunner that is considered the test package usually associated with a very specific target Package to be tested. However, in the case of SAFS we want to make a completely reusable test package that is NOT built with a specific target Package association. We want this general-purpose test framework to be usable to test all Android Applications via the data-driven SAFS framework.

The initial implementation, however, is not necessarily SAFS-specific.

How the remote control mechanism works:
The test package AdroidManifest.xml does need to have the Instrumentation tags set for the target Application to be tested. There is no getting around this:

 <instrumentation android:name="com.jayway.android.robotium.remotecontrol.client.RobotiumTestRunner"
                  android:targetPackage="com.android.example.spinner"
                  android:label="General-Purpose SAFS Droid Automation Framework"/>
 

The AndroidManifest.xml then simply needs to be repackaged into a working test APK in order to test the target application.

The test consists of the following on-device assets:
1. TCP Messenger Service,
2. Robotium Remote Solo APK,
3. Target Application APK.

The remote control assets are simply:
1. Remote Controller implementing a TCP SocketServerListener,
2. TCP SocketServer binding to the on-device TCP Messenger Service for two-way communication.

There is a predefined TCP Protocol the remote TCP SocketServer and the on-device TCP Messenger Service must adhere to for proper signalling and synchronization.

When using the Droid Emulator, the remote controller must ensure the proper emulator port forwarding is set in order for the TCP Messenger Service to be able to communicate with the outside world.

Author:

Carl Nagle, SAS Institute, Inc.
May 21, 2013 (LeiWang) Use RCSolo instead of Solo.

See Also:

MessengerService, AbstractTestRunner

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) RobotiumTestCase	activityrunner
(package private) int	ALL_APPLICATION_INFO Flags OR'd together to retrieve all available information on an Application.
(package private) int	ALL_PACKAGE_INFO Flags OR'd together to retrieve all available information on an installed Package.
(package private) android.app.Activity	mainApp
(package private) android.content.pm.InstrumentationInfo	myInstrumentInfo
(package private) android.content.pm.PackageInfo	myPackageInfo
(package private) android.content.pm.PackageManager	myPackageManager
(package private) RCSolo	solo
static java.lang.String	TAG
(package private) android.content.pm.ActivityInfo[]	targetActivityInfo
(package private) java.lang.String	targetApplicationClassName
(package private) android.content.Intent	targetLaunchIntent
(package private) android.content.pm.PackageInfo	targetPackageInfo
(package private) java.lang.String	targetPackageString

Fields inherited from class com.jayway.android.robotium.remotecontrol.client.AbstractTestRunner

lock, messageRunner, mIsBound, processorsMap, resource_bind_service, resource_service_attached, resource_service_disconnect, resource_service_release, runnerStopped

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
RobotiumTestRunner()

Method Summary

Modifier and Type	Method and Description
void	afterStart() Called as part of the AbstractTestRunner.onCreate(Bundle) initialization after Instrumentation.start().
boolean	beforeStart() Called as part of the AbstractTestRunner.onCreate(Bundle) initialization after AbstractTestRunner.doBindService() immediately before Instrumentation.start().
void	closeApplication() Force a shutdown of ANY running test Activities.
(package private) boolean	createRobotiumTestCase() Instantiate the RobotiumTestCase.
RobotiumTestCase	getActivityrunner()
java.lang.String	getListenerName() Unique name to identify the listener.
RCSolo	getSolo() The returned RCSolo is probably a null. The RCSolo object will be initialized after calling launchApplication()
(package private) boolean	getTargetPackageInfo() Attempt to extract all pertinent information for launching/driving the package we are testing.
MessageResult	handleDispatchFile(java.lang.String filename) =========================================================================================== Following are the call-back methods inheritated from CommandListener ===========================================================================================
MessageResult	handleMessage(java.lang.String message)
MessageResult	handleRemoteShutdown()
MessageResult	handleServerConnected()
MessageResult	handleServerDisconnected()
MessageResult	handleServerShutdown()
(package private) boolean	initializeInstrumentation() Attempt to initialize the RobotiumTestCase with Intent and Instrumentation.
SoloProcessor	initializeSoloProcessor() Subclasses will want to override to instantiate their own SoloProcessor subclass. This Processor will be add to processors-cache with key Message.target_solo
void	launchApplication() Launches the main Application Activity and initializes the Robotium Solo object.

Methods inherited from class com.jayway.android.robotium.remotecontrol.client.AbstractTestRunner

addProcessor, debug, doBindService, doUnbindService, finishInstrumentation, getProcessors, handleDispatchProps, handleEngineShutdown, isDebugEnabled, messengerRunnerStopped, onCreate, onReceiveDebug, onStart, removeProcessor, removeProcessors, removeProcessors, sendServiceResult, setDebugEnabled

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

Field Detail

TAG

public static java.lang.String TAG

myPackageManager

android.content.pm.PackageManager myPackageManager

ALL_PACKAGE_INFO

int ALL_PACKAGE_INFO

Flags OR'd together to retrieve all available information on an installed Package.

ALL_APPLICATION_INFO

int ALL_APPLICATION_INFO

Flags OR'd together to retrieve all available information on an Application.

myPackageInfo

android.content.pm.PackageInfo myPackageInfo

myInstrumentInfo

android.content.pm.InstrumentationInfo myInstrumentInfo

targetPackageString

java.lang.String targetPackageString

targetLaunchIntent

android.content.Intent targetLaunchIntent

targetApplicationClassName

java.lang.String targetApplicationClassName

targetPackageInfo

android.content.pm.PackageInfo targetPackageInfo

targetActivityInfo

android.content.pm.ActivityInfo[] targetActivityInfo

activityrunner

RobotiumTestCase activityrunner

mainApp

android.app.Activity mainApp

solo

RCSolo solo

Constructor Detail

RobotiumTestRunner

public RobotiumTestRunner()

Method Detail

initializeSoloProcessor

public SoloProcessor initializeSoloProcessor()

Subclasses will want to override to instantiate their own SoloProcessor subclass.
This Processor will be add to processors-cache with key Message.target_solo

Parameters:

runner -

Returns:

See Also:

Message.target_solo

getActivityrunner

public RobotiumTestCase getActivityrunner()

getSolo

public RCSolo getSolo()

The returned RCSolo is probably a null.
The RCSolo object will be initialized after calling launchApplication()

We CANNOT automatically call launchApplication as part of this method because there are cases--especially during initialization--when the call to launchApplication will most definitely fail.

Returns:

RCSolo or null if the application has not yet been launched by the test/user at an appropriate time.

getListenerName

public java.lang.String getListenerName()

Description copied from interface: NamedListener

Unique name to identify the listener.

Specified by:

getListenerName in interface NamedListener

Overrides:

getListenerName in class AbstractTestRunner

Returns:

name of listener. Might be null.

createRobotiumTestCase

boolean createRobotiumTestCase()

Instantiate the RobotiumTestCase. Subclasses will likely override. Called as part of the beforeStart initialization AFTER getTargetPackageInfo has initialized some critical fields.

See Also:

RobotiumTestCase, beforeStart(), getTargetPackageInfo()

initializeInstrumentation

boolean initializeInstrumentation()

Attempt to initialize the RobotiumTestCase with Intent and Instrumentation. Normally, subclasses would not need to override this method.

See Also:

ActivityInstrumentationTestCase2.setActivityIntent(Intent), InstrumentationTestCase.injectInstrumentation(android.app.Instrumentation)

getTargetPackageInfo

boolean getTargetPackageInfo()

Attempt to extract all pertinent information for launching/driving the package we are testing.

See Also:

PackageManager.getPackageInfo(String, int), PackageInfo.instrumentation, InstrumentationInfo.targetPackage, PackageManager.getLaunchIntentForPackage(String)

beforeStart

public boolean beforeStart()

Description copied from class: AbstractTestRunner

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

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

Specified by:

beforeStart in class AbstractTestRunner

Returns:

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

afterStart

public void afterStart()

Description copied from class: AbstractTestRunner

Called as part of the AbstractTestRunner.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.

Specified by:

afterStart in class AbstractTestRunner

launchApplication

public void launchApplication()

Launches the main Application Activity and initializes the Robotium Solo object. This method MUST be invoked firstly before we can use Robotium Solo object to do further work.

See Also:

RobotiumTestCase.setUp(), RobotiumTestCase.getRobotium()

closeApplication

public void closeApplication()

Force a shutdown of ANY running test Activities. This is done via our Robotium Solo instance.

handleDispatchFile

public MessageResult handleDispatchFile(java.lang.String filename)

=========================================================================================== Following are the call-back methods inheritated from CommandListener ===========================================================================================

handleMessage

public MessageResult handleMessage(java.lang.String message)

handleServerConnected

public MessageResult handleServerConnected()

handleServerDisconnected

public MessageResult handleServerDisconnected()

handleServerShutdown

public MessageResult handleServerShutdown()

handleRemoteShutdown

public MessageResult handleRemoteShutdown()