IBuildInfo
public
interface
IBuildInfo
com.android.tradefed.build.IBuildInfo |
Holds information about the build under test.
Summary
Nested classes | |
---|---|
enum |
IBuildInfo.BuildInfoProperties
Some properties that a |
Constants | |
---|---|
String |
UNKNOWN_BUILD_ID
Default value when build ID is unknown. |
Public methods | |
---|---|
abstract
void
|
addBuildAttribute(String attributeName, String attributeValue)
Add a build attribute |
default
void
|
addBuildAttributes(
Add build attributes |
abstract
void
|
cleanUp()
Clean up any temporary build files |
abstract
void
|
cleanUp(
Version of |
abstract
IBuildInfo
|
clone()
Clones the |
abstract
|
getBuildAttributes()
Get a set of name-value pairs of additional attributes describing the build. |
abstract
String
|
getBuildBranch()
Optional method to return the source control branch that the build being tested was produced from. |
abstract
String
|
getBuildFlavor()
Optional method to return the type of build being tested. |
abstract
String
|
getBuildId()
Returns the unique identifier of build under test. |
abstract
String
|
getBuildTargetName()
Return complete name for the build being tested. |
abstract
String
|
getDeviceSerial()
|
abstract
File
|
getFile(String name)
Helper method to retrieve a file with given name. |
default
File
|
getFile(BuildInfoKey.BuildInfoFileKey key)
Helper method to retrieve a file with given a |
abstract
|
getFiles()
Returns all |
abstract
|
getProperties()
Returns a copy of the properties currently set on the |
abstract
String
|
getTestTag()
Return a unique name for the tests being run. |
default
String
|
getVersion(BuildInfoKey.BuildInfoFileKey key)
Helper method to retrieve a file version with given a |
abstract
String
|
getVersion(String name)
Helper method to retrieve a file version with given name. |
default
VersionedFile
|
getVersionedFile(BuildInfoKey.BuildInfoFileKey key)
Helper method to retrieve a |
default
VersionedFile
|
getVersionedFile(String name)
Helper method to retrieve a |
default
|
getVersionedFileKeys()
Returns the set of keys available to query |
default
|
getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)
Helper method to retrieve a list of |
default
boolean
|
isTestResourceBuild()
Check if this build is a test resource build or not. |
abstract
void
|
setBuildBranch(String branch)
Set the build branch |
abstract
void
|
setBuildFlavor(String buildFlavor)
Set the build flavor. |
abstract
void
|
setBuildId(String buildId)
Sets the unique identifier of build under test. |
abstract
void
|
setDeviceSerial(String serial)
Set the |
abstract
void
|
setFile(String name, File file, String version)
Stores an file with given name in this build info. |
default
void
|
setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version)
Stores an file given a |
abstract
void
|
setProperties(BuildInfoProperties... properties)
Set the |
default
void
|
setTestResourceBuild(boolean testResourceBuild)
Set the build as test resource build. |
abstract
void
|
setTestTag(String testTag)
Sets the unique name for the tests being run. |
default
BuildInformation.BuildInfo
|
toProto()
Serialize a the BuildInfo instance into a protobuf. |
Constants
UNKNOWN_BUILD_ID
public static final String UNKNOWN_BUILD_ID
Default value when build ID is unknown.
Constant Value: "-1"
Public methods
addBuildAttribute
public abstract void addBuildAttribute (String attributeName, String attributeValue)
Add a build attribute
Parameters | |
---|---|
attributeName |
String : the unique attribute name |
attributeValue |
String : the attribute value
|
addBuildAttributes
public void addBuildAttributes (buildAttributes)
Add build attributes
Parameters | |
---|---|
buildAttributes |
: Map of attributes to be added
|
cleanUp
public abstract void cleanUp ()
Clean up any temporary build files
cleanUp
public abstract void cleanUp (doNotDelete)
Version of cleanUp()
where some files are not deleted.
Parameters | |
---|---|
doNotDelete |
|
getBuildAttributes
public abstractgetBuildAttributes ()
Get a set of name-value pairs of additional attributes describing the build.
Returns | |
---|---|
|
a ERROR(/Map) of build attributes. Will not be null , but may be empty.
|
getBuildBranch
public abstract String getBuildBranch ()
Optional method to return the source control branch that the build being tested was produced from.
Returns | |
---|---|
String |
the build branch or null if unset/not applicable
|
getBuildFlavor
public abstract String getBuildFlavor ()
Optional method to return the type of build being tested.
A common implementation for Android platform builds is to return (build product)-(build os)-(build variant). ie generic-linux-userdebugReturns | |
---|---|
String |
the build flavor or null if unset/not applicable
|
getBuildId
public abstract String getBuildId ()
Returns the unique identifier of build under test. Should never be null. Defaults to
UNKNOWN_BUILD_ID
.
Returns | |
---|---|
String |
getBuildTargetName
public abstract String getBuildTargetName ()
Return complete name for the build being tested.
A common implementation is to construct the build target name from a combination of the build flavor and branch name. [ie (branch name)-(build flavor)]Returns | |
---|---|
String |
getDeviceSerial
public abstract String getDeviceSerial ()
Returns | |
---|---|
String |
the ITestDevice serial that this build was executed on. Returns null
if no device is associated with this build.
|
getFile
public abstract File getFile (String name)
Helper method to retrieve a file with given name.
Returns | |
---|---|
File |
the image file or null if not found
|
getFile
public File getFile (BuildInfoKey.BuildInfoFileKey key)
Helper method to retrieve a file with given a BuildInfoFileKey
.
Parameters | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : the BuildInfoFileKey that is requested. |
Returns | |
---|---|
File |
the image file or null if not found
|
getProperties
public abstractgetProperties ()
Returns a copy of the properties currently set on the IBuildInfo
.
Returns | |
---|---|
|
getTestTag
public abstract String getTestTag ()
Return a unique name for the tests being run.
Returns | |
---|---|
String |
getVersion
public String getVersion (BuildInfoKey.BuildInfoFileKey key)
Helper method to retrieve a file version with given a BuildInfoFileKey
.
Parameters | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : The BuildInfoFileKey requested. |
Returns | |
---|---|
String |
the image version or null if not found
|
getVersion
public abstract String getVersion (String name)
Helper method to retrieve a file version with given name.
Returns | |
---|---|
String |
the image version or null if not found
|
getVersionedFile
public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)
Helper method to retrieve a VersionedFile
with a given BuildInfoFileKey
.
Parameters | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : The BuildInfoFileKey requested. |
Returns | |
---|---|
VersionedFile |
The versioned file or null if not found
|
getVersionedFile
public VersionedFile getVersionedFile (String name)
Helper method to retrieve a VersionedFile
with a given name.
Returns | |
---|---|
VersionedFile |
The versioned file or null if not found
|
getVersionedFileKeys
publicgetVersionedFileKeys ()
Returns the set of keys available to query VersionedFile
via getFile(BuildInfoKey.BuildInfoFileKey)
.
Returns | |
---|---|
|
getVersionedFiles
publicgetVersionedFiles (BuildInfoKey.BuildInfoFileKey key)
Helper method to retrieve a list of VersionedFile
s associated with a given BuildInfoFileKey
. If the key allows to store a list.
Parameters | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : The BuildInfoFileKey requested. |
Returns | |
---|---|
|
The versioned file or null if not found
|
isTestResourceBuild
public boolean isTestResourceBuild ()
Check if this build is a test resource build or not.
Returns | |
---|---|
boolean |
setBuildBranch
public abstract void setBuildBranch (String branch)
Set the build branch
Parameters | |
---|---|
branch |
String : the branch name
|
setBuildFlavor
public abstract void setBuildFlavor (String buildFlavor)
Set the build flavor.
setBuildId
public abstract void setBuildId (String buildId)
Sets the unique identifier of build under test. Should never be null.
Parameters | |
---|---|
buildId |
String |
setDeviceSerial
public abstract void setDeviceSerial (String serial)
Set the ITestDevice
serial associated with this build.
Parameters | |
---|---|
serial |
String : the serial number of the ITestDevice that this build was executed with.
|
setFile
public abstract void setFile (String name, File file, String version)
Stores an file with given name in this build info.
Parameters | |
---|---|
name |
String : the unique name of the file |
file |
File : the local ERROR(/File) |
version |
String : the file version
|
setFile
public void setFile (BuildInfoKey.BuildInfoFileKey key, File file, String version)
Stores an file given a BuildInfoFileKey
in this build info.
Parameters | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : the unique name of the file based on BuildInfoFileKey . |
file |
File : the local ERROR(/File) |
version |
String : the file version
|
setProperties
public abstract void setProperties (BuildInfoProperties... properties)
Set the BuildInfoProperties
for the IBuildInfo
instance. Override any
existing properties set before.
Parameters | |
---|---|
properties |
BuildInfoProperties : The list of properties to add.
|
setTestResourceBuild
public void setTestResourceBuild (boolean testResourceBuild)
Set the build as test resource build.
Parameters | |
---|---|
testResourceBuild |
boolean |
setTestTag
public abstract void setTestTag (String testTag)
Sets the unique name for the tests being run.
Parameters | |
---|---|
testTag |
String |
toProto
public BuildInformation.BuildInfo toProto ()
Serialize a the BuildInfo instance into a protobuf.
Returns | |
---|---|
BuildInformation.BuildInfo |
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2019-10-02 UTC.