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.

GkiDeviceFlashPreparer

public class GkiDeviceFlashPreparer
extends BaseTargetPreparer

java.lang.Object
↳	com.android.tradefed.targetprep.BaseTargetPreparer
	↳	com.android.tradefed.targetprep.GkiDeviceFlashPreparer

A target preparer that flash the device with android common kernel generic image. Please see https://source.android.com/devices/architecture/kernel/android-common for details.

Summary

Public constructors
`GkiDeviceFlashPreparer()`

Public methods
`void`	`setUp(TestInformation testInfo)`
`void`	`validateGkiBootImg(ITestDevice device, IBuildInfo buildInfo)` Validate GKI boot image is expected.

Protected methods
`IHostOptions`	`getHostOptions()` Get a reference to the `IHostOptions`
`IRunUtil`	`getRunUtil()` Get the `IRunUtil` instance to use.
`void`	`validateGkiBootImg(ITestDevice device, IBuildInfo buildInfo, File tmpDir)` Validate GKI boot image is expected.

Public constructors

GkiDeviceFlashPreparer

public GkiDeviceFlashPreparer ()

Public methods

setUp

public void setUp (TestInformation testInfo)

Parameters
`testInfo`	`TestInformation`

Throws
`BuildError`
`DeviceNotAvailableException`
`TargetSetupError`

validateGkiBootImg

public void validateGkiBootImg (ITestDevice device, 
                IBuildInfo buildInfo)

Validate GKI boot image is expected. (Obsoleted. Please call with tmpDir provided)

Parameters
`device`	`ITestDevice`: the `ITestDevice`
`buildInfo`	`IBuildInfo`: the `IBuildInfo` the build info

Throws
`TargetSetupError`	if there is no valid gki boot.img

Protected methods

getHostOptions

protected IHostOptions getHostOptions ()

Get a reference to the IHostOptions

Returns
`IHostOptions`	the `IHostOptions` to use

getRunUtil

protected IRunUtil getRunUtil ()

Get the IRunUtil instance to use.

Returns
`IRunUtil`	the `IRunUtil` to use

validateGkiBootImg

protected void validateGkiBootImg (ITestDevice device, 
                IBuildInfo buildInfo, 
                File tmpDir)

Validate GKI boot image is expected. Throw exception if there is no valid boot.img.

Parameters
`device`	`ITestDevice`: the `ITestDevice`
`buildInfo`	`IBuildInfo`: the `IBuildInfo` the build info
`tmpDir`	`File`: the temporary directory `ERROR(/File)`

Throws
`TargetSetupError`	if there is no valid gki boot.img