CommandOptions

public class CommandOptions
extends Object implements ICommandOptions

java.lang.Object
↳	com.android.tradefed.command.CommandOptions

---

ICommandOptions 的实现。

摘要

字段
public static final String	DRY_RUN_OPTION
public static final String	ENABLE_SANDBOX_TEST_MODE
public static final String	INVOCATION_DATA
public static final String	JDK_FOLDER_OPTION_NAME
public static final String	NOISY_DRY_RUN_OPTION
public static final String	TEST_TAG_OPTION
public static final String	USE_REMOTE_SANDBOX
public static final String	USE_SANDBOX

公共构造函数
CommandOptions()

公共方法
boolean	captureLogcatOnFailure() 是否在测试用例失败时捕获 logcat
boolean	captureScreenshotOnFailure() 是否在测试用例失败时截取屏幕截图
ICommandOptions	clone()
boolean	delegatedEarlyDeviceRelease() 是否在委托模式下提前释放设备。
boolean	earlyDeviceRelease() 是否在使用完设备后提前释放设备。
boolean	filterPreviousPassedTests() 是否过滤上次尝试中已通过的测试用例。
	getAutoLogCollectors() 返回要为调用添加的一组自动日志收集器
	getDynamicDownloadArgs() 返回要传递给动态下载查询的参数映射。
	getExperimentalFlags() 返回实验性标志映射，可用于功能门控项目。
int	getExtraRemotePostsubmitInstance() 在提交后是否在远程虚拟机中启动额外实例。
String	getHostLogSuffix() 返回要附加到 Tradefed host_log 的后缀；如果没有前缀，则返回 null。
UniqueMultiMap<String, String>	getInvocationData() 返回传递给调用的描述数据
long	getInvocationTimeout() 返回指定的调用超时时间。
File	getJdkFolderForSubprocess() 返回在子进程中分叉执行时要使用的 JDK 文件夹。
long	getLoopTime() 获取重新调度此命令之前需要等待的时间。
long	getMaxLoopCount() 返回安排命令的次数上限。
Integer	getMultiDeviceCount() 针对多设备测试返回设备数量。
boolean	getOptimizeMainlineTest() 如果我们应优化 Mainline 测试的测试模块列表，则返回 true。
Duration	getParallelPreInvocationSetupTimeout() 返回并行预调用设置的超时时间。
Duration	getParallelSetupTimeout() 返回在并行设置期间要使用的超时时间。
String	getRemoteCacheInstanceName() 返回用于处理远程缓存的实例的名称。
	getRemoteFiles() 返回已配置的远程文件列表。
Integer	getShardCount() 返回命令的分片总数。
Integer	getShardIndex() 返回命令的分片编号。
String	getTestTag() 返回调用的测试标记。
String	getTestTagSuffix() 返回要附加到 test-tag 以表示某个测试的某些变体的 test-tag 后缀。
boolean	isConditionalBugreportDisabled() 返回是否停用了有条件的 bug 报告
boolean	isDryRunMode() 如果应跳过将此命令添加到队列，则返回 true。
boolean	isExperimentEnabled() 是否通过实验性标志启用实验。
boolean	isFullHelpMode() 如果已请求完整详细帮助模式，则返回 true
boolean	isHelpMode() 如果已请求缩写帮助模式，则返回 true
boolean	isLoopMode() 返回配置的循环模式。
boolean	isNoisyDryRunMode() 如果我们应在跳过将命令添加到队列之前将命令输出到控制台，则返回 true。
boolean	isRemoteInvocationDeviceless() 是否触发无设备远程调用。
boolean	isTracingEnabled() 返回是否启用调用跟踪。
boolean	reportCacheResults() 如果应在有缓存结果时报告缓存结果，则返回 true。
boolean	reportInvocationComplete() 是否在 invocationComplete 之前报告日志。
boolean	reportPassedTests() 是否报告已通过的测试用例。
boolean	reportTestCaseCount() 是否报告每种测试类型的测试用例数量。
	reportingTags() 用于报告与调用相关信息的标签列表。
boolean	runOnAllDevices() 如果命令应在所有设备上运行，则返回 true。
void	setAutoLogCollectors( autoLogCollectors) 设置应添加到调用的一组自动日志收集器。
void	setBugreportOnInvocationEnded(boolean takeBugreport) 设置是否在调用结束时捕获 bug 报告。
void	setBugreportzOnInvocationEnded(boolean takeBugreportz) 设置是否在调用结束时捕获 bugreportz。
void	setDelegatedEarlyDeviceRelease(boolean earlyRelease) 设置是否在委托模式下提前释放设备。
void	setHostLogSuffix(String suffix) 设置要附加到 Tradefed host_log 的后缀。
void	setInvocationTimeout(Long invocationTimeout) 设置调用超时。
void	setLoopMode(boolean loopMode) 为配置设置循环模式。
void	setMultiDeviceCount(int count) 设置多设备测试的预期设备数量。
void	setReplicateSetup(boolean replicate) 设置是否使用复制设置。
void	setReportInvocationComplete(boolean reportInvocationCompleteLogs) 设置是否在 invocationComplete 之前报告日志
void	setReportTestCaseCount(boolean report) 设置是否报告每个测试类型的测试用例数量。
void	setShardCount(Integer shardCount) 设置命令的分片数。
void	setShardIndex(Integer shardIndex) 设置命令的分片编号。
void	setShouldRemoteDynamicShard(boolean shouldRemoteDynamicShard) 设置是否使用远程动态分片服务器
void	setShouldUseEvenModuleSharding(boolean useEvenModuleSharding) 设置是否尝试在分片中均匀分布模块数量
void	setShouldUseSandboxing(boolean use) 设置是否应使用 TF 容器
void	setTestTag(String testTag) 为调用设置测试标记。
void	setUseSandboxTestMode(boolean use) 设置是否应使用 TF 沙盒测试模式。
boolean	shouldDisableInvocationSetupAndTeardown() 是否停用调用前设置和调用后拆解。
boolean	shouldRemoteDynamicShard() 返回是否使用远程动态分片服务器
boolean	shouldReportModuleProgression() 是否在模块级报告远程调用的进度。
boolean	shouldUploadCacheResults() 如果应在缓存中捕获结果，则返回 true。
boolean	shouldUseDynamicSharding() 返回是否应使用动态分片
boolean	shouldUseEvenModuleSharding() 返回是否尝试在分片中均匀分布模块数量
boolean	shouldUseParallelPreInvocationSetup() 返回是否并行执行调用前设置。
boolean	shouldUseParallelRemoteSetup() 是否尝试并行设置远程设备。
boolean	shouldUseParallelSetup() 是否尝试并行设置。
boolean	shouldUseRemoteSandboxMode() 是否在远程调用中使用沙盒模式。
boolean	shouldUseReplicateSetup() 是否为所有远程设备使用复制设置。
boolean	shouldUseSandboxTestMode() 如果我们应在测试模式下使用 Tf 沙盒，则返回 true。
boolean	shouldUseSandboxing() 如果我们应使用 Tf 容器运行调用，则返回 true
boolean	shouldUseTokenSharding() 分片是否应使用令牌支持。
boolean	skipTrybotExperiment() 是否为 TRYBOT 运行跳过实验。
boolean	takeBugreportOnInvocationEnded() 如果应在测试调用结束时生成 bug 报告，则返回 true。
boolean	takeBugreportzOnInvocationEnded() 如果在测试调用最终 bugreport 期间应使用 bugreportz 而非 bugreport，则返回 true。

字段

DRY_RUN_OPTION

public static final String DRY_RUN_OPTION

ENABLE_SANDBOX_TEST_MODE

public static final String ENABLE_SANDBOX_TEST_MODE

INVOCATION_DATA

public static final String INVOCATION_DATA

JDK_FOLDER_OPTION_NAME

public static final String JDK_FOLDER_OPTION_NAME

NOISY_DRY_RUN_OPTION

public static final String NOISY_DRY_RUN_OPTION

TEST_TAG_OPTION

public static final String TEST_TAG_OPTION

USE_REMOTE_SANDBOX

public static final String USE_REMOTE_SANDBOX

USE_SANDBOX

public static final String USE_SANDBOX

公共构造函数

CommandOptions

public CommandOptions ()

公共方法

captureLogcatOnFailure

public boolean captureLogcatOnFailure ()

是否在测试用例失败时捕获 logcat

返回
boolean

captureScreenshotOnFailure

public boolean captureScreenshotOnFailure ()

是否在测试用例失败时截取屏幕截图

返回
boolean

clone

public ICommandOptions clone ()

返回
ICommandOptions

delegatedEarlyDeviceRelease

public boolean delegatedEarlyDeviceRelease ()

是否在委托模式下提前释放设备。

返回
boolean

earlyDeviceRelease

public boolean earlyDeviceRelease ()

是否在使用完设备后提前释放设备。

返回
boolean

filterPreviousPassedTests

public boolean filterPreviousPassedTests ()

是否过滤上次尝试中已通过的测试用例。

返回
boolean

getAutoLogCollectors

public  getAutoLogCollectors ()

返回要为调用添加的一组自动日志收集器

返回

getDynamicDownloadArgs

public  getDynamicDownloadArgs ()

返回要传递给动态下载查询的参数映射。

返回

getExperimentalFlags

public  getExperimentalFlags ()

返回实验性标志映射，可用于功能门控项目。

返回

getExtraRemotePostsubmitInstance

public int getExtraRemotePostsubmitInstance ()

在提交后，是否在远程虚拟机中启动额外实例。

返回
int

getHostLogSuffix

public String getHostLogSuffix ()

返回要附加到 Tradefed host_log 的后缀；如果没有前缀，则返回 null。

返回
String

getInvocationData

public UniqueMultiMap<String, String> getInvocationData ()

返回传递给调用的描述数据

返回
UniqueMultiMap<String, String>

getInvocationTimeout

public long getInvocationTimeout ()

返回指定的调用超时时间。如果不使用超时，则为 0。

返回
long

getJdkFolderForSubprocess

public File getJdkFolderForSubprocess ()

返回在子进程中分叉执行时要使用的 JDK 文件夹。

返回
File

getLoopTime

public long getLoopTime ()

获取重新调度此命令之前需要等待的时间。

返回
long	时间（毫秒）

getMaxLoopCount

public long getMaxLoopCount ()

返回安排命令的次数上限。如果 isLoopMode 为 false，则无效。

返回
long

getMultiDeviceCount

public Integer getMultiDeviceCount ()

返回多设备测试的设备数量。

返回
Integer

getOptimizeMainlineTest

public boolean getOptimizeMainlineTest ()

如果我们应优化 Mainline 测试的测试模块列表，则返回 true。

返回
boolean

getParallelPreInvocationSetupTimeout

public Duration getParallelPreInvocationSetupTimeout ()

返回并行预调用设置的超时时间。

返回
Duration

getParallelSetupTimeout

public Duration getParallelSetupTimeout ()

返回要在并行设置期间使用的超时时间。

返回
Duration

getRemoteCacheInstanceName

public String getRemoteCacheInstanceName ()

返回用于处理远程缓存的实例的名称。

返回
String

getRemoteFiles

public  getRemoteFiles ()

返回已配置的远程文件列表。

返回

getShardCount

public Integer getShardCount ()

返回该命令的总分片数。

返回
Integer

getShardIndex

public Integer getShardIndex ()

返回命令的分片索引。

返回
Integer

getTestTag

public String getTestTag ()

返回调用的测试标记。如果未指定，则默认为“stub”。

返回
String

getTestTagSuffix

public String getTestTagSuffix ()

返回附加到 test-tag 的 test-tag 后缀，用于表示某个测试的某些变体。

返回
String

isConditionalBugreportDisabled

public boolean isConditionalBugreportDisabled ()

返回是否停用了有条件的 bug 报告

返回
boolean

isDryRunMode

public boolean isDryRunMode ()

如果应跳过将此命令添加到队列，则返回 true。

返回
boolean

isExperimentEnabled

public boolean isExperimentEnabled ()

是否通过实验性标志启用实验。

返回
boolean

isFullHelpMode

public boolean isFullHelpMode ()

如果已请求完整详细帮助模式，则返回 true

返回
boolean

isHelpMode

public boolean isHelpMode ()

如果已请求缩写帮助模式，则返回 true

返回
boolean

isLoopMode

public boolean isLoopMode ()

返回配置的循环模式。

返回
boolean

isNoisyDryRunMode

public boolean isNoisyDryRunMode ()

如果应先将命令输出到控制台，然后再跳过将其添加到队列，请返回 true。

返回
boolean

isRemoteInvocationDeviceless

public boolean isRemoteInvocationDeviceless ()

是否触发无设备远程调用。

返回
boolean

isTracingEnabled

public boolean isTracingEnabled ()

返回是否启用了调用跟踪。

返回
boolean

reportCacheResults

public boolean reportCacheResults ()

如果应在有缓存结果时报告缓存结果，则返回 true。

返回
boolean

reportInvocationComplete

public boolean reportInvocationComplete ()

是否在 invocationComplete 之前报告日志。

返回
boolean

reportPassedTests

public boolean reportPassedTests ()

是否报告已通过的测试用例。

返回
boolean

reportTestCaseCount

public boolean reportTestCaseCount ()

是否报告每种测试类型的测试用例数量。

返回
boolean

ReportingTag

public  reportingTags ()

用于生成与调用相关的报告的标记列表。

返回

runOnAllDevices

public boolean runOnAllDevices ()

如果命令应在所有设备上运行，则返回 true。

返回
boolean

setAutoLogCollector

public void setAutoLogCollectors ( autoLogCollectors)

设置应添加到调用的一组自动日志收集器。

参数
autoLogCollectors

setBugreportOnInvocationEnded

public void setBugreportOnInvocationEnded (boolean takeBugreport)

设置是否在调用结束时捕获 bug 报告。

参数
takeBugreport	boolean

setBugreportzOnInvocationEnded

public void setBugreportzOnInvocationEnded (boolean takeBugreportz)

设置是否在调用结束时捕获 bugreportz。

参数
takeBugreportz	boolean

setDelegatedEarlyDeviceRelease

public void setDelegatedEarlyDeviceRelease (boolean earlyRelease)

设置是否要在委托模式下提前释放设备。

参数
earlyRelease	boolean

setHostLogSuffix

public void setHostLogSuffix (String suffix)

设置要附加到 Tradefed host_log 的后缀。

参数
suffix	String

setInvocationTimeout

public void setInvocationTimeout (Long invocationTimeout)

设置调用超时。如果不使用超时，则为 0。

参数
invocationTimeout	Long

setLoopMode

public void setLoopMode (boolean loopMode)

为配置设置循环模式。

setMultiDeviceCount

public void setMultiDeviceCount (int count)

设置多设备测试的预期设备数量。

参数
count	int

setReplicateSetup

public void setReplicateSetup (boolean replicate)

设置是否使用复制设置。

参数
replicate	boolean

setReportInvocationComplete

public void setReportInvocationComplete (boolean reportInvocationCompleteLogs)

设置是否在 invocationComplete 之前报告日志

参数
reportInvocationCompleteLogs	boolean

setReportTestCaseCount

public void setReportTestCaseCount (boolean report)

设置是否按测试类型报告测试用例数。

参数
report	boolean

setShardCount

public void setShardCount (Integer shardCount)

设置命令的分片数。

参数
shardCount	Integer

setShardIndex

public void setShardIndex (Integer shardIndex)

设置命令的分片编号。

参数
shardIndex	Integer

setShouldRemoteDynamicShard

public void setShouldRemoteDynamicShard (boolean shouldRemoteDynamicShard)

设置是否使用远程动态分片服务器

参数
shouldRemoteDynamicShard	boolean

setShouldUseevenModuleSharding

public void setShouldUseEvenModuleSharding (boolean useEvenModuleSharding)

设置是否尝试在分片之间均匀分布模块数量

参数
useEvenModuleSharding	boolean

setShouldUseSandboxing

public void setShouldUseSandboxing (boolean use)

设置是否应使用 TF 容器

参数
use	boolean

setTestTag

public void setTestTag (String testTag)

为调用设置测试标记。

setUseSandboxTestMode

public void setUseSandboxTestMode (boolean use)

设置是否应使用 TF 沙盒测试模式。

参数
use	boolean

shouldDisableInvocationSetupAndTeardown

public boolean shouldDisableInvocationSetupAndTeardown ()

是否停用调用前设置和调用后拆解。

返回
boolean

shouldRemoteDynamicShard

public boolean shouldRemoteDynamicShard ()

返回是否使用远程动态分片服务器

返回
boolean

shouldReportModuleProgression

public boolean shouldReportModuleProgression ()

是否在模块级报告远程调用的进度。

返回
boolean

shouldUploadCacheResults

public boolean shouldUploadCacheResults ()

如果应在缓存中捕获结果，则返回 true。

返回
boolean

shouldUseDynamicSharding

public boolean shouldUseDynamicSharding ()

返回是否应使用动态分片

返回
boolean

shouldUseEvenModuleSharding

public boolean shouldUseEvenModuleSharding ()

返回是否尝试在分片之间均匀分布模块数

返回
boolean

shouldUseParallelPreInvocationSetup

public boolean shouldUseParallelPreInvocationSetup ()

返回是否并行执行调用前设置。

返回
boolean

应该使用 ParallelRemoteSetup

public boolean shouldUseParallelRemoteSetup ()

是否尝试并行设置远程设备。

返回
boolean

shouldUseParallelSetup

public boolean shouldUseParallelSetup ()

是否尝试并行设置。

返回
boolean

shouldUseRemoteSandboxMode

public boolean shouldUseRemoteSandboxMode ()

是否在远程调用中使用沙盒模式。

返回
boolean

shouldUseReplicateSetup

public boolean shouldUseReplicateSetup ()

是否为所有远程设备使用复制设置。

返回
boolean

shouldUseSandboxTestMode

public boolean shouldUseSandboxTestMode ()

如果我们应在测试模式下使用 Tf 沙盒，则返回 true。

返回
boolean

shouldUseSandboxing

public boolean shouldUseSandboxing ()

如果应使用 Tf 容器运行调用，则返回 true

返回
boolean

shouldUseTokenSharding

public boolean shouldUseTokenSharding ()

分片是否应使用令牌支持。

返回
boolean

skipTrybotExperiment

public boolean skipTrybotExperiment ()

是否为 TRYBOT 运行跳过实验。

返回
boolean

takeBugreportOnInvocationEnded

public boolean takeBugreportOnInvocationEnded ()

如果应在测试调用结束时获取 bug 报告，则返回 true。

返回
boolean

takeBugreportzOnInvocationEnded

public boolean takeBugreportzOnInvocationEnded ()

如果在测试调用最终 bugreport 期间应使用 bugreportz 而非 bugreport，则返回 true。

返回
boolean