TestDeviceOptions

public class TestDeviceOptions
extends Object

java.lang.Object
   ↳ com.android.tradefed.device.TestDeviceOptions


ITestDevice Option 的容器

摘要

常量

int DEFAULT_ADB_PORT

String INSTANCE_TYPE_OPTION

String REMOTE_TF_VERSION_OPTION

字段

protected long mAdbConnectWaitTime

公共构造函数

TestDeviceOptions()

公共方法

void addGceDriverParams(String param)

向 GCE 驱动程序参数添加了一个参数。

boolean allowGceCmdTimeoutOverride()

返回是否应依赖来自 acloud 的启动超时参数(如果存在)。

boolean evaluateDeviceConnection()
File getAdbBinary()

返回要使用的指定 adb 二进制文件。

long getAdbCommandTimeout()
long getAdbConnectWaitTime()

返回要应用于 ADB 连接的超时值(以毫秒为单位)。

int getAdbRecoveryTimeout()
long getAdbRootUnavailableTimeout()
String getAdbServerPort()

返回与设备关联的 adb 服务器端口。

long getAvailableTimeout()
File getAvdConfigFile()

返回 GCE AVD 配置文件以启动实例。

File getAvdDriverBinary()

返回用于启动 GCE AVD 实例的二进制文件的路径。

String getBaseImage()

返回要用于当前实例的基础映像名称

long getBugreportzTimeout()

返回要应用于 bugreportz 捕获的超时值。

String getConnCheckUrl()
static String getCreateCommandByInstanceType(TestDeviceOptions.InstanceType type)
String getCrosPassword()

返回用于登录 ChromeOS 的密码。

String getCrosUser()

返回要登录的 Chrome OS 用户。

Integer getCutoffBattery()
String getDefaultNetworkType()
MultiMap<File, String> getExtraFiles()

返回在 acloud 创建期间需要上传到 GCE 的额外文件。

getExtraOxygenArgs()

返回用于租用 Oxygen 设备的额外实参。

static getExtraParamsByInstanceType(TestDeviceOptions.InstanceType type, String baseImage)
File getFastbootBinary()

返回要使用的指定 fastboot 二进制文件。

long getFastbootOutputTimeout()
int getFastbootTimeout()
String getGceAccount()

返回要与驱动程序搭配使用的 GCE 电子邮件账号

long getGceCmdTimeout()

返回 GCE AVD 超时时间,以便实例上线。

String getGceDriverBuildIdParam()

返回应与 build 信息中的 build ID 配对的 GCE 驱动程序参数

MultiMap<String, File> getGceDriverFileParams()

以通过选项提供的 GCE 驱动程序参数形式返回其他文件路径。

Log.LogLevel getGceDriverLogLevel()

返回 GCE AVD 驱动程序的日志级别。

getGceDriverParams()

返回通过选项提供的其他 GCE 驱动程序参数

int getGceMaxAttempt()

返回启动 GCE 设备的尝试次数上限

TestDeviceOptions.InstanceType getInstanceType()

返回应创建的虚拟设备的实例类型

String getInstanceUser()

返回应创建的 GCE 虚拟设备的实例用户

getInvocationAttributeToMetadata()
String getLogcatOptions()
long getMaxLogcatDataSize()

获取要保留的临时 logcat 数据的大致最大大小(以字节为单位)。

long getMaxWifiConnectTime()
long getOnlineTimeout()
String getOxygenAccountingUser()

返回 Oxygen 设备的会计用户。

TestDeviceOptions.DeviceSize getOxygenDeviceSize()

返回 Oxygen 虚拟设备将运行的主机的大小。

long getOxygenLeaseLength()

返回 Oxygen 设备租用时长(以毫秒为单位)。

String getOxygenServiceAddress()

返回 Oxygen 设备的相应服务地址。

String getOxygenTargetRegion()

返回 Oxygen 设备的目标地区。

getPostBootCommands()
int getRebootTimeout()
int getRemoteAdbPort()

返回 adb 服务器监听的实例中的远程端口

getRemoteFetchFilePattern()

返回要尝试通过 scp 提取的模式列表。

File getRemoteTf()

指向要推送到远程设备的 Tradefed 版本目录的文件。

File getServiceAccountJsonKeyFile()
long getSnapuserdTimeout()
File getSshPrivateKeyPath()

