構建信息

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)

不刪除某些文件的cleanUp()版本。

abstract IBuildInfo clone ()

克隆IBuildInfo對象。

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)

使用給定的BuildInfoFileKey檢索文件的輔助方法。

abstract getFiles ()

返回存儲在此BuildInfo中的所有VersionedFile

abstract getProperties ()

返回當前在IBuildInfo上設置的屬性的副本。

default getRemoteFiles ()

獲取延遲下載的構建工件的路徑。

abstract String getTestTag ()

返回正在運行的測試的唯一名稱。

default String getVersion ( BuildInfoKey.BuildInfoFileKey key)

使用給定的BuildInfoFileKey檢索文件版本的幫助程序方法。

abstract String getVersion (String name)

用於檢索具有給定名稱的文件版本的幫助程序方法。

default VersionedFile getVersionedFile ( BuildInfoKey.BuildInfoFileKey key)

使用給定的BuildInfoFileKey檢索VersionedFile幫助程序方法。

default VersionedFile getVersionedFile (String name)

用於檢索具有給定名稱的VersionedFile幫助程序方法。

default getVersionedFileKeys ()

返回可用於通過getFile(BuildInfoFileKey)查詢VersionedFile鍵集。

default getVersionedFiles ( BuildInfoKey.BuildInfoFileKey key)

檢索與給定BuildInfoFileKey關聯的VersionedFile列表的輔助方法。

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)

設置與此構建關聯的ITestDevice序列號。

abstract void setFile (String name, File file, String version)

在此構建信息中存儲具有給定名稱的文件。

default void setFile ( BuildInfoKey.BuildInfoFileKey key, File file, String version)

在此構建信息中存儲給定BuildInfoFileKey文件。

abstract void setProperties ( BuildInfoProperties... properties)

IBuildInfo實例設置BuildInfoProperties

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 ()

清理所有臨時構建文件

清理

public abstract void cleanUp ( doNotDelete)

不刪除某些文件的cleanUp()版本。

參數
doNotDelete

克隆

public abstract IBuildInfo clone ()

克隆IBuildInfo對象。

退貨
IBuildInfo

獲取應用程序包文件

public  getAppPackageFiles ()

獲取一組本地應用程序 apk 文件及其版本的副本。返回的順序與將 apk 添加到IAppBuildInfo順序相匹配。

退貨

獲取構建屬性

public abstract  getBuildAttributes ()

獲取一組描述構建的附加屬性的名稱-值對。

退貨
構建屬性的ERROR(/Map) 。不會為null ,但可能為空。

獲取構建分支

public abstract String getBuildBranch ()

可選方法,用於返回生成被測試構建的源代碼控制分支。

退貨
String構建分支或null如果未設置/不適用

獲取BuildFlavor

public abstract String getBuildFlavor ()

返回正在測試的構建類型的可選方法。

Android 平台構建的一個常見實現是返回(構建產品)-(構建操作系統)-(構建變體)。即通用-linux-userdebug

退貨
String構建風格或null如果未設置/不適用

獲取BuildId

public abstract String getBuildId ()

返回被測構建的唯一標識符。永遠不應該為空。默認為UNKNOWN_BUILD_ID

退貨
String

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如果找不到

獲取文件

public abstract  getFiles ()

返回存儲在此BuildInfo中的所有VersionedFile

退貨

獲取屬性

public abstract  getProperties ()

返回當前在IBuildInfo上設置的屬性的副本。

退貨

獲取遠程文件

public  getRemoteFiles ()

獲取延遲下載的構建工件的路徑。

退貨

獲取測試標籤

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

public  getVersionedFileKeys ()

返回可用於通過getFile(BuildInfoFileKey)查詢VersionedFile鍵集。

退貨

獲取版本文件

public  getVersionedFiles (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