Stay organized with collections Save and categorize content based on your preferences.

ModuleDefinition

public class ModuleDefinition
extends Object implements ITestCollector

java.lang.Object
   ↳ com.android.tradefed.testtype.suite.ModuleDefinition


Container for the test run configuration. This class is an helper to prepare and run the tests.

Summary

Fields

public static final String MODULE_ABI

public static final String MODULE_CONTROLLER

public static final String MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_ID

Module ID the name that will be used to identify uniquely the module during testRunStart.

public static final String MODULE_ISOLATED

This property is set to true if the module was running on a freshly prepared device.

public static final String MODULE_NAME

Module name is the base name associated with the module, usually coming from the Xml TF config file the module was loaded from.

public static final String MODULE_PARAMETERIZATION

public static final String MODULE_TEST_COUNT

public static final String PREPARATION_TIME

public static final String RETRY_FAIL_COUNT

public static final String RETRY_SUCCESS_COUNT

public static final String RETRY_TIME

public static final String TEAR_DOWN_TIME

public static final String TEST_TIME

Public constructors

ModuleDefinition()
ModuleDefinition(String name, tests, preparersPerDevice, multiPreparers, IConfiguration moduleConfig)

Constructor

ModuleDefinition(String name, tests, preparersPerDevice, suitePreparersPerDevice, multiPreparers, IConfiguration moduleConfig)

Constructor

Public methods

int compareTo(ModuleDefinition moduleDef)

String getId()

Return the unique module name.

IConfiguration getModuleConfiguration()
IInvocationContext getModuleInvocationContext()

Returns the IInvocationContext associated with the module.

getRequiredTokens(TestInformation testInfo)
long getRuntimeHint()

Returns the approximate time to run all the tests in the module.

boolean hasModuleFailed()

Returns True if a testRunFailure has been called on the module *

int neededDevices()

Returns the number of devices expected to run this test.

int numTests()

Returns the current number of IRemoteTest waiting to be executed.

final void reportNotExecuted(ITestInvocationListener listener, String message)

Report completely not executed modules.

final void run(TestInformation moduleInfo, ITestInvocationListener listener, moduleLevelListeners, TestFailureListener failureListener, int maxRunLimit)

Run all the IRemoteTest contained in the module and use all the preparers before and after to setup and clean the device.

final void run(TestInformation moduleInfo, ITestInvocationListener listener, moduleLevelListeners, TestFailureListener failureListener)

Run all the IRemoteTest contained in the module and use all the preparers before and after to setup and clean the device.

final void run(TestInformation moduleInfo, ITestInvocationListener listener)

Run all the IRemoteTest contained in the module and use all the preparers before and after to setup and clean the device.

Throwable runPreparation(boolean includeSuitePreparers)

Run preparers of the test, including suite level preparers if specified.

void setBuild(IBuildInfo build)

Inject the IBuildInfo to be used during the tests.

void setCollectTestsOnly(boolean collectTestsOnly)

Enables or disables test collection mode

void setDevice(ITestDevice device)

Inject the ITestDevice to be used during the tests.

void setEnableDynamicDownload(boolean enableDynamicDownload)

Whether or not to enable dynamic download at module level.

void setLogSaver(ILogSaver logSaver)

Pass the invocation log saver to the module so it can use it if necessary.

final void setMergeAttemps(boolean mergeAttempts)

Sets whether or not we should merge results.

void setMetricCollectors( collectors)

Inject the List of IMetricCollector to be used by the module.

final void setRetryDecision(IRetryDecision decision)

Sets the IRetryDecision to be used for intra-module retry.

String toString()

void transferSuiteLevelOptions(IConfiguration mSuiteConfiguration)

Copy a few of the suite level configuration

Protected methods

boolean hasTests()

Return True if the Module still has IRemoteTest to run in its pool.

Fields

MODULE_ABI

public static final String MODULE_ABI

MODULE_CONTROLLER

public static final String MODULE_CONTROLLER

MODULE_EXTERNAL_DEPENDENCIES

public static final String MODULE_EXTERNAL_DEPENDENCIES

MODULE_ID

public static final String MODULE_ID

Module ID the name that will be used to identify uniquely the module during testRunStart. It will usually be a combination of MODULE_ABI + MODULE_NAME.

MODULE_ISOLATED

public static final String MODULE_ISOLATED

This property is set to true if the module was running on a freshly prepared device.

MODULE_NAME

public static final String MODULE_NAME

Module name is the base name associated with the module, usually coming from the Xml TF config file the module was loaded from.

MODULE_PARAMETERIZATION

public static final String MODULE_PARAMETERIZATION

MODULE_TEST_COUNT

public static final String MODULE_TEST_COUNT

PREPARATION_TIME

public static final String PREPARATION_TIME

RETRY_FAIL_COUNT

public static final String RETRY_FAIL_COUNT

RETRY_SUCCESS_COUNT

public static final String RETRY_SUCCESS_COUNT

RETRY_TIME

public static final String RETRY_TIME

TEAR_DOWN_TIME

public static final String TEAR_DOWN_TIME

TEST_TIME

public static final String TEST_TIME

Public constructors

ModuleDefinition

public ModuleDefinition ()

ModuleDefinition

public ModuleDefinition (String name, 
                 tests, 
                 preparersPerDevice, 
                 multiPreparers, 
                IConfiguration moduleConfig)

Constructor

Parameters
name String: unique name of the test configuration.

tests : list of IRemoteTest that needs to run.

preparersPerDevice : list of ITargetPreparer to be used to setup the device.

multiPreparers

moduleConfig IConfiguration: the IConfiguration of the underlying module config.

ModuleDefinition

public ModuleDefinition (String name, 
                 tests, 
                 preparersPerDevice, 
                 suitePreparersPerDevice, 
                 multiPreparers, 
                IConfiguration moduleConfig)

Constructor

Parameters
name String: unique name of the test configuration.

tests : list of IRemoteTest that needs to run.

preparersPerDevice : list of ITargetPreparer to be used to setup the device.

suitePreparersPerDevice

multiPreparers

moduleConfig IConfiguration: the IConfiguration of the underlying module config.

Public methods

compareTo

public int compareTo (ModuleDefinition moduleDef)

Parameters
moduleDef ModuleDefinition

Returns
int

getId

public String getId ()

Return the unique module name.

Returns
String

getModuleConfiguration

public IConfiguration getModuleConfiguration ()

Returns
IConfiguration

getModuleInvocationContext

public IInvocationContext getModuleInvocationContext ()

Returns the IInvocationContext associated with the module.

Returns
IInvocationContext

getRequiredTokens

public  getRequiredTokens (TestInformation testInfo)

Parameters
testInfo TestInformation

Returns

getRuntimeHint

public long getRuntimeHint ()

Returns the approximate time to run all the tests in the module.

Returns
long

hasModuleFailed

public boolean hasModuleFailed ()

Returns True if a testRunFailure has been called on the module *

Returns
boolean

neededDevices

public int neededDevices ()

Returns the number of devices expected to run this test.

Returns
int

numTests

public int numTests ()

Returns the current number of IRemoteTest waiting to be executed.

Returns
int

reportNotExecuted

public final void reportNotExecuted (ITestInvocationListener listener, 
                String message)

Report completely not executed modules.

Parameters
listener ITestInvocationListener

message String

run

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener, 
                 moduleLevelListeners, 
                TestFailureListener failureListener, 
                int maxRunLimit)

Run all the IRemoteTest contained in the module and use all the preparers before and after to setup and clean the device.

Parameters
moduleInfo TestInformation: the TestInformation for the module.

listener ITestInvocationListener: the ITestInvocationListener where to report results.

moduleLevelListeners : The list of listeners at the module level.

failureListener TestFailureListener: a particular listener to collect logs on testFail. Can be null.

maxRunLimit int: the max number of runs for each testcase.

Throws
DeviceNotAvailableException in case of device going offline.

run

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener, 
                 moduleLevelListeners, 
                TestFailureListener failureListener)

Run all the IRemoteTest contained in the module and use all the preparers before and after to setup and clean the device.

Parameters
moduleInfo TestInformation

listener ITestInvocationListener: the ITestInvocationListener where to report results.

moduleLevelListeners : The list of listeners at the module level.

failureListener TestFailureListener: a particular listener to collect logs on testFail. Can be null.

Throws
DeviceNotAvailableException in case of device going offline.

run

public final void run (TestInformation moduleInfo, 
                ITestInvocationListener listener)

Run all the IRemoteTest contained in the module and use all the preparers before and after to setup and clean the device.

Parameters
moduleInfo TestInformation

listener ITestInvocationListener: the ITestInvocationListener where to report results.

Throws
DeviceNotAvailableException in case of device going offline.

runPreparation

public Throwable runPreparation (boolean includeSuitePreparers)

Run preparers of the test, including suite level preparers if specified.

Parameters
includeSuitePreparers boolean: Set to true to also run suite level preparers.

Returns
Throwable Throwable of any exception raised when running preparers.

setBuild

public void setBuild (IBuildInfo build)

Inject the IBuildInfo to be used during the tests.

Parameters
build IBuildInfo

setCollectTestsOnly

public void setCollectTestsOnly (boolean collectTestsOnly)

Enables or disables test collection mode

setDevice

public void setDevice (ITestDevice device)

Inject the ITestDevice to be used during the tests.

Parameters
device ITestDevice

setEnableDynamicDownload

public void setEnableDynamicDownload (boolean enableDynamicDownload)

Whether or not to enable dynamic download at module level.

Parameters
enableDynamicDownload boolean

setLogSaver

public void setLogSaver (ILogSaver logSaver)

Pass the invocation log saver to the module so it can use it if necessary.

Parameters
logSaver ILogSaver

setMergeAttemps

public final void setMergeAttemps (boolean mergeAttempts)

Sets whether or not we should merge results.

Parameters
mergeAttempts boolean

setMetricCollectors

public void setMetricCollectors ( collectors)

Inject the List of IMetricCollector to be used by the module.

Parameters
collectors

setRetryDecision

public final void setRetryDecision (IRetryDecision decision)

Sets the IRetryDecision to be used for intra-module retry.

Parameters
decision IRetryDecision

toString

public String toString ()

Returns
String

transferSuiteLevelOptions

public void transferSuiteLevelOptions (IConfiguration mSuiteConfiguration)

Copy a few of the suite level configuration

Parameters
mSuiteConfiguration IConfiguration

Protected methods

hasTests

protected boolean hasTests ()

Return True if the Module still has IRemoteTest to run in its pool. False otherwise.

Returns
boolean