IBuildInfo

public interface IBuildInfo
implements Serializable

com.android.tradefed.build.IBuildInfo

מכיל מידע על הגרסה שנבדקת.

סיכום

ערכים קבועים

String REMOTE_FILE_PREFIX

תחילית שמשמשת בשם כדי לציין שההורדה של הקובץ מוגדרת להשהיה.

String REMOTE_FILE_VERSION

לקובץ המרוחק אין גרסאות.

String UNKNOWN_BUILD_ID

ערך ברירת המחדל כשמזהה ה-build לא ידוע.

‫methods ציבוריים

default void addAppPackageFile(File appPackageFile, String version)

הוספה של קובץ ה-APK המקומי והגרסה שמשויכת אליו.

abstract void addBuildAttribute(String attributeName, String attributeValue)

מוסיפים מאפיין build.

default void addBuildAttributes(Map<String, String> buildAttributes)

הוספת מאפייני build

default void allowStagingRemoteFile(boolean stageRemoteFile)

הגדרה של הרשאה שמאפשרת העברה של קבצים מרוחקים לסביבת פיתוח.

abstract void cleanUp()

ניקוי של קבצים זמניים של גרסת build

abstract void cleanUp(List<File> doNotDelete)

גרסה של cleanUp() שבה חלק מהקבצים לא נמחקים.

abstract IBuildInfo clone()

משכפל את אובייקט IBuildInfo.

default List<VersionedFile> getAppPackageFiles()

מקבל עותק של קובצי ה-APK של האפליקציה המקומית ושל הגרסאות שלהם.

abstract Map<String, String> getBuildAttributes()

קבלת קבוצה של צמדי שם/ערך של מאפיינים נוספים שמתארים את הבנייה.

abstract String getBuildBranch()

שיטה אופציונלית להחזרת ענף בקרת המקור שממנו נוצרת הגרסה שנבדקת.

abstract String getBuildFlavor()

שיטה אופציונלית להחזרת סוג ה-build שנבדק.

abstract String getBuildId()

מחזירה את המזהה הייחודי של הגרסה שנבדקת.

abstract String getBuildTargetName()

החזרת השם המלא של הגרסה שנבדקת.

abstract String getDeviceSerial()
abstract File getFile(String name)

שיטת עזר לאחזור קובץ עם שם נתון.

default File getFile(BuildInfoKey.BuildInfoFileKey key)

שיטת עזר לאחזור קובץ עם BuildInfoFileKey נתון.

abstract Collection<VersionedFile> getFiles()

מחזירה את כל ה-VersionedFiles שמאוחסנים ב-BuildInfo הזה.

abstract Set<IBuildInfo.BuildInfoProperties> getProperties()

הפונקציה מחזירה עותק של המאפיינים שמוגדרים כרגע ב-IBuildInfo.

default Set<File> getRemoteFiles()

קבלת הנתיבים של פריטי מידע שנוצרים בתהליך פיתוח (Artifact) שלא הורדו בזמן.

abstract String getTestTag()

הפונקציה מחזירה שם ייחודי לבדיקות שמופעלות.

default String getVersion(BuildInfoKey.BuildInfoFileKey key)

שיטת עזר לאחזור גרסת קובץ עם BuildInfoFileKey נתון.

abstract String getVersion(String name)

שיטת עזר לאחזור גרסת קובץ עם שם נתון.

default VersionedFile getVersionedFile(BuildInfoKey.BuildInfoFileKey key)

שיטת עזר לאחזור VersionedFile עם BuildInfoFileKey נתון.

default VersionedFile getVersionedFile(String name)

שיטת עזר לאחזור VersionedFile עם שם נתון.

default Set<String> getVersionedFileKeys()

הפונקציה מחזירה את קבוצת המפתחות שאפשר לשלוח לגביהם שאילתות אל VersionedFile באמצעות getFile(BuildInfoFileKey).

default List<VersionedFile> getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)

שיטת עזר לאחזור רשימה של VersionedFile שמשויכים ל-BuildInfoFileKey נתון.

default void removeBuildAttribute(String attributeName)

הסרה של attributeName מסוים מהמעקב.

abstract void setBuildBranch(String branch)

הגדרת ענף הבנייה

abstract void setBuildFlavor(String buildFlavor)

מגדירים את טעם ה-build.

abstract void setBuildId(String buildId)

הגדרת המזהה הייחודי של גרסת ה-build שנבדקת.

abstract void setDeviceSerial(String serial)

מגדירים את המספר הסידורי של ITestDevice שמשויך לגרסה הזו.

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

שומר קובץ בהינתן BuildInfoFileKey בפרטי הגרסה האלה.

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

שומר קובץ עם שם נתון בפרטי הגרסה הזו.

