com.facebook.buck.android

Class AdbHelper

java.lang.Object

com.facebook.buck.android.AdbHelper

All Implemented Interfaces:

AndroidDevicesHelper, Closeable, AutoCloseable

public class AdbHelper
extends Object
implements AndroidDevicesHelper

Helper for executing commands over ADB, especially for multiple devices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdbHelper.CommandFailedException An exception that indicates that an executed command returned an unsuccessful exit code.

Nested classes/interfaces inherited from interface com.facebook.buck.android.exopackage.AndroidDevicesHelper

AndroidDevicesHelper.AdbDeviceCallable

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	PACKAGE_NAME_PATTERN Pattern that matches safe package names.

Constructor Summary

Constructors

Constructor and Description
AdbHelper(AdbOptions adbOptions, TargetDeviceOptions deviceOptions, ToolchainProvider toolchainProvider, java.util.function.Supplier<ExecutionContext> contextSupplier, boolean restartAdbOnFailure, com.google.common.collect.ImmutableList<String> rapidInstallTypes)

Method Summary

Modifier and Type	Method and Description
void	adbCall(String description, AndroidDevicesHelper.AdbDeviceCallable func, boolean quiet) Execute an AdbDeviceCallable for all matching devices.
void	close()
com.google.common.collect.ImmutableList<AndroidDevice>	getDevices(boolean quiet)
void	installApk(SourcePathResolverAdapter pathResolver, HasInstallableApk hasInstallableApk, boolean installViaSd, boolean quiet, String processName) Install apk on all matching devices.
static void	setDevicesSupplierForTests(Optional<java.util.function.Supplier<com.google.common.collect.ImmutableList<AndroidDevice>>> devicesSupplierForTests)
void	startActivity(SourcePathResolverAdapter pathResolver, HasInstallableApk hasInstallableApk, String activity, boolean waitForDebugger)
static String	tryToExtractPackageNameFromManifest(SourcePathResolverAdapter pathResolver, HasInstallableApk.ApkInfo apkInfo)
void	uninstallApp(String packageName, boolean shouldKeepUserData) Uninstall apk from all matching devices.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.android.exopackage.AndroidDevicesHelper

adbCallOrThrow

Field Detail

PACKAGE_NAME_PATTERN

public static final Pattern PACKAGE_NAME_PATTERN

Pattern that matches safe package names. (Must be a full string match).

Constructor Detail

AdbHelper

public AdbHelper(AdbOptions adbOptions,
                 TargetDeviceOptions deviceOptions,
                 ToolchainProvider toolchainProvider,
                 java.util.function.Supplier<ExecutionContext> contextSupplier,
                 boolean restartAdbOnFailure,
                 com.google.common.collect.ImmutableList<String> rapidInstallTypes)

Method Detail

setDevicesSupplierForTests

public static void setDevicesSupplierForTests(Optional<java.util.function.Supplier<com.google.common.collect.ImmutableList<AndroidDevice>>> devicesSupplierForTests)

getDevices

public com.google.common.collect.ImmutableList<AndroidDevice> getDevices(boolean quiet)

Specified by:

getDevices in interface AndroidDevicesHelper

adbCall

public void adbCall(String description,
                    AndroidDevicesHelper.AdbDeviceCallable func,
                    boolean quiet)
             throws InterruptedException

Execute an AdbDeviceCallable for all matching devices. This functions performs device filtering based on three possible arguments:

-e (emulator-only) - only emulators are passing the filter -d (device-only) - only real devices are passing the filter -s (serial) - only device/emulator with specific serial number are passing the filter

If more than one device matches the filter this function will fail unless multi-install mode is enabled (-x). This flag is used as a marker that user understands that multiple devices will be used to install the apk if needed.

Specified by:

adbCall in interface AndroidDevicesHelper

Throws:

InterruptedException

installApk

public void installApk(SourcePathResolverAdapter pathResolver,
                       HasInstallableApk hasInstallableApk,
                       boolean installViaSd,
                       boolean quiet,
                       @Nullable
                       String processName)
                throws InterruptedException

Description copied from interface: AndroidDevicesHelper

Install apk on all matching devices. This functions performs device filtering based on three possible arguments:

-e (emulator-only) - only emulators are passing the filter -d (device-only) - only real devices are passing the filter -s (serial) - only device/emulator with specific serial number are passing the filter

If more than one device matches the filter this function will fail unless multi-install mode is enabled (-x). This flag is used as a marker that user understands that multiple devices will be used to install the apk if needed.

Specified by:

installApk in interface AndroidDevicesHelper

Throws:

InterruptedException

startActivity

public void startActivity(SourcePathResolverAdapter pathResolver,
                          HasInstallableApk hasInstallableApk,
                          @Nullable
                          String activity,
                          boolean waitForDebugger)
                   throws IOException

Specified by:

startActivity in interface AndroidDevicesHelper

Throws:

IOException

uninstallApp

public void uninstallApp(String packageName,
                         boolean shouldKeepUserData)
                  throws InterruptedException

Uninstall apk from all matching devices.

Specified by:

uninstallApp in interface AndroidDevicesHelper

Throws:

InterruptedException

See Also:

installApk(SourcePathResolverAdapter, HasInstallableApk, boolean, boolean, String)

tryToExtractPackageNameFromManifest

public static String tryToExtractPackageNameFromManifest(SourcePathResolverAdapter pathResolver,
                                                         HasInstallableApk.ApkInfo apkInfo)

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable