SoloTest (SAFS API DOCUMENT)

java.lang.Object
- org.safs.android.remotecontrol.SoloTest

public class SoloTest
extends java.lang.Object

This is used to test Remote Solo Implementation with a SAFSTestRunner.
The tested Activity is "com.android.example.spinner.SpinnerActivity"
If testing with another Activity, we suggest to subclass this program.

Prerequisite:

 1. Set the android sdk dir (use one of 2 ways):
 
    1.1 set environment ANDROID_HOME
    1.2 launch application with JVM property as: -Dandroid-home="D:\\your\\android-sdk-dir"
    
 2. (Optional)Set the ant sdk dir if you need rebuild the test-runner-apk (use one of 2 ways):
 
    2.1 set environment ANT_HOME
    2.2 launch application with JVM property as: -Dant-home="D:\\your\\ant-sdk-dir"
       
 3. Command-line args to set the APK of AUT, SAFSMessenger and SAFSTestRunner to be installed:
    
    aut="C:\\SAFS\\samples\\Droid\\SpinnerSample\\bin\\SpinnerActivity-debug.apk"  (sets installAUT=true)
    messenger="C:\\SAFS\\samples\\Droid\\SAFSTCPMessenger\\bin\\SAFSTCPMessenger-debug.apk"  (sets installMessenger=true)
    runner="C:\\SAFS\\samples\\Droid\\SAFSTestRunner\\bin\\SAFSTestRunner-debug.apk"   (sets installRunner=true)
      (or runnersource=d:\\testRunnerSourcePath like below:)
    runnersource="C:\\SAFS\\samples\\Droid\\SAFSTestRunner" (sets rebuildRunner=true) 
    
    OR, to bypass individual installs and use what is already installed:
    
    -noaut
    -nomessenger
    -norunner
    
    
 4. Command-line arg to set the instrument:
 
    instrument=org.safs.android.engine/org.safs.android.engine.DSAFSTestRunner
 
 5. Command-line arg to set the avd name to launch, or the device/emulator serial number to look for:
    
    avd="avdName" or avd="devOrEmuSerial"
    
 6. Command-line arg to set the persistence of launched emulator:
    
    persistavd="True" or persistavd="False" (default=false)
    
 7. Command-line arg to set to resign AUT automatically:
    
    resignjar=C:\\safs\\lib\\re-sign.jar
    
 8. Command-line arg to set to remove installed APKs automatically after test finish:
    
    -removeinstalledapk

  
 Run as:
 
   java org.safs.android.remotecontrol.SoloTest aut="C:\\buildFilePath\\SpinnerActivity-debug.apk" messenger="c:\\buildFilePath\\SAFSTCPMessenger-debug.apk" runner="c:\\buildFilePath\\SAFSTestRunner-debug.apk" instrument=org.safs.android.engine/org.safs.android.engine.DSAFSTestRunner
   
   or, rebuild testrunner and use it
   
   java -Dant-home="C:\\pathTo\\ant-sdk" org.safs.android.remotecontrol.SoloTest aut="C:\\buildFilePath\\SpinnerActivity-debug.apk" messenger="c:\\buildFilePath\\SAFSTCPMessenger-debug.apk" runnersource="c:\\buildSourcePath\\" instrument=org.safs.android.engine/org.safs.android.engine.DSAFSTestRunner
   
   or, assuming everything is already installed:
   
   java -Dandroid-home="C:\\pathTo\\android-sdk" org.safs.android.remotecontrol.SoloTest -noaut -nomessenger -norunner instrument=org.safs.android.engine/org.safs.android.engine.DSAFSTestRunner

