BaseModuleController

public abstract class BaseModuleController
extends Object implements IModuleController

java.lang.Object
↳	com.android.tradefed.testtype.suite.module.BaseModuleController

Known direct subclasses

ArchModuleController, CarModuleController, CommandSuccessModuleController, DeviceFeatureModuleController, KernelTestModuleController, MainlineTestModuleController, MaxSdkModuleController, MinApiLevelModuleController, MinSdkModuleController, NativeBridgeModuleController, PackageInstalledModuleController, ShippingApiLevelModuleController, SkipHWASanModuleController, TestFailureModuleController

ArchModuleController	Module controller to not run tests when it doesn't match any given architectures.
CarModuleController	This controller prevents execution of tests cases on non-automotive devices.
CommandSuccessModuleController	Base class for a module controller to skip test module based on shell command failure.
DeviceFeatureModuleController	A module controller to not run tests when it doesn't support certain feature.
KernelTestModuleController	Base class for a module controller to not run tests when it doesn't match the architecture .
MainlineTestModuleController	Base class for a module controller to run tests based on the preloaded mainline modules on the device under test.
MaxSdkModuleController	Base class for a module controller to not run tests on versions above a specified SDK version number.
MinApiLevelModuleController	Base class for a module controller to not run tests when it below a specified API Level.
MinSdkModuleController	Base class for a module controller to not run tests on versions below a specified SDK version number.
NativeBridgeModuleController	A module controller to check if a device support native bridge.
PackageInstalledModuleController	Module controller to not run tests when the device has not got the given packages installed.
ShippingApiLevelModuleController	Run tests if the device meets the following conditions: If `min-api-level` is defined: The device shipped with the `min-api-level` or later.
SkipHWASanModuleController	Base class for a module controller to not run tests on HWASan builds.
TestFailureModuleController	Controller for module that simply want to tune how the tests failures log collected are behaving.

Known indirect subclasses

Sdk28ModuleController, Sdk29ModuleController, Sdk30ModuleController, Sdk31ModuleController, Sdk32ModuleController, Sdk33ModuleController, Sdk34ModuleController, Sdk35ModuleController

Sdk28ModuleController	A module controller to check if a device is on SDK 28 (Android 9) or above.
Sdk29ModuleController	Only run tests if the device under test is SDK version 29 or above.
Sdk30ModuleController	Only run tests if the device under test is SDK version 30 or above.
Sdk31ModuleController	Only run tests if the device under test is SDK version 31 or above.
Sdk32ModuleController	Only run tests if the device under test is SDK version 32 or above.
Sdk33ModuleController	Only run tests if the device under test is SDK version 33 or above.
Sdk34ModuleController	Only run tests if the device under test is SDK version 34 or above.
Sdk35ModuleController	Only run tests if the device under test is SDK version 35 or above.

Basic implementation of IModuleController that should be implemented for checking if a module should run or not.

Summary

Public constructors
`BaseModuleController()`

Public methods
`final IAbi`	`getModuleAbi()` Helper method to get the module abi.
`final String`	`getModuleName()` Helper method to get the module name.
`final boolean`	`shouldCaptureBugreport()` Returns whether of not the module wants to capture the bugreport on test failure.
`final boolean`	`shouldCaptureLogcat()` Returns whether of not the module wants to capture the logcat on test failure.
`final boolean`	`shouldCaptureScreenshot()` Returns whether of not the module wants to capture the screenshot on test failure.
`abstract IModuleController.RunStrategy`	`shouldRun(IInvocationContext context)` Method to decide if the module should run or not.
`final IModuleController.RunStrategy`	`shouldRunModule(IInvocationContext context)` Method to determine if a module should run or not.

Public constructors

BaseModuleController

public BaseModuleController ()

Public methods

getModuleAbi

public final IAbi getModuleAbi ()

Helper method to get the module abi.

Returns
`IAbi`

getModuleName

public final String getModuleName ()

Helper method to get the module name.

Returns
`String`

shouldCaptureBugreport

public final boolean shouldCaptureBugreport ()

Returns whether of not the module wants to capture the bugreport on test failure.

Returns
`boolean`

shouldCaptureLogcat

public final boolean shouldCaptureLogcat ()

Returns whether of not the module wants to capture the logcat on test failure.

Returns
`boolean`

shouldCaptureScreenshot

public final boolean shouldCaptureScreenshot ()

Returns whether of not the module wants to capture the screenshot on test failure.

Returns
`boolean`

shouldRun

public abstract IModuleController.RunStrategy shouldRun (IInvocationContext context)

Method to decide if the module should run or not.

Parameters
`context`	`IInvocationContext`: the `IInvocationContext` of the module

Returns
`IModuleController.RunStrategy`	True if the module should run, false otherwise.

Throws
`DeviceNotAvailableException`

shouldRunModule

public final IModuleController.RunStrategy shouldRunModule (IInvocationContext context)

Method to determine if a module should run or not.

Parameters
`context`	`IInvocationContext`: the `IInvocationContext` of the module.

Returns
`IModuleController.RunStrategy`	True if the module should run, false otherwise.

Throws
`DeviceNotAvailableException`

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2024-05-08 UTC.