ITargetPreparer

public interface ITargetPreparer
implements IDisableable

com.android.tradefed.targetprep.ITargetPreparer

Known indirect subclasses

AbstractTargetCleaner, AdbStopServerPreparer, AdditionalFilesInstaller, AllTestAppsInstallSetup, AoaTargetPreparer, AppSetup, BaseTargetPreparer, BuildInfoAttributePreparer, BuildInfoRecorder, CheckPairingPreparer, CompanionAllocator, CompanionAwarePreparer, CompanionRunCommandTargetPreparer, CompanionTestAppInstallSetup, ConnectionChecker, and 50 others.

AbstractTargetCleaner	An `ITargetCleaner` class with a stub `setUp(ITestDevice, IBuildInfo)` method
AdbStopServerPreparer	Target preparer to stop adb server on the host before and after running adb tests.
AdditionalFilesInstaller	A `ITargetPreparer` that pushes all `IBuildInfo#getFiles()` to specific path on device.
AllTestAppsInstallSetup	A `ITargetPreparer` that installs all apps from a `IDeviceBuildInfo#getTestsDir()` folder onto device.
AoaTargetPreparer	`ITargetPreparer` that executes a series of actions (e.g. clicks and swipes) using the Android Open Accessory (AOAv2) protocol.
AppSetup	A `ITargetPreparer` that installs an apk and its tests.
BaseTargetPreparer	Base implementation class for `ITargetPreparer` that allows to control whether the object is disabled or not.
BuildInfoAttributePreparer	A `ITargetPreparer` that adds arbitrary attributes to the `IBuildInfo`.
BuildInfoRecorder	An `ITargetPreparer` that writes build info meta data into a specified file.
CheckPairingPreparer	A `CompanionAwarePreparer` that verifies BT bonding between primary and companion devices
CompanionAllocator	Base class that takes care of allocating and freeing companion device `getCompanionDeviceSelectionOptions()` should be implemented to describe the criteria needed to allocate the companion device
CompanionAwarePreparer	An `ITargetPreparer` that encapsulates the logic of getting an already allocated companion device.
CompanionRunCommandTargetPreparer	A `ITargetPreparer` that runs specified commands on the allocated companion device
CompanionTestAppInstallSetup	A `ITargetPreparer` that installs one or more apps from a `IDeviceBuildInfo#getTestsDir()` folder onto an allocated companion device.
ConnectionChecker	Target preparer that waits until an ip address is asigned to any of the specified interfaces.
CpuThrottlingWaiter	An `ITargetPreparer` that waits until max frequency on all cores are restored to highest level available
CrashCollector	A `ITargetPreparer` that runs crash collector on device which suppresses and logs crashes during test execution.
CreateUserPreparer	Target preparer for creating user and cleaning it up at the end.
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.
DeviceSetup	A `ITargetPreparer` that configures a device for testing based on provided `Option`s.
DeviceStorageFiller	Target preparer to fill up storage so some amount of free space is available.
DeviceStringPusher	Target preparer to write a string to a file.
DeviceWiper	A `ITargetPreparer` that wipes userdata
DisableSELinuxTargetPreparer	Target preparer that disables SELinux if enabled.
EraseUserDataPreparer	A `ITargetPreparer` that wipes user data on the device.
FastbootCommandPreparer	Target preparer that triggers fastboot and sends fastboot commands.
FileCleaner	A `ITargetCleaner` that removes filesystem files on teardown
FolderSaver	A `ITargetCleaner` that pulls directories off device, compresses and saves it into logging backend.
ITargetCleaner	Cleans up the target device after the test run has finished.
InstallAllTestZipAppsSetup	A `ITargetPreparer` that installs all apps in a test zip.
InstallApexModuleTargetPreparer
InstallApkSetup	A `ITargetPreparer` that installs one or more apks located on the filesystem.
InstallBuildEnvApkSetup	A `ITargetPreparer` that installs one or more test apks from an Android platform build env.
InstrumentationPreparer	A `ITargetPreparer` that runs instrumentation
KeyValueConfigPreparer	A `ITargetPreparer` which creates and pushes a simple key/value config file to the device.
NativeLeakCollector	A `ITargetCleaner` that runs 'dumpsys meminfo --unreachable -a' to identify the unreachable native memory currently held by each process.
NoApkTestSkipper	Special preparer that allows to skip an invocation completely (preparation and tests) if there are no apks to tests.
PerfettoPreparer	Perfetto preparer pushes the config file in to the device at a standard location to which perfetto have access.
PreloadedClassesPreparer	A `ITargetPreparer` that replaces the preloaded classes file on a device.
PushFileInvoker	A `ITargetPreparer` that pushes files from tests zip onto device, mark them as executable and invokes the binary or script on device.
PushFilePreparer	A `ITargetPreparer` that attempts to push any number of files from any host path to any device path.
PythonVirtualenvPreparer	Sets up a Python virtualenv on the host and installs packages.
RebootTargetPreparer	Target preparer that reboots the device.
RemoveSystemAppPreparer	A `ITargetPreparer` for removing an apk from the system partition before a test run.
RestartSystemServerTargetPreparer	Target preparer that restarts the system server without rebooting the device.
RootTargetPreparer	Target preparer that performs "adb root".
RunCommandTargetPreparer
RunHostCommandTargetPreparer	Target preparer to run arbitrary host commands before and after running the test.
SemaphoreTokenTargetPreparer	This is a preparer used to use token to serialize test excution in tradefed host.
StopServicesSetup	A `ITargetPreparer` that stops services on the device.
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.
SwitchUserTargetPreparer	A `ITargetPreparer` that switches to the specified user kind in setUp.
TearDownPassThroughPreparer	Allows for running tearDown on preparers that are included in a config as an object.
TemperatureThrottlingWaiter	An `ITargetPreparer` that waits until device's temperature gets down to target
TestAppInstallSetup	A `ITargetPreparer` that installs one or more apps from a `IDeviceBuildInfo#getTestsDir()` folder onto device.
TestFilePushSetup	A `ITargetPreparer` that pushes one or more files/dirs from a `IDeviceBuildInfo#getTestsDir()` folder onto device.
TestSystemAppInstallSetup	A `ITargetPreparer` that installs one or more apps from a `IDeviceBuildInfo#getTestsDir()` folder onto the /system partition on device.
TimeSetterTargetPreparer	Target preparer to restore the correct time to the device on cleanup.
TimeWaster	A simple target preparer to waste time and potentially restart the device.
UserCleaner	A `ITargetCleaner` that removes secondary users on teardown.
WaitForDeviceDatetimePreparer	A `ITargetPreparer` that waits for datetime to be set on device Optionally this preparer can force a `TargetSetupError` if datetime is not set within timeout, or force host datetime onto device,
WifiPreparer	A `ITargetPreparer` that configures wifi on the device if necessary.

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
`abstract void`	`setUp(ITestDevice device, IBuildInfo buildInfo)` Perform the target setup for testing.

Public methods

setUp

public abstract void setUp (ITestDevice device, 
                IBuildInfo buildInfo)

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
`DeviceNotAvailableException`	if device became unresponsive
`BuildError`