com.jayway.android.robotium.remotecontrol.install

Class SilentInstaller

java.lang.Object

com.jayway.android.robotium.remotecontrol.install.SilentInstaller

public class SilentInstaller
extends java.lang.Object

RobotiumRC installer designed to extract the contents of ZIP files into parameter-specified locations.

The app can handle new installs, and overlaying updates to existing installs, or performing a crude "uninstall" by recursively removing files and subfolders from the specified install location.

The default ZIP file sought for RobotiumRC installs is: RobotiumRCInstall.ZIP

The default ZIP file sought for RobotiumRC overlays is: RobotiumRCOverlay.ZIP

The default install location for RobotiumRC is:

 Windows: C:\RobotiumRC

   Linux: /usr/local/robotiumrc

     Mac: /Library/robotiumrc
 

The app can remove and install, install and overlay, or remove and install and overly in a single invocation if all the parameters are properly specified. If no parameters whatsoever are specified then the app will attempt an install to the default location.

Author:

Carl Nagle JUN 25, 2012 Original Release
Lei Wang JUL 02, 2013 Modify to build Runner/Messenger automatically.
Lei Wang JUL 03, 2013 Add ProgressIndicator to show the progress.
Carl Nagle JUL 11, 2013 Add -resignjar, -originalapk, and -resignedapk options to re-sign the sample apk
Lei Wang JUL 25, 2013 Move some codes to org.safs.text.FileUtilities
Move ProgressIndicator to package org.safs.install
Lei Wang NOV 01, 2013 Add "-testrunner" option to decide what is wrote to local.properties of TCPMessenger
Modify method modifyPropertiesFile(): add more comments to .properties file. Carl Nagle JUL 24, 2014 RobotiumTestRunner is no longer built all the time.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	androidHome
(package private) static AndroidTools	androidtool
(package private) static java.lang.String	antHome
(package private) static AntTool	anttool
static java.lang.String	DEFAULT_MAC_SAFS_DIR "/Library/robotiumrc"
static java.lang.String	DEFAULT_UNX_SAFS_DIR "/usr/local/robotiumrc"
static java.lang.String	DEFAULT_WIN_SAFS_DIR "C:\RobotiumRC"
(package private) static int	DEFAULTMESSENGERSDK
(package private) static int	DEFAULTRUNNERSDK
(package private) static boolean	dobuild
(package private) static boolean	doResign
(package private) static java.lang.String	installedsafsdir
(package private) static boolean	installsafs
(package private) static boolean	installsilent
static java.lang.String	OPTION_ALTSAFS "-robotiumrc"
static java.lang.String	OPTION_ANDROID_HOME "-androidhome"
static java.lang.String	OPTION_ANT_HOME "-anthome"
static java.lang.String	OPTION_BUILD_RUNNER_MESSENGER "-dobuild"
static java.lang.String	OPTION_ORIGINAL_APK "-originalapk"
static java.lang.String	OPTION_OVERLAY "-overlay"
static java.lang.String	OPTION_REMOVE_SAFS "-removerobotiumrc"
static java.lang.String	OPTION_RESIGN_JAR "-resignjar"
static java.lang.String	OPTION_RESIGNED_APK "-resignedapk"
static java.lang.String	OPTION_SILENT "-silent"
static java.lang.String	OPTION_TESTRUNNER "-testrunner"
static java.lang.String	OPTION_VERBOSE "-v"
(package private) static java.lang.String	originalAPK
(package private) static java.lang.String	overlayfile
(package private) static boolean	overlaysafs
(package private) static ProgressIndicator	progresser progressbar is a swing panel to show the progress of installation.
(package private) static boolean	removesafs
(package private) static java.lang.String	resignedAPK
(package private) static java.lang.String	resignJAR
(package private) static java.lang.String	ROBOTIUM_RUNNER_FOLDER
static java.lang.String	ROBOTIUM_TEST_RUNNER
(package private) static java.lang.String	SAFS_RUNNER_FOLDER
(package private) static java.lang.String	safs_silent
static java.lang.String	SAFS_TEST_RUNNER
(package private) static java.lang.String	safsdir
(package private) static java.lang.String	SAMPLE_SPINNER_FOLDER
(package private) static java.lang.String	TCP_MESSENGER_FOLDER
(package private) static java.lang.String	testRunner
(package private) static boolean	verbose
(package private) static java.lang.String	ZIP_INSTALL_FILE "RobotiumRCInstall.ZIP"
(package private) static java.lang.String	ZIP_OVERLAY_FILE "RobotiumRCOverlay.ZIP"

