IBuildInfo
public
interface
IBuildInfo
com.android.tradefed.build.IBuildInfo |
Chứa thông tin về bản dựng đang được kiểm thử.
Tóm tắt
Hằng số | |
---|---|
String |
REMOTE_FILE_PREFIX
Tiền tố được dùng trong tên để cho biết tệp được đặt là tải xuống bị trì hoãn. |
String |
REMOTE_FILE_VERSION
Tệp từ xa không được tạo phiên bản. |
String |
UNKNOWN_BUILD_ID
Giá trị mặc định khi không xác định được mã bản dựng. |
Phương thức công khai | |
---|---|
default
void
|
addAppPackageFile(File appPackageFile, String version)
Thêm tệp apk cục bộ và phiên bản liên kết của tệp đó. |
abstract
void
|
addBuildAttribute(String attributeName, String attributeValue)
Thêm thuộc tính bản dựng. |
default
void
|
addBuildAttributes(
Thêm thuộc tính bản dựng |
default
void
|
allowStagingRemoteFile(boolean stageRemoteFile)
Đặt quyền cho phép lưu trữ các tệp từ xa. |
abstract
void
|
cleanUp()
Dọn dẹp mọi tệp bản dựng tạm thời |
abstract
void
|
cleanUp(
Phiên bản |
abstract
IBuildInfo
|
clone()
Sao chép đối tượng |
default
|
getAppPackageFiles()
Lấy bản sao của tập hợp(các) tệp apk ứng dụng cục bộ và phiên bản của các tệp đó. |
abstract
|
getBuildAttributes()
Nhận một tập hợp cặp tên-giá trị của các thuộc tính bổ sung mô tả bản dựng. |
abstract
String
|
getBuildBranch()
Phương thức không bắt buộc để trả về nhánh kiểm soát nguồn mà bản dựng đang được kiểm thử được tạo từ đó. |
abstract
String
|
getBuildFlavor()
Phương thức không bắt buộc để trả về loại bản dựng đang được kiểm thử. |
abstract
String
|
getBuildId()
Trả về giá trị nhận dạng duy nhất của bản dựng đang được kiểm thử. |
abstract
String
|
getBuildTargetName()
Trả về tên đầy đủ của bản dựng đang được kiểm thử. |
abstract
String
|
getDeviceSerial()
|
abstract
File
|
getFile(String name)
Phương thức trợ giúp để truy xuất tệp có tên đã cho. |
default
File
|
getFile(BuildInfoKey.BuildInfoFileKey key)
Phương thức trợ giúp để truy xuất tệp có |
abstract
|
getFiles()
Trả về tất cả |
abstract
|
getProperties()
Trả về bản sao của các thuộc tính hiện được đặt trên |
default
|
getRemoteFiles()
Nhận đường dẫn cho các cấu phần phần mềm bản dựng bị trì hoãn tải xuống. |
abstract
String
|
getTestTag()
Trả về một tên duy nhất cho các chương trình kiểm thử đang chạy. |
default
String
|
getVersion(BuildInfoKey.BuildInfoFileKey key)
Phương thức trợ giúp để truy xuất phiên bản tệp đã cho |
abstract
String
|
getVersion(String name)
Phương thức trợ giúp để truy xuất phiên bản tệp có tên đã cho. |
default
VersionedFile
|
getVersionedFile(BuildInfoKey.BuildInfoFileKey key)
Phương thức trợ giúp để truy xuất |
default
VersionedFile
|
getVersionedFile(String name)
Phương thức trợ giúp để truy xuất |
default
|
getVersionedFileKeys()
Trả về tập hợp các khoá có sẵn để truy vấn |
default
|
getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)
Phương thức trợ giúp để truy xuất danh sách |
default
void
|
removeBuildAttribute(String attributeName)
Xoá một attributeName nhất định khỏi tính năng theo dõi. |
abstract
void
|
setBuildBranch(String branch)
Đặt nhánh bản dựng |
abstract
void
|
setBuildFlavor(String buildFlavor)
Đặt phiên bản bản dựng. |
abstract
void
|
setBuildId(String buildId)
Đặt giá trị nhận dạng duy nhất của bản dựng đang được kiểm thử. |
abstract
void
|
setDeviceSerial(String serial)
Đặt số sê-ri |
abstract
void
|
setFile(String name, File file, String version)
Lưu trữ một tệp có tên đã cho trong thông tin bản dựng này. |
default
void
|
setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version)
Lưu trữ một tệp được cung cấp |
abstract
void
|
setProperties(BuildInfoProperties... properties)
Đặt |
abstract
void
|
setTestTag(String testTag)
Đặt tên duy nhất cho các chương trình kiểm thử đang chạy. |
default
File
|
stageRemoteFile(String fileName, File workingDir)
Đặt một tệp thuộc về các tệp từ xa trong thư mục gốc của thông tin bản dựng. |
default
BuildInformation.BuildInfo
|
toProto()
Tuần tự hoá thực thể BuildInfo thành protobuf. |
Hằng số
REMOTE_FILE_PREFIX
public static final String REMOTE_FILE_PREFIX
Tiền tố được dùng trong tên để cho biết tệp được đặt là tải xuống bị trì hoãn.
Giá trị không đổi: "remote_file:"
REMOTE_FILE_VERSION
public static final String REMOTE_FILE_VERSION
Tệp từ xa không được tạo phiên bản.
Giá trị không đổi: ""
UNKNOWN_BUILD_ID
public static final String UNKNOWN_BUILD_ID
Giá trị mặc định khi không xác định được mã bản dựng.
Giá trị không đổi: "-1"
Phương thức công khai
addAppPackageFile
public void addAppPackageFile (File appPackageFile, String version)
Thêm tệp apk cục bộ và phiên bản liên kết của tệp đó. Xin lưu ý rằng các tệp apk sẽ được trả về từ getAppPackageFiles()
theo thứ tự mà phương thức này thêm các tệp apk đó.
Tham số | |
---|---|
appPackageFile |
File |
version |
String |
addBuildAttribute
public abstract void addBuildAttribute (String attributeName, String attributeValue)
Thêm thuộc tính bản dựng. Điều này không cho phép ghi đè attributeName hiện có.
Tham số | |
---|---|
attributeName |
String : tên thuộc tính duy nhất |
attributeValue |
String : giá trị thuộc tính |
addBuildAttributes
public void addBuildAttributes (buildAttributes)
Thêm thuộc tính bản dựng
Tham số | |
---|---|
buildAttributes |
: Bản đồ các thuộc tính cần thêm |
allowStagingRemoteFile
public void allowStagingRemoteFile (boolean stageRemoteFile)
Đặt quyền cho phép lưu trữ các tệp từ xa.
Tham số | |
---|---|
stageRemoteFile |
boolean |
cleanUp
public abstract void cleanUp ()
Dọn dẹp mọi tệp bản dựng tạm thời
cleanUp
public abstract void cleanUp (doNotDelete)
Phiên bản cleanUp()
trong đó một số tệp không bị xoá.
Tham số | |
---|---|
doNotDelete |
|
nhân bản
public abstract IBuildInfo clone ()
Sao chép đối tượng IBuildInfo
.
Giá trị trả về | |
---|---|
IBuildInfo |
getAppPackageFiles
publicgetAppPackageFiles ()
Lấy bản sao của tập hợp(các) tệp apk ứng dụng cục bộ và phiên bản của các tệp đó. Thứ tự trả về khớp với thứ tự các tệp apk được thêm vào IAppBuildInfo
.
Giá trị trả về | |
---|---|
|
getBuildAttributes
public abstractgetBuildAttributes ()
Nhận một tập hợp cặp tên-giá trị của các thuộc tính bổ sung mô tả bản dựng.
Giá trị trả về | |
---|---|
|
ERROR(/Map) của các thuộc tính bản dựng. Sẽ không phải là null , nhưng có thể để trống. |
getBuildBranch
public abstract String getBuildBranch ()
Phương thức không bắt buộc để trả về nhánh kiểm soát nguồn mà bản dựng đang được kiểm thử được tạo từ đó.
Giá trị trả về | |
---|---|
String |
nhánh bản dựng hoặc null nếu không được đặt/không áp dụng |
getBuildFlavor
public abstract String getBuildFlavor ()
Phương thức không bắt buộc để trả về loại bản dựng đang được kiểm thử.
Một cách triển khai phổ biến cho các bản dựng nền tảng Android là trả về (build product)-(build os)-(build variant). ie generic-linux-userdebug
Giá trị trả về | |
---|---|
String |
phiên bản xây dựng hoặc null nếu không được đặt/không áp dụng |
getBuildId
public abstract String getBuildId ()
Trả về giá trị nhận dạng duy nhất của bản dựng đang được kiểm thử. Không được để trống. Giá trị mặc định là UNKNOWN_BUILD_ID
.
Giá trị trả về | |
---|---|
String |
getBuildTargetName
public abstract String getBuildTargetName ()
Trả về tên đầy đủ của bản dựng đang được kiểm thử.
Một cách triển khai phổ biến là tạo tên mục tiêu bản dựng từ tổ hợp phiên bản bản dựng và tên nhánh. [tức là (tên nhánh)-(phiên bản)]
Giá trị trả về | |
---|---|
String |
getDeviceSerial
public abstract String getDeviceSerial ()
Giá trị trả về | |
---|---|
String |
số sê-ri ITestDevice mà bản dựng này được thực thi. Trả về null
nếu không có thiết bị nào được liên kết với bản dựng này. |
getFile
public abstract File getFile (String name)
Phương thức trợ giúp để truy xuất tệp có tên đã cho.
Giá trị trả về | |
---|---|
File |
tệp hình ảnh hoặc null nếu không tìm thấy |
getFile
public File getFile (BuildInfoKey.BuildInfoFileKey key)
Phương thức trợ giúp để truy xuất tệp có BuildInfoFileKey
đã cho.
Tham số | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : BuildInfoFileKey được yêu cầu. |
Giá trị trả về | |
---|---|
File |
tệp hình ảnh hoặc null nếu không tìm thấy |
getFiles
public abstractgetFiles ()
Trả về tất cả VersionedFile
được lưu trữ trong BuildInfo
này.
Giá trị trả về | |
---|---|
|
getProperties
public abstractgetProperties ()
Trả về bản sao của các thuộc tính hiện được đặt trên IBuildInfo
.
Giá trị trả về | |
---|---|
|
getRemoteFiles
publicgetRemoteFiles ()
Nhận đường dẫn cho các cấu phần phần mềm bản dựng bị trì hoãn tải xuống.
Giá trị trả về | |
---|---|
|
getTestTag
public abstract String getTestTag ()
Trả về một tên duy nhất cho các chương trình kiểm thử đang chạy.
Giá trị trả về | |
---|---|
String |
getVersion
public String getVersion (BuildInfoKey.BuildInfoFileKey key)
Phương thức trợ giúp để truy xuất phiên bản tệp đã cho BuildInfoFileKey
.
Tham số | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : BuildInfoFileKey được yêu cầu. |
Giá trị trả về | |
---|---|
String |
phiên bản hình ảnh hoặc null nếu không tìm thấy |
getVersion
public abstract String getVersion (String name)
Phương thức trợ giúp để truy xuất phiên bản tệp có tên đã cho.
Giá trị trả về | |
---|---|
String |
phiên bản hình ảnh hoặc null nếu không tìm thấy |
getVersionedFile
public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)
Phương thức trợ giúp để truy xuất VersionedFile
bằng một BuildInfoFileKey
nhất định.
Tham số | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : BuildInfoFileKey được yêu cầu. |
Giá trị trả về | |
---|---|
VersionedFile |
Tệp có phiên bản hoặc null nếu không tìm thấy |
getVersionedFile
public VersionedFile getVersionedFile (String name)
Phương thức trợ giúp để truy xuất VersionedFile
có tên nhất định.
Giá trị trả về | |
---|---|
VersionedFile |
Tệp có phiên bản hoặc null nếu không tìm thấy |
getVersionedFileKeys
publicgetVersionedFileKeys ()
Trả về tập hợp các khoá có sẵn để truy vấn VersionedFile
thông qua getFile(BuildInfoFileKey)
.
Giá trị trả về | |
---|---|
|
getVersionedFiles
publicgetVersionedFiles (BuildInfoKey.BuildInfoFileKey key)
Phương thức trợ giúp để truy xuất danh sách VersionedFile
được liên kết với một BuildInfoFileKey
nhất định. Nếu khoá cho phép lưu trữ danh sách.
Tham số | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : BuildInfoFileKey được yêu cầu. |
Giá trị trả về | |
---|---|
|
Tệp có phiên bản hoặc null nếu không tìm thấy |
removeBuildAttribute
public void removeBuildAttribute (String attributeName)
Xoá một attributeName nhất định khỏi tính năng theo dõi.
Tham số | |
---|---|
attributeName |
String : thuộc tính để ngừng theo dõi |
setBuildBranch
public abstract void setBuildBranch (String branch)
Đặt nhánh bản dựng
Tham số | |
---|---|
branch |
String : tên nhánh |
setBuildFlavor
public abstract void setBuildFlavor (String buildFlavor)
Đặt phiên bản bản dựng.
setBuildId
public abstract void setBuildId (String buildId)
Đặt giá trị nhận dạng duy nhất của bản dựng đang được kiểm thử. Không được để trống.
Tham số | |
---|---|
buildId |
String |
setDeviceSerial
public abstract void setDeviceSerial (String serial)
Đặt số sê-ri ITestDevice
liên kết với bản dựng này.
Tham số | |
---|---|
serial |
String : số sê-ri của ITestDevice mà bản dựng này được thực thi. |
setFile
public abstract void setFile (String name, File file, String version)
Lưu trữ một tệp có tên đã cho trong thông tin bản dựng này.
Tham số | |
---|---|
name |
String : tên duy nhất của tệp |
file |
File : ERROR(/File) cục bộ |
version |
String : phiên bản tệp |
setFile
public void setFile (BuildInfoKey.BuildInfoFileKey key, File file, String version)
Lưu trữ một tệp được cung cấp BuildInfoFileKey
trong thông tin bản dựng này.
Tham số | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : tên duy nhất của tệp dựa trên BuildInfoFileKey . |
file |
File : ERROR(/File) cục bộ |
version |
String : phiên bản tệp |
setProperties
public abstract void setProperties (BuildInfoProperties... properties)
Đặt BuildInfoProperties
cho thực thể IBuildInfo
. Ghi đè mọi thuộc tính hiện có đã đặt trước đó.
Tham số | |
---|---|
properties |
BuildInfoProperties : Danh sách thuộc tính cần thêm. |
setTestTag
public abstract void setTestTag (String testTag)
Đặt tên duy nhất cho các chương trình kiểm thử đang chạy.
Tham số | |
---|---|
testTag |
String |
stageRemoteFile
public File stageRemoteFile (String fileName, File workingDir)
Đặt một tệp thuộc về các tệp từ xa trong thư mục gốc của thông tin bản dựng.
TODO(b/138416078): Xoá giao diện này và phương thức gọi của giao diện đó khi các mô-đun mà kiểm thử yêu cầu có thể được tạo đúng cách thành đầu ra cho chính thư mục của mô-đun kiểm thử.
Tham số | |
---|---|
fileName |
String : Tên của tệp sẽ nằm trong các tệp từ xa. |
workingDir |
File : đối tượng ERROR(/File) của thư mục để đưa tệp vào giai đoạn. |
Giá trị trả về | |
---|---|
File |
đối tượng ERROR(/File) của tệp được sắp xếp trong workingDir cục bộ. |
toProto
public BuildInformation.BuildInfo toProto ()
Tuần tự hoá thực thể BuildInfo thành protobuf.
Giá trị trả về | |
---|---|
BuildInformation.BuildInfo |