返回要用于与 Gce Avd 实例进行操作的 ssh 密钥的路径。

int getUnencryptRebootTimeout()
boolean getUseFastbootErase()
int getWifiAttempts()
int getWifiRetryWaitTime()
String getWifiUtilAPKPath()
boolean isCmdWifiVirtual()
boolean isDisableKeyguard()

检查是否应在启动完成后尝试停用锁屏

boolean isEnableAdbRoot()

检查是否应在启动时为此设备启用 adb root

boolean isLogcatCaptureEnabled()
boolean isWifiExpoRetryEnabled()
void setAdbCommandTimeout(long adbCommandTimeout)

设置发送命令的超时时间(以毫秒为单位)。

void setAdbRecoveryTimeout(int adbRecoveryTimeout)
void setAdbRootUnavailableTimeout(long adbRootUnavailableTimeout)
void setAvdConfigFile(File avdConfigFile)

设置 GCE AVD 配置文件以启动实例。

void setAvdDriverBinary(File avdDriverBinary)

设置启动 Gce Avd 实例的二进制文件的路径。

void setConnCheckUrl(String url)
void setCutoffBattery(int cutoffBattery)

设置继续调用所需的最低电池电量。

void setDisableKeyguard(boolean disableKeyguard)

设置是否应在启动完成后尝试停用锁屏

void setExtraFiles(MultiMap<File, String> extraFiles)

设置在 acloud 创建期间需要上传到 GCE 的额外文件。

void setFastbootTimeout(int fastbootTimeout)
void setGceCmdTimeout(long gceCmdTimeout)

设置 GCE AVD 超时时间,以便实例上线。

void setGceDriverBuildIdParam(String gceDriverBuildIdParam)

设置应与 build 信息中的 build ID 配对的 GCE 驱动程序参数

void setGceDriverLogLevel(Log.LogLevel mGceDriverLogLevel)

设置 Gce Avd 驱动程序的日志级别。

void setGceMaxAttempt(int gceMaxAttempt)

设置启动 GCE 设备的尝试次数上限

void setInstanceType(TestDeviceOptions.InstanceType type)

设置应创建的虚拟设备的实例类型

void setInstanceUser(String instanceUser)

设置应创建的 GCE 虚拟设备的实例用户。

void setLogcatOptions(String logcatOptions)

设置要传递给 logcat 的选项

void setMaxLogcatDataSize(long maxLogcatDataSize)

设置要保留的临时 logcat 的大致大小上限(以字节为单位)

void setOnlineTimeout(long onlineTimeout)
void setRebootTimeout(int rebootTimeout)
void setRemoteAdbPort(int remoteAdbPort)

设置 adb 服务器监听的实例中的远程端口

void setServiceAccountJsonKeyFile(File jsonKeyFile)

设置服务账号 JSON 密钥文件。

void setSkipTearDown(boolean shouldSkipTearDown)

如果应跳过 GCE 拆除,则返回 true。

void setSshPrivateKeyPath(File sshPrivateKeyPath)

设置要用于 Gce Avd 实例操作的 ssh 密钥的路径。

void setUnencryptRebootTimeout(int unencryptRebootTimeout)
void setUseCmdWifi(boolean useCmdWifi)
void setUseConnection(boolean useConnection)
void setUseFastbootErase(boolean useFastbootErase)
void setWifiAttempts(int wifiAttempts)
boolean shouldDisableReboot()
boolean shouldSkipBootComplete()
boolean shouldSkipTearDown()

如果应跳过 GCE 拆除,则返回 true。

boolean shouldUseConnection()

返回是否应使用新的连接功能。

boolean shouldUseContentProvider()

返回 Tradefed 内容提供程序是否可用于推送/拉取文件。

boolean useCmdWifiCommands()

返回是否使用 cmd wifi 命令(而非 APK)。

boolean useCvdCF()

辅助函数,用于在设备由 CVD 启动时返回 true,否则返回 false。

boolean useExitStatusWorkaround()

返回是否使用变通方法在没有 shell v2 的旧设备上获取 shell 退出状态。

boolean useIpV6ForTcpFastboot()
boolean useOxygen()

如果使用 Oxygen 创建虚拟设备,则返回 true。

boolean useOxygenProxy()