Constructor Summary

Constructors

Constructor and Description
SilentInstaller()

Method Summary

Modifier and Type	Method and Description
(package private) static java.lang.String	addEscapeToFilepath(java.lang.String filepath) To build a project, Ant requires that the file path separator "\" must be escaped as "\\" in the .properties file. Before writing a file path to the properties file, call this method to get an escaped string.
(package private) static boolean	buildAPK(java.lang.String appDirString, boolean debug)
(package private) static void	buildMessengerRunner() This method will build RobotiumTestRunner, SAFSTestRunner and SAFSTCPMessenger It will use Ant Tool to build.
(package private) static int	doSAFSInstall() Perform RobotiumRC install.
(package private) static int	doSAFSOverlay() Perform RobotiumRC Overlay.
(package private) static int	doSAFSUnInstall()
static void	main(java.lang.String[] args) This SilentInstaller provides no GUI, but will accept some configuration parameters.
(package private) static void	modifyPropertiesFile(java.io.File root) This method will modify the file local.properties of SamplSpinner, SAFSTestRunner and SAFSTCPMessenger It requires that android sdk has been installed. It will need androidHome to modify the property file.
(package private) static void	modifyPropertiesFile(java.io.File directory, java.lang.String androidHome, int targetLevel, int defaultSdkLevel, java.lang.String[] automationLibsFolder)
(package private) static boolean	modUnixRecursiveFolderAllWritePermissions(java.io.File afolder) chmod -R a+w on the provided folder. Only valid on Unix/Mac systems.
(package private) static void	parseArgs(java.lang.String[] args)
(package private) static void	printArgs(java.lang.String[] args)
(package private) static void	resignOriginalAPK() This method will attempt to re-sign originalAPK with the resignJAR and write it to resignedAPK.

Methods inherited from class java.lang.Object

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

Field Detail

ZIP_INSTALL_FILE

static final java.lang.String ZIP_INSTALL_FILE

"RobotiumRCInstall.ZIP"

See Also:

Constant Field Values

ZIP_OVERLAY_FILE

static final java.lang.String ZIP_OVERLAY_FILE

"RobotiumRCOverlay.ZIP"

See Also:

Constant Field Values

DEFAULT_WIN_SAFS_DIR

public static final java.lang.String DEFAULT_WIN_SAFS_DIR

"C:\RobotiumRC"

See Also:

Constant Field Values

DEFAULT_UNX_SAFS_DIR

public static final java.lang.String DEFAULT_UNX_SAFS_DIR

"/usr/local/robotiumrc"

See Also:

Constant Field Values

DEFAULT_MAC_SAFS_DIR

public static final java.lang.String DEFAULT_MAC_SAFS_DIR

"/Library/robotiumrc"

See Also:

Constant Field Values

ROBOTIUM_TEST_RUNNER

public static final java.lang.String ROBOTIUM_TEST_RUNNER

See Also:

Constant Field Values

SAFS_TEST_RUNNER

public static final java.lang.String SAFS_TEST_RUNNER

See Also:

Constant Field Values

OPTION_REMOVE_SAFS

public static final java.lang.String OPTION_REMOVE_SAFS

"-removerobotiumrc"

See Also:

Constant Field Values

OPTION_SILENT

public static final java.lang.String OPTION_SILENT

"-silent"

See Also:

Constant Field Values

OPTION_ALTSAFS

public static final java.lang.String OPTION_ALTSAFS

"-robotiumrc"

See Also:

Constant Field Values

OPTION_ANDROID_HOME

public static final java.lang.String OPTION_ANDROID_HOME

"-androidhome"

See Also:

Constant Field Values

OPTION_ANT_HOME

public static final java.lang.String OPTION_ANT_HOME

"-anthome"

See Also:

Constant Field Values

OPTION_BUILD_RUNNER_MESSENGER

public static final java.lang.String OPTION_BUILD_RUNNER_MESSENGER

"-dobuild"

See Also:

Constant Field Values

OPTION_RESIGN_JAR

public static final java.lang.String OPTION_RESIGN_JAR

"-resignjar"

See Also:

Constant Field Values

OPTION_ORIGINAL_APK

public static final java.lang.String OPTION_ORIGINAL_APK

"-originalapk"

See Also:

Constant Field Values

OPTION_RESIGNED_APK

public static final java.lang.String OPTION_RESIGNED_APK

"-resignedapk"

See Also:

Constant Field Values

OPTION_OVERLAY

public static final java.lang.String OPTION_OVERLAY

"-overlay"

See Also:

Constant Field Values

