Google は、黒人コミュニティに対する人種平等の促進に取り組んでいます。取り組みを見る
このページは Cloud Translation API によって翻訳されました。
Switch to English

NativeDevice

public class NativeDevice
extends Object implements IManagedTestDevice

java.lang.Object
com.android.tradefed.device.NativeDevice


ITestDevice非フルスタックAndroidデバイスのデフォルト実装。

概要

ネストされたクラス

class NativeDevice.AdbAction

OSの「adb ....」コマンドを実行するためのDeviceAction

class NativeDevice.AdbShellAction

class NativeDevice.RebootDeviceAction

DeviceActionを再起動するためのDeviceAction

定数

int INVALID_USER_ID

無効/見つからないユーザーIDに対して返される値:UserHandleは-10000値を定義しました

long MAX_HOST_DEVICE_TIME_OFFSET

int MAX_RETRY_ATTEMPTS

実行するコマンド再試行のデフォルトの回数

田畑

protected TestDeviceOptions mOptions

protected final IDeviceStateMonitor mStateMonitor

パブリックコンストラクター

NativeDevice (IDevice device, IDeviceStateMonitor stateMonitor, IDeviceMonitor allocationMonitor)

TestDevice作成します。

パブリックメソッド

boolean checkApiLevelAgainstNextRelease (int strictMinLevel)

最低限サポートされているレベルで、機能が現在サポートされているかどうかを確認します。

boolean checkConnectivity ()

デバイスにネットワーク接続があることを確認します。

boolean clearErrorDialogs ()

デバイスのUIに現在表示されているエラーダイアログをすべて閉じてみます。

void clearLastConnectedWifiNetwork ()

最後に接続したWi-Fiネットワークをクリアします。

void clearLogcat ()

蓄積されたlogcatデータを削除します。

boolean connectToWifiNetwork (String wifiSsid, String wifiPsk)

Wi-Fiネットワークに接続します。

boolean connectToWifiNetwork (String wifiSsid, String wifiPsk, boolean scanSsid)

Wi-Fiネットワークに接続します。

boolean connectToWifiNetworkIfNeeded (String wifiSsid, String wifiPsk, boolean scanSsid)

デバイスに現在ネットワーク接続がない場合にのみ接続するconnectToWifiNetwork(String, String)バリアント。

boolean connectToWifiNetworkIfNeeded (String wifiSsid, String wifiPsk)

デバイスに現在ネットワーク接続がない場合にのみ接続するconnectToWifiNetwork(String, String)バリアント。

int createUser (String name, boolean guest, boolean ephemeral)

指定された名前と指定されたフラグでユーザーを作成します

int createUser (String name)

指定された名前とデフォルトのフラグ0でユーザーを作成します。

int createUserNoThrow (String name)

指定された名前とデフォルトのフラグ0でユーザーを作成します。

void deleteFile (String deviceFilePath)

デバイス上のファイルまたはディレクトリを削除するヘルパーメソッド。

boolean disableAdbRoot ()

adbルートをオフにします。

void disableKeyguard ()

キーガードを無効にしようとします。

boolean disableNetworkMonitor ()

デバイスのネットワーク監視を無効にします。

boolean disconnectFromWifi ()

Wi-Fiネットワークから切断します。

boolean doesFileExist (String deviceFilePath)

デバイス上のファイルが存在するかどうかを判別するヘルパーメソッド。

File dumpHeap (String process, String devicePath)

system_serverからヒープをダンプしようとしました。

boolean enableAdbRoot ()

adbルートをオンにします。

boolean enableNetworkMonitor ()

デバイスのネットワーク監視を有効にします。

boolean encryptDevice (boolean inplace)

デバイスを暗号化します。

String executeAdbCommand (String... cmdArgs)

adbコマンドをシステムコマンドとして実行するヘルパーメソッド。

CommandResult executeFastbootCommand (String... cmdArgs)

デフォルトのタイムアウトが2分のシステムコマンドとしてfastbootコマンドを実行するヘルパーメソッド。

CommandResult executeFastbootCommand (long timeout, String... cmdArgs)

システムコマンドとしてfastbootコマンドを実行するヘルパーメソッド。

CommandResult executeLongFastbootCommand (String... cmdArgs)

長時間実行されるfastbootコマンドをシステムコマンドとして実行するヘルパーメソッド。

String executeShellCommand (String command)

adbシェルコマンドを実行し、出力をStringとして返すヘルパーメソッド。

void executeShellCommand (String command, IShellOutputReceiver receiver, long maxTimeToOutputShellResponse, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御するパラメーターを追加して、adbシェルコマンドを実行します。

void executeShellCommand (String command, IShellOutputReceiver receiver, long maxTimeoutForCommand, long maxTimeToOutputShellResponse, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御するパラメーターを追加して、adbシェルコマンドを実行します。

void executeShellCommand (String command, IShellOutputReceiver receiver)

指定されたadbシェルコマンドを実行し、コマンドが失敗した場合は複数回再試行します。

CommandResult executeShellV2Command (String cmd)

adbシェルコマンドを実行し、コマンドステータス出力、stdoutおよびstderrが適切に入力されたCommandResultとして結果を返すヘルパーメソッド。

CommandResult executeShellV2Command (String cmd, OutputStream pipeToOutput)

adbシェルコマンドを実行し、コマンドステータス出力、stdoutおよびstderrが適切に入力されたCommandResultとして結果を返すヘルパーメソッド。

CommandResult executeShellV2Command (String cmd, File pipeAsInput)

adbシェルコマンドを実行し、コマンドステータス出力、stdoutおよびstderrが適切に入力されたCommandResultとして結果を返すヘルパーメソッド。

CommandResult executeShellV2Command (String cmd, long maxTimeoutForCommand, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御するためのパラメーターを追加して、adbシェルコマンドを実行します。

CommandResult executeShellV2Command (String cmd, long maxTimeoutForCommand, TimeUnit timeUnit)

コマンドの動作を制御するためのパラメーターを追加して、adbシェルコマンドを実行します。

CommandResult executeShellV2Command (String cmd, File pipeAsInput, OutputStream pipeToOutput, long maxTimeoutForCommand, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御するためのパラメーターを追加して、adbシェルコマンドを実行します。

CommandResult fastbootWipePartition (String partition)

デバイスのパーティションをワイプするヘルパーメソッド。

getActiveApexes ()

デバイスでアクティブ化されているAPEXに関する情報を取得します。

getAllSettings (String namespace)

要求された名前空間のキーと値のペアを返します。

DeviceAllocationState getAllocationState ()

デバイスの現在の割り当て状態を返します

String getAndroidId (int userId)

userIdに関連付けられているandroid-idを見つけて返します。見つからない場合はnullです。

getAndroidIds ()

ユーザーIDに一致するAndroid IDのマップを作成します。

int getApiLevel ()

デバイスのAPIレベルを取得します。

PackageInfo getAppPackageInfo (String packageName)

デバイスにインストールされているパッケージに関する情報を取得します。

String getBasebandVersion ()

このデバイスのベースバンド(無線)バージョンを取得する簡易メソッド。

Integer getBattery ()

デバイスの現在のバッテリーレベルを返します。バッテリーレベルが利用できない場合はNullを返します。

String getBootloaderVersion ()

このデバイスのブートローダーバージョンを取得する簡易メソッド。

InputStreamSource getBugreport ()

デバイスからバグレポートを取得します。

InputStreamSource getBugreportz ()

デバイスからバグレポートを取得します。

String getBuildAlias ()

デバイスが現在実行しているビルドのエイリアスを取得します。

String getBuildFlavor ()

デバイスのビルドフレーバーを取得します。

String getBuildId ()

デバイスが現在実行しているビルドを取得します。

String getBuildSigningKeys ()

デバイスイメージの署名に使用されるキータイプを返します

通常、Androidデバイスは、テストキー(AOSPなど)またはリリースキー(個々のデバイスメーカーによって制御されます)で署名されます。

String[] getChildren (String path)

アクセス許可のために機能しない場合があるIFileEntryを使用する代わり。

int getCurrentUser ()

現在実行中のユーザーのIDを返します。

String getDeviceClass ()

デバイスクラスを取得します。

long getDeviceDate ()

エポック以降のデバイスの日付をミリ秒で返します。

DeviceDescriptor getDeviceDescriptor ()

実際のデバイスオブジェクトを渡さずにデバイス情報を取得するには、デバイス情報からDeviceDescriptorを返します。

TestDeviceState getDeviceState ()

デバイスの状態を取得します。

long getDeviceTimeOffset (Date date)

デバイスと特定のERROR(/Date)間の時差を取得するヘルパー。

InputStreamSource getEmulatorOutput ()

エミュレーターのstdoutとstderrのストリームを取得する

Process getEmulatorProcess ()

このエミュレータに対応するProcess返します。

final File getExecuteShellCommandLog ()

すべてのexecuteShellCommand(String)ログを含むログ。

long getExternalStoreFreeSpace ()

デバイスの外部ストレージの空き容量を確認するヘルパーメソッド。

String getFastbootPath ()

使用されているfastbootバイナリのパスを返します。

String getFastbootProductType ()

fastbootモードのときにこのデバイスの製品タイプを取得する簡易メソッド。

String getFastbootProductVariant ()

fastbootモードのときにこのデバイスの製品タイプを取得する簡易メソッド。

String getFastbootVersion ()

使用されているfastbootバイナリのバージョン文字列を返します。

IFileEntry getFileEntry (String path)

デバイス上のリモートファイルへの参照を取得します。

IFileEntry getFileEntry (FileListingService.FileEntry entry)

非ルートパスからFileEntryを取得する非公式のヘルパー。

IDevice getIDevice ()

関連するddmlib IDeviceへの参照を返します。

getInstalledPackageNames ()

デバイスに存在するアプリケーションパッケージ名を取得します。

String getIpAddress ()

デバイスのIPアドレスを取得します。

KeyguardControllerState getKeyguardState ()

キーガードの現在の状態を取得するオブジェクトを返すか、サポートされていない場合はnullを返します。

long getLastExpectedRebootTimeMillis ()

System.currentTimeMillis()によって返されたEPOCH以降、Tradefed APIが最後に再起動をトリガーした時間をミリ秒単位で返します。

InputStreamSource getLogcat ()

logcatデータのスナップショットストリームを取得します。

InputStreamSource getLogcat (int maxBytes)

キャプチャされたlogcatデータの最後のmaxBytesスナップショットストリームを取得します。

InputStreamSource getLogcatDump ()

デバイスの現在のlogcatのダンプを取得します。

InputStreamSource getLogcatSince (long date)

指定された日付から、キャプチャされたlogcatデータのスナップショットストリームを取得します。

String getMacAddress ()

デバイスのMACアドレスを返します。デバイスからのクエリに失敗した場合はnullを返します。

int getMaxNumberOfRunningUsersSupported ()

サポートされている同時実行ユーザーの最大数を取得します。

int getMaxNumberOfUsersSupported ()

サポートされるユーザーの最大数を取得します。

IDeviceStateMonitor getMonitor ()

デバイスに関連付けられたIDeviceStateMonitor返します。

String getMountPoint (String mountName)

マウントポイントを返します。

ITestDevice.MountPointInfo getMountPointInfo (String mountpoint)

指定されたマウントポイントパスに対応するMountPointInfo返します。そのパスに何もマウントされていない場合、または/ proc / mountsにマウントポイントとして表示されない場合はnullを返します。

getMountPointInfo ()

デバイスの/ proc / mountsにある情報の解析されたバージョンを返します

TestDeviceOptions getOptions ()

デバイスのテストオプションを取得します。

long getPartitionFreeSpace (String partition)

デバイスパーティションの空き容量を確認するヘルパーメソッド。

Integer getPrimaryUserId ()

プライマリユーザーIDを返します。

ProcessInfo getProcessByName (String processName)

ヘルパーメソッドは「ps」コマンドを実行し、指定されたプロセス名のUSER、PID、およびNAMEを返します。

String getProcessPid (String process)

サービスのpidを返すか、何か問題があった場合はnullを返します。

getProcesses ()

ヘルパーメソッドは「ps」コマンドを実行し、すべてのプロセスのUSER、PID、NAMEのリストを返します。

String getProductType ()

このデバイスの製品タイプを取得する簡易メソッド。

String getProductVariant ()

このデバイスの製品バリアントを取得する簡易メソッド。

String getProperty (String name)

指定されたプロパティ値をデバイスから取得します。

ITestDevice.RecoveryMode getRecoveryMode ()

デバイスで使用されている現在の回復モードを取得します。

InputStreamSource getScreenshot (int displayId)

指定された表示IDのデバイスからスクリーンショットを取得します。

InputStreamSource getScreenshot (String format)

デバイスからスクリーンショットを取得します。

InputStreamSource getScreenshot (String format, boolean rescale)

デバイスからスクリーンショットを取得します。

InputStreamSource getScreenshot ()

デバイスからスクリーンショットを取得します。

String getSerialNumber ()

このデバイスのシリアル番号を取得する簡易メソッド。

String getSetting (int userId, String namespace, String key)

要求された設定の値を返します。

String getSetting (String namespace, String key)

getSetting(int, String, String)を参照して、システムユーザーに対して実行してください。

String getSimOperator ()

SIMカードオペレーターを返すか、デバイスが利用できない場合はnullを返します。

String getSimState ()

SIMカードの状態を返すか、デバイスが利用できない場合はnullを返します。

getTombstones ()

デバイスからトゥームストーンのリストを取得して返します。

long getTotalMemory ()

物理メモリの合計サイズをバイト単位で返すか、内部エラーの場合は-1を返します

getUninstallablePackageNames ()

アンインストールできるアプリケーションパッケージ名を取得します。

boolean getUseFastbootErase ()

fastboot eraseまたはfastbootフォーマットを使用してデバイスのパーティションをワイプするかどうかを取得します。

int getUserFlags (int userId)

特定のユーザーのフラグを検索して返します。

getUserInfos ()

useIdの地図に取得しUserInfoデバイス上で。

int getUserSerialNumber (int userId)

見つかった場合はuserIdに関連付けられたシリアル番号を返し、それ以外の場合は-10000を返します。

IManagedTestDevice.DeviceEventResponse handleAllocationEvent (DeviceEvent event)

指定されたDeviceEvent処理します。

このデバイスを新しい割り当て状態に移行する場合と移行しない場合があるDeviceEventを処理します。

boolean hasFeature (String feature)

デバイスで利用可能な機能があるかどうかを確認します。

String installPackage (File packageFile, boolean reinstall, String... extraArgs)

デバイスにAndroidパッケージをインストールします。

String installPackage (File packageFile, boolean reinstall, boolean grantPermissions, String... extraArgs)

デバイスにAndroidパッケージをインストールします。

String installPackageForUser (File packageFile, boolean reinstall, int userId, String... extraArgs)

特定のユーザーのAndroidパッケージをデバイスにインストールします。

String installPackageForUser (File packageFile, boolean reinstall, boolean grantPermissions, int userId, String... extraArgs)

特定のユーザーのAndroidパッケージをデバイスにインストールします。

boolean isAdbRoot ()

boolean isAdbTcp ()
boolean isDeviceEncrypted ()

デバイスが暗号化されているかどうかを返します。

boolean isDirectory (String path)

デバイスのパスがディレクトリの場合はTrueを、それ以外の場合はFalseを返します。

boolean isEnableAdbRoot ()
boolean isEncryptionSupported ()

デバイスで暗号化がサポートされているかどうかを返します。

boolean isExecutable (String fullPath)

デバイス上のファイルパスが実行可能ファイルである場合はTrueを、それ以外の場合はFalseを返します。

boolean isFastbootEnabled ()

デバイスでfastbootを使用できる場合は戻ります。

boolean isHeadless ()

デバイスがヘッドレス(画面なし)の場合はtrueを返し、それ以外の場合はfalseを返します。

boolean isMultiUserSupported ()

マルチユーザーがサポートされているかどうかを判断します。

boolean isPackageInstalled (String packageName, String userId)

特定のパッケージ名と特定のユーザーIDについてデバイスをクエリし、そのユーザーに対して現在インストールされているかどうかを確認します。

boolean isPackageInstalled (String packageName)

デバイスに特定のパッケージ名を照会して、現在インストールされているかどうかを確認します。

boolean isRuntimePermissionSupported ()

デバイスのプラットフォームがランタイム権限付与をサポートしているかどうかを確認します

boolean isUserRunning (int userId)

特定のユーザーが実行しているかどうかを確認します。

boolean isUserSecondary (int userId)

指定されたユーザーがフラグに従ってセカンダリユーザーであるかどうかを返します。

boolean isWifiEnabled ()

wifiが有効になっているかどうかをテストします。

listDisplayIds ()

「dumpsys SurfaceFlinger」によって報告された、デバイスで使用可能なディスプレイIDのリストを収集します。

listUsers ()

デバイス上のユーザーのリストを取得します。

boolean logBugreport (String dataName, ITestLogger listener)

バグレポートを取得してレポーターに記録するヘルパーメソッド。

void logOnDevice (String tag, Log.LogLevel level, String format, Object... args)

デバイスのlogcatにメッセージを記録します。

void nonBlockingReboot ()

デバイスを再起動するコマンドを発行し、コマンドの完了時とデバイスがadbから見えなくなったときに戻ります。

void postAdbRootAction ()

デバイスがadb rootの後、デバイスがオンラインに戻る前に特定のアクションを実行する必要がある場合はオーバーライドします。

void postAdbUnrootAction ()

デバイスがadb unroot後、デバイスがオンラインに戻る前に特定のアクションを実行する必要がある場合は、オーバーライドします。

void postBootSetup ()

起動後にデバイスをテストするように構成する手順を実行します。

void postInvocationTearDown ()

呼び出しの完了後に実行される、デバイス固有の必要なクリーンアップのための追加の手順。

void preInvocationSetup ( IBuildInfo info)

呼び出しフローの前にデバイスで実行される、デバイス固有の必要なセットアップの追加手順。

boolean pullDir (String deviceFilePath, File localDir)

デバイスからディレクトリの内容を再帰的にプルします。

boolean pullFile (String remoteFilePath, File localFile)

デバイスからファイルを取得します。

File pullFile (String remoteFilePath)

デバイスからファイルを取得し、ローカルの一時的なERROR(/File)に保存して、そのFileを返しFile

String pullFileContents (String remoteFilePath)

デバイスからファイルを取得し、その内容を返します。

File pullFileFromExternal (String remoteFilePath)

デバイスの外部ストレージからファイルを取得し、ローカルの一時的なERROR(/File)に保存し、そのFileへの参照を返す便利なメソッド。

boolean pushDir (File localFileDir, String deviceFilePath, excludedDirectories) pushDir (File localFileDir, String deviceFilePath, excludedDirectories)

フィルターされた一部のディレクトリを除外しながら、ディレクトリの内容をデバイスに再帰的にプッシュします。

boolean pushDir (File localFileDir, String deviceFilePath)

ディレクトリの内容をデバイスに再帰的にプッシュします。

boolean pushFile (File localFile, String remoteFilePath)

ファイルをデバイスにプッシュする

boolean pushString (String contents, String remoteFilePath)

文字列から作成されたファイルをデバイスにプッシュする

void reboot ()

デバイスをadbモードで再起動します。

void rebootIntoBootloader ()

デバイスをブートローダーモードで再起動します。

void rebootIntoRecovery ()

デバイスをadbリカバリモードで再起動します。

void rebootUntilOnline ()

デバイスがオンラインになるまでreboot()つまり、adbから見えるようになるまでreboot()ブロックするreboot()の代替。

void recoverDevice ()

デバイス通信の回復を試みます。

void remountSystemWritable ()

デバイスのシステムパーティションを書き込み可能にします。

boolean removeAdmin (String componentName, int userId)

特定のユーザーの特定のデバイス管理者を削除し、成功した場合はtrue 、それ以外の場合はfalseを返しtrue

void removeOwners ()

既存のデバイスプロファイルの所有者をすべて最善の努力で削除します。

boolean removeUser (int userId)

特定のユーザーをデバイスから削除します。

boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, ITestLifeCycleReceiver... listeners)

パラメータとして渡された1つ以上のリスナーを使用してERROR(/#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection))を実行するための簡易メソッド。

boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, listeners) runInstrumentationTests (IRemoteAndroidTestRunner runner, listeners)

インスツルメンテーションテストを実行し、デバイスの回復を提供します。

boolean runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, int userId, ITestLifeCycleReceiver... listeners)

ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, ITestLifeCycleReceiver...)が、指定されたユーザーのテストを実行します。

boolean runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, int userId, listeners) runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, int userId, listeners)

ERROR(ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection)/com.android.tradefed.device.ITestDevice#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection) ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection))指定されたユーザーの。

void setDate (Date date)

デバイスに日付を設定します

注:デバイスに日付を設定するにはルートが必要です

boolean setDeviceOwner (String componentName, int userId)

特定のユーザーのデバイス所有者としてデバイス管理コンポーネントを設定します。

void setDeviceState ( TestDeviceState deviceState)

デバイスの状態を更新します。

void setEmulatorOutputStream ( SizeLimitedOutputStream output)

エミュレーターの場合、 SizeLimitedOutputStreamをログ出力に設定

void setEmulatorProcess (Process p)

このデバイスがエミュレータである場合、 Process設定します。

void setFastbootEnabled (boolean fastbootEnabled)

デバイスのfastbootオプションを設定します。

void setFastbootPath (String fastbootPath)

使用するfastbootバイナリへのパスを設定します。

void setIDevice (IDevice newDevice)

このITestDeviceに関連付けられているIDeviceを更新します。

void setOptions ( TestDeviceOptions options)

デバイスのTestDeviceOptionsを設定します

boolean setProperty (String propKey, String propValue)

デバイスに指定されたプロパティ値を設定します。

void setRecovery ( IDeviceRecovery recovery)

このデバイスで使用するIDeviceRecoveryを設定します。

void setRecoveryMode ( ITestDevice.RecoveryMode mode)

デバイスで使用する現在の回復モードを設定します。

void setSetting (String namespace, String key, String value)

setSetting(int, String, String, String)を参照して、システムユーザーに対して実行してください。

void setSetting (int userId, String namespace, String key, String value)

特定のユーザーの名前空間に設定値を追加します。

void setUseFastbootErase (boolean useFastbootErase)

デバイスのパーティションを消去するために、fastboot eraseまたはfastbootフォーマットを使用するかどうかを設定します。

void startLogcat ()

バックグラウンドでデバイスからのlogcat出力のキャプチャを開始します。

boolean startUser (int userId)

現在停止している場合、特定のユーザーをバックグラウンドで起動します。

boolean startUser (int userId, boolean waitFlag)

現在停止している場合、特定のユーザーをバックグラウンドで起動します。

void stopEmulatorOutput ()

エミュレータ出力を閉じて削除します。

void stopLogcat ()

デバイスからのlogcat出力のキャプチャを停止し、現在保存されているlogcatデータを破棄します。

boolean stopUser (int userId)

特定のユーザーを停止します。

boolean stopUser (int userId, boolean waitFlag, boolean forceFlag)

特定のユーザーを停止します。

String switchToAdbTcp ()

デバイスをadb-over-tcpモードに切り替えます。

boolean switchToAdbUsb ()

USBモードでデバイスをadbに切り替えます。

boolean switchUser (int userId)

デフォルトのタイムアウトで別のuserIdに切り替えます。

boolean switchUser (int userId, long timeout)

指定されたタイムアウトを期限として別のuserIdに切り替えます。

boolean syncFiles (File localFileDir, String deviceFilePath)

ローカルファイルディレクトリの内容を増分的にデバイスに同期します。

Bugreport takeBugreport ()

Bugreport 、それを処理するためにBugreportオブジェクト内に返します。

boolean unencryptDevice ()

デバイスの暗号化を解除します。

String uninstallPackage (String packageName)

デバイスからAndroidパッケージをアンインストールします。

boolean unlockDevice ()

デバイスが暗号化された状態の場合、デバイスのロックを解除します。

boolean waitForBootComplete (long timeOut)

デバイスの起動完了フラグが設定されるまでブロックします。

void waitForDeviceAvailable ()

デバイスが応答し、テストに使用できるようになるのを待ちます。

void waitForDeviceAvailable (long waitTime)

デバイスが応答し、テストに使用できるようになるのを待ちます。

boolean waitForDeviceInRecovery (long waitTime)

デバイスが 'adb recovery'状態になるためのブロック(これはIDeviceRecoveryとは異なりIDeviceRecovery )。

boolean waitForDeviceNotAvailable (long waitTime)

デバイスのブロックが使用できない、つまりadbにない

void waitForDeviceOnline ()

デバイスがadbを介して表示されるまでブロックします。

void waitForDeviceOnline (long waitTime)

デバイスがadbを介して表示されるまでブロックします。

boolean waitForDeviceShell (long waitTime)

デバイスが基本的なadbシェルコマンドに応答するのを待ちます。

保護されたメソッド

void checkApiLevelAgainst (String feature, int strictMinLevel)
NativeDevice.RebootDeviceAction createRebootDeviceAction (String into)

再起動アクションを実行するときに使用するRebootDeviceActionを作成します。

void doAdbReboot (String into)

adbの再起動を実行します。

void ensureRuntimePermissionSupported ()

ランタイム権限がサポートされていない場合に例外をスローするヘルパーメソッド

InputStreamSource getBugreportInternal ()
File getBugreportzInternal ()

bugreportz zipファイルをERROR(/File)として取得するための内部ヘルパーメソッド。

IRunUtil getRunUtil ()

使用するRunUtilインスタンスを取得します。

String internalGetProperty (String propName, String fastbootVar, String description)

デフォルトでddmlibキャッシュからデバイスプロパティをフェッチし、デバイスがFastbootにあるかどうかに応じて、 `adb shell getprop`または` fastboot getvar`のいずれかにフォールバックします。

boolean isNewer (File localFile, IFileEntry entry)

ローカルファイルがリモートファイルよりも新しい場合はtrue返します。

boolean performDeviceAction (String actionDescription, com.android.tradefed.device.NativeDevice.DeviceAction action, int retryAttempts)

このデバイスでアクションを実行します。

void postAdbReboot ()

再起動後に実行できる可能な追加のアクション。

void prePostBootSetup ()

各デバイスタイプ(AndroidNativeDevice、TestDevice)が特定の起動後のセットアップでこのメソッドをオーバーライドできるようにします。

void setClock (Clock clock)

使用するClockインスタンスを設定します。

void setLogStartDelay (int delay)

オンラインデバイスのlogcatキャプチャを開始する前に待機する時間をミリ秒単位で設定します。

void waitForDeviceNotAvailable (String operationDesc, long time)

定数

INVALID_USER_ID

public static final int INVALID_USER_ID

無効/見つからないユーザーIDに対して返される値:UserHandleは-10000値を定義しました

定数値:-10000(0xffffd8f0)

MAX_HOST_DEVICE_TIME_OFFSET

protected static final long MAX_HOST_DEVICE_TIME_OFFSET

定数値:5000(0x0000000000001388)

MAX_RETRY_ATTEMPTS

protected static final int MAX_RETRY_ATTEMPTS

実行するコマンド再試行のデフォルトの回数

定数値:2(0x00000002)

田畑

mOptions

protected TestDeviceOptions mOptions

mStateMonitor

protected final IDeviceStateMonitor mStateMonitor

パブリックコンストラクター

NativeDevice

public NativeDevice (IDevice device, 
                IDeviceStateMonitor stateMonitor, 
                IDeviceMonitor allocationMonitor)

TestDevice作成します。

パラメーター
device IDevice :関連するIDevice

stateMonitor IDeviceStateMonitor :使用するIDeviceStateMonitorメカニズム

allocationMonitor IDeviceMonitor :割り当て状態の変更を通知するIDeviceMonitor 。 nullにすることができます

パブリックメソッド

checkApiLevelAgainstNextRelease

public boolean checkApiLevelAgainstNextRelease (int strictMinLevel)

最低限サポートされているレベルで、機能が現在サポートされているかどうかを確認します。このメソッドは、APIレベルが上がる前に、まだリリースされていない機能を考慮します。

パラメーター
strictMinLevel int :この機能をサポートする厳密な最小レベル。

戻り値
boolean レベルがサポートされている場合はTrue。それ以外の場合はfalse。

投げる
DeviceNotAvailableException

checkConnectivity

public boolean checkConnectivity ()

デバイスにネットワーク接続があることを確認します。

戻り値
boolean デバイスにネットワーク接続が機能している場合はtrue 、それ以外の場合はfalse

投げる
DeviceNotAvailableException

clearErrorDialogs

public boolean clearErrorDialogs ()

デバイスのUIに現在表示されているエラーダイアログをすべて閉じてみます。

戻り値
boolean ダイアログが存在しないか、ダイアログが正常にクリアされた場合はtrue 。それ以外の場合はfalse

投げる
DeviceNotAvailableException

clearLastConnectedWifiNetwork

public void clearLastConnectedWifiNetwork ()

最後に接続したWi-Fiネットワークをクリアします。デバイスの再起動後、前のテストで使用されたwifiネットワークへの接続を避けるために、新しい呼び出しを開始するときにこれを呼び出す必要があります。

clearLogcat

public void clearLogcat ()

蓄積されたlogcatデータを削除します。

これは、 ITestDevice#getLogcat()が特定のポイント(新しいデバイスビルドのフラッシュ後など)の後で生成されたログデータのみを返すようにする場合に便利です。

connectToWifiNetwork

public boolean connectToWifiNetwork (String wifiSsid, 
                String wifiPsk)

Wi-Fiネットワークに接続します。

wifiをオンにし、指定されたwifiネットワークへの接続が成功するまでブロックします。接続が確立されると、インスタンスは再起動ごとにITestDevice#disconnectFromWifi()またはITestDevice#clearLastConnectedWifiNetwork()が呼び出されるまで接続を復元しようとします。

パラメーター
wifiSsid String :接続するwifi ssid

wifiPsk String :PSKパスフレーズ、または暗号化されていない場合はnull

戻り値
boolean wifiネットワークへの接続に成功した場合はtrue 。そうでなければfalse

投げる
DeviceNotAvailableException

connectToWifiNetwork

public boolean connectToWifiNetwork (String wifiSsid, 
                String wifiPsk, 
                boolean scanSsid)

Wi-Fiネットワークに接続します。

wifiをオンにし、指定されたwifiネットワークへの接続が成功するまでブロックします。接続が確立されると、インスタンスは再起動ごとにITestDevice#disconnectFromWifi()またはITestDevice#clearLastConnectedWifiNetwork()が呼び出されるまで接続を復元しようとします。

パラメーター
wifiSsid String :接続するwifi ssid

wifiPsk String :PSKパスフレーズ、または暗号化されていない場合はnull

scanSsid boolean :このネットワークの非表示のSSIDをスキャンするかどうか。

戻り値
boolean wifiネットワークへの接続に成功した場合はtrue 。そうでなければfalse

投げる
DeviceNotAvailableException

connectToWifiNetworkIfNeeded

public boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk, 
                boolean scanSsid)

デバイスに現在ネットワーク接続がない場合にのみ接続するconnectToWifiNetwork(String, String)バリアント。

パラメーター
scanSsid boolean :このネットワークの非表示のSSIDをスキャンするかどうか

戻り値
boolean wifiネットワークへの接続に成功した場合はtrue 。そうでなければfalse

投げる
DeviceNotAvailableException

connectToWifiNetworkIfNeeded

public boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk)

デバイスに現在ネットワーク接続がない場合にのみ接続するconnectToWifiNetwork(String, String)バリアント。

戻り値
boolean wifiネットワークへの接続に成功した場合はtrue 。そうでなければfalse

投げる
DeviceNotAvailableException

ユーザーを作成

public int createUser (String name, 
                boolean guest, 
                boolean ephemeral)

指定された名前と指定されたフラグでユーザーを作成します

パラメーター
name String :デバイスで作成するユーザーの

guest boolean :作成時にユーザーフラグ--guestを有効にする

ephemeral boolean :作成中にユーザーフラグ--ephemeralを有効にします

戻り値
int 作成されたユーザーのID

投げる
DeviceNotAvailableException

ユーザーを作成

public int createUser (String name)

指定された名前とデフォルトのフラグ0でユーザーを作成します。

パラメーター
name String :デバイスで作成するユーザーの

戻り値
int 作成されたユーザーIDの整数

投げる
DeviceNotAvailableException

createUserNoThrow

public int createUserNoThrow (String name)

指定された名前とデフォルトのフラグ0でユーザーを作成します。

パラメーター
name String :デバイスで作成するユーザーの

戻り値
int 作成されたユーザーIDの整数、またはエラーの場合は-1。

投げる
DeviceNotAvailableException

ファイルを削除する

public void deleteFile (String deviceFilePath)

デバイス上のファイルまたはディレクトリを削除するヘルパーメソッド。

パラメーター
deviceFilePath String :デバイス上のファイルの絶対パス。

投げる
DeviceNotAvailableException

disableAdbRoot

public boolean disableAdbRoot ()

adb rootをオフにします。

adb rootを無効にすると、デバイスがadbから切断される場合があります。このメソッドは、デバイスが利用可能になるまでブロックします。

戻り値
boolean 成功した場合はtrue

投げる
DeviceNotAvailableException

disableKeyguard

public void disableKeyguard ()

キーガードを無効にしようとします。

まず、入力ディスパッチの準備が整うまで待機します。これは、現在のフレームワーク実装が時々競合状態になるため、デバイスがBOOT_COMPLETEを報告するのとほぼ同時に、明らかに非同期に発生します。次に、キーガードを閉じるコマンドが送信されます(非セキュアなものでのみ機能します)

投げる
DeviceNotAvailableException

disableNetworkMonitor

public boolean disableNetworkMonitor ()

デバイスのネットワーク監視を無効にします。

戻り値
boolean 監視が正常に無効になった場合はtrue 。失敗した場合はfalse

投げる
DeviceNotAvailableException

disconnectFromWifi

public boolean disconnectFromWifi ()

Wi-Fiネットワークから切断します。

既知のネットワークリストからすべてのネットワークを削除し、Wi-Fiを無効にします。

戻り値
boolean wifiネットワークから正常に切断された場合はtrue 。切断に失敗した場合はfalse

投げる
DeviceNotAvailableException

doesFileExist

public boolean doesFileExist (String deviceFilePath)

デバイス上のファイルが存在するかどうかを判断するヘルパーメソッド。

パラメーター
deviceFilePath String :チェックするデバイス上のファイルの絶対パス

戻り値
boolean ファイルが存在する場合はtrue 、それ以外の場合はfalse

投げる
DeviceNotAvailableException

dumpHeap

public File dumpHeap (String process, 
                String devicePath)

system_serverからヒープをダンプしようとしました。ダンプされたファイルをクリーンアップするのは呼び出し側の責任です。

パラメーター
process String :ダンプヒープの対象となるデバイスプロセスの名前。

devicePath String :ダンプを配置するデバイス上のパス。これは、権限で許可されている場所である必要があります。

戻り値
File レポートを含むERROR(/File) 。何かが失敗した場合はnull。

投げる
DeviceNotAvailableException

enableAdbRoot

public boolean enableAdbRoot ()

adbルートをオンにします。 「enable-root」設定が「false」の場合、はメッセージをログに記録し、rootを有効にせずに戻ります。

adb rootを有効にすると、デバイスがadbから切断される可能性があります。このメソッドは、デバイスが利用可能になるまでブロックします。

戻り値
boolean 成功した場合はtrue

投げる
DeviceNotAvailableException

enableNetworkMonitor

public boolean enableNetworkMonitor ()

デバイスのネットワーク監視を有効にします。

戻り値
boolean 監視が正常に有効になった場合はtrue 。失敗した場合はfalse

投げる
DeviceNotAvailableException

encryptDevice

public boolean encryptDevice (boolean inplace)

デバイスを暗号化します。

デバイスの暗号化は、インプレースまたはワイプで実行できます。インプレース暗号化はデバイス上のデータをワイプしませんが、通常はワイプよりも数桁長くかかります。

このメソッドは、デバイスがまだ暗号化されていない場合はデバイスを再起動し、デバイスがオンラインになるまでブロックします。また、再起動後にデバイスを復号化しません。したがって、このメソッドが返されたときに、デバイスが完全に起動していないか、テストの準備ができていない可能性があります。

パラメーター
inplace boolean :暗号化プロセスを実行し、デバイスをワイプしない場合。

戻り値
boolean 成功した場合はtrue

投げる
DeviceNotAvailableException

executeAdbCommand

public String executeAdbCommand (String... cmdArgs)

adbコマンドをシステムコマンドとして実行するヘルパーメソッド。

代わりにexecuteShellCommand(String)を使用する必要があります。この方法を使用すると、障害の検出とパフォーマンスが向上します。

パラメーター
cmdArgs String :adbコマンドと実行する引数

戻り値
String コマンドの標準出力。コマンドの実行に失敗した場合はnull

投げる
DeviceNotAvailableException

executeFastbootCommand

public CommandResult executeFastbootCommand (String... cmdArgs)

デフォルトのタイムアウトが2分のシステムコマンドとしてfastbootコマンドを実行するヘルパーメソッド。

デバイスがすでにfastbootモードになっているときに使用することが期待されています。

パラメーター
cmdArgs String :fastbootコマンドと実行する引数

戻り値
CommandResult コマンドの出力を含むCommandResult

投げる
DeviceNotAvailableException

executeFastbootCommand

public CommandResult executeFastbootCommand (long timeout, 
                String... cmdArgs)

システムコマンドとしてfastbootコマンドを実行するヘルパーメソッド。

デバイスがすでにfastbootモードになっているときに使用することが期待されています。

パラメーター
timeout long :コマンドが期限切れになるまでの時間(ミリ秒)

cmdArgs String :fastbootコマンドと実行する引数

戻り値
CommandResult コマンドの出力を含むCommandResult

投げる
DeviceNotAvailableException

executeLongFastbootCommand

public CommandResult executeLongFastbootCommand (String... cmdArgs)

長時間実行されるfastbootコマンドをシステムコマンドとして実行するヘルパーメソッド。

より長いタイムアウトを使用することを除いて、 executeFastbootCommand(String)と同じです。

パラメーター
cmdArgs String :fastbootコマンドと実行する引数

戻り値
CommandResult コマンドの出力を含むCommandResult

投げる
DeviceNotAvailableException

executeShellCommand

public String executeShellCommand (String command)

adbシェルコマンドを実行し、出力をStringとして返すヘルパーメソッド。

パラメーター
command String :実行するadbシェルコマンド

戻り値
String シェル出力

投げる
DeviceNotAvailableException

executeShellCommand

public void executeShellCommand (String command, 
                IShellOutputReceiver receiver, 
                long maxTimeToOutputShellResponse, 
                TimeUnit timeUnit, 
                int retryAttempts)

コマンドの動作を制御するためのパラメーターを追加して、adbシェルコマンドを実行します。

パラメーター
command String :実行するadbシェルコマンド

receiver IShellOutputReceiver :シェル出力をIShellOutputReceiverするIShellOutputReceiver

maxTimeToOutputShellResponse long :コマンドが応答を出力できない最大時間。 timeUnit指定されたtimeUnit

timeUnit TimeUnitmaxTimeToOutputShellResponse単位

retryAttempts int :例外のためにコマンドが失敗した場合にコマンドを再試行する最大回数。成功せずにretryAttemptsを実行すると、 retryAttemptsがスローされます。

投げる
DeviceNotAvailableException

executeShellCommand

public void executeShellCommand (String command, 
                IShellOutputReceiver receiver, 
                long maxTimeoutForCommand, 
                long maxTimeToOutputShellResponse, 
                TimeUnit timeUnit, 
                int retryAttempts)

コマンドの動作を制御するためのパラメーターを追加して、adbシェルコマンドを実行します。

パラメーター
command String :実行するadbシェルコマンド

receiver IShellOutputReceiver :シェル出力をIShellOutputReceiverするIShellOutputReceiver

maxTimeoutForCommand long :コマンドが完了するまでの最大タイムアウト。 timeUnit指定されたtimeUnit

maxTimeToOutputShellResponse long :コマンドが応答を出力できない最大時間。 timeUnit指定されたtimeUnit

timeUnit TimeUnitmaxTimeToOutputShellResponse単位

retryAttempts int :例外のためにコマンドが失敗した場合にコマンドを再試行する最大回数。成功せずにretryAttemptsを実行すると、 retryAttemptsがスローされます。

投げる
DeviceNotAvailableException

executeShellCommand

public void executeShellCommand (String command, 
                IShellOutputReceiver receiver)

指定されたadbシェルコマンドを実行し、コマンドが失敗した場合は複数回再試行します。

デフォルト値を持つexecuteShellCommand(String, com.android.ddmlib.IShellOutputReceiver, long, TimeUnit, int)より単純な形式のexecuteShellCommand(String, com.android.ddmlib.IShellOutputReceiver, long, TimeUnit, int)

パラメーター
command String :実行するadbシェルコマンド

receiver IShellOutputReceiver :シェル出力をIShellOutputReceiverするIShellOutputReceiver

投げる
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd)

adbシェルコマンドを実行し、コマンドステータス出力、stdoutおよびstderrが適切に入力されたCommandResultとして結果を返すヘルパーメソッド。

パラメーター
cmd String :実行するコマンド。

戻り値
CommandResult CommandResultの結果。

投げる
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                OutputStream pipeToOutput)

adbシェルコマンドを実行し、コマンドステータス出力、stdoutおよびstderrが適切に入力されたCommandResultとして結果を返すヘルパーメソッド。

パラメーター
cmd String :実行するコマンド。

pipeToOutput OutputStreamERROR(/OutputStream) std出力がリダイレクトされます。

戻り値
CommandResult CommandResultの結果。

投げる
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                File pipeAsInput)

adbシェルコマンドを実行し、コマンドステータス出力、stdoutおよびstderrが適切に入力されたCommandResultとして結果を返すヘルパーメソッド。

パラメーター
cmd String :実行するコマンド。

pipeAsInput File :コマンドへの入力としてパイプされるERROR(/File)

戻り値
CommandResult CommandResultの結果。

投げる
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit, 
                int retryAttempts)

コマンドの動作を制御するためのパラメーターを追加して、adbシェルコマンドを実行します。

パラメーター
cmd String :実行するadbシェルコマンド

maxTimeoutForCommand long :コマンドが完了するまでの最大タイムアウト。 timeUnit指定されたtimeUnit

timeUnit TimeUnitmaxTimeToOutputShellResponse単位

retryAttempts int :例外のためにコマンドが失敗した場合にコマンドを再試行する最大回数。成功せずにretryAttemptsを実行すると、 retryAttemptsがスローされます。

戻り値
CommandResult

投げる
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit)

コマンドの動作を制御するパラメーターを追加して、adbシェルコマンドを実行します。

パラメーター
cmd String :実行するadbシェルコマンド

maxTimeoutForCommand long :コマンドが完了するまでの最大タイムアウト。 timeUnit指定されたtimeUnit

timeUnit TimeUnitmaxTimeToOutputShellResponse単位

戻り値
CommandResult

投げる
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                File pipeAsInput, 
                OutputStream pipeToOutput, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit, 
                int retryAttempts)

コマンドの動作を制御するためのパラメーターを追加して、adbシェルコマンドを実行します。

パラメーター
cmd String :実行するadbシェルコマンド

pipeAsInput File :コマンドへの入力としてパイプされるERROR(/File)

pipeToOutput OutputStreamERROR(/OutputStream) std出力がリダイレクトされます。

maxTimeoutForCommand long :コマンドが完了するまでの最大タイムアウト。 timeUnit指定されたtimeUnit

timeUnit TimeUnitmaxTimeToOutputShellResponse単位

retryAttempts int :例外のためにコマンドが失敗した場合にコマンドを再試行する最大回数。成功せずにretryAttemptsを実行すると、 retryAttemptsがスローされます。

戻り値
CommandResult

投げる
DeviceNotAvailableException

fastbootWipePartition

public CommandResult fastbootWipePartition (String partition)

デバイスのパーティションをワイプするヘルパーメソッド。

getUseFastbootErase()true場合、パーティションのワイプにfastboot消去が使用されます。デバイスは、次にデバイスが起動するときにファイルシステムを作成する必要があります。それ以外の場合は、デバイスに新しいファイルシステムを作成するfastboot形式が使用されます。

デバイスがすでにfastbootモードになっているときに使用することが期待されています。

パラメーター
partition String :ワイプするパーティション

戻り値
CommandResult コマンドの出力を含むCommandResult

投げる
DeviceNotAvailableException

getActiveApexes

public  getActiveApexes ()

デバイスでアクティブ化されているAPEXに関する情報を取得します。

戻り値
デバイスで現在アクティブ化されているApexInfo ERROR(/Set)

投げる
DeviceNotAvailableException

getAllSettings

public  getAllSettings (String namespace)

要求された名前空間のキーと値のペアを返します。

パラメーター
namespace String :{"system"、 "secure"、 "global"}のいずれかである必要があります

戻り値
キーと値のペアのマップ。名前空間がサポートされていない場合はnull。

投げる
DeviceNotAvailableException

getAllocationState

public DeviceAllocationState getAllocationState ()

デバイスの現在の割り当て状態を返します

戻り値
DeviceAllocationState

getAndroidId

public String getAndroidId (int userId)

userIdに関連付けられているandroid-idを見つけて返します。見つからない場合はnullです。

パラメーター
userId int

戻り値
String

投げる
DeviceNotAvailableException

getAndroidIds

public  getAndroidIds ()

ユーザーIDと一致するAndroid IDのマップを作成します。各ユーザーIDがこの関数に関連付けられたAndroid IDを検出するという保証はありません。そのため、一部のユーザーIDはnullと一致する場合があります。

戻り値
一致するユーザーIDが見つかったAndroid IDのマップ。

投げる
DeviceNotAvailableException

getApiLevel

public int getApiLevel ()

デバイスのAPIレベルを取得します。デフォルトはUNKNOWN_API_LEVELです。

戻り値
int デバイスのAPIレベルを示す整数

投げる
DeviceNotAvailableException

getAppPackageInfo

public PackageInfo getAppPackageInfo (String packageName)

デバイスにインストールされているパッケージに関する情報を取得します。

パラメーター
packageName String

戻り値
PackageInfo PackageInfoまたは情報を取得できなかった場合はnull

投げる
DeviceNotAvailableException

getBasebandVersion

public String getBasebandVersion ()

このデバイスのベースバンド(無線)バージョンを取得する簡易メソッド。無線バージョンの取得はデバイス固有であるため、すべてのデバイスについて正しい情報が返されない場合があります。このメソッドは、gsm.version.basebandプロパティに依存して正しいバージョン情報を返します。これは一部のCDMAデバイスでは正確ではなく、ここで返されるバージョンはfastbootから報告されたバージョンと一致せず、CDMA無線のバージョンを返さない場合があります。 TL; DRこのメソッドは、gsm.version.basebandプロパティがfastboot getvar version-basebandによって返されたバージョンと同じである場合にのみ、正確なバージョンを報告します。

戻り値
String Stringベースバンドバージョン、または判別できない場合はnull (デバイスに無線がないか、バージョン文字列を読み取れない)

投げる
DeviceNotAvailableException

getBattery

public Integer getBattery ()

デバイスの現在のバッテリーレベルを返します。バッテリーレベルが利用できない場合はNullを返します。

戻り値
Integer

getBootloaderVersion

public String getBootloaderVersion ()

このデバイスのブートローダーバージョンを取得する簡易メソッド。

デバイスの現在の状態からブートローダーのバージョンを取得しようとします。 (つまり、デバイスがfastbootモードの場合、デバイスはfastbootからバージョンを取得しようとします)

戻り値
String Stringブートローダーのバージョン。見つからない場合はnull

投げる
DeviceNotAvailableException

getBugreport

public InputStreamSource getBugreport ()

デバイスからバグレポートを取得します。

The implementation of this is guaranteed to continue to work on a device without an sdcard (or where the sdcard is not yet mounted).

Returns
InputStreamSource An InputStreamSource which will produce the bugreport contents on demand. In case of failure, the InputStreamSource will produce an empty ERROR(/InputStream) .

getBugreportz

public InputStreamSource getBugreportz ()

Retrieves a bugreportz from the device. Zip format bugreport contains the main bugreport and other log files that are useful for debugging.

Only supported for 'adb version' > 1.0.36

Returns
InputStreamSource a InputStreamSource of the zip file containing the bugreportz, return null in case of failure.

getBuildAlias

public String getBuildAlias ()

Retrieve the alias of the build that the device is currently running.

Build alias is usually a more readable string than build id (typically a number for Nexus builds). For example, final Android 4.2 release has build alias JDQ39, and build id 573038

Returns
String the build alias or fall back to build id if it could not be retrieved

Throws
DeviceNotAvailableException

getBuildFlavor

public String getBuildFlavor ()

Retrieve the build flavor for the device.

Returns
String the build flavor or null if it could not be retrieved

Throws
DeviceNotAvailableException

getBuildId

public String getBuildId ()

Retrieve the build the device is currently running.

Returns
String the build id or IBuildInfo#UNKNOWN_BUILD_ID if it could not be retrieved

Throws
DeviceNotAvailableException

getBuildSigningKeys

public String getBuildSigningKeys ()

Returns the key type used to sign the device image

Typically Android devices may be signed with test-keys (like in AOSP) or release-keys (controlled by individual device manufacturers)

Returns
String The signing key if found, null otherwise.

Throws
DeviceNotAvailableException

getChildren

public String[] getChildren (String path)

Alternative to using IFileEntry that sometimes won't work because of permissions.

Parameters
path String : is the path on the device where to do the search

Returns
String[] Array of string containing all the file in a path on the device.

Throws
DeviceNotAvailableException

getCurrentUser

public int getCurrentUser ()

Return the id of the current running user.

Returns
int

Throws
DeviceNotAvailableException

getDeviceClass

public String getDeviceClass ()

Get the device class.

Returns
String the String device class.

getDeviceDate

public long getDeviceDate ()

Return the date of the device in millisecond since epoch.

Returns
long the date of the device in epoch format.

Throws
DeviceNotAvailableException

getDeviceDescriptor

public DeviceDescriptor getDeviceDescriptor ()

Return a DeviceDescriptor from the device information to get info on it without passing the actual device object.

Returns
DeviceDescriptor

getDeviceState

public TestDeviceState getDeviceState ()

Get the device's state.

Returns
TestDeviceState

getDeviceTimeOffset

public long getDeviceTimeOffset (Date date)

Helper to get the time difference between the device and a given ERROR(/Date) . Use Epoch time internally.

Parameters
date Date

Returns
long the difference in milliseconds

Throws
DeviceNotAvailableException

getEmulatorOutput

public InputStreamSource getEmulatorOutput ()

Get the stream of emulator stdout and stderr

Returns
InputStreamSource emulator output

getEmulatorProcess

public Process getEmulatorProcess ()

Return the Process corresponding to this emulator.

Returns
Process the Process or null

getExecuteShellCommandLog

public final File getExecuteShellCommandLog ()

The log that contains all the executeShellCommand(String) logs.

Returns
File

getExternalStoreFreeSpace

public long getExternalStoreFreeSpace ()

Helper method to determine amount of free space on device external storage.

Returns
long the amount of free space in KB

Throws
DeviceNotAvailableException

getFastbootPath

public String getFastbootPath ()

Returns the path of the fastboot binary being used. Still requires isFastbootEnabled() to be true, to have fastboot functions enabled.

Returns
String

getFastbootProductType

public String getFastbootProductType ()

Convenience method to get the product type of this device when its in fastboot mode.

This method should only be used if device should be in fastboot. Its a bit safer variant than the generic getProductType() method in this case, because ITestDevice will know to recover device into fastboot if device is in incorrect state or is unresponsive.

Returns
String the String product type name or null if it cannot be determined

Throws
DeviceNotAvailableException

getFastbootProductVariant

public String getFastbootProductVariant ()

Convenience method to get the product type of this device when its in fastboot mode.

This method should only be used if device should be in fastboot. Its a bit safer variant than the generic getProductType() method in this case, because ITestDevice will know to recover device into fastboot if device is in incorrect state or is unresponsive.

Returns
String the String product type name or null if it cannot be determined

Throws
DeviceNotAvailableException

getFastbootVersion

public String getFastbootVersion ()

Returns the version string of the fastboot binary being used. Or null if something goes wrong.

Returns
String

getFileEntry

public IFileEntry getFileEntry (String path)

Retrieve a reference to a remote file on device.

Parameters
path String : the file path to retrieve. Can be an absolute path or path relative to '/'. (ie both "/system" and "system" syntax is supported)

Returns
IFileEntry the IFileEntry or null if file at given path cannot be found

Throws
DeviceNotAvailableException

getFileEntry

public IFileEntry getFileEntry (FileListingService.FileEntry entry)

Unofficial helper to get a FileEntry from a non-root path. FIXME: Refactor the FileEntry system to have it available from any path. (even non root).

Parameters
entry FileListingService.FileEntry : a FileEntry not necessarily root as Ddmlib requires.

Returns
IFileEntry a FileEntryWrapper representing the FileEntry.

Throws
DeviceNotAvailableException

getIDevice

public IDevice getIDevice ()

Returns a reference to the associated ddmlib IDevice .

A new IDevice may be allocated by DDMS each time the device disconnects and reconnects from adb. Thus callers should not keep a reference to the IDevice , because that reference may become stale.

Returns
IDevice the IDevice

getInstalledPackageNames

public  getInstalledPackageNames ()

Fetch the application package names present on the device.

Returns
ERROR(/Set) of String package names currently installed on the device.

Throws
DeviceNotAvailableException

getIpAddress

public String getIpAddress ()

Gets the device's IP address.

Returns
String the device's IP address, or null if device has no IP address

Throws
DeviceNotAvailableException

getKeyguardState

public KeyguardControllerState getKeyguardState ()

Return an object to get the current state of the keyguard or null if not supported.

Returns
KeyguardControllerState a KeyguardControllerState containing a snapshot of the state of the keyguard and returns Null if the Keyguard query is not supported.

Throws
DeviceNotAvailableException

getLastExpectedRebootTimeMillis

public long getLastExpectedRebootTimeMillis ()

Returns the last time Tradefed APIs triggered a reboot in milliseconds since EPOCH as returned by System.currentTimeMillis() .

Returns
long

getLogcat

public InputStreamSource getLogcat ()

Grabs a snapshot stream of the logcat data.

Works in two modes:

  • If the logcat is currently being captured in the background, will return up to TestDeviceOptions#getMaxLogcatDataSize() bytes of the current contents of the background logcat capture
  • Otherwise, will return a static dump of the logcat data if device is currently responding

    Returns
    InputStreamSource

  • getLogcat

    public InputStreamSource getLogcat (int maxBytes)

    Grabs a snapshot stream of the last maxBytes of captured logcat data.

    Useful for cases when you want to capture frequent snapshots of the captured logcat data without incurring the potentially big disk space penalty of getting the entire getLogcat() snapshot.

    Parameters
    maxBytes int : the maximum amount of data to return. Should be an amount that can comfortably fit in memory

    Returns
    InputStreamSource

    getLogcatDump

    public InputStreamSource getLogcatDump ()

    Get a dump of the current logcat for device. Unlike getLogcat() , this method will always return a static dump of the logcat.

    Has the disadvantage that nothing will be returned if device is not reachable.

    Returns
    InputStreamSource a InputStreamSource of the logcat data. An empty stream is returned if fail to capture logcat data.

    getLogcatSince

    public InputStreamSource getLogcatSince (long date)

    Grabs a snapshot stream of captured logcat data starting the date provided. The time on the device should be used getDeviceDate() .

    Parameters
    date long : in millisecond since epoch format of when to start the snapshot until present. (can be be obtained using 'date +%s')

    Returns
    InputStreamSource

    getMacAddress

    public String getMacAddress ()

    Returns the MAC address of the device, null if it fails to query from the device.

    Returns
    String

    getMaxNumberOfRunningUsersSupported

    public int getMaxNumberOfRunningUsersSupported ()

    Get the maximum number of supported simultaneously running users. Defaults to 0.

    Returns
    int an integer indicating the number of simultaneously running users

    Throws
    DeviceNotAvailableException

    getMaxNumberOfUsersSupported

    public int getMaxNumberOfUsersSupported ()

    Get the maximum number of supported users. Defaults to 0.

    Returns
    int an integer indicating the number of supported users

    Throws
    DeviceNotAvailableException

    getMonitor

    public IDeviceStateMonitor getMonitor ()

    Return the IDeviceStateMonitor associated with device.

    Returns
    IDeviceStateMonitor

    getMountPoint

    public String getMountPoint (String mountName)

    Returns a mount point.

    Queries the device directly if the cached info in IDevice is not available.

    TODO: move this behavior to IDevice#getMountPoint(String)

    Parameters
    mountName String : the name of the mount point

    Returns
    String the mount point or null

    getMountPointInfo

    public ITestDevice.MountPointInfo getMountPointInfo (String mountpoint)

    Returns a MountPointInfo corresponding to the specified mountpoint path, or null if that path has nothing mounted or otherwise does not appear in /proc/mounts as a mountpoint.

    Parameters
    mountpoint String

    Returns
    ITestDevice.MountPointInfo A ERROR(/List) of MountPointInfo containing the information in "/proc/mounts"

    Throws
    DeviceNotAvailableException

    getMountPointInfo

    public  getMountPointInfo ()

    Returns a parsed version of the information in /proc/mounts on the device

    Returns
    A ERROR(/List) of MountPointInfo containing the information in "/proc/mounts"

    Throws
    DeviceNotAvailableException

    getOptions

    public TestDeviceOptions getOptions ()

    Fetch the test options for the device.

    Returns
    TestDeviceOptions TestDeviceOptions related to the device under test.

    getPartitionFreeSpace

    public long getPartitionFreeSpace (String partition)

    Helper method to determine amount of free space on device partition.

    Parameters
    partition String

    Returns
    long the amount of free space in KB

    Throws
    DeviceNotAvailableException

    getPrimaryUserId

    public Integer getPrimaryUserId ()

    Returns the primary user id.

    Returns
    Integer the userId of the primary user if there is one, and null if there is no primary user.

    Throws
    DeviceNotAvailableException

    getProcessByName

    public ProcessInfo getProcessByName (String processName)

    Helper method runs the "ps" command and returns USER, PID and NAME of the given process name.

    Parameters
    processName String

    Returns
    ProcessInfo ProcessInfo of given processName

    Throws
    DeviceNotAvailableException

    getProcessPid

    public String getProcessPid (String process)

    Returns the pid of the service or null if something went wrong.

    Parameters
    process String

    Returns
    String

    Throws
    DeviceNotAvailableException

    getProcesses

    public  getProcesses ()

    Helper method runs the "ps" command and returns list of USER, PID and NAME of all the processes.

    Returns
    List of ProcessInfo objects

    Throws
    DeviceNotAvailableException

    getProductType

    public String getProductType ()

    Convenience method to get the product type of this device.

    This method will work if device is in either adb or fastboot mode.

    Returns
    String the String product type name. Will not be null

    Throws
    DeviceNotAvailableException

    getProductVariant

    public String getProductVariant ()

    Convenience method to get the product variant of this device.

    This method will work if device is in either adb or fastboot mode.

    Returns
    String the String product variant name or null if it cannot be determined

    Throws
    DeviceNotAvailableException

    getProperty

    public String getProperty (String name)

    Retrieve the given property value from the device.

    Parameters
    name String : the property name

    Returns
    String the property value or null if it does not exist

    Throws
    DeviceNotAvailableException

    getRecoveryMode

    public ITestDevice.RecoveryMode getRecoveryMode ()

    Get the current recovery mode used for the device.

    Returns
    ITestDevice.RecoveryMode the current recovery mode used for the device.

    getScreenshot

    public InputStreamSource getScreenshot (int displayId)

    Grabs a screenshot from the device given display id. Format is PNG.

    TODO: extend the implementations above to support 'format' and 'rescale'

    Parameters
    displayId int : the display id of the screen to get screenshot from.

    Returns
    InputStreamSource a InputStreamSource of the screenshot in format, or null if the screenshot was not successful.

    Throws
    DeviceNotAvailableException

    getScreenshot

    public InputStreamSource getScreenshot (String format)

    Grabs a screenshot from the device. Recommended to use getScreenshot(format) instead with JPEG encoding for smaller size

    Parameters
    format String : supported PNG, JPEG

    Returns
    InputStreamSource a InputStreamSource of the screenshot in format, or null if the screenshot was not successful.

    Throws
    DeviceNotAvailableException

    getScreenshot

    public InputStreamSource getScreenshot (String format, 
                    boolean rescale)

    Grabs a screenshot from the device. Recommended to use getScreenshot(String) instead with JPEG encoding for smaller size.

    Parameters
    format String : supported PNG, JPEG

    rescale boolean : if screenshot should be rescaled to reduce the size of resulting image

    Returns
    InputStreamSource a InputStreamSource of the screenshot in format, or null if the screenshot was not successful.

    Throws
    DeviceNotAvailableException

    getScreenshot

    public InputStreamSource getScreenshot ()

    Grabs a screenshot from the device.

    Returns
    InputStreamSource a InputStreamSource of the screenshot in png format, or null if the screenshot was not successful.

    Throws
    DeviceNotAvailableException

    getSerialNumber

    public String getSerialNumber ()

    Convenience method to get serial number of this device.

    Returns
    String the String serial number

    getSetting

    public String getSetting (int userId, 
                    String namespace, 
                    String key)

    Return the value of the requested setting. namespace must be one of: {"system", "secure", "global"}

    Parameters
    userId int

    namespace String

    key String

    Returns
    String the value associated with the namespace:key of a user. Null if not found.

    Throws
    DeviceNotAvailableException

    getSetting

    public String getSetting (String namespace, 
                    String key)

    See getSetting(int, String, String) and performed on system user.

    Parameters
    namespace String

    key String

    Returns
    String

    Throws
    DeviceNotAvailableException

    getSimOperator

    public String getSimOperator ()

    Return the SIM card operator or null if device is not available.

    Returns
    String

    getSimState

    public String getSimState ()

    Return the SIM card state or null if device is not available.

    Returns
    String

    getTombstones

    public  getTombstones ()

    Fetch and return the list of tombstones from the devices. Requires root.

    method is best-effort so if one tombstone fails to be pulled for any reason it will be missing from the list. Only a DeviceNotAvailableException will terminate the method early.

    Returns
    A list of tombstone files, empty if no tombstone.

    Throws
    DeviceNotAvailableException

    getTotalMemory

    public long getTotalMemory ()

    Returns total physical memory size in bytes or -1 in case of internal error

    Returns
    long

    getUninstallablePackageNames

    public  getUninstallablePackageNames ()

    Fetch the application package names that can be uninstalled. This is presently defined as non-system packages, and updated system packages.

    Returns
    ERROR(/Set) of uninstallable String package names currently installed on the device.

    Throws
    DeviceNotAvailableException

    getUseFastbootErase

    public boolean getUseFastbootErase ()

    Get whether to use fastboot erase or fastboot format to wipe a partition on the device.

    Returns
    boolean true if fastboot erase will be used or false if fastboot format will be used.

    getUserFlags

    public int getUserFlags (int userId)

    Find and return the flags of a given user. Flags are defined in "android.content.pm.UserInfo" class in Android Open Source Project.

    Parameters
    userId int

    Returns
    int the flags associated with the userId provided if found, -10000 in any other cases.

    Throws
    DeviceNotAvailableException

    getUserInfos

    public  getUserInfos ()

    Gets the Map of useId to UserInfo on the device. Will throw DeviceRuntimeException if output from device is not as expected.

    Returns
    the list of UserInfo objects.

    Throws
    DeviceNotAvailableException

    getUserSerialNumber

    public int getUserSerialNumber (int userId)

    Return the serial number associated to the userId if found, -10000 in any other cases.

    Parameters
    userId int

    Returns
    int

    Throws
    DeviceNotAvailableException

    handleAllocationEvent

    public IManagedTestDevice.DeviceEventResponse handleAllocationEvent (DeviceEvent event)

    Process the given DeviceEvent . May transition device to new state. Will inform the IDeviceMonitor of any state transitions.

    Process the DeviceEvent, which may or may not transition this device to a new allocation state.

    Parameters
    event DeviceEvent

    Returns
    IManagedTestDevice.DeviceEventResponse

    hasFeature

    public boolean hasFeature (String feature)

    Check if a feature is available on a device.

    Parameters
    feature String : which format should be "feature: ".

    Returns
    boolean True if feature is found, false otherwise.

    Throws
    DeviceNotAvailableException

    installPackage

    public String installPackage (File packageFile, 
                    boolean reinstall, 
                    String... extraArgs)

    Install an Android package on device.

    Parameters
    packageFile File : the apk file to install

    reinstall boolean : true if a reinstall should be performed

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

    Returns
    String a String with an error code, or null if success.

    Throws
    DeviceNotAvailableException

    installPackage

    public String installPackage (File packageFile, 
                    boolean reinstall, 
                    boolean grantPermissions, 
                    String... extraArgs)

    Install an Android package on device.

    Note: Only use cases that requires explicit control of granting runtime permission at install time should call this function.

    Parameters
    packageFile File : the apk file to install

    reinstall boolean : true if a reinstall should be performed

    grantPermissions boolean : if all runtime permissions should be granted at install time

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

    Returns
    String a String with an error code, or null if success.

    Throws
    DeviceNotAvailableException

    installPackageForUser

    public String installPackageForUser (File packageFile, 
                    boolean reinstall, 
                    int userId, 
                    String... extraArgs)

    Install an Android package on device for a given user.

    Parameters
    packageFile File : the apk file to install

    reinstall boolean : true if a reinstall should be performed

    userId int : the integer user id to install for.

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

    Returns
    String a String with an error code, or null if success.

    Throws
    DeviceNotAvailableException

    installPackageForUser

    public String installPackageForUser (File packageFile, 
                    boolean reinstall, 
                    boolean grantPermissions, 
                    int userId, 
                    String... extraArgs)

    Install an Android package on device for a given user.

    Note: Only use cases that requires explicit control of granting runtime permission at install time should call this function.

    Parameters
    packageFile File : the apk file to install

    reinstall boolean : true if a reinstall should be performed

    grantPermissions boolean : if all runtime permissions should be granted at install time

    userId int : the integer user id to install for.

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

    Returns
    String a String with an error code, or null if success.

    Throws
    DeviceNotAvailableException

    isAdbRoot

    public boolean isAdbRoot ()

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    isAdbTcp

    public boolean isAdbTcp ()

    Returns
    boolean

    isDeviceEncrypted

    public boolean isDeviceEncrypted ()

    Returns if the device is encrypted.

    Returns
    boolean true if the device is encrypted.

    Throws
    DeviceNotAvailableException

    isDirectory

    public boolean isDirectory (String path)

    Return True if the path on the device is a directory, false otherwise.

    Parameters
    path String

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    isEnableAdbRoot

    public boolean isEnableAdbRoot ()

    Returns
    boolean true if adb root should be enabled on device

    isEncryptionSupported

    public boolean isEncryptionSupported ()

    Returns if encryption is supported on the device.

    Returns
    boolean true if the device supports encryption.

    Throws
    DeviceNotAvailableException

    isExecutable

    public boolean isExecutable (String fullPath)

    Returns True if the file path on the device is an executable file, false otherwise.

    Parameters
    fullPath String

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    isFastbootEnabled

    public boolean isFastbootEnabled ()

    Return if fastboot is available for the device.

    Returns
    boolean

    isHeadless

    public boolean isHeadless ()

    Return true if the device is headless (no screen), false otherwise.

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    isMultiUserSupported

    public boolean isMultiUserSupported ()

    Determines if multi user is supported.

    Returns
    boolean true if multi user is supported, false otherwise

    Throws
    DeviceNotAvailableException

    isPackageInstalled

    public boolean isPackageInstalled (String packageName, 
                    String userId)

    Query the device for a given package name and given user id to check if it's currently installed or not for that user.

    Parameters
    packageName String : the package we are checking if it's installed.

    userId String : The user id we are checking the package is installed for. If null, primary user zero will be used.

    Returns
    boolean True if the package is reported as installed. False otherwise.

    Throws
    DeviceNotAvailableException

    isPackageInstalled

    public boolean isPackageInstalled (String packageName)

    Query the device for a given package name to check if it's currently installed or not.

    Parameters
    packageName String

    Returns
    boolean True if the package is reported as installed. False otherwise.

    Throws
    DeviceNotAvailableException

    isRuntimePermissionSupported

    public boolean isRuntimePermissionSupported ()

    Check whether platform on device supports runtime permission granting

    Returns
    boolean True if runtime permission are supported, false otherwise.

    Throws
    DeviceNotAvailableException

    isUserRunning

    public boolean isUserRunning (int userId)

    Check if a given user is running.

    Parameters
    userId int

    Returns
    boolean True if the user is running, false in every other cases.

    Throws
    DeviceNotAvailableException

    isUserSecondary

    public boolean isUserSecondary (int userId)

    Return whether the specified user is a secondary user according to it's flags.

    Parameters
    userId int

    Returns
    boolean true if the user is secondary, false otherwise.

    Throws
    DeviceNotAvailableException

    isWifiEnabled

    public boolean isWifiEnabled ()

    Test if wifi is enabled.

    Checks if wifi is enabled on device. Useful for asserting wifi status before tests that shouldn't run with wifi, eg mobile data tests.

    Returns
    boolean true if wifi is enabled. false if disabled

    Throws
    DeviceNotAvailableException

    listDisplayIds

    public  listDisplayIds ()

    Collect the list of available displays id on the device as reported by "dumpsys SurfaceFlinger".

    Returns
    The list of displays. Default always returns the default display 0.

    Throws
    DeviceNotAvailableException

    listUsers

    public  listUsers ()

    Gets the list of users on the device. Will throw DeviceRuntimeException if output from device is not as expected.

    Returns
    the list of user ids.

    Throws
    DeviceNotAvailableException

    logBugreport

    public boolean logBugreport (String dataName, 
                    ITestLogger listener)

    Helper method to take a bugreport and log it to the reporters.

    Parameters
    dataName String : name under which the bugreport will be reported.

    listener ITestLogger : an ITestLogger to log the bugreport.

    Returns
    boolean True if the logging was successful, false otherwise.

    logOnDevice

    public void logOnDevice (String tag, 
                    Log.LogLevel level, 
                    String format, 
                    Object... args)

    Log a message in the logcat of the device. This is a safe call that will not throw even if the logging fails.

    Parameters
    tag String : The tag under which we log our message in the logcat.

    level Log.LogLevel : The debug level of the message in the logcat.

    format String : The message format.

    args Object : the args to be replaced via String.format().

    nonBlockingReboot

    public void nonBlockingReboot ()

    Issues a command to reboot device and returns on command complete and when device is no longer visible to adb.

    Throws
    DeviceNotAvailableException

    postAdbRootAction

    public void postAdbRootAction ()

    Override if the device needs some specific actions to be taken after adb root and before the device is back online. Default implementation doesn't include any addition actions. adb root is not guaranteed to be enabled at this stage.

    Throws
    DeviceNotAvailableException

    postAdbUnrootAction

    public void postAdbUnrootAction ()

    Override if the device needs some specific actions to be taken after adb unroot and before the device is back online. Default implementation doesn't include any additional actions. adb root is not guaranteed to be disabled at this stage.

    Throws
    DeviceNotAvailableException

    postBootSetup

    public void postBootSetup ()

    Perform instructions to configure device for testing that after every boot.

    Should be called after device is fully booted/available

    In normal circumstances this method doesn't need to be called explicitly, as implementations should perform these steps automatically when performing a reboot.

    Where it may need to be called is when device reboots due to other events (eg when a fastboot update command has completed)

    Throws
    DeviceNotAvailableException

    postInvocationTearDown

    public void postInvocationTearDown ()

    Extra steps for device specific required clean up that will be executed after the invocation is done.

    preInvocationSetup

    public void preInvocationSetup ( IBuildInfo info)

    Extra steps for device specific required setup that will be executed on the device prior to the invocation flow.

    Parameters
    info IBuildInfo

    Throws
    DeviceNotAvailableException
    TargetSetupError

    pullDir

    public boolean pullDir (String deviceFilePath, 
                    File localDir)

    Recursively pull directory contents from device.

    Parameters
    deviceFilePath String : the absolute file path of the remote source

    localDir File : the local directory to pull files into

    Returns
    boolean true if file was pulled successfully. false otherwise.

    Throws
    DeviceNotAvailableException

    pullFile

    public boolean pullFile (String remoteFilePath, 
                    File localFile)

    Retrieves a file off device.

    Parameters
    remoteFilePath String : the absolute path to file on device.

    localFile File : the local file to store contents in. If non-empty, contents will be replaced.

    Returns
    boolean true if file was retrieved successfully. false otherwise.

    Throws
    DeviceNotAvailableException

    pullFile

    public File pullFile (String remoteFilePath)

    Retrieves a file off device, stores it in a local temporary ERROR(/File) , and returns that File .

    Parameters
    remoteFilePath String : the absolute path to file on device.

    Returns
    File A ERROR(/File) containing the contents of the device file, or null if the copy failed for any reason (including problems with the host filesystem)

    Throws
    DeviceNotAvailableException

    pullFileContents

    public String pullFileContents (String remoteFilePath)

    Retrieves a file off device, and returns the contents.

    Parameters
    remoteFilePath String : the absolute path to file on device.

    Returns
    String A String containing the contents of the device file, or null if the copy failed for any reason (including problems with the host filesystem)

    Throws
    DeviceNotAvailableException

    pullFileFromExternal

    public File pullFileFromExternal (String remoteFilePath)

    A convenience method to retrieve a file from the device's external storage, stores it in a local temporary ERROR(/File) , and return a reference to that File .

    Parameters
    remoteFilePath String : the path to file on device, relative to the device's external storage mountpoint

    Returns
    File A ERROR(/File) containing the contents of the device file, or null if the copy failed for any reason (including problems with the host filesystem)

    Throws
    DeviceNotAvailableException

    pushDir

    public boolean pushDir (File localFileDir, 
                    String deviceFilePath, 
                     excludedDirectories)

    Recursively push directory contents to device while excluding some directories that are filtered.

    Parameters
    localFileDir File : the local directory to push

    deviceFilePath String : the absolute file path of the remote destination

    excludedDirectories : Set of excluded directories names that shouldn't be pushed.

    Returns
    boolean true if file was pushed successfully. false otherwise.

    Throws
    DeviceNotAvailableException

    pushDir

    public boolean pushDir (File localFileDir, 
                    String deviceFilePath)

    Recursively push directory contents to device.

    Parameters
    localFileDir File : the local directory to push

    deviceFilePath String : the absolute file path of the remote destination

    Returns
    boolean true if file was pushed successfully. false otherwise.

    Throws
    DeviceNotAvailableException

    pushFile

    public boolean pushFile (File localFile, 
                    String remoteFilePath)

    Push a file to device

    Parameters
    localFile File : the local file to push

    remoteFilePath String : the remote destination absolute file path

    Returns
    boolean true if file was pushed successfully. false otherwise.

    Throws
    DeviceNotAvailableException

    pushString

    public boolean pushString (String contents, 
                    String remoteFilePath)

    Push file created from a string to device

    Parameters
    contents String : the contents of the file to push

    remoteFilePath String : the remote destination absolute file path

    Returns
    boolean true if string was pushed successfully. false otherwise.

    Throws
    DeviceNotAvailableException

    reboot

    public void reboot ()

    Reboots the device into adb mode.

    Blocks until device becomes available.

    Throws
    DeviceNotAvailableException

    rebootIntoBootloader

    public void rebootIntoBootloader ()

    Reboots the device into bootloader mode.

    Blocks until device is in bootloader mode.

    Throws
    DeviceNotAvailableException

    rebootIntoRecovery

    public void rebootIntoRecovery ()

    Reboots the device into adb recovery mode.

    Blocks until device enters recovery

    Throws
    DeviceNotAvailableException

    rebootUntilOnline

    public void rebootUntilOnline ()

    An alternate to reboot() that only blocks until device is online ie visible to adb.

    Throws
    DeviceNotAvailableException

    recoverDevice

    public void recoverDevice ()

    Attempts to recover device communication.

    Throws
    DeviceNotAvailableException if device is not longer available

    remountSystemWritable

    public void remountSystemWritable ()

    Make the system partition on the device writable. May reboot the device.

    Throws
    DeviceNotAvailableException

    removeAdmin

    public boolean removeAdmin (String componentName, 
                    int userId)

    Remove given device admin in given user and return true if it is successful, false otherwise.

    Parameters
    componentName String : of device admin to be removed.

    userId int : of user that the device admin lives in.

    Returns
    boolean True if it is successful, false otherwise.

    Throws
    DeviceNotAvailableException

    removeOwners

    public void removeOwners ()

    Remove all existing device profile owners with the best effort.

    Throws
    DeviceNotAvailableException

    removeUser

    public boolean removeUser (int userId)

    Remove a given user from the device.

    Parameters
    userId int : of the user to remove

    Returns
    boolean true if we were successful in removing the user, false otherwise.

    Throws
    DeviceNotAvailableException

    runInstrumentationTests

    public boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, 
                    ITestLifeCycleReceiver... listeners)

    Convenience method for performing ERROR(/#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection)) with one or more listeners passed as parameters.

    Parameters
    runner IRemoteAndroidTestRunner : the IRemoteAndroidTestRunner which runs the tests

    listeners ITestLifeCycleReceiver : the test result listener(s)

    Returns
    boolean true if test command completed. false if it failed to complete, but recovery succeeded

    Throws
    DeviceNotAvailableException

    runInstrumentationTests

    public boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, 
                     listeners)

    Runs instrumentation tests, and provides device recovery.

    If connection with device is lost before test run completes, and recovery succeeds, all listeners will be informed of testRunFailed and "false" will be returned. The test command will not be rerun. It is left to callers to retry if necessary.

    If connection with device is lost before test run completes, and recovery fails, all listeners will be informed of testRunFailed and DeviceNotAvailableException will be thrown.

    Parameters
    runner IRemoteAndroidTestRunner : the IRemoteAndroidTestRunner which runs the tests

    listeners : the test result listeners

    Returns
    boolean true if test command completed. false if it failed to complete due to device communication exception, but recovery succeeded

    Throws
    DeviceNotAvailableException

    runInstrumentationTestsAsUser

    public boolean runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, 
                    int userId, 
                    ITestLifeCycleReceiver... listeners)

    Same as ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, ITestLifeCycleReceiver...) but runs the test for a given user.

    Parameters
    runner IRemoteAndroidTestRunner

    userId int

    listeners ITestLifeCycleReceiver

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    runInstrumentationTestsAsUser

    public boolean runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, 
                    int userId, 
                     listeners)

    Same as ERROR(ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection)/com.android.tradefed.device.ITestDevice#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection) ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection)) but runs the test for the given user.

    Parameters
    runner IRemoteAndroidTestRunner

    userId int

    listeners

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    setDate

    public void setDate (Date date)

    Sets the date on device

    Note: setting date on device requires root

    Parameters
    date Date : specify a particular date; will use host date if null

    Throws
    DeviceNotAvailableException

    setDeviceOwner

    public boolean setDeviceOwner (String componentName, 
                    int userId)

    Set a device admin component as device owner in given user.

    Parameters
    componentName String : of device admin to be device owner.

    userId int : of the user that the device owner lives in.

    Returns
    boolean True if it is successful, false otherwise.

    Throws
    DeviceNotAvailableException

    setDeviceState

    public void setDeviceState ( TestDeviceState deviceState)

    Update the device's state.

    Parameters
    deviceState TestDeviceState : the TestDeviceState

    setEmulatorOutputStream

    public void setEmulatorOutputStream ( SizeLimitedOutputStream output)

    For emulator set SizeLimitedOutputStream to log output

    Parameters
    output SizeLimitedOutputStream : to log the output

    setEmulatorProcess

    public void setEmulatorProcess (Process p)

    Sets the Process , when this device is an emulator.

    Parameters
    p Process

    setFastbootEnabled

    public void setFastbootEnabled (boolean fastbootEnabled)

    Set the fastboot option for the device. Should be set when device is first allocated.

    Parameters
    fastbootEnabled boolean : whether fastboot is available for the device or not

    setFastbootPath

    public void setFastbootPath (String fastbootPath)

    Sets the path to the fastboot binary that should be used. Still requires isFastbootEnabled() to be true, to have fastboot functions enabled.

    Parameters
    fastbootPath String

    setIDevice

    public void setIDevice (IDevice newDevice)

    Update the IDevice associated with this ITestDevice.

    The new IDevice must refer the same physical device as the current reference. This method will be called if DDMS has allocated a new IDevice

    Parameters
    newDevice IDevice : the IDevice

    setOptions

    public void setOptions ( TestDeviceOptions options)

    Set the TestDeviceOptions for the device

    Parameters
    options TestDeviceOptions

    setProperty

    public boolean setProperty (String propKey, 
                    String propValue)

    Sets the given property value on the device. Requires adb root is true.

    Parameters
    propKey String : The key targeted to be set.

    propValue String : The property value to be set.

    Returns
    boolean returns True if the setprop command was successful, False otherwise.

    Throws
    DeviceNotAvailableException

    setRecovery

    public void setRecovery ( IDeviceRecovery recovery)

    Set the IDeviceRecovery to use for this device. Should be set when device is first allocated.

    Parameters
    recovery IDeviceRecovery : the IDeviceRecovery

    setRecoveryMode

    public void setRecoveryMode ( ITestDevice.RecoveryMode mode)

    Set the current recovery mode to use for the device.

    Used to control what recovery method to use when a device communication problem is encountered. Its recommended to only use this method sparingly when needed (for example, when framework is down, etc

    Parameters
    mode ITestDevice.RecoveryMode : whether 'recover till online only' mode should be on or not.

    setSetting

    public void setSetting (String namespace, 
                    String key, 
                    String value)

    See setSetting(int, String, String, String) and performed on system user.

    Parameters
    namespace String

    key String

    value String

    Throws
    DeviceNotAvailableException

    setSetting

    public void setSetting (int userId, 
                    String namespace, 
                    String key, 
                    String value)

    Add a setting value to the namespace of a given user. Some settings will only be available after a reboot. namespace must be one of: {"system", "secure", "global"}

    Parameters
    userId int

    namespace String

    key String

    value String

    Throws
    DeviceNotAvailableException

    setUseFastbootErase

    public void setUseFastbootErase (boolean useFastbootErase)

    Set whether to use fastboot erase or fastboot format to wipe a partition on the device.

    Parameters
    useFastbootErase boolean : true if fastboot erase should be used or false if fastboot format should be used.

    startLogcat

    public void startLogcat ()

    Start capturing logcat output from device in the background.

    Will have no effect if logcat output is already being captured. Data can be later retrieved via getLogcat.

    When the device is no longer in use, stopLogcat() must be called.

    startLogcat() and stopLogcat() do not normally need to be called when within a TF invocation context, as the TF framework will start and stop logcat.

    startUser

    public boolean startUser (int userId)

    Starts a given user in the background if it is currently stopped. If the user is already running in the background, this method is a NOOP.

    Parameters
    userId int : of the user to start in the background

    Returns
    boolean true if the user was successfully started in the background.

    Throws
    DeviceNotAvailableException

    startUser

    public boolean startUser (int userId, 
                    boolean waitFlag)

    Starts a given user in the background if it is currently stopped. If the user is already running in the background, this method is a NOOP. Possible to provide extra flag to wait for the operation to have effect.

    Parameters
    userId int : of the user to start in the background

    waitFlag boolean : will make the command wait until user is started and unlocked.

    Returns
    boolean true if the user was successfully started in the background.

    Throws
    DeviceNotAvailableException

    stopEmulatorOutput

    public void stopEmulatorOutput ()

    Close and delete the emulator output.

    stopLogcat

    public void stopLogcat ()

    Stop capturing logcat output from device, and discard currently saved logcat data.

    Will have no effect if logcat output is not being captured.

    stopUser

    public boolean stopUser (int userId)

    Stops a given user. If the user is already stopped, this method is a NOOP. Cannot stop current and system user.

    Parameters
    userId int : of the user to stop.

    Returns
    boolean true if the user was successfully stopped.

    Throws
    DeviceNotAvailableException

    stopUser

    public boolean stopUser (int userId, 
                    boolean waitFlag, 
                    boolean forceFlag)

    Stop a given user. Possible to provide extra flags to wait for the operation to have effect, and force terminate the user. Cannot stop current and system user.

    Parameters
    userId int : of the user to stop.

    waitFlag boolean : will make the command wait until user is stopped.

    forceFlag boolean : will force stop the user.

    Returns
    boolean true if the user was successfully stopped.

    Throws
    DeviceNotAvailableException

    switchToAdbTcp

    public String switchToAdbTcp ()

    Switch device to adb-over-tcp mode.

    Returns
    String the tcp serial number or null if device could not be switched

    Throws
    DeviceNotAvailableException

    switchToAdbUsb

    public boolean switchToAdbUsb ()

    Switch device to adb over usb mode.

    Returns
    boolean true if switch was successful, false otherwise.

    Throws
    DeviceNotAvailableException

    switchUser

    public boolean switchUser (int userId)

    Switch to another userId with a default timeout. switchUser(int, long) .

    Parameters
    userId int

    Returns
    boolean True if the new userId matches the userId provider. False otherwise.

    Throws
    DeviceNotAvailableException

    switchUser

    public boolean switchUser (int userId, 
                    long timeout)

    Switch to another userId with the provided timeout as deadline. Attempt to disable keyguard after user change is successful.

    Parameters
    userId int

    timeout long : to wait before returning false for switch-user failed.

    Returns
    boolean True if the new userId matches the userId provider. False otherwise.

    Throws
    DeviceNotAvailableException

    syncFiles

    public boolean syncFiles (File localFileDir, 
                    String deviceFilePath)

    Incrementally syncs the contents of a local file directory to device.

    Decides which files to push by comparing timestamps of local files with their remote equivalents. Only 'newer' or non-existent files will be pushed to device. Thus overhead should be relatively small if file set on device is already up to date.

    Hidden files (with names starting with ".") will be ignored.

    Example usage: syncFiles("/tmp/files", "/sdcard") will created a /sdcard/files directory if it doesn't already exist, and recursively push the /tmp/files contents to /sdcard/files.

    Parameters
    localFileDir File : the local file directory containing files to recursively push.

    deviceFilePath String : the remote destination absolute file path root. All directories in thos file path must be readable. ie pushing to /data/local/tmp when adb is not root will fail

    Returns
    boolean true if files were synced successfully. false otherwise.

    Throws
    DeviceNotAvailableException

    takeBugreport

    public Bugreport takeBugreport ()

    Take a bugreport and returns it inside a Bugreport object to handle it. Return null in case of issue.

    File referenced in the Bugreport object need to be cleaned via Bugreport#close() .

    Returns
    Bugreport

    unencryptDevice

    public boolean unencryptDevice ()

    Unencrypts the device.

    Unencrypting the device may cause device to be wiped and may reboot device. This method will block until device is available and ready for testing. Requires fastboot inorder to wipe the userdata partition.

    Returns
    boolean true if successful.

    Throws
    DeviceNotAvailableException

    uninstallPackage

    public String uninstallPackage (String packageName)

    Uninstall an Android package from device.

    Parameters
    packageName String : the Android package to uninstall

    Returns
    String a String with an error code, or null if success.

    Throws
    DeviceNotAvailableException

    unlockDevice

    public boolean unlockDevice ()

    Unlocks the device if the device is in an encrypted state.

    This method may restart the framework but will not call postBootSetup() . Therefore, the device might not be fully ready to be tested when this method returns.

    Returns
    boolean true if successful or if the device is unencrypted.

    Throws
    DeviceNotAvailableException

    waitForBootComplete

    public boolean waitForBootComplete (long timeOut)

    Blocks until the device's boot complete flag is set.

    Parameters
    timeOut long : time in msecs to wait for the flag to be set

    Returns
    boolean true if device's boot complete flag is set within the timeout

    Throws
    DeviceNotAvailableException

    waitForDeviceAvailable

    public void waitForDeviceAvailable ()

    Waits for the device to be responsive and available for testing. Uses default timeout.

    Throws
    DeviceNotAvailableException

    waitForDeviceAvailable

    public void waitForDeviceAvailable (long waitTime)

    Waits for the device to be responsive and available for testing.

    Parameters
    waitTime long : the time in ms to wait

    Throws
    DeviceNotAvailableException

    waitForDeviceInRecovery

    public boolean waitForDeviceInRecovery (long waitTime)

    Blocks for the device to be in the 'adb recovery' state (note this is distinct from IDeviceRecovery ).

    Parameters
    waitTime long : the time in ms to wait

    Returns
    boolean true if device boots into recovery before time expires. false otherwise

    waitForDeviceNotAvailable

    public boolean waitForDeviceNotAvailable (long waitTime)

    Blocks for the device to be not available ie missing from adb

    Parameters
    waitTime long : the time in ms to wait

    Returns
    boolean true if device becomes not available before time expires. false otherwise

    waitForDeviceOnline

    public void waitForDeviceOnline ()

    Blocks until device is visible via adb. Uses default timeout

    Note the device may not necessarily be responsive to commands on completion. Use waitForDeviceAvailable() instead.

    Throws
    DeviceNotAvailableException

    waitForDeviceOnline

    public void waitForDeviceOnline (long waitTime)

    Blocks until device is visible via adb.

    Note the device may not necessarily be responsive to commands on completion. Use waitForDeviceAvailable() instead.

    Parameters
    waitTime long : the time in ms to wait

    Throws
    DeviceNotAvailableException

    waitForDeviceShell

    public boolean waitForDeviceShell (long waitTime)

    Waits for device to be responsive to a basic adb shell command.

    Parameters
    waitTime long : the time in ms to wait

    Returns
    boolean true if device becomes responsive before waitTime elapses.

    Protected methods

    checkApiLevelAgainst

    protected void checkApiLevelAgainst (String feature, 
                    int strictMinLevel)

    Parameters
    feature String

    strictMinLevel int

    createRebootDeviceAction

    protected NativeDevice.RebootDeviceAction createRebootDeviceAction (String into)

    Create a RebootDeviceAction to be used when performing a reboot action.

    Parameters
    into String : the bootloader name to reboot into, or null to just reboot the device.

    Returns
    NativeDevice.RebootDeviceAction the created RebootDeviceAction .

    doAdbReboot

    protected void doAdbReboot (String into)

    Perform a adb reboot.

    Parameters
    into String : the bootloader name to reboot into, or null to just reboot the device.

    Throws
    DeviceNotAvailableException

    ensureRuntimePermissionSupported

    protected void ensureRuntimePermissionSupported ()

    helper method to throw exception if runtime permission isn't supported

    Throws
    DeviceNotAvailableException

    getBugreportInternal

    protected InputStreamSource getBugreportInternal ()

    Returns
    InputStreamSource

    getBugreportzInternal

    protected File getBugreportzInternal ()

    Internal Helper method to get the bugreportz zip file as a ERROR(/File) .

    Returns
    File

    getRunUtil

    protected IRunUtil getRunUtil ()

    Get the RunUtil instance to use.

    Returns
    IRunUtil

    internalGetProperty

    protected String internalGetProperty (String propName, 
                    String fastbootVar, 
                    String description)

    Fetch a device property, from the ddmlib cache by default, and falling back to either `adb shell getprop` or `fastboot getvar` depending on whether the device is in Fastboot or not.

    Parameters
    propName String : The name of the device property as returned by `adb shell getprop`

    fastbootVar String : The name of the equivalent fastboot variable to query. if null , fastboot query will not be attempted

    description String : A simple description of the variable. First letter should be capitalized.

    Returns
    String A string, possibly null or empty, containing the value of the given property

    Throws
    DeviceNotAvailableException

    isNewer

    protected boolean isNewer (File localFile, 
                    IFileEntry entry)

    Return true if local file is newer than remote file. IFileEntry being accurate to the minute, in case of equal times, the file will be considered newer.

    Parameters
    localFile File

    entry IFileEntry

    Returns
    boolean

    performDeviceAction

    protected boolean performDeviceAction (String actionDescription, 
                    com.android.tradefed.device.NativeDevice.DeviceAction action, 
                    int retryAttempts)

    Performs an action on this device. Attempts to recover device and optionally retry command if action fails.

    Parameters
    actionDescription String : a short description of action to be performed. Used for logging purposes only.

    action com.android.tradefed.device.NativeDevice.DeviceAction : the action to be performed

    retryAttempts int : the retry attempts to make for action if it fails but recovery succeeds

    Returns
    boolean true if action was performed successfully

    Throws
    DeviceNotAvailableException if recovery attempt fails or max attempts done without success

    postAdbReboot

    protected void postAdbReboot ()

    Possible extra actions that can be taken after a reboot.

    Throws
    DeviceNotAvailableException

    prePostBootSetup

    protected void prePostBootSetup ()

    Allows each device type (AndroidNativeDevice, TestDevice) to override this method for specific post boot setup.

    Throws
    DeviceNotAvailableException

    setClock

    protected void setClock (Clock clock)

    Set the Clock instance to use.

    Parameters
    clock Clock

    setLogStartDelay

    protected void setLogStartDelay (int delay)

    Sets the time in ms to wait before starting logcat capture for a online device.

    Parameters
    delay int : the delay in ms

    waitForDeviceNotAvailable

    protected void waitForDeviceNotAvailable (String operationDesc, 
                    long time)

    Parameters
    operationDesc String

    time long