Author:: Carl Nagle, SAS Institute, Inc.
(LeiWang) AUG 16, 2013 Add option to permit remove installed apks automatically after test finish.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ARG_KEY_AUT_APK`
`static java.lang.String`	`ARG_KEY_AVD`
`static java.lang.String`	`ARG_KEY_INSTRUMENT_ARG`
`static java.lang.String`	`ARG_KEY_MESSENGER_APK`
`static java.lang.String`	`ARG_KEY_NO_AUT`
`static java.lang.String`	`ARG_KEY_NO_MESSENGER`
`static java.lang.String`	`ARG_KEY_NO_RUNNER`
`static java.lang.String`	`ARG_KEY_PERSIST_AVD`
`static java.lang.String`	`ARG_KEY_REMOVE_INSTALLED_APK`
`static java.lang.String`	`ARG_KEY_RESIGN_JAR`
`static java.lang.String`	`ARG_KEY_TESTRUNNER_APK`
`static java.lang.String`	`ARG_KEY_TESTRUNNER_SOURCE`
`boolean`	`argAUTpassed` true if we received the 'aut' command-line argument, or setAUTApk() was called.
`boolean`	`argINSTRUMENTpassed` true if we received the 'instrument' command-line argument, or setInstrumentArg() was called.
`boolean`	`argMESSENGERpassed` true if we received the 'messenger' command-line argument, or setMessengerApk() was called.
`boolean`	`argRESIGNJARpassed` true if we received the 'resignjar' command-line argument, or setResignJar() was called.
`boolean`	`argRUNNERpassed` true if we received the 'runner' command-line argument, or setTestRunnerApk() was called.
`boolean`	`argRUNNERSOURCEpassed` true if we received the 'runnersource' command-line argument, or setTestRunnerSourceDir() was called.
`protected java.lang.String`	`avdSerialNo` avdSerialNo is device or emulator's serial number, it is "" by default it will be modified by the value pass in as 'avd=' argument If there is no device/emulator is attached/launched, we will try to launch the emulator with this serial number. If there is one device/emulator is attached/launched, we will ignore this serial number. If there are multiple devices/emulators are attached/launched, we use this serial number to locate the device/emulator.
`static java.lang.String`	`DEFAULT_AUT_APK` Modify `DEFAULT_AUT_APK` according to your system. Modify `DEFAULT_MESSENGER_APK` according to your system. Modify `DEFAULT_TESTRUNNER_APK` according to your system. Modify `DEFAULT_TESTRUNNER_SOURCE_DIR` according to your system. Modify `DEFAULT_INSTRUMENT_ARG` according to your system.
`static java.lang.String`	`DEFAULT_INSTRUMENT_ARG`
`static java.lang.String`	`DEFAULT_MESSENGER_APK`
`static java.lang.String`	`DEFAULT_TESTRUNNER_APK`
`static java.lang.String`	`DEFAULT_TESTRUNNER_SOURCE_DIR`
`SAFSDriverCommands`	`driver`
`SAFSEngineCommands`	`engine`
`protected java.lang.String`	`mainActivityUID` This field will store the activity UID of you launch AUT. It will be set in method `initialize()` It will be used in method `goBackToViewUID(String)` to prevent infinite loop.
`protected boolean`	`persistEmulators` If this is true, we will keep the launched emulator running even after the test has finished. The default value is false. it will be modified by the value pass in as 'persistavd=' argument
`boolean`	`removeinstalledapk` default is false.
`Timeout`	`robotiumTimeout`
`RobotiumUtils`	`robotiumUtils`
`Solo`	`solo`
`protected boolean`	`unlockEmulatorScreen` flag defaults to true to unlock the screen of any emulator we wish to connect to.
`protected boolean`	`weLaunchedEmulator`

Constructor Summary

Constructors
Constructor and Description
`SoloTest()` Instantiates the Solo instance but does not yet initialize it.
`SoloTest(java.lang.String[] args)`
`SoloTest(java.lang.String messengerApk, java.lang.String testRunnerApk, java.lang.String instrumentArg)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`debug(java.lang.String message)`
`void`	`error(java.lang.String message)`
`void`	`fail(java.lang.String message)`
`java.lang.String`	`getAUTApk()`
`java.lang.String`	`getInstrumentArg()`
`java.lang.String`	`getMessengerApk()`
`java.lang.String`	`getResignJar()`
`java.lang.String`	`getTestRunnerApk()`
`java.lang.String`	`getTestRunnerSourceDir()`
`protected void`	`goBackToViewUID(java.lang.String viewUID)`
`void`	`info(java.lang.String message)`
`protected boolean`	`initialize()` Initialize the Solo object and the SAFSEngineCommands instance and launches the main application. You will not modify this method in the sub-class, normally
`boolean`	`isRemoveinstalledapk()`
`static void`	`main(java.lang.String[] args)`
`void`	`pass(java.lang.String message)`
`protected void`	`pause(int millis)`
`protected boolean`	`preparation()` Install the apk of SAFSTCPMessenger and SAFSTestRunner Forward the tcp port from on-computer-2411 to on-device-2410
`boolean`	`prepareDevice()`
`void`	`process()` A template method.
`(package private) void`	`removeInstalledAPK()`
`protected void`	`scrollToBottoum()`
`protected void`	`scrollToTop()`
`void`	`setAUTApk(java.lang.String autApk)`
`void`	`setInstallAUT(boolean installAUT)`
`void`	`setInstallMessenger(boolean installMessenger)`
`void`	`setInstallRunner(boolean installRunner)`
`void`	`setInstrumentArg(java.lang.String instrumentArg)`
`void`	`setMessengerApk(java.lang.String messengerApk)`
`void`	`setProtocolDebug(boolean enableProtocolDebug)` Turn on or off the protocol's debug message
`void`	`setRebuildRunner(boolean rebuildRunner)` Rebuilding testrunner will depend on `autApk` and `testRunnerSourceDir`
`void`	`setRemoveinstalledapk(boolean removeinstalledapk)`
`void`	`setResignJar(java.lang.String resignJar)`
`void`	`setRunnerDebug(boolean enableRunnerDebug)` Turn on or off the runner's debug message
`void`	`setTestRunnerApk(java.lang.String testRunnerApk)`
`void`	`setTestRunnerSourceDir(java.lang.String testRunnerSourceDir)`
`protected boolean`	`stopEmulator()` Stop the emulator launched by us only if we have launched it and we don't want to persist it.
`protected boolean`	`terminate()` Terminate the remote engine. Terminate the local controller runner. Terminate the emulator if we have started it. You will not modify this method in the sub-class.
`protected void`	`test()` Use solo and engine to test. You will extend this method in the sub-class, normally In the SAFSTestRunner project, there is a file AndroidManifest.xml: There is a tag like following: If you want to test another application, you should modify the property "android:targetPackage" For example, android:targetPackage="your.test.application.package" And you need to override this method to do the test work.
`void`	`warn(java.lang.String message)`
`protected java.lang.String`	`wrapRegex(java.lang.String text)` Wrap the text with regex prefix and suffix ".*" When you call some method like `Solo.clickOnText(String)`, the parameter can be regex string to match more, you can call this method to wrap the parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - solo
```
public Solo solo
```
  - engine
```
public SAFSEngineCommands engine
```
  - driver
```
public SAFSDriverCommands driver
```
  - robotiumUtils
```
public RobotiumUtils robotiumUtils
```
  - robotiumTimeout
```
public Timeout robotiumTimeout
```
  - avdSerialNo
```
protected java.lang.String avdSerialNo
```
    avdSerialNo is device or emulator's serial number, it is "" by default
    it will be modified by the value pass in as 'avd=' argument
    If there is no device/emulator is attached/launched, we will try to
    launch the emulator with this serial number.
    If there is one device/emulator is attached/launched, we will ignore
    this serial number.
    If there are multiple devices/emulators are attached/launched, we
    use this serial number to locate the device/emulator.
  - persistEmulators
```
protected boolean persistEmulators
```
    If this is true, we will keep the launched emulator running even after the
    test has finished.
    The default value is false.
    it will be modified by the value pass in as 'persistavd=' argument
  - weLaunchedEmulator
```
protected boolean weLaunchedEmulator
```
  - unlockEmulatorScreen
```
protected boolean unlockEmulatorScreen
```
    flag defaults to true to unlock the screen of any emulator we wish to connect to.
  - mainActivityUID
```
protected java.lang.String mainActivityUID
```
    This field will store the activity UID of you launch AUT.
    It will be set in method initialize()
    It will be used in method goBackToViewUID(String) to prevent infinite loop.
  - argAUTpassed
