TestDeviceOptions

public class TestDeviceOptions
extends Object

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

---

ITestDevice 个 Option 的容器

摘要

常量
int	DEFAULT_ADB_PORT

字段
public static final String	INSTANCE_TYPE_OPTION
public static final String	REMOTE_TF_VERSION_OPTION

公共构造函数
TestDeviceOptions()

公共方法
void	addGceDriverParams(String param) 向 gce 驱动程序参数添加一个参数。
boolean	allowGceCmdTimeoutOverride() 返回是否应该依赖来自 acloud 的启动超时参数（如果存在）。
long	getAdbCommandTimeout()
int	getAdbRecoveryTimeout()
long	getAdbRootUnavailableTimeout()
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() 返回用于登录 Chrome 操作系统的密码。
String	getCrosUser() 返回登录时所用的 Chrome 操作系统用户。
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() 获取要保留的 tmp logcat 数据的大致大小上限（以字节为单位）。
long	getMaxWifiConnectTime()
long	getOnlineTimeout()
String	getOxygenAccountingUser() 返回 Oxygen 设备的计费用户。
TestDeviceOptions.DeviceSize	getOxygenDeviceSize() 返回将运行 Oxygen 虚拟设备的主机大小。
long	getOxygenLeaseLength() 返回氧气设备的租用时长（以毫秒为单位）。
String	getOxygenServiceAddress() 返回氧气设备的服务地址。
String	getOxygenTargetRegion() 返回氧气设备的目标区域。
	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) 设置要保留的 tmp 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	shouldSkipTearDown() 如果应跳过 GCE 拆解，则返回 true。
boolean	shouldUseConnection() 返回是否应该使用新的连接功能。
boolean	shouldUseContentProvider() 返回 Tradefed 内容提供程序是否可以用于推送/拉取文件。
boolean	useCmdWifiCommands() 返回是否使用 cmd wifi 命令而不是 apk。
boolean	useExitStatusWorkaround() 返回是否采用权宜解决方法在没有 shell v2 的旧款设备上获取 shell 退出状态。
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

REMOTE_TF_VERSION_OPTION

public static final String REMOTE_TF_VERSION_OPTION

公共构造函数

TestDeviceOptions

public TestDeviceOptions ()

公共方法

addGceDriverParams

public void addGceDriverParams (String param)

为 gce 驱动程序参数添加一个参数。

参数
param	String

allowGceCmdTimeoutOverride

public boolean allowGceCmdTimeoutOverride ()

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

返回
boolean

getAdbCommandTimeout

public long getAdbCommandTimeout ()

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

getAdbRecoveryTimeout

public int getAdbRecoveryTimeout ()

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

getAdbRootUnavailableTimeout 类中的方法

public long getAdbRootUnavailableTimeout ()

返回
long	adb root 后等待设备变为不可用状态的时间（以毫秒为单位）。

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 ()

返回用于登录 Chrome 操作系统的密码。

返回
String

getCrosUser

public String getCrosUser ()

返回登录时所用的 Chrome 操作系统用户。

返回
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 ()

获取要保留的 tmp logcat 数据的大致大小上限（以字节为单位）。

返回
long

getMaxWifiConnectTime

public long getMaxWifiConnectTime ()

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

getOnlineTimeout

public long getOnlineTimeout ()

返回
long	等待设备联网的默认时间（以毫秒为单位）。

getOxygenAccountingUser

public String getOxygenAccountingUser ()

返回 Oxgen 设备的计费用户。

返回
String

getOxygenDeviceSize

public TestDeviceOptions.DeviceSize getOxygenDeviceSize ()

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

返回
TestDeviceOptions.DeviceSize

getOxygenLeaseLength

public long getOxygenLeaseLength ()

返回氧气设备的租用时长（以毫秒为单位）。

返回
long

getOxygenServiceAddress

public String getOxygenServiceAddress ()

返回氧气设备的服务地址。

返回
String

getOxygenTargetRegion

public String getOxygenTargetRegion ()

返回氧气设备的目标区域。

返回
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 清空（而非 fastboot 格式）来擦除分区。

getWifiAttempts

public int getWifiAttempts ()

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

获取 Wi-Fi 重试等待时间

public int getWifiRetryWaitTime ()

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

getWifiUtilAPKPath

public String getWifiUtilAPKPath ()

返回
String	wifiutil APK 路径

isCmdWifiVirtual

public boolean isCmdWifiVirtual ()

返回
boolean

isDisableKeyguard

public boolean isDisableKeyguard ()

检查我们是否应在启动完成后尝试停用键盘锁

返回
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)

设置要保留的 tmp 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 清空（而非 fastboot 格式）来擦除分区。

setWifiAttempts

public void setWifiAttempts (int wifiAttempts)

参数
wifiAttempts	int

shouldDisableReboot

public boolean shouldDisableReboot ()

返回
boolean	是否应停用设备重新启动功能

shouldSkipTearDown

public boolean shouldSkipTearDown ()

如果应跳过 GCE 拆解，则返回 true。否则为 false。

返回
boolean

shouldUseConnection

public boolean shouldUseConnection ()

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

返回
boolean

应当使用内容提供程序

public boolean shouldUseContentProvider ()

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

返回
boolean

useCmdWifiCommands

public boolean useCmdWifiCommands ()

返回是否使用 cmd wifi 命令而不是 apk。

返回
boolean

useExitStatusWorkaround

public boolean useExitStatusWorkaround ()

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

返回
boolean

使用氧气

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