org.arquillian.droidium.container.api

Interface AndroidDevice

public interface AndroidDevice

Representation of Android Device

Author:

Karel Piwko, Stefan Miklosovic

Method Summary

Methods

Modifier and Type	Method and Description
void	createPortForwarding(int localPort, int remotePort) Creates a port forwarding between a local and a remote port.
void	executeShellCommand(String command) Executes a shell command on the device.
void	executeShellCommand(String command, AndroidDeviceOutputReciever reciever) Executes a shell command on the device
ActivityManager	getActivityManager()
boolean	getAlreadyRuns()
String	getAvdName() Returns name of Android Virtual Device.
String	getConsolePort()
int	getDroneGuestPort() Guest port is port on the Android device side
int	getDroneHostPort() Host is your local computer.
String	getProperty(String name) Returns a value of property with given name
Screenshot	getScreenshot()
String	getSerialNumber() Returns serial number of device.
void	installPackage(File packageFilePath, boolean reinstall, String... extraArgs) Installs an Android application on device.
void	installPackage(String packageFilePath, boolean reinstall, String... extraArgs) Installs an Android application on device.
boolean	isEmulator() Checks if the device is an emulator
boolean	isOffline() Checks if the device is offline.
boolean	isOnline() Checks if the device is online
boolean	isPackageInstalled(String packageName) Checks if an APK package of name packageName is installed or not.
boolean	isRecording() Checks if this Android device records some video.
void	pull(File remoteFile, File localFile) Pulls file from mobile phone to computer.
void	pull(String remoteFilePath, String localFilePath) Pulls file from mobile phone to computer.
void	push(File localFile, File remoteFile) Pushes file from computer to mobile phone.
void	push(String localFilePath, String remoteFilePath) Pushes file from computer to mobile phone.
void	remove(File remoteFile) Removes file on Android device.
void	remove(String remoteFilePath) Removes file on Android device.
void	removePortForwarding(int localPort, int remotePort) Removes a port forwarding between a local and a remote port.
void	setActivityManager(ActivityManager activityManager)
void	setAlreadyRuns(boolean alreadyRuns)
void	setDroneGuestPort(int droneGuestPort) Guest port is port on the Android device side
void	setDroneHostPort(int droneHostPort) Host is your local computer
void	startRecording(File remoteFilePath, ScreenrecordOptions options) Starts video recording.
void	startRecording(ScreenrecordOptions options) Starts video recording.
void	startRecording(String remoteFilePath, ScreenrecordOptions options) Starts video recording.
Video	stopRecording(File localFilePath) Stops Android device from recording a video.
Video	stopRecording(String localFilePath) Stops Android device from recording a video.
void	uninstallPackage(String packageName) Uninstalls an package from the device.

Method Detail

getSerialNumber

String getSerialNumber()

Returns serial number of device.

Returns:

Serial number

getAvdName

String getAvdName()

Returns name of Android Virtual Device.

Returns:

Either a virtual device name or null if device is not an emulator

getProperty

String getProperty(String name)
                   throws IOException,
                          AndroidExecutionException

Returns a value of property with given name

Parameters:

name - A key

Returns:

Value of property or null if not present

Throws:

IOException

AndroidExecutionException

isOnline

boolean isOnline()

Checks if the device is online

Returns:

true if device is online, false otherwise

isEmulator

boolean isEmulator()

Checks if the device is an emulator

Returns:

true if device is an emulator, false otherwise

isOffline

boolean isOffline()

Checks if the device is offline.

Returns:

true if device is offline, false otherwise

executeShellCommand

void executeShellCommand(String command)
                         throws AndroidExecutionException

Executes a shell command on the device. Silently discards command output.

Parameters:

command - The command to be executed

Throws:

AndroidExecutionException

executeShellCommand

void executeShellCommand(String command,
                       AndroidDeviceOutputReciever reciever)
                         throws AndroidExecutionException

Executes a shell command on the device

Parameters:

command - The command to be executed

reciever - A processor to process command output

Throws:

AndroidExecutionException

createPortForwarding

void createPortForwarding(int localPort,
                        int remotePort)
                          throws AndroidExecutionException

Creates a port forwarding between a local and a remote port.

Parameters:

localPort - the local port to forward

remotePort - the remote port.

Throws:

AndroidExecutionException

removePortForwarding

void removePortForwarding(int localPort,
                        int remotePort)
                          throws AndroidExecutionException

Removes a port forwarding between a local and a remote port.

Parameters:

localPort - the local port to forward

remotePort - the remote port.

Throws:

AndroidExecutionException

installPackage

void installPackage(File packageFilePath,
                  boolean reinstall,
                  String... extraArgs)
                    throws AndroidExecutionException

Installs an Android application on device. This is a helper method that combines the syncPackageToDevice, installRemotePackage, and removePackage steps

Parameters:

packageFilePath - the absolute file system path to file on local host to install

reinstall - set to trueif re-install of app should be performed

extraArgs - optional extra arguments to pass. See 'adb shell pm install --help' for available options.

Throws:

AndroidExecutionException

installPackage

void installPackage(String packageFilePath,
                  boolean reinstall,
                  String... extraArgs)
                    throws AndroidExecutionException

Installs an Android application on device. This is a helper method that combines the syncPackageToDevice, installRemotePackage, and removePackage steps

Parameters:

packageFilePath - the absolute file system path to file on local host to install

reinstall - set to trueif re-install of app should be performed

extraArgs - optional extra arguments to pass. See 'adb shell pm install --help' for available options.

Throws:

AndroidExecutionException

uninstallPackage

void uninstallPackage(String packageName)
                      throws AndroidExecutionException

Uninstalls an package from the device.

Parameters:

packageName - the Android application package name to uninstall

Throws:

AndroidExecutionException

isPackageInstalled

boolean isPackageInstalled(String packageName)
                           throws AndroidExecutionException

Checks if an APK package of name packageName is installed or not.

Parameters:

packageName - name of the installed package

Returns:

true if a package of packageName is installed, false otherwise

Throws:

AndroidExecutionException

getConsolePort

String getConsolePort()

Returns:

console port of the emulator - the number after "emulator" string in the serial number string of the emulator obtained by adb devices -l command.

getDroneHostPort

int getDroneHostPort()

Host is your local computer.

Returns:

host port for extensions like Droidium native or web plugin

getDroneGuestPort

int getDroneGuestPort()

Guest port is port on the Android device side

Returns:

guest port for extensions like Droidium native or web plugin

setDroneHostPort

void setDroneHostPort(int droneHostPort)

Host is your local computer

Parameters:

droneHostPort - for extensions like Droidium native or web plugin

setDroneGuestPort

void setDroneGuestPort(int droneGuestPort)

Guest port is port on the Android device side

Parameters:

droneGuestPort - for extensions like Droidium native or web plugin

getScreenshot

Screenshot getScreenshot()
                         throws Exception

Returns:

screenshot of Android device

Throws:

Exception

setActivityManager

void setActivityManager(ActivityManager activityManager)

Parameters:

activityManager -

getActivityManager

ActivityManager getActivityManager()

Returns:

activity manager

setAlreadyRuns

void setAlreadyRuns(boolean alreadyRuns)

Parameters:

alreadyRuns - true if Android device already runs, false otherwise

getAlreadyRuns

boolean getAlreadyRuns()

Returns:

true if Android device is already running prior to test execution, false otherwise

pull

void pull(String remoteFilePath,
        String localFilePath)
          throws Exception

Pulls file from mobile phone to computer.

Parameters:

remoteFilePath - remote file to pull

localFilePath - local file to save pulled file to

Throws:

Exception

pull

void pull(File remoteFile,
        File localFile)
          throws Exception

Pulls file from mobile phone to computer.

Parameters:

remoteFile - remote file to pull

localFile - local file to save pulled file to

Throws:

Exception

push

void push(String localFilePath,
        String remoteFilePath)
          throws Exception

Pushes file from computer to mobile phone.

Parameters:

localFilePath - local file to push

remoteFilePath - remote file to save pushed file to

Throws:

Exception

push

void push(File localFile,
        File remoteFile)
          throws Exception

Pushes file from computer to mobile phone.

Parameters:

localFile - local file to push

remoteFile - remote file to save pushed file to

Throws:

Exception

remove

void remove(String remoteFilePath)
            throws Exception

Removes file on Android device.

Parameters:

remoteFilePath - file path to remove

Throws:

Exception

remove

void remove(File remoteFile)
            throws Exception

Removes file on Android device.

Parameters:

remoteFile - file to remove

Throws:

Exception

startRecording

void startRecording(String remoteFilePath,
                  ScreenrecordOptions options)
                    throws Exception

Starts video recording. You have to use Android device of API level 19 (4.4) and above in order to use this with success.

Parameters:

remoteFilePath - path on mobile phone to save the recorded video to

options -

Throws:

Exception

Since:

1.0.0.Alpha6

startRecording

void startRecording(File remoteFilePath,
                  ScreenrecordOptions options)
                    throws Exception

Starts video recording. You have to use Android device of API level 19 (4.4) and above in order to use this with success.

Parameters:

remoteFilePath - path on mobile phone to save the recorded video to

options -

Throws:

Exception

Since:

1.0.0.Alpha6

startRecording

void startRecording(ScreenrecordOptions options)
                    throws Exception

Starts video recording. Recorded video will be automatically saved somewhere to /sdcard on a mobile phone.

Parameters:

options -

Throws:

Exception

Since:

1.0.0.Alpha6

isRecording

boolean isRecording()

Checks if this Android device records some video.

Returns:

true if device records some video, false otherwise

stopRecording

Video stopRecording(String localFilePath)
                    throws Exception

Stops Android device from recording a video. Returned video is in fact pulled from device dynamically to the host computer. You have to use Android device of API level 19 (4.4) and above in order to use this with success.

Parameters:

localFilePath - path on computer host where to save recorded file by startRecording(ScreenrecordOptions)

Returns:

recorded video of Android device

Throws:

Exception

Since:

1.0.0.Alpha6

stopRecording

Video stopRecording(File localFilePath)
                    throws Exception

Stops Android device from recording a video. Returned video is in fact pulled from device dynamically to the host computer. You have to use Android device of API level 19 (4.4) and above in order to use this with success.

Parameters:

localFilePath - path on computer host where to save recorded file by startRecording(ScreenrecordOptions)

Returns:

recorded video of Android device

Throws:

Exception

Since:

1.0.0.Alpha6