```
public boolean argAUTpassed
```
    true if we received the 'aut' command-line argument, or setAUTApk() was called.
  - argMESSENGERpassed
```
public boolean argMESSENGERpassed
```
    true if we received the 'messenger' command-line argument, or setMessengerApk() was called.
  - argRUNNERpassed
```
public boolean argRUNNERpassed
```
    true if we received the 'runner' command-line argument, or setTestRunnerApk() was called.
  - argINSTRUMENTpassed
```
public boolean argINSTRUMENTpassed
```
    true if we received the 'instrument' command-line argument, or setInstrumentArg() was called.
  - argRESIGNJARpassed
```
public boolean argRESIGNJARpassed
```
    true if we received the 'resignjar' command-line argument, or setResignJar() was called.
  - argRUNNERSOURCEpassed
```
public boolean argRUNNERSOURCEpassed
```
    true if we received the 'runnersource' command-line argument, or setTestRunnerSourceDir() was called.
  - removeinstalledapk
```
public boolean removeinstalledapk
```
    default is false. true if we received the '-removeinstalledapk' command-line argument, or setRemoveinstalledapk(true) was called. If this is true, all installed apk including 'aut', 'runner' and 'messenger' will be removed.
  - DEFAULT_AUT_APK
```
public static final java.lang.String DEFAULT_AUT_APK
```
    Modify DEFAULT_AUT_APK according to your system.
    Modify DEFAULT_MESSENGER_APK according to your system.
    Modify DEFAULT_TESTRUNNER_APK according to your system.
    Modify DEFAULT_TESTRUNNER_SOURCE_DIR according to your system.
    Modify DEFAULT_INSTRUMENT_ARG according to your system.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MESSENGER_APK
```
public static final java.lang.String DEFAULT_MESSENGER_APK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TESTRUNNER_APK
```
public static final java.lang.String DEFAULT_TESTRUNNER_APK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TESTRUNNER_SOURCE_DIR
```
public static final java.lang.String DEFAULT_TESTRUNNER_SOURCE_DIR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_INSTRUMENT_ARG
```
public static final java.lang.String DEFAULT_INSTRUMENT_ARG
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_RESIGN_JAR
```
public static final java.lang.String ARG_KEY_RESIGN_JAR
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_AUT_APK
```
public static final java.lang.String ARG_KEY_AUT_APK
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_MESSENGER_APK
```
public static final java.lang.String ARG_KEY_MESSENGER_APK
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_TESTRUNNER_APK
```
public static final java.lang.String ARG_KEY_TESTRUNNER_APK
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_TESTRUNNER_SOURCE
```
public static final java.lang.String ARG_KEY_TESTRUNNER_SOURCE
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_INSTRUMENT_ARG
```
public static final java.lang.String ARG_KEY_INSTRUMENT_ARG
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_AVD
```
public static final java.lang.String ARG_KEY_AVD
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_PERSIST_AVD
```
public static final java.lang.String ARG_KEY_PERSIST_AVD
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_NO_MESSENGER
```
public static final java.lang.String ARG_KEY_NO_MESSENGER
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_NO_RUNNER
```
public static final java.lang.String ARG_KEY_NO_RUNNER
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_NO_AUT
```
public static final java.lang.String ARG_KEY_NO_AUT
```
    See Also:
    
    Constant Field Values
  - ARG_KEY_REMOVE_INSTALLED_APK
