DeviceBuildInfo

public class DeviceBuildInfo
extends BuildInfo implements IDeviceBuildInfo

java.lang.Object
   ↳ com.android.tradefed.build.BuildInfo
     ↳ com.android.tradefed.build.DeviceBuildInfo


A IBuildInfo that represents a complete Android device build and (optionally) its tests.

Summary

Public constructors

DeviceBuildInfo()
DeviceBuildInfo(BuildInfo buildInfo)
DeviceBuildInfo(String buildId, String buildTargetName)

Public methods

void cleanUp()

Clean up any temporary build files

void cleanUp(List<File> doNotClean)

Version of cleanUp() where some files are not deleted.

File getBasebandImageFile()

Get the local baseband image file.

String getBasebandVersion()

Get the baseband version.

File getBootloaderImageFile()

Get the local bootloader image file.

String getBootloaderVersion()

Get the bootloader version.

String getDeviceBuildFlavor()

Optional method to return the type of the platform build being tested.

String getDeviceBuildId()

Returns the unique identifier of platform build under test.

File getDeviceImageFile()

Get the local device image zip file.

String getDeviceImageVersion()

Get the local device image zip version.

File getMkbootimgFile()

Gets the mkbootimg file used to create the kernel image.

String getMkbootimgVersion()

Gets the mkbootimg version.

File getOtaPackageFile()

Get the device OTA package zip file.

String getOtaPackageVersion()

Get the device OTA package zip version.

File getRamdiskFile()

Gets the ramdisk file used to create the kernel image.

String getRamdiskVersion()

Gets the ramdisk version.

File getTestsDir()

Get the local path to the extracted tests.zip file contents.

String getTestsDirVersion()

Get the extracted tests.zip version.

File getTrustyImageFile()

Get the local trusty image file.

String getTrustyVersion()

Get the trusty version.

File getUserDataImageFile()

Get the local test userdata image file.

String getUserDataImageVersion()

Get the local test userdata image version.

void setBasebandImage(File basebandFile, String version)

Set the baseband image for the device build.

void setBootloaderImageFile(File bootloaderImgFile, String version)

Set the bootloader image for the device build.

void setDeviceBuildFlavor(String deviceBuildFlavor)

Set the build-flavor for the device part of the build info if different from setBuildFlavor(String).

void setDeviceImageFile(File deviceImageFile, String version)

Set the device system image file to use.

void setMkbootimgFile(File mkbootimg, String version)

Sets the mkbootimg file used to create the kernel image.

void setOtaPackageFile(File otaFile, String version)

Set the device OTA package zip file.

void setRamdiskFile(File ramdisk, String version)

Gets the ramdisk file used to create the kernel image.

void setTestsDir(File testsDir, String version)

Set local path to the extracted tests.zip file contents.

void setUserDataImageFile(File userDataFile, String version)

Set the user data image file to use.

final void unmountAll()

Unmounts mounted device images.

Public constructors

DeviceBuildInfo

public DeviceBuildInfo ()

DeviceBuildInfo

public DeviceBuildInfo (BuildInfo buildInfo)

Parameters
buildInfo BuildInfo

DeviceBuildInfo

public DeviceBuildInfo (String buildId, 
                String buildTargetName)

Parameters
buildId String

buildTargetName String

Public methods

cleanUp

public void cleanUp ()

Clean up any temporary build files

cleanUp

public void cleanUp (List<File> doNotClean)

Version of cleanUp() where some files are not deleted.

Parameters
doNotClean List

getBasebandImageFile

public File getBasebandImageFile ()

Get the local baseband image file.

Returns
File

getBasebandVersion

public String getBasebandVersion ()

Get the baseband version.

Returns
String

getBootloaderImageFile

public File getBootloaderImageFile ()

Get the local bootloader image file.

Returns
File

getBootloaderVersion

public String getBootloaderVersion ()

Get the bootloader version.

Returns
String

getDeviceBuildFlavor

public String getDeviceBuildFlavor ()

Optional method to return the type of the platform build being tested.

Returns
String

getDeviceBuildId

public String getDeviceBuildId ()

Returns the unique identifier of platform build under test. Should never be null. Defaults to IBuildInfo.UNKNOWN_BUILD_ID.

Returns
String getDeviceImageVersion() if not null, else IBuildInfo.UNKNOWN_BUILD_ID

getDeviceImageFile

public File getDeviceImageFile ()

Get the local device image zip file. The return value can be a directory which is the device image zip file uncompressed. Note that in the case of a directory, it can be a mounted read-only virtual filesystem which limits the operations that can be applied to the directory or its contents.

Returns
File

getDeviceImageVersion

public String getDeviceImageVersion ()

Get the local device image zip version.

Returns
String

getMkbootimgFile

public File getMkbootimgFile ()

Gets the mkbootimg file used to create the kernel image.

Returns
File

getMkbootimgVersion

public String getMkbootimgVersion ()

Gets the mkbootimg version.

Returns
String

getOtaPackageFile

public File getOtaPackageFile ()

Get the device OTA package zip file.

Returns
File

getOtaPackageVersion

public String getOtaPackageVersion ()

Get the device OTA package zip version.

Returns
String

getRamdiskFile

public File getRamdiskFile ()

Gets the ramdisk file used to create the kernel image.

Returns
File

getRamdiskVersion

public String getRamdiskVersion ()

Gets the ramdisk version.

Returns
String

getTestsDir

public File getTestsDir ()

Get the local path to the extracted tests.zip file contents.

Returns
File

getTestsDirVersion

public String getTestsDirVersion ()

Get the extracted tests.zip version.

Returns
String

getTrustyImageFile

public File getTrustyImageFile ()

Get the local trusty image file.

Returns
File

getTrustyVersion

public String getTrustyVersion ()

Get the trusty version.

Returns
String

getUserDataImageFile

public File getUserDataImageFile ()

Get the local test userdata image file.

Returns
File

getUserDataImageVersion

public String getUserDataImageVersion ()

Get the local test userdata image version.

Returns
String

setBasebandImage

public void setBasebandImage (File basebandFile, 
                String version)

Set the baseband image for the device build.

Parameters
basebandFile File: the baseband image File

version String: the version of the baseband

setBootloaderImageFile

public void setBootloaderImageFile (File bootloaderImgFile, 
                String version)

Set the bootloader image for the device build.

Parameters
bootloaderImgFile File: the bootloader image File

version String: the version of the bootloader

setDeviceBuildFlavor

public void setDeviceBuildFlavor (String deviceBuildFlavor)

Set the build-flavor for the device part of the build info if different from setBuildFlavor(String).

Parameters
deviceBuildFlavor String: Flavor of the device build

setDeviceImageFile

public void setDeviceImageFile (File deviceImageFile, 
                String version)

Set the device system image file to use.

Parameters
version String

setMkbootimgFile

public void setMkbootimgFile (File mkbootimg, 
                String version)

Sets the mkbootimg file used to create the kernel image.

Parameters
mkbootimg File

version String

setOtaPackageFile

public void setOtaPackageFile (File otaFile, 
                String version)

Set the device OTA package zip file.

Parameters
otaFile File

version String

setRamdiskFile

public void setRamdiskFile (File ramdisk, 
                String version)

Gets the ramdisk file used to create the kernel image.

Parameters
ramdisk File

version String

setTestsDir

public void setTestsDir (File testsDir, 
                String version)

Set local path to the extracted tests.zip file contents.

Parameters
version String

setUserDataImageFile

public void setUserDataImageFile (File userDataFile, 
                String version)

Set the user data image file to use.

Parameters
version String

unmountAll

public final void unmountAll ()

Unmounts mounted device images.

This is useful to unmount device images before the DeviceBuildInfo object is destroyed, for scenarios where cleanUp() can't be called due to file sharing, like copyAllFileFrom() has been called on this.