如果我们希望 TradeFed 直接调用 Oxygen 来租用设备,则返回 true。

boolean useOxygenationDevice()

如果要在 OmniLab 的基础设施中租赁氧合设备,则返回 true。

boolean useUpdatedBootloaderStatus()

返回是否使用较新的引导加载程序状态。

boolean waitForGceTearDown()

如果应在继续之前阻塞 GCE 拆除完成,则返回 true。

常量

DEFAULT_ADB_PORT

public static final int DEFAULT_ADB_PORT

常量值: 5555 (0x000015b3)

INSTANCE_TYPE_OPTION

public static final String INSTANCE_TYPE_OPTION

常量值: "instance-type"

REMOTE_TF_VERSION_OPTION

public static final String REMOTE_TF_VERSION_OPTION

常量值: "remote-tf-version"

字段

mAdbConnectWaitTime

protected long mAdbConnectWaitTime

公共构造函数

TestDeviceOptions

public TestDeviceOptions ()

公共方法

addGceDriverParams

public void addGceDriverParams (String param)

向 GCE 驱动程序参数添加了一个参数。

参数
param String

allowGceCmdTimeoutOverride

public boolean allowGceCmdTimeoutOverride ()

返回是否应依赖来自 acloud 的启动超时时间实参(如果存在)。

返回
boolean

evaluateDeviceConnection

public boolean evaluateDeviceConnection ()

返回
boolean

getAdbBinary

public File getAdbBinary ()

返回要使用的指定 adb 二进制文件。如果为 null,则使用 DeviceManager 中的二进制文件。

返回
File

getAdbCommandTimeout

public long getAdbCommandTimeout ()

返回
long 发送命令的超时时间(以毫秒为单位)。

getAdbConnectWaitTime

public long getAdbConnectWaitTime ()

返回要应用于 ADB 连接的超时值(以毫秒为单位)。

返回
long

getAdbRecoveryTimeout

public int getAdbRecoveryTimeout ()

返回
int 启动进入恢复模式的超时时间(以毫秒为单位)。

getAdbRootUnavailableTimeout

public long getAdbRootUnavailableTimeout ()

返回
long 在执行 adb root 后等待设备变为不可用的时间(以毫秒为单位)。

getAdbServerPort

public String getAdbServerPort ()

返回与设备关联的 adb 服务器端口。如果为 null,则使用默认端口。

返回
String

getAvailableTimeout

public long getAvailableTimeout ()

返回
long 等待设备可用的默认时间(以毫秒为单位)。

getAvdConfigFile

public File getAvdConfigFile ()

返回 GCE AVD 配置文件以启动实例。

返回
File

getAvdDriverBinary

public File getAvdDriverBinary ()

返回用于启动 GCE AVD 实例的二进制文件的路径。

返回
File

getBaseImage

public String getBaseImage ()

返回要用于当前实例的基础映像名称

返回
String

getBugreportzTimeout

public long getBugreportzTimeout ()

返回要应用于 bugreportz 捕获的超时值。

返回
long

getConnCheckUrl

public String getConnCheckUrl ()

返回
String 用于连接测试的默认网址。

getCreateCommandByInstanceType

public static String getCreateCommandByInstanceType (TestDeviceOptions.InstanceType type)

参数
type TestDeviceOptions.InstanceType

返回
String

getCrosPassword

public String getCrosPassword ()

返回用于登录 ChromeOS 的密码。

返回
String

getCrosUser

public String getCrosUser ()

返回要登录的 Chrome OS 用户。

返回
String

getCutoffBattery

public Integer getCutoffBattery ()

返回
Integer 继续调用所需的最低电池电量。

getDefaultNetworkType

public String getDefaultNetworkType ()

返回
String

getExtraFiles

public MultiMap<File, String> getExtraFiles ()

返回在 acloud 创建期间需要上传到 GCE 的额外文件。

返回
MultiMap<File, String>

getExtraOxygenArgs

public  getExtraOxygenArgs ()

返回用于租用 Oxygen 设备的额外实参。

返回

getExtraParamsByInstanceType

public static  getExtraParamsByInstanceType (TestDeviceOptions.InstanceType type, 
                String baseImage)

参数
type TestDeviceOptions.InstanceType

baseImage String

返回

getFastbootBinary