```
public static final java.lang.String ARG_KEY_REMOVE_INSTALLED_APK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SoloTest
```
public SoloTest()
```
    Instantiates the Solo instance but does not yet initialize it.
    
    See Also:
    
    solo, engine
  - SoloTest
```
public SoloTest(java.lang.String messengerApk,
                java.lang.String testRunnerApk,
                java.lang.String instrumentArg)
```
  - SoloTest
```
public SoloTest(java.lang.String[] args)
```
    Parameters:
    
    args - Array of Strings: "aut=xxx", "messenger=xxx", "runner=xxx", "runnersource=xxx", "instrument=xxx"
- Method Detail
  - getTestRunnerSourceDir
```
public java.lang.String getTestRunnerSourceDir()
```
  - setTestRunnerSourceDir
```
public void setTestRunnerSourceDir(java.lang.String testRunnerSourceDir)
```
  - isRemoveinstalledapk
```
public boolean isRemoveinstalledapk()
```
  - setRemoveinstalledapk
```
public void setRemoveinstalledapk(boolean removeinstalledapk)
```
  - getResignJar
```
public java.lang.String getResignJar()
```
  - setResignJar
```
public void setResignJar(java.lang.String resignJar)
```
  - getAUTApk
```
public java.lang.String getAUTApk()
```
  - setAUTApk
```
public void setAUTApk(java.lang.String autApk)
```
  - getMessengerApk
```
public java.lang.String getMessengerApk()
```
  - setMessengerApk
```
public void setMessengerApk(java.lang.String messengerApk)
```
  - getTestRunnerApk
```
public java.lang.String getTestRunnerApk()
```
  - setTestRunnerApk
```
public void setTestRunnerApk(java.lang.String testRunnerApk)
```
  - getInstrumentArg
```
public java.lang.String getInstrumentArg()
```
  - setInstrumentArg
```
public void setInstrumentArg(java.lang.String instrumentArg)
```
  - setProtocolDebug
```
public void setProtocolDebug(boolean enableProtocolDebug)
```
    Turn on or off the protocol's debug message
    
    Parameters:
    
    enable -
  - setRunnerDebug
```
public void setRunnerDebug(boolean enableRunnerDebug)
```
    Turn on or off the runner's debug message
    
    Parameters:
    
    enable -
  - setInstallAUT
```
public void setInstallAUT(boolean installAUT)
```
  - setInstallMessenger
```
public void setInstallMessenger(boolean installMessenger)
```
  - setInstallRunner
```
public void setInstallRunner(boolean installRunner)
```
  - setRebuildRunner
```
public void setRebuildRunner(boolean rebuildRunner)
```
    Rebuilding testrunner will depend on autApk and testRunnerSourceDir
    
    Parameters:
    
    rebuildRunner -
  - process
```
public final void process()
```
    A template method.
    
    See Also:
    
    preparation(), initialize(), test(), terminate()
  - preparation
```
protected final boolean preparation()
```
    Install the apk of SAFSTCPMessenger and SAFSTestRunner
    Forward the tcp port from on-computer-2411 to on-device-2410
    
    Returns:
    
    True if the preparation is finished successfully.
  - prepareDevice
```
public boolean prepareDevice()
```
  - initialize
```
protected final boolean initialize()
```
    Initialize the Solo object and the SAFSEngineCommands instance and launches the main application.
    You will not modify this method in the sub-class, normally
    
    Returns:
    
    true if the initialization is successful.
  - terminate
```
protected final boolean terminate()
```
    Terminate the remote engine.
    Terminate the local controller runner.
    Terminate the emulator if we have started it.
    You will not modify this method in the sub-class.
    
    Returns:
    
    true if the initialization is successful.
  - removeInstalledAPK
```
final void removeInstalledAPK()
```
  - stopEmulator
```
protected final boolean stopEmulator()
```
    Stop the emulator launched by us only if we have launched it and
    we don't want to persist it.
    
    Returns:
    
    boolean, true if the emulator is stopped successfully or we don't need to stop it.
  - test
```
protected void test()
```
    Use solo and engine to test.
    You will extend this method in the sub-class, normally
    In the SAFSTestRunner project, there is a file AndroidManifest.xml:
    There is a tag like following: If you want to test another application, you should modify the property "android:targetPackage"
    For example, android:targetPackage="your.test.application.package"
    And you need to override this method to do the test work.
  - debug
```
public void debug(java.lang.String message)
```
  - info
```
public void info(java.lang.String message)
```
  - warn
```
public void warn(java.lang.String message)
```
  - pass
```
public void pass(java.lang.String message)
```
  - fail
```
public void fail(java.lang.String message)
```
  - error
```
public void error(java.lang.String message)
```
  - goBackToViewUID
```
protected void goBackToViewUID(java.lang.String viewUID)
                        throws java.lang.Exception
