构建信息
public interface IBuildInfo
com.android.tradefed.build.IBuildInfo |
保存有关被测构建的信息。
概括
常量 | |
---|---|
String | REMOTE_FILE_PREFIX 名称中使用的前缀表示文件设置为延迟下载。 |
String | REMOTE_FILE_VERSION 远程文件未版本化。 |
String | UNKNOWN_BUILD_ID 构建 ID 未知时的默认值。 |
公共方法 | |
---|---|
default void | addAppPackageFile (File appPackageFile, String version) 添加本地 apk 文件及其关联版本。 |
abstract void | addBuildAttribute (String attributeName, String attributeValue) 添加构建属性。 |
default void | addBuildAttributes ( buildAttributes) addBuildAttributes ( buildAttributes) 添加构建属性 |
abstract void | cleanUp () 清理所有临时构建文件 |
abstract void | cleanUp ( doNotDelete) cleanUp ( doNotDelete) 不删除某些文件的 |
abstract IBuildInfo | clone () 克隆 |
default | getAppPackageFiles () 获取一组本地应用程序 apk 文件及其版本的副本。 |
abstract | getBuildAttributes () 获取一组描述构建的附加属性的名称-值对。 |
abstract String | getBuildBranch () 可选方法,用于返回生成被测试构建的源代码控制分支。 |
abstract String | getBuildFlavor () 返回正在测试的构建类型的可选方法。 |
abstract String | getBuildId () 返回被测构建的唯一标识符。 |
abstract String | getBuildTargetName () 返回正在测试的构建的完整名称。 |
abstract String | getDeviceSerial () |
abstract File | getFile (String name) 检索具有给定名称的文件的辅助方法。 |
default File | getFile ( BuildInfoKey.BuildInfoFileKey key) 使用给定的 |
abstract | getFiles () 返回存储在此 |
abstract | getProperties () 返回当前在 |
default | getRemoteFiles () 获取延迟下载的构建工件的路径。 |
abstract String | getTestTag () 返回正在运行的测试的唯一名称。 |
default String | getVersion ( BuildInfoKey.BuildInfoFileKey key) 使用给定的 |
abstract String | getVersion (String name) 用于检索具有给定名称的文件版本的帮助程序方法。 |
default VersionedFile | getVersionedFile ( BuildInfoKey.BuildInfoFileKey key) 使用给定的 |
default VersionedFile | getVersionedFile (String name) 用于检索具有给定名称的 |
default | getVersionedFileKeys () 返回可用于通过 |
default | getVersionedFiles ( BuildInfoKey.BuildInfoFileKey key) 检索与给定 |
default void | removeBuildAttribute (String attributeName) 从跟踪中删除给定的 attributeName。 |
abstract void | setBuildBranch (String branch) 设置构建分支 |
abstract void | setBuildFlavor (String buildFlavor) 设置构建风格。 |
abstract void | setBuildId (String buildId) 设置被测构建的唯一标识符。 |
abstract void | setDeviceSerial (String serial) 设置与此构建关联的 |
abstract void | setFile (String name, File file, String version) 在此构建信息中存储具有给定名称的文件。 |
default void | setFile ( BuildInfoKey.BuildInfoFileKey key, File file, String version) 在此构建信息中存储给定 |
abstract void | setProperties ( BuildInfoProperties... properties) |
abstract void | setTestTag (String testTag) 为正在运行的测试设置唯一名称。 |
default File | stageRemoteFile (String fileName, File workingDir) 在构建信息的根目录中暂存一个属于远程文件的文件。 |
default BuildInformation.BuildInfo | toProto () 将 BuildInfo 实例序列化为 protobuf。 |
常量
REMOTE_FILE_PREFIX
public static final String REMOTE_FILE_PREFIX
名称中使用的前缀表示文件设置为延迟下载。
常数值:“remote_file:”
REMOTE_FILE_VERSION
public static final String REMOTE_FILE_VERSION
远程文件未版本化。
恒定值:“”
UNKNOWN_BUILD_ID
public static final String UNKNOWN_BUILD_ID
构建 ID 未知时的默认值。
常数值:“-1”
公共方法
添加应用程序包文件
public void addAppPackageFile (File appPackageFile, String version)
添加本地 apk 文件及其关联版本。请注意,apk 将按照此方法添加它们的顺序从getAppPackageFiles()
返回。
参数 | |
---|---|
appPackageFile | File |
version | String |
添加构建属性
public abstract void addBuildAttribute (String attributeName, String attributeValue)
添加构建属性。这不允许覆盖现有的 attributeName。
参数 | |
---|---|
attributeName | String : 唯一的属性名称 |
attributeValue | String : 属性值 |
添加构建属性
public void addBuildAttributes (buildAttributes)
添加构建属性
参数 | |
---|---|
buildAttributes |
清理
public abstract void cleanUp ()
清理所有临时构建文件
获取应用程序包文件
publicgetAppPackageFiles ()
获取一组本地应用程序 apk 文件及其版本的副本。返回的顺序与将 apk 添加到IAppBuildInfo
顺序相匹配。
退货 | |
---|---|
获取构建分支
public abstract String getBuildBranch ()
可选方法,用于返回生成被测试构建的源代码控制分支。
退货 | |
---|---|
String | 构建分支或null 如果未设置/不适用 |
获取BuildFlavor
public abstract String getBuildFlavor ()
返回正在测试的构建类型的可选方法。
Android 平台构建的一个常见实现是返回(构建产品)-(构建操作系统)-(构建变体)。即通用-linux-userdebug退货 | |
---|---|
String | 构建风格或null 如果未设置/不适用 |
getBuildTargetName
public abstract String getBuildTargetName ()
返回正在测试的构建的完整名称。
一个常见的实现是通过构建风格和分支名称的组合来构造构建目标名称。 [即(分支名称)-(构建风味)]退货 | |
---|---|
String |
获取设备序列号
public abstract String getDeviceSerial ()
退货 | |
---|---|
String | 执行此构建的ITestDevice 序列号。如果没有设备与此构建关联,则返回null 。 |
获取文件
public abstract File getFile (String name)
检索具有给定名称的文件的辅助方法。
退货 | |
---|---|
File | 图像文件或null 如果找不到 |
获取文件
public File getFile (BuildInfoKey.BuildInfoFileKey key)
使用给定的BuildInfoFileKey
检索文件的辅助方法。
参数 | |
---|---|
key | BuildInfoKey.BuildInfoFileKey :请求的BuildInfoFileKey 。 |
退货 | |
---|---|
File | 图像文件或null 如果找不到 |
获取远程文件
publicgetRemoteFiles ()
获取延迟下载的构建工件的路径。
退货 | |
---|---|
获取测试标签
public abstract String getTestTag ()
返回正在运行的测试的唯一名称。
退货 | |
---|---|
String |
获取版本
public String getVersion (BuildInfoKey.BuildInfoFileKey key)
使用给定的BuildInfoFileKey
检索文件版本的帮助程序方法。
参数 | |
---|---|
key | BuildInfoKey.BuildInfoFileKey :请求的BuildInfoFileKey 。 |
退货 | |
---|---|
String | 图像版本,如果未找到则为null |
获取版本
public abstract String getVersion (String name)
用于检索具有给定名称的文件版本的帮助程序方法。
退货 | |
---|---|
String | 图像版本,如果未找到则为null |
获取版本文件
public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)
使用给定的BuildInfoFileKey
检索VersionedFile
帮助程序方法。
参数 | |
---|---|
key | BuildInfoKey.BuildInfoFileKey :请求的BuildInfoFileKey 。 |
退货 | |
---|---|
VersionedFile | 版本化文件,如果未找到则为null |
获取版本文件
public VersionedFile getVersionedFile (String name)
用于检索具有给定名称的VersionedFile
帮助程序方法。
退货 | |
---|---|
VersionedFile | 版本化文件,如果未找到则为null |
getVersionedFileKeys
publicgetVersionedFileKeys ()
返回可用于通过getFile(BuildInfoFileKey)
查询VersionedFile
键集。
退货 | |
---|---|
获取版本文件
publicgetVersionedFiles (BuildInfoKey.BuildInfoFileKey key)
检索与给定BuildInfoFileKey
关联的VersionedFile
列表的辅助方法。如果密钥允许存储列表。
参数 | |
---|---|
key | BuildInfoKey.BuildInfoFileKey :请求的BuildInfoFileKey 。 |
退货 | |
---|---|
版本化文件,如果未找到则为null |
移除构建属性
public void removeBuildAttribute (String attributeName)
从跟踪中删除给定的 attributeName。
参数 | |
---|---|
attributeName | String : 停止跟踪的属性 |
设置BuildBranch
public abstract void setBuildBranch (String branch)
设置构建分支
参数 | |
---|---|
branch | String : 分支名称 |
设置BuildFlavor
public abstract void setBuildFlavor (String buildFlavor)
设置构建风格。
设置BuildId
public abstract void setBuildId (String buildId)
设置被测构建的唯一标识符。永远不应该为空。
参数 | |
---|---|
buildId | String |
设置设备序列号
public abstract void setDeviceSerial (String serial)
设置与此构建关联的ITestDevice
序列号。
参数 | |
---|---|
serial | String :执行此构建的ITestDevice 的序列号。 |
设置文件
public abstract void setFile (String name, File file, String version)
在此构建信息中存储具有给定名称的文件。
参数 | |
---|---|
name | String : 文件的唯一名称 |
file | File :本地ERROR(/File) |
version | String :文件版本 |
设置文件
public void setFile (BuildInfoKey.BuildInfoFileKey key, File file, String version)
在此构建信息中存储给定BuildInfoFileKey
文件。
参数 | |
---|---|
key | BuildInfoKey.BuildInfoFileKey :基于BuildInfoFileKey 文件的唯一名称。 |
file | File :本地ERROR(/File) |
version | String :文件版本 |
设置属性
public abstract void setProperties (BuildInfoProperties... properties)
为IBuildInfo
实例设置BuildInfoProperties
。覆盖之前设置的任何现有属性。
参数 | |
---|---|
properties | BuildInfoProperties :要添加的属性列表。 |
设置测试标签
public abstract void setTestTag (String testTag)
为正在运行的测试设置唯一名称。
参数 | |
---|---|
testTag | String |
阶段远程文件
public File stageRemoteFile (String fileName, File workingDir)
在构建信息的根目录中暂存一个属于远程文件的文件。
TODO(b/138416078):当测试所需的模块可以正确构建输出到测试模块目录本身时,删除此接口及其调用方。
参数 | |
---|---|
fileName | String :要位于远程文件中的文件的名称。 |
workingDir | File :用于暂存文件的目录的ERROR(/File) 对象。 |
退货 | |
---|---|
File | 在本地 workingDir 中暂存的文件的ERROR(/File) 对象。 |
到原型
public BuildInformation.BuildInfo toProto ()
将 BuildInfo 实例序列化为 protobuf。
退货 | |
---|---|
BuildInformation.BuildInfo |