abstract void setProperties(BuildInfoProperties... properties)

מגדירים את BuildInfoProperties למופע IBuildInfo.

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

ערך ברירת המחדל כשמזהה ה-build לא ידוע.

ערך קבוע: "-1"

‫methods ציבוריים

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

הוספה של קובץ ה-APK המקומי והגרסה שמשויכת אליו. שימו לב: קובצי ה-APK יוחזרו מ-getAppPackageFiles() לפי הסדר שבו הם נוספו באמצעות השיטה הזו.

פרמטרים
appPackageFile File

version String

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

מוסיפים מאפיין build. אי אפשר להשתמש בשיטה הזו כדי לבטל מאפיין קיים.

פרמטרים
attributeName String: שם המאפיין הייחודי
attributeValue ‫String: ערך המאפיין

addBuildAttributes

public void addBuildAttributes (Map<String, String> buildAttributes)

הוספת מאפייני build

פרמטרים
buildAttributes ‫Map: מיפוי של מאפיינים שצריך להוסיף

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

הגדרה של הרשאה שמאפשרת העברה של קבצים מרוחקים לסביבת פיתוח.

פרמטרים
stageRemoteFile boolean

cleanUp

public abstract void cleanUp ()

ניקוי של קבצים זמניים של גרסת build

cleanUp

public abstract void cleanUp (List<File> doNotDelete)

גרסה של cleanUp() שבה חלק מהקבצים לא נמחקים.

פרמטרים
doNotDelete List

שכפל

public abstract IBuildInfo clone ()

משכפל את אובייקט IBuildInfo.

החזרות
IBuildInfo

getAppPackageFiles

public List<VersionedFile> getAppPackageFiles ()

מקבל עותק של קובצי ה-APK של האפליקציה המקומית ושל הגרסאות שלהם. הסדר שמוחזר זהה לסדר שבו קובצי ה-APK נוספו ל-IAppBuildInfo.

החזרות
List<VersionedFile>

getBuildAttributes

public abstract Map<String, String> getBuildAttributes ()

קבלת קבוצה של צמדי שם/ערך של מאפיינים נוספים שמתארים את הבנייה.

החזרות
Map<String, String> Map של מאפייני בנייה. לא יהיה null, אבל יכול להיות ריק.

getBuildBranch

public abstract String getBuildBranch ()

שיטה אופציונלית להחזרת ענף בקרת המקור שממנו נוצרת הגרסה שנבדקת.

החזרות
String ענף הבנייה או null אם לא מוגדר או לא רלוונטי

getBuildFlavor

public abstract String getBuildFlavor ()

שיטה אופציונלית להחזרת סוג ה-build שנבדק.

הטמעה נפוצה של גרסאות build בפלטפורמת Android היא החזרת הערך (build product)-(build os)-(וריאנט build). למשל, generic-linux-userdebug

החזרות
String הגרסה או null אם לא הוגדרה או לא רלוונטית

getBuildId

public abstract String getBuildId ()

מחזירה את המזהה הייחודי של הגרסה שנבדקת. הערך אף פעם לא יכול להיות null. ברירת המחדל היא UNKNOWN_BUILD_ID.

החזרות
String

getBuildTargetName

public abstract String getBuildTargetName ()

החזרת השם המלא של הגרסה שנבדקת.

הטמעה נפוצה היא בניית שם יעד הבנייה משילוב של טעם הבנייה ושם הענף. [ie (branch name)-(build flavor)]

החזרות
String

getDeviceSerial

public abstract String getDeviceSerial ()

החזרות
String מספר ITestDevice סידורי שההרצה של הגרסה הזו בוצעה בו. הפונקציה מחזירה null אם אין מכשיר שמשויך לגרסת ה-build הזו.

getFile

public abstract File getFile (String name)

שיטת עזר לאחזור קובץ עם שם נתון.

החזרות
File קובץ התמונה או null אם לא נמצא

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

שיטת עזר לאחזור קובץ עם BuildInfoFileKey נתון.

פרמטרים
key ‫BuildInfoKey.BuildInfoFileKey: BuildInfoFileKey שהתבקש.
החזרות
File קובץ התמונה או null אם לא נמצא

getFiles

public abstract Collection<VersionedFile> getFiles ()

מחזירה את כל ה-VersionedFiles שמאוחסנים ב-BuildInfo הזה.

החזרות
Collection<VersionedFile>

getProperties

public abstract Set<IBuildInfo.BuildInfoProperties> getProperties ()

הפונקציה מחזירה עותק של המאפיינים שמוגדרים כרגע ב-IBuildInfo.

החזרות
Set<IBuildInfo.BuildInfoProperties>

getRemoteFiles

public Set<File> getRemoteFiles ()