```
    Parameters:
    
    viewUID -
    
    Throws:
    
    java.lang.Exception
  - pause
```
protected void pause(int millis)
```
  - scrollToTop
```
protected void scrollToTop()
```
  - scrollToBottoum
```
protected void scrollToBottoum()
```
  - wrapRegex
```
protected java.lang.String wrapRegex(java.lang.String text)
```
    Wrap the text with regex prefix and suffix ".*"
    When you call some method like Solo.clickOnText(String), the parameter
    can be regex string to match more, you can call this method to wrap the parameter.
    
    Parameters:
    
    text - String
    
    Returns:
    
    String, .*text.*
  - main
```
public static void main(java.lang.String[] args)
```
    Parameters:
    
    args - Array of String passed from command line: messenger=xxx runner=xxx runnersource=xxx instrument=xxx

Class SoloTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

solo

engine

driver

robotiumUtils

robotiumTimeout

avdSerialNo

persistEmulators

weLaunchedEmulator

unlockEmulatorScreen

mainActivityUID

argAUTpassed

argMESSENGERpassed

argRUNNERpassed

argINSTRUMENTpassed

argRESIGNJARpassed

argRUNNERSOURCEpassed

removeinstalledapk

DEFAULT_AUT_APK

DEFAULT_MESSENGER_APK

DEFAULT_TESTRUNNER_APK

DEFAULT_TESTRUNNER_SOURCE_DIR

DEFAULT_INSTRUMENT_ARG

ARG_KEY_RESIGN_JAR

ARG_KEY_AUT_APK

ARG_KEY_MESSENGER_APK

ARG_KEY_TESTRUNNER_APK

ARG_KEY_TESTRUNNER_SOURCE

ARG_KEY_INSTRUMENT_ARG

ARG_KEY_AVD

ARG_KEY_PERSIST_AVD

ARG_KEY_NO_MESSENGER

ARG_KEY_NO_RUNNER

ARG_KEY_NO_AUT

ARG_KEY_REMOVE_INSTALLED_APK

Constructor Detail

SoloTest

SoloTest

SoloTest

Method Detail

getTestRunnerSourceDir

setTestRunnerSourceDir

isRemoveinstalledapk

setRemoveinstalledapk

getResignJar

setResignJar

getAUTApk

setAUTApk

getMessengerApk

setMessengerApk

getTestRunnerApk

setTestRunnerApk

getInstrumentArg

setInstrumentArg

setProtocolDebug

setRunnerDebug

setInstallAUT

setInstallMessenger

setInstallRunner

setRebuildRunner

process

preparation

prepareDevice

initialize

terminate

removeInstalledAPK

stopEmulator

test

debug

info

warn

pass

fail

error

goBackToViewUID