ICommandOptions

public interface ICommandOptions

com.android.tradefed.command.ICommandOptions


Container for execution options for commands.

Summary

Public methods

abstract boolean captureLogcatOnFailure()

Whether or not to capture a logcat on test case failure

abstract boolean captureScreenshotOnFailure()

Whether or not to capture a screenshot on test case failure

abstract ICommandOptions clone()

Creates a copy of the ICommandOptions object.

abstract getAutoLogCollectors()

Returns the set of auto log collectors to be added for an invocation

abstract String getHostLogSuffix()

Returns the suffix to append to the Tradefed host_log or null if no prefix.

abstract UniqueMultiMap<String, String> getInvocationData()

Returns the data passed to the invocation to describe it

abstract long getInvocationTimeout()

Return the invocation timeout specified.

abstract long getLoopTime()

Get the time to wait before re-scheduling this command.

abstract long getMinLoopTime()

This method is deprecated. use getLoopTime() instead

abstract Integer getShardCount()

Return the total shard count for the command.

abstract Integer getShardIndex()

Return the shard index for the command.

abstract String getTestTag()

Return the test-tag for the invocation.

abstract String getTestTagSuffix()

Return the test-tag suffix, appended to test-tag to represents some variants of one test.

abstract boolean isDryRunMode()

Return true if we should skip adding this command to the queue.

abstract boolean isFullHelpMode()

Returns true if full detailed help mode has been requested

abstract boolean isHelpMode()

Returns true if abbreviated help mode has been requested

abstract boolean isJsonHelpMode()

Returns true if full json help mode has been requested

abstract boolean isLoopMode()

Return the loop mode for the config.

abstract boolean isNoisyDryRunMode()

Return true if we should print the command out to the console before we skip adding it to the queue.

abstract boolean runOnAllDevices()

Return true if command should run on all devices.

abstract void setAutoLogCollectors( autoLogCollectors)

Sets the set of auto log collectors that should be added to an invocation.

abstract void setBugreportOnInvocationEnded(boolean takeBugreport)

Sets whether or not to capture a bugreport at the end of the invocation.

abstract void setBugreportzOnInvocationEnded(boolean takeBugreportz)

Sets whether or not to capture a bugreportz at the end of the invocation.

abstract void setHostLogSuffix(String suffix)

Sets the suffix to append to Tradefed host_log.

abstract void setInvocationTimeout(Long mInvocationTimeout)

Set the invocation timeout.

abstract void setLoopMode(boolean loopMode)

Sets the loop mode for the command

abstract void setShardCount(Integer shardCount)

Sets the shard count for the command.

abstract void setShardIndex(Integer shardIndex)

Sets the shard index for the command.

abstract void setShouldUseSandboxing(boolean use)

Sets whether or not we should use TF containers

abstract void setTestTag(String testTag)

Sets the test-tag for the invocation.

abstract void setUseSandboxTestMode(boolean use)

Sets whether or not we should use the TF sandbox test mode.

abstract boolean shouldSkipPreDeviceSetup()

Return true if the test should skip device setup during TestInvocation setup.

abstract boolean shouldUseDynamicSharding()

Returns if we should use dynamic sharding or not

abstract boolean shouldUseParallelRemoteSetup()

Whether or not to attempt parallel setup of the remote devices.

abstract boolean shouldUseRemoteSandboxMode()

Whether or not to use sandbox mode in remote invocation.

abstract boolean shouldUseSandboxTestMode()

Returns true if we should use the Tf sandbox in a test mode.

abstract boolean shouldUseSandboxing()

Returns true if we should use Tf containers to run the invocation

abstract boolean shouldUseTokenSharding()

Whether or not sharding should use the token support.

abstract boolean takeBugreportOnInvocationEnded()

Return true if a bugreport should be taken when the test invocation has ended.

abstract boolean takeBugreportzOnInvocationEnded()

Return true if a bugreportz should be taken instead of bugreport during the test invocation final bugreport.

Public methods

captureLogcatOnFailure

public abstract boolean captureLogcatOnFailure ()

Whether or not to capture a logcat on test case failure

Returns
boolean

captureScreenshotOnFailure

public abstract boolean captureScreenshotOnFailure ()

Whether or not to capture a screenshot on test case failure

Returns
boolean

clone

public abstract ICommandOptions clone ()

Creates a copy of the ICommandOptions object.

Returns
ICommandOptions

getAutoLogCollectors

public abstract  getAutoLogCollectors ()

Returns the set of auto log collectors to be added for an invocation

Returns

getHostLogSuffix

public abstract String getHostLogSuffix ()

Returns the suffix to append to the Tradefed host_log or null if no prefix.

Returns
String

getInvocationData

public abstract UniqueMultiMap<String, String> getInvocationData ()

Returns the data passed to the invocation to describe it

Returns
UniqueMultiMap<String, String>

getInvocationTimeout

public abstract long getInvocationTimeout ()

Return the invocation timeout specified. 0 if no timeout to be used.

Returns
long

getLoopTime

public abstract long getLoopTime ()

Get the time to wait before re-scheduling this command.

Returns
long time in ms

getMinLoopTime

public abstract long getMinLoopTime ()

This method is deprecated.
use getLoopTime() instead

Get the min loop time for the config.

Returns
long

getShardCount

public abstract Integer getShardCount ()

Return the total shard count for the command.

Returns
Integer

getShardIndex

public abstract Integer getShardIndex ()

Return the shard index for the command.

Returns
Integer

getTestTag

public abstract String getTestTag ()

Return the test-tag for the invocation. Default is 'stub' if unspecified.

Returns
String

getTestTagSuffix

public abstract String getTestTagSuffix ()

Return the test-tag suffix, appended to test-tag to represents some variants of one test.

Returns
String

isDryRunMode

public abstract boolean isDryRunMode ()

Return true if we should skip adding this command to the queue.

Returns
boolean

isFullHelpMode

public abstract boolean isFullHelpMode ()

Returns true if full detailed help mode has been requested

Returns
boolean

isHelpMode

public abstract boolean isHelpMode ()

Returns true if abbreviated help mode has been requested

Returns
boolean

isJsonHelpMode

public abstract boolean isJsonHelpMode ()

Returns true if full json help mode has been requested

Returns
boolean

isLoopMode

public abstract boolean isLoopMode ()

Return the loop mode for the config.

Returns
boolean

isNoisyDryRunMode

public abstract boolean isNoisyDryRunMode ()

Return true if we should print the command out to the console before we skip adding it to the queue.

Returns
boolean

runOnAllDevices

public abstract boolean runOnAllDevices ()

Return true if command should run on all devices.

Returns
boolean

setAutoLogCollectors

public abstract void setAutoLogCollectors ( autoLogCollectors)

Sets the set of auto log collectors that should be added to an invocation.

Parameters
autoLogCollectors

setBugreportOnInvocationEnded

public abstract void setBugreportOnInvocationEnded (boolean takeBugreport)

Sets whether or not to capture a bugreport at the end of the invocation.

Parameters
takeBugreport boolean

setBugreportzOnInvocationEnded

public abstract void setBugreportzOnInvocationEnded (boolean takeBugreportz)

Sets whether or not to capture a bugreportz at the end of the invocation.

Parameters
takeBugreportz boolean

setHostLogSuffix

public abstract void setHostLogSuffix (String suffix)

Sets the suffix to append to Tradefed host_log.

Parameters
suffix String

setInvocationTimeout

public abstract void setInvocationTimeout (Long mInvocationTimeout)

Set the invocation timeout. 0 if no timeout to be used.

Parameters
mInvocationTimeout Long

setLoopMode

public abstract void setLoopMode (boolean loopMode)

Sets the loop mode for the command

setShardCount

public abstract void setShardCount (Integer shardCount)

Sets the shard count for the command.

Parameters
shardCount Integer

setShardIndex

public abstract void setShardIndex (Integer shardIndex)

Sets the shard index for the command.

Parameters
shardIndex Integer

setShouldUseSandboxing

public abstract void setShouldUseSandboxing (boolean use)

Sets whether or not we should use TF containers

Parameters
use boolean

setTestTag

public abstract void setTestTag (String testTag)

Sets the test-tag for the invocation.

setUseSandboxTestMode

public abstract void setUseSandboxTestMode (boolean use)

Sets whether or not we should use the TF sandbox test mode.

Parameters
use boolean

shouldSkipPreDeviceSetup

public abstract boolean shouldSkipPreDeviceSetup ()

Return true if the test should skip device setup during TestInvocation setup.

Returns
boolean

shouldUseDynamicSharding

public abstract boolean shouldUseDynamicSharding ()

Returns if we should use dynamic sharding or not

Returns
boolean

shouldUseParallelRemoteSetup

public abstract boolean shouldUseParallelRemoteSetup ()

Whether or not to attempt parallel setup of the remote devices.

Returns
boolean

shouldUseRemoteSandboxMode

public abstract boolean shouldUseRemoteSandboxMode ()

Whether or not to use sandbox mode in remote invocation.

Returns
boolean

shouldUseSandboxTestMode

public abstract boolean shouldUseSandboxTestMode ()

Returns true if we should use the Tf sandbox in a test mode.

Returns
boolean

shouldUseSandboxing

public abstract boolean shouldUseSandboxing ()

Returns true if we should use Tf containers to run the invocation

Returns
boolean

shouldUseTokenSharding

public abstract boolean shouldUseTokenSharding ()

Whether or not sharding should use the token support.

Returns
boolean

takeBugreportOnInvocationEnded

public abstract boolean takeBugreportOnInvocationEnded ()

Return true if a bugreport should be taken when the test invocation has ended.

Returns
boolean

takeBugreportzOnInvocationEnded

public abstract boolean takeBugreportzOnInvocationEnded ()

Return true if a bugreportz should be taken instead of bugreport during the test invocation final bugreport.

Returns
boolean