Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

ITargetPreparer

public interface ITargetPreparer
implements IDisableable

com.android.tradefed.targetprep.ITargetPreparer

Known indirect subclasses

BaseEmulatorPreparer, BaseTargetPreparer, BuildInfoRecorder, CreateAvdPreparer, CreateUserPreparer, DeviceBuildInfoBootStrapper, DeviceBuildInfoInjector, DeviceCleaner, DeviceFlashPreparer, DeviceImageZipFlashingTargetPreparer, DeviceSetup, DeviceUpdateTargetPreparer, FastbootUpdateBootstrapPreparer, FoldableModePreparer, GkiDeviceFlashPreparer, and 15 others.

BaseEmulatorPreparer	Common preparer for launching a local emulator.
BaseTargetPreparer	Base implementation class for `ITargetPreparer` that allows to control whether the object is disabled or not.
BuildInfoRecorder	An `ITargetPreparer` that writes build info meta data into a specified file.
CreateAvdPreparer
CreateUserPreparer	Target preparer for creating user and cleaning it up at the end.
DeviceBuildInfoBootStrapper	A `ITargetPreparer` that replaces build info fields with attributes read from device This is useful for testing devices with builds generated from an external source (e.g.
DeviceBuildInfoInjector	A `ITargetPreparer` that inserts `DeviceBuildDescriptor` metadata into the `IBuildInfo`.
DeviceCleaner	Performs reboot or format as cleanup action after test, and optionally turns screen off
DeviceFlashPreparer	A `ITargetPreparer` that flashes an image on physical Android hardware.
DeviceImageZipFlashingTargetPreparer	A target preparer that flashes the device with device images provided via a specific format.
DeviceSetup	A `ITargetPreparer` that configures a device for testing based on provided `Option`s.
DeviceUpdateTargetPreparer	An abstract `ITargetPreparer` that takes care of common steps around updating devices with a device image file from an external source (as opposed to a build service).
FastbootUpdateBootstrapPreparer	An `ITargetPreparer` that stages specified files (bootloader, radio, device image zip) into `IDeviceBuildInfo` to get devices flashed with `FastbootDeviceFlasher`, then injects post-boot device attributes into the build info for result reporting purposes.
FoldableModePreparer	A target preparer that can switch the foldable state of a device.
GkiDeviceFlashPreparer	A target preparer that flash the device with android common kernel generic image.
GsiDeviceFlashPreparer	A target preparer that flashes the device with android generic system image.
ITargetCleaner	This interface is deprecated. tearDown has been moved to the base ITargetPreparer interface.
InstallApexModuleTargetPreparer
KillExistingEmulatorPreparer	A `ITargetPreparer` that shuts down a running emulator.
LocalEmulatorLaunch	A TargetPreparer that launches an emulator locally from an android build environment.
LocalEmulatorSnapshot	A TargetPreparer intended for generating a clean emulator snapshot from a android build/development environment
ModuleOemTargetPreparer
RecoveryLogPreparer	A target preparer used to collect logs before recovery.
RunCommandTargetPreparer
RunOnSecondaryUserTargetPreparer	An `ITargetPreparer` that creates a secondary user in setup, and marks that tests should be run in that user.
RunOnSystemUserTargetPreparer	An `ITargetPreparer` that marks that tests should be run on the user (rather than the current user).
RunOnWorkProfileTargetPreparer	An `ITargetPreparer` that creates a work profile in setup, and marks that tests should be run in that user.
StubTargetPreparer	Placeholder empty implementation of a `ITargetPreparer`.
SuiteApkInstaller	Installs specified APKs for Suite configuration: either from $ANDROID_TARGET_OUT_TESTCASES variable or the ROOT_DIR in build info.
TestAppInstallSetup	A `ITargetPreparer` that installs one or more apps from a `IDeviceBuildInfo.getTestsDir()` folder onto device.

Prepares the test environment for the test run.

For example, installs software, tweaks env settings for testing, launches targets etc.

Note that multiple ITargetPreparers can be specified in a configuration. It is recommended that each ITargetPreparer clearly document its expected environment pre-setup and post-setUp. e.g. a ITargetPreparer that configures a device for testing must be run after the ITargetPreparer that installs software.

Summary

Public methods
`default void`	`setUp(ITestDevice device, IBuildInfo buildInfo)` This method is deprecated. Use `setUp(com.android.tradefed.invoker.TestInformation)` instead
`default void`	`setUp(TestInformation testInformation)` Perform the target setup for testing.
`default void`	`tearDown(TestInformation testInformation, Throwable e)` Perform the target cleanup/teardown after testing.
`default void`	`tearDown(ITestDevice device, IBuildInfo buildInfo, Throwable e)` This method is deprecated. Use `tearDown(com.android.tradefed.invoker.TestInformation, Throwable)` instead

Public methods

setUp

public void setUp (ITestDevice device, 
                IBuildInfo buildInfo)

This method is deprecated.
Use setUp(com.android.tradefed.invoker.TestInformation) instead

Perform the target setup for testing.

Parameters
`device`	`ITestDevice`: the `ITestDevice` to prepare.
`buildInfo`	`IBuildInfo`: data about the build under test.

Throws
`TargetSetupError`	if fatal error occurred setting up environment
`BuildError`	If an error related to the BuildInfo occurs
`DeviceNotAvailableException`	if device became unresponsive

setUp

public void setUp (TestInformation testInformation)

Perform the target setup for testing.

Parameters
`testInformation`	`TestInformation`: The `TestInformation` of the invocation.

Throws
`TargetSetupError`	if fatal error occurred setting up environment
`BuildError`	If an error occurs due to the build being prepared
`DeviceNotAvailableException`	if device became unresponsive

tearDown

public void tearDown (TestInformation testInformation, 
                Throwable e)

Perform the target cleanup/teardown after testing.

Parameters
`testInformation`	`TestInformation`: The `TestInformation` of the invocation.
`e`	`Throwable`: if the invocation ended with an exception, this will be the exception that was caught at the Invocation level. Otherwise, will be `null`.

Throws
`DeviceNotAvailableException`	if device became unresponsive

tearDown

public void tearDown (ITestDevice device, 
                IBuildInfo buildInfo, 
                Throwable e)

This method is deprecated.
Use tearDown(com.android.tradefed.invoker.TestInformation, Throwable) instead

Perform the target cleanup/teardown after testing.

Parameters
`device`	`ITestDevice`: the `ITestDevice` to prepare.
`buildInfo`	`IBuildInfo`: data about the build under test.
`e`	`Throwable`: if the invocation ended with an exception, this will be the exception that was caught at the Invocation level. Otherwise, will be `null`.

Throws
`DeviceNotAvailableException`	if device became unresponsive