קבלת הנתיבים של פריטי מידע שנוצרים בתהליך פיתוח (Artifact) שלא הורדו בזמן.

החזרות
Set<File>

getTestTag

public abstract String getTestTag ()

הפונקציה מחזירה שם ייחודי לבדיקות שמופעלות.

החזרות
String

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

שיטת עזר לאחזור גרסת קובץ עם BuildInfoFileKey נתון.

פרמטרים
key ‫BuildInfoKey.BuildInfoFileKey: BuildInfoFileKey שהתבקש.
החזרות
String גרסת התמונה או null אם לא נמצאה

getVersion

public abstract String getVersion (String name)

שיטת עזר לאחזור גרסת קובץ עם שם נתון.

החזרות
String גרסת התמונה או null אם לא נמצאה

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

שיטת עזר לאחזור VersionedFile עם BuildInfoFileKey נתון.

פרמטרים
key ‫BuildInfoKey.BuildInfoFileKey: BuildInfoFileKey שהתבקש.
החזרות
VersionedFile הקובץ עם הגרסה או null אם הוא לא נמצא

getVersionedFile

public VersionedFile getVersionedFile (String name)

שיטת עזר לאחזור VersionedFile עם שם נתון.

החזרות
VersionedFile הקובץ עם הגרסה או null אם הוא לא נמצא

getVersionedFileKeys

public Set<String> getVersionedFileKeys ()

הפונקציה מחזירה את קבוצת המפתחות שאפשר לשלוח לגביהם שאילתות אל VersionedFile באמצעות getFile(BuildInfoFileKey).

החזרות
Set<String>

getVersionedFiles

public List<VersionedFile> getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

שיטת עזר לאחזור רשימה של VersionedFile שמשויכים ל-BuildInfoFileKey נתון. אם המפתח מאפשר לאחסן רשימה.

פרמטרים
key ‫BuildInfoKey.BuildInfoFileKey: BuildInfoFileKey שהתבקש.
החזרות
List<VersionedFile> הקובץ עם הגרסה או null אם הוא לא נמצא

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

הסרה של attributeName מסוים מהמעקב.

פרמטרים
attributeName ‫String: המאפיין שרוצים להפסיק לעקוב אחריו

setBuildBranch

public abstract void setBuildBranch (String branch)

הגדרת ענף הבנייה

פרמטרים
branch ‫String: שם הענף

setBuildFlavor

public abstract void setBuildFlavor (String buildFlavor)

מגדירים את טעם ה-build.

setBuildId

public abstract void setBuildId (String buildId)

הגדרת המזהה הייחודי של גרסת ה-build שנבדקת. הערך אף פעם לא יכול להיות null.

פרמטרים
buildId String

setDeviceSerial

public abstract void setDeviceSerial (String serial)

מגדירים את המספר הסידורי של ITestDevice שמשויך לגרסה הזו.

פרמטרים
serial ‫String: המספר הסידורי של ITestDevice שבו בוצעה הבנייה הזו.

setFile

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

שומר קובץ בהינתן BuildInfoFileKey בפרטי הגרסה האלה.

פרמטרים
key ‫BuildInfoKey.BuildInfoFileKey: השם הייחודי של הקובץ על סמך BuildInfoFileKey.
file ‫File: File המקומי
version ‫String: גרסת הקובץ

setFile

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

שומר קובץ עם שם נתון בפרטי הגרסה הזו.

פרמטרים
name ‫String: השם הייחודי של הקובץ
file ‫File: File המקומי
version ‫String: גרסת הקובץ

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

מגדירים את BuildInfoProperties למופע IBuildInfo. החלפת מאפיינים קיימים שהוגדרו קודם.

פרמטרים
properties ‫BuildInfoProperties: רשימת המאפיינים שרוצים להוסיף.

setTestTag

public abstract void setTestTag (String testTag)

הגדרת שם ייחודי לבדיקות שמופעלות.

פרמטרים
testTag String

stageRemoteFile

public File stageRemoteFile (String fileName, 
                File workingDir)

העלאה של קובץ שהוא חלק מקבצים מרוחקים בספריית הבסיס של פרטי הגרסה.

TODO(b/138416078): Remove this interface and its caller when modules required by a test can be properly built output to the test module's directory itself.

פרמטרים
fileName ‫String: שם הקובץ שצריך לאתר בקבצים מרוחקים.
workingDir ‫File: אובייקט File של הספרייה שבה רוצים להכין את הקובץ.
החזרות
File האובייקט File של הקובץ שהועבר להמתנה ב-local workingDir.

toProto

public BuildInformation.BuildInfo toProto ()

סריאליזציה של מופע BuildInfo ל-protobuf.

החזרות
BuildInformation.BuildInfo