OPTION_VERBOSE

public static final java.lang.String OPTION_VERBOSE

"-v"

See Also:

Constant Field Values

OPTION_TESTRUNNER

public static final java.lang.String OPTION_TESTRUNNER

"-testrunner"

See Also:

Constant Field Values

overlaysafs

static boolean overlaysafs

installsafs

static boolean installsafs

removesafs

static boolean removesafs

verbose

static boolean verbose

dobuild

static boolean dobuild

installedsafsdir

static java.lang.String installedsafsdir

safsdir

static java.lang.String safsdir

overlayfile

static java.lang.String overlayfile

safs_silent

static java.lang.String safs_silent

installsilent

static boolean installsilent

androidHome

static java.lang.String androidHome

antHome

static java.lang.String antHome

resignJAR

static java.lang.String resignJAR

originalAPK

static java.lang.String originalAPK

resignedAPK

static java.lang.String resignedAPK

doResign

static boolean doResign

testRunner

static java.lang.String testRunner

anttool

static AntTool anttool

androidtool

static AndroidTools androidtool

progresser

static ProgressIndicator progresser

progressbar is a swing panel to show the progress of installation.

TCP_MESSENGER_FOLDER

static final java.lang.String TCP_MESSENGER_FOLDER

See Also:

Constant Field Values

ROBOTIUM_RUNNER_FOLDER

static final java.lang.String ROBOTIUM_RUNNER_FOLDER

See Also:

Constant Field Values

SAFS_RUNNER_FOLDER

static final java.lang.String SAFS_RUNNER_FOLDER

See Also:

Constant Field Values

SAMPLE_SPINNER_FOLDER

static final java.lang.String SAMPLE_SPINNER_FOLDER

See Also:

Constant Field Values

DEFAULTMESSENGERSDK

static int DEFAULTMESSENGERSDK

DEFAULTRUNNERSDK

static int DEFAULTRUNNERSDK

Constructor Detail

SilentInstaller

public SilentInstaller()

Method Detail

printArgs

static void printArgs(java.lang.String[] args)

parseArgs

static void parseArgs(java.lang.String[] args)

doSAFSInstall

static int doSAFSInstall()
                  throws java.io.IOException,
                         java.io.FileNotFoundException

Perform RobotiumRC install. The RobotiumRC install is currently always silent (GUI-less).
If -altdir parameter was specified then the install will attempt to use any provided user-specified directory for the install.

Any user-specified directories must exist; or, we must not be denied the ability to create them and write/copy files to them.

Throws:

java.io.IOException

java.io.FileNotFoundException

modifyPropertiesFile

static void modifyPropertiesFile(java.io.File root)
                          throws java.io.FileNotFoundException

This method will modify the file local.properties of SamplSpinner, SAFSTestRunner and SAFSTCPMessenger
It requires that android sdk has been installed.
It will need androidHome to modify the property file. So please call main() with parameter "-androidhome androidHome", or
an environment "ANDROID_HOME"/"ANDROID_SDK" should be set to the "Android sdk home directory".

Parameters:

root, - File, the root directory where the robotium rc has been installed.

Throws:

java.io.FileNotFoundException

modifyPropertiesFile

static void modifyPropertiesFile(java.io.File directory,
                                 java.lang.String androidHome,
                                 int targetLevel,
                                 int defaultSdkLevel,
                                 java.lang.String[] automationLibsFolder)
                          throws java.io.FileNotFoundException

Parameters:

directory, - File, the Runner or Messenger's project folder.

androidHome, - String, the android sdk home, to be wrote to local.properties

targetLevel, - int, the real target level to be set for 'target=Google Inc.:Google APIs:?'

defaultSdkLevel, - int, for messenger; for Runner.

automationLibsFolder, - String[], an array of the libs folder of the Runner, the first one will be used, other will be put into properties file as comment Only used when modifying Messenger's property file. null when modifying Runner's property file.

Throws:

java.io.FileNotFoundException

See Also:

#modifyPropertiesFile(File)}, #addEscapeToFilepath(String)}

addEscapeToFilepath

static java.lang.String addEscapeToFilepath(java.lang.String filepath)

To build a project, Ant requires that the file path separator "\" must be escaped as "\\" in the .properties file.
Before writing a file path to the properties file, call this method to get an escaped string.

Parameters:

filepath, - String, the file path to be modified

Returns:

String, The escaped file path

See Also:

#modifyPropertiesFile(File, String, int, int, String)

resignOriginalAPK

static void resignOriginalAPK()
                       throws java.io.FileNotFoundException

This method will attempt to re-sign originalAPK with the resignJAR and write it to resignedAPK.

Throws:

java.io.FileNotFoundException - if the re-sign JAR file or the originalAPK file are not valid, or if the output directory for the resignedAPK is not valid.

buildMessengerRunner

static void buildMessengerRunner()
                          throws java.io.FileNotFoundException

This method will build RobotiumTestRunner, SAFSTestRunner and SAFSTCPMessenger
It will use Ant Tool to build. So please call main() with parameter "-anthome antHome", or
an environment "ANT_HOME" should be set to the "Ant tool home directory".

Throws:

java.io.FileNotFoundException

See Also:

#buildAPK(String, boolean)}

modUnixRecursiveFolderAllWritePermissions

static boolean modUnixRecursiveFolderAllWritePermissions(java.io.File afolder)

chmod -R a+w on the provided folder.
Only valid on Unix/Mac systems.

Parameters:

afolder -

Returns:

buildAPK

static boolean buildAPK(java.lang.String appDirString,
                        boolean debug)

Parameters:

appDirString, - String, the directory where the application locates

debug, - boolean, to build a debug or release version

Returns:

boolean, true if the build succeed

See Also:

buildMessengerRunner()

doSAFSOverlay

static int doSAFSOverlay()
                  throws java.io.IOException,
                         java.io.FileNotFoundException

Perform RobotiumRC Overlay. The RobotiumRC overlay is currently always silent (GUI-less).
If -overlay parameter was specified then the install will attempt to use the provided Snapshot ZIP file for the overlay.

The overlay ZIP file must exist. An overlay can be applied immediately following a RobotiumRC Install during the same invocation of this installer. Thus, you can run an initial install and then do an updated overlay on top of that as part of one invocation.

Throws:

java.io.IOException

java.io.FileNotFoundException

doSAFSUnInstall

static int doSAFSUnInstall()

main

public static void main(java.lang.String[] args)

This SilentInstaller provides no GUI, but will accept some configuration parameters. Any user-specified directories must exist; or, we must not be denied the ability to create them and write/copy files to them.

Parameters:

args[] - The following parameters or arguments can be specified:

• -silent
  Currently, the install for RobotiumRC is always silent (GUI-less).

• -robotiumrc "robotium install directory"
  Install RobotiumRC files to the user specified directory instead of the default install directory.

  You *must* provide this parameter with the desired install directory--even if default--if the invocation is trying to combine operations like remove then install, or install then overlay, or remove then install then overlay.

• -overlay RobotiumRCSnapshot.ZIP
  Overlay RobotiumRC files over an existing RobotiumRC installation.
  The overlay can occur immediately following a new installation during the same class invocation.
• -removerobotiumrc installedrobotiumrc
  Remove the installed RobotiumRC. installedrobotiumrc indicates the directory where RobotiumRC is installed, like "C:\RobotiumRC\" or "/usr/local/robotiumrc"
• -androidhome androidHome
  It indicates 'the home directory to android sdk' It is used to modify local.properties of Runner and Messenger. Only installsafs is true, this parameter will take effect.
• -anthome antHome
  It indicates 'the home directory to ant sdk' It is used to build Runner and Messenger. Only both installsafs/overlaysafs and dobuild are true, this parameter will take effect.
• -dobuild
  If this parameter is present, program will try to build the TestRunner and Messenger. Only installsafs or overlaysafs, this parameter will take effect.
• -resignjar "<pathTo/re-sign.jar"
  If this parameter is present, along with valid settings for -originalapk and -resignedapk, the installer will attempt to re-sign the -originalapk with the installed SDK credentials and write the new apk out to the -resignedapk path. Only with installsafs will these parameters take effect.
• -originalapk "<pathTo/SpinnerActivity.apk"
  If this parameter is present, along with valid settings for -resignjar and -resignedapk, the installer will attempt to re-sign the -originalapk with the installed SDK credentials and write the new apk out to the -resignedapk path. Only with installsafs will these parameters take effect.
• -resignedapk "<pathTo/SpinnerActivity-debug.apk"
  If this parameter is present, along with valid settings for -resignjar and -originalapk, the installer will attempt to re-sign the -originalapk with the installed SDK credentials and write the new apk out to the -resignedapk path. Only with installsafs will these parameters take effect.
• -v
  Verbose to see the detail installation or un-installation information
• -testrunner "RobotiumTestRunner or SAFSTestRunner"
  It indicates the test runner to be used. If this is not present, the default test runner is RobotiumTestRunner. This setting will affect the content of local.properties of TCPMessenger project.