public File getFastbootBinary ()

返回要使用的指定 fastboot 二进制文件。如果为 null,则使用 DeviceManager 二进制文件。

返回
File

getFastbootOutputTimeout

public long getFastbootOutputTimeout ()

返回
long

getFastbootTimeout

public int getFastbootTimeout ()

返回
int 以毫秒为单位的超时时间,用于启动进入 fastboot 模式。

getGceAccount

public String getGceAccount ()

返回要与驱动程序搭配使用的 GCE 电子邮件账号

返回
String

getGceCmdTimeout

public long getGceCmdTimeout ()

返回 GCE AVD 超时时间,以便实例上线。

返回
long

getGceDriverBuildIdParam

public String getGceDriverBuildIdParam ()

返回应与 build 信息中的 build ID 配对的 GCE 驱动程序参数

返回
String

getGceDriverFileParams

public MultiMap<String, File> getGceDriverFileParams ()

以通过选项提供的 GCE 驱动程序参数的形式返回其他文件路径。

返回
MultiMap<String, File>

getGceDriverLogLevel

public Log.LogLevel getGceDriverLogLevel ()

返回 GCE AVD 驱动程序的日志级别。

返回
Log.LogLevel

getGceDriverParams

public  getGceDriverParams ()

返回通过选项提供的其他 GCE 驱动程序参数

返回

getGceMaxAttempt

public int getGceMaxAttempt ()

返回启动 GCE 设备的尝试次数上限

返回
int

getInstanceType

public TestDeviceOptions.InstanceType getInstanceType ()

返回应创建的虚拟设备的实例类型

返回
TestDeviceOptions.InstanceType

getInstanceUser

public String getInstanceUser ()

返回应创建的 GCE 虚拟设备的实例用户

返回
String

getInvocationAttributeToMetadata

public  getInvocationAttributeToMetadata ()

返回

getLogcatOptions

public String getLogcatOptions ()

返回
String 配置的 logcat 选项

getMaxLogcatDataSize

public long getMaxLogcatDataSize ()

获取要保留的临时 logcat 数据的大致最大大小(以字节为单位)。

返回
long

getMaxWifiConnectTime

public long getMaxWifiConnectTime ()

返回
long 尝试连接到 Wi-Fi 的最长时间。

getOnlineTimeout

public long getOnlineTimeout ()

返回
long 等待设备上线的默认时间(以毫秒为单位)。

getOxygenAccountingUser

public String getOxygenAccountingUser ()

返回 Oxygen 设备的会计用户。

返回
String

getOxygenDeviceSize

public TestDeviceOptions.DeviceSize getOxygenDeviceSize ()

返回 Oxygen 虚拟设备将运行的主机的大小。

返回
TestDeviceOptions.DeviceSize

getOxygenLeaseLength

public long getOxygenLeaseLength ()

返回租用 Oxygen 设备的时长(以毫秒为单位)。

返回
long

getOxygenServiceAddress

public String getOxygenServiceAddress ()

返回 Oxygen 设备的客服地址。

返回
String

getOxygenTargetRegion

public String getOxygenTargetRegion ()

返回 Oxygen 设备的目标区域。

返回
String

getPostBootCommands

public  getPostBootCommands ()

返回
重新启动后要运行的 shell 命令列表。

getRebootTimeout

public int getRebootTimeout ()

返回
int 完整系统启动的超时时间(以毫秒为单位)。

getRemoteAdbPort

public int getRemoteAdbPort ()

返回 adb 服务器监听的实例中的远程端口

返回
int

getRemoteFetchFilePattern

public  getRemoteFetchFilePattern ()

返回要尝试通过 scp 提取的模式列表。

返回

getRemoteTf

public File getRemoteTf ()

指向要推送到远程设备的 Tradefed 版本目录的文件。

返回
File

getServiceAccountJsonKeyFile

public File getServiceAccountJsonKeyFile ()

返回
File 服务账号 JSON 密钥文件。

getSnapuserdTimeout

public long getSnapuserdTimeout ()

返回
long

getSshPrivateKeyPath

public File getSshPrivateKeyPath ()

返回要用于与 GCE AVD 实例进行操作的 SSH 密钥的路径。

返回
File

getUnencryptRebootTimeout

public int getUnencryptRebootTimeout ()

返回
int 文件系统格式化和设备在解密后重新启动的超时时间(以毫秒为单位)。

getUseFastbootErase

public boolean getUseFastbootErase ()

返回
boolean 是否使用 fastboot erase 而不是 fastboot format 来擦除分区。

getWifiAttempts

public int getWifiAttempts ()

返回
int 连接到 Wi-Fi 网络的默认尝试次数。

getWifiRetryWaitTime

public int getWifiRetryWaitTime ()

返回
int Wi-Fi 连接重试之间的基本等待时间。

getWifiUtilAPKPath

public String getWifiUtilAPKPath ()

返回
String wifiutil APK 路径

isCmdWifiVirtual

public boolean isCmdWifiVirtual ()

返回
boolean

isDisableKeyguard

public boolean isDisableKeyguard ()

检查是否应在启动完成后尝试停用 Keyguard

返回
boolean

isEnableAdbRoot

public boolean isEnableAdbRoot ()

检查是否应在启动时为此设备启用 adb root

返回
boolean

isLogcatCaptureEnabled

public boolean isLogcatCaptureEnabled ()

返回
boolean 如果已启用后台 Logcat 捕获,则为 true

isWifiExpoRetryEnabled

public boolean isWifiExpoRetryEnabled ()

返回
boolean 是否应使用指数重试策略。

setAdbCommandTimeout

public void setAdbCommandTimeout (long adbCommandTimeout)

设置发送命令的超时时间(以毫秒为单位)。

参数
adbCommandTimeout long

setAdbRecoveryTimeout

public void setAdbRecoveryTimeout (int adbRecoveryTimeout)

参数
adbRecoveryTimeout int:启动进入恢复模式的超时时间(以毫秒为单位)。

setAdbRootUnavailableTimeout

public void setAdbRootUnavailableTimeout (long adbRootUnavailableTimeout)

参数
adbRootUnavailableTimeout long:在 adb root 之后等待设备变为不可用的时间(以毫秒为单位)。

setAvdConfigFile

public void setAvdConfigFile (File avdConfigFile)

设置 GCE AVD 配置文件以启动实例。

参数
avdConfigFile File

setAvdDriverBinary

public void setAvdDriverBinary (File avdDriverBinary)

设置启动 GCE AVD 实例的二进制文件路径。

参数
avdDriverBinary File

setConnCheckUrl

public void setConnCheckUrl (String url)

参数
url String

setCutoffBattery

public void setCutoffBattery (int cutoffBattery)

设置继续调用所需的最低电池电量。

参数
cutoffBattery int

setDisableKeyguard

public void setDisableKeyguard (boolean disableKeyguard)

设置在启动完成后是否应尝试停用锁屏

参数
disableKeyguard boolean

setExtraFiles

public void setExtraFiles (MultiMap<File, String> extraFiles)

设置在 acloud 创建期间需要上传到 GCE 的额外文件。

参数
extraFiles MultiMap

setFastbootTimeout

public void setFastbootTimeout (int fastbootTimeout)

参数
fastbootTimeout int:启动进入 fastboot 模式的超时时间(以毫秒为单位)。

setGceCmdTimeout

public void setGceCmdTimeout (long gceCmdTimeout)

设置 GCE AVD 超时时间,以便实例上线。

参数
gceCmdTimeout long

setGceDriverBuildIdParam

public void setGceDriverBuildIdParam (String gceDriverBuildIdParam)

设置应与 build 信息中的 build ID 配对的 GCE 驱动程序参数

参数
gceDriverBuildIdParam String

setGceDriverLogLevel

public void setGceDriverLogLevel (Log.LogLevel mGceDriverLogLevel)

设置 GCE AVD 驱动程序的日志级别。

参数
mGceDriverLogLevel Log.LogLevel

setGceMaxAttempt

public void setGceMaxAttempt (int gceMaxAttempt)

设置启动 GCE 设备的尝试次数上限

参数
gceMaxAttempt int

setInstanceType

public void setInstanceType (TestDeviceOptions.InstanceType type)

设置应创建的虚拟设备的实例类型

参数
type TestDeviceOptions.InstanceType

setInstanceUser

public void setInstanceUser (String instanceUser)

设置应创建的 GCE 虚拟设备的实例用户。

