to top
public class

SystemUpdaterDeviceFlasher

extends Object
implements IDeviceFlasher
java.lang.Object
   ↳ com.android.tradefed.targetprep.SystemUpdaterDeviceFlasher

Class Overview

A IDeviceFlasher that relies on the system updater to install a system image bundled in a OTA update package. In particular, this implementation doesn't rely on fastboot.

Summary

Public Constructors
SystemUpdaterDeviceFlasher()
Public Methods
void flash(ITestDevice device, IDeviceBuildInfo deviceBuild)
Flashes build on device.

This implementation assumes the device image file returned by getDeviceImageFile() is an OTA update zip.

IDeviceFlasher.UserDataFlashOption getUserDataFlashOption()
Gets whether the user data image should be flashed, wiped, or retained
void overrideDeviceOptions(ITestDevice device)
Override options for a device.
void setDataWipeSkipList(Collection<String> dataWipeSkipList)
Sets the list of paths under /data to avoid clearing when using ERROR(/ITestsZipInsaller)

Note that the granularity of the skip list is direct children of /data.

void setFlashingResourcesRetriever(IFlashingResourcesRetriever retriever)
Sets the mechanism by which the flasher can retrieve resource files for flashing.
void setForceSystemFlash(boolean forceSystemFlash)
Sets if system should always be flashed even if running current build
void setUserDataFlashOption(IDeviceFlasher.UserDataFlashOption flashOption)
Toggles whether the user data image should be flashed, wiped, or retained

This implementation only supports TESTS_ZIP and RETAIN as a valid options

[Expand]
Inherited Methods
From class java.lang.Object
From interface com.android.tradefed.targetprep.IDeviceFlasher

Public Constructors

public SystemUpdaterDeviceFlasher ()

Public Methods

public void flash (ITestDevice device, IDeviceBuildInfo deviceBuild)

Flashes build on device.

Returns immediately after flashing is complete. Callers should wait for device to be online and available before proceeding with testing.

This implementation assumes the device image file returned by getDeviceImageFile() is an OTA update zip. It's not safe to use this updater in a context where this interpretation doesn't hold.

Parameters
device the ITestDevice to flash
deviceBuild the IDeviceBuildInfo to flash
Throws
DeviceNotAvailableException
TargetSetupError
DeviceNotAvailableException

public IDeviceFlasher.UserDataFlashOption getUserDataFlashOption ()

Gets whether the user data image should be flashed, wiped, or retained

Returns
  • Whether the user data image should be flashed, wiped, or retained

public void overrideDeviceOptions (ITestDevice device)

Override options for a device. Used to override default option values if the defaults are not supported by a particular device.

public void setDataWipeSkipList (Collection<String> dataWipeSkipList)

Sets the list of paths under /data to avoid clearing when using ERROR(/ITestsZipInsaller)

Note that the granularity of the skip list is direct children of /data.

public void setFlashingResourcesRetriever (IFlashingResourcesRetriever retriever)

Sets the mechanism by which the flasher can retrieve resource files for flashing.

Parameters
retriever the IFlashingResourcesRetriever to use

public void setForceSystemFlash (boolean forceSystemFlash)

Sets if system should always be flashed even if running current build

public void setUserDataFlashOption (IDeviceFlasher.UserDataFlashOption flashOption)

Toggles whether the user data image should be flashed, wiped, or retained

This implementation only supports TESTS_ZIP and RETAIN as a valid options