com.facebook.buck.apple.simulator

Class AppleDeviceController

java.lang.Object

com.facebook.buck.apple.simulator.AppleDeviceController

public class AppleDeviceController
extends Object

Utility class to control Apple Devices (both simulators and physical devices). Examples include booting them, installing and launching bundles inside of the devices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppleDeviceController.AppleDeviceKindEnum Enum indicating the different kinds of devices possible
static class	AppleDeviceController.LaunchBehavior Enum for the different ways to launch the simulator

Constructor Summary

Constructors

Constructor and Description
AppleDeviceController(ProcessExecutor processExecutor, Path idbPath)

Method Summary

Modifier and Type	Method and Description
boolean	bootSimulator(String simulatorUdid) Starts up the iOS simulator using idb, which waits until the simulator is completely booted.
boolean	bringSimulatorToFront(String simulatorUdid) Brings the desired simulator to the front
com.google.common.collect.ImmutableSet<String>	getBootedSimulatorsUdids()
AppleDeviceController.AppleDeviceKindEnum	getDeviceKind(AppleDevice device)
com.google.common.collect.ImmutableSet<AppleDevice>	getPhysicalDevices()
com.google.common.collect.ImmutableSet<AppleDevice>	getSimulators()
Optional<String>	getSimulatorUdidForTest() Picks the simulator to be used for testing
Optional<String>	getUdidFromDeviceName(String name)
Optional<String>	installBundle(String deviceUdid, Path bundlePath) Installs a bundle in a previously-started simulator or physical device.
boolean	isSimulatorAvailable(String simulatorUdid)
boolean	launchInstalledBundle(String deviceUdid, String bundleID) Launches an installed bundle in a device
Optional<String>	startDebugServer(String deviceUdid, String bundleID) Starts the debugserver of the installed app

Methods inherited from class java.lang.Object

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

Constructor Detail

AppleDeviceController

public AppleDeviceController(ProcessExecutor processExecutor,
                             Path idbPath)

Method Detail

getSimulators

public com.google.common.collect.ImmutableSet<AppleDevice> getSimulators()

Returns:

the set of Apple simulators

getPhysicalDevices

public com.google.common.collect.ImmutableSet<AppleDevice> getPhysicalDevices()

Returns:

the set of Apple physical devices

getBootedSimulatorsUdids

public com.google.common.collect.ImmutableSet<String> getBootedSimulatorsUdids()

Returns:

set of udids of the booted devices

getUdidFromDeviceName

public Optional<String> getUdidFromDeviceName(String name)

Returns:

the udid of the device that has the determined name. If no device is found with that name, will return optional empty

getSimulatorUdidForTest

public Optional<String> getSimulatorUdidForTest()

Picks the simulator to be used for testing

Returns:

the udid of any booted simulator (iphone) and if there are none returns any simulator. If there are none, returns optional empty

bootSimulator

public boolean bootSimulator(String simulatorUdid)
                      throws IOException,
                             InterruptedException

Starts up the iOS simulator using idb, which waits until the simulator is completely booted.

Call isSimulatorAvailable(String) before invoking this method to ensure the simulator is available.

Returns:

true if idb was able to boot the simulator, false otherwise

Throws:

IOException

InterruptedException

isSimulatorAvailable

public boolean isSimulatorAvailable(String simulatorUdid)

Parameters:

simulatorUdid - of the simulator is available

Returns:

true if the simulator is available, false otherwise

installBundle

public Optional<String> installBundle(String deviceUdid,
                                      Path bundlePath)
                               throws IOException,
                                      InterruptedException

Installs a bundle in a previously-started simulator or physical device.

Returns:

true if the bundle was installed, false otherwise.

Throws:

IOException

InterruptedException

bringSimulatorToFront

public boolean bringSimulatorToFront(String simulatorUdid)
                              throws IOException,
                                     InterruptedException

Brings the desired simulator to the front

Returns:

true if it managed to do so, false otherwise

Throws:

IOException

InterruptedException

launchInstalledBundle

public boolean launchInstalledBundle(String deviceUdid,
                                     String bundleID)
                              throws IOException,
                                     InterruptedException

Launches an installed bundle in a device

Returns:

true if it was able to launch and false otherwise

Throws:

IOException

InterruptedException

startDebugServer

public Optional<String> startDebugServer(String deviceUdid,
                                         String bundleID)
                                  throws IOException,
                                         InterruptedException

Starts the debugserver of the installed app

Returns:

the command to be run in lldb

Throws:

IOException

InterruptedException

getDeviceKind

public AppleDeviceController.AppleDeviceKindEnum getDeviceKind(AppleDevice device)

Parameters:

device - to be analized

Returns:

the enum indicating the kind of device it is