参数
instanceUser String

setLogcatOptions

public void setLogcatOptions (String logcatOptions)

设置要传递给 logcat 的选项

参数
logcatOptions String

setMaxLogcatDataSize

public void setMaxLogcatDataSize (long maxLogcatDataSize)

设置要保留的临时 logcat 的大致最大大小(以字节为单位)

参数
maxLogcatDataSize long

setOnlineTimeout

public void setOnlineTimeout (long onlineTimeout)

参数
onlineTimeout long

setRebootTimeout

public void setRebootTimeout (int rebootTimeout)

参数
rebootTimeout int:系统完全启动的超时时间(以毫秒为单位)。

setRemoteAdbPort

public void setRemoteAdbPort (int remoteAdbPort)

设置 adb 服务器监听的实例中的远程端口

参数
remoteAdbPort int

setServiceAccountJsonKeyFile

public void setServiceAccountJsonKeyFile (File jsonKeyFile)

设置服务账号 JSON 密钥文件。

参数
jsonKeyFile File:密钥文件。

setSkipTearDown

public void setSkipTearDown (boolean shouldSkipTearDown)

如果应跳过 GCE 拆除,则返回 true。否则输出 false。

参数
shouldSkipTearDown boolean

setSshPrivateKeyPath

public void setSshPrivateKeyPath (File sshPrivateKeyPath)

设置要用于与 Gce Avd 实例进行操作的 SSH 密钥的路径。

参数
sshPrivateKeyPath File

setUnencryptRebootTimeout

public void setUnencryptRebootTimeout (int unencryptRebootTimeout)

参数
unencryptRebootTimeout int:文件系统格式化和设备在解密后重新启动的超时时间(以毫秒为单位)。

setUseCmdWifi

public void setUseCmdWifi (boolean useCmdWifi)

参数
useCmdWifi boolean

setUseConnection

public void setUseConnection (boolean useConnection)

参数
useConnection boolean

setUseFastbootErase

public void setUseFastbootErase (boolean useFastbootErase)

参数
useFastbootErase boolean:是否使用 fastboot erase 而不是 fastboot format 来擦除分区。

setWifiAttempts

public void setWifiAttempts (int wifiAttempts)

参数
wifiAttempts int

shouldDisableReboot

public boolean shouldDisableReboot ()

返回
boolean 是否应停用设备重启

shouldSkipBootComplete

public boolean shouldSkipBootComplete ()

返回
boolean

shouldSkipTearDown

public boolean shouldSkipTearDown ()

如果应跳过 GCE 拆除,则返回 true。否则输出 false。

返回
boolean

shouldUseConnection

public boolean shouldUseConnection ()

返回是否应使用新的连接功能。

返回
boolean

shouldUseContentProvider

public boolean shouldUseContentProvider ()

返回 Tradefed 内容提供程序是否可用于推送/拉取文件。

返回
boolean

useCmdWifiCommands

public boolean useCmdWifiCommands ()

返回是否使用 cmd wifi 命令(而非 apk)。

返回
boolean

useCvdCF

public boolean useCvdCF ()

辅助函数,用于在设备由 CVD 启动时返回 true,否则返回 false。

返回
boolean

useExitStatusWorkaround

public boolean useExitStatusWorkaround ()

返回是否使用解决方法在没有 shell v2 的旧设备上获取 shell 退出状态。

返回
boolean

useIpV6ForTcpFastboot

public boolean useIpV6ForTcpFastboot ()

返回
boolean

useOxygen

public boolean useOxygen ()

如果使用 Oxygen 创建虚拟设备,则返回 true。否则输出 false。

返回
boolean

useOxygenProxy

public boolean useOxygenProxy ()

如果我们希望 TradeFed 直接调用 Oxygen 来租用设备,则返回 true。

返回
boolean

useOxygenationDevice

public boolean useOxygenationDevice ()

如果要在 OmniLab 的基础设施中租赁氧合设备,则返回 true。否则输出 false。

返回
boolean

useUpdatedBootloaderStatus

public boolean useUpdatedBootloaderStatus ()

返回是否使用较新的引导加载程序状态。

返回
boolean

waitForGceTearDown

public boolean waitForGceTearDown ()

如果应在继续之前阻塞 GCE 拆除完成,则返回 true。

返回
boolean