IBuildInfo

public interface IBuildInfo

com.android.tradefed.build.IBuildInfo

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

סיכום

קבועים

String REMOTE_FILE_PREFIX

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

String REMOTE_FILE_VERSION

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

String UNKNOWN_BUILD_ID

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

שיטות ציבוריות

default void addAppPackageFile(File appPackageFile, String version)

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

abstract void addBuildAttribute(String attributeName, String attributeValue)

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

default void addBuildAttributes( buildAttributes)

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

default void allowStagingRemoteFile(boolean stageRemoteFile)

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

abstract void cleanUp()

ניקוי של קבצי build זמניים

abstract void cleanUp( doNotDelete)

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

abstract IBuildInfo clone()

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

default getAppPackageFiles()

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

abstract getBuildAttributes()

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

abstract String getBuildBranch()

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

abstract String getBuildFlavor()

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

abstract String getBuildId()

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

abstract String getBuildTargetName()

החזרת השם המלא של ה-build שנבדק.

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

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

default File getFile(BuildInfoKey.BuildInfoFileKey key)

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

abstract getFiles()

הפונקציה מחזירה את כל ה-VersionedFile שמאוחסנים ב-BuildInfo הזה.

abstract getProperties()

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

default getRemoteFiles()

הצגת הנתיבים של פריטי המידע שנוצרו בתהליך הפיתוח (artifacts) שההורדה שלהם מושהית.

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

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

default getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)

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

default void removeBuildAttribute(String attributeName)

הסרת attributeName נתון מהמעקב.

abstract void setBuildBranch(String branch)

הגדרת ההסתעפות ל-build

abstract void setBuildFlavor(String buildFlavor)

מגדירים את סוג ה-build.

abstract void setBuildId(String buildId)

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

abstract void setDeviceSerial(String serial)

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

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

שמירת קובץ בשם נתון בפרטי ה-build האלה.

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

שמירת קובץ עם BuildInfoFileKey בנתוני ה-build האלה.

abstract void setProperties(BuildInfoProperties... properties)

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

abstract void setTestTag(String testTag)

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

default File stageRemoteFile(String fileName, File workingDir)

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

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"

שיטות ציבוריות

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

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

פרמטרים
appPackageFile File

version String

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

מוסיפים מאפיין build. כך לא ניתן לשנות את attributeName הקיים.

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

addBuildAttributes

public void addBuildAttributes ( buildAttributes)

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

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

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

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

פרמטרים
stageRemoteFile boolean

cleanUp

public abstract void cleanUp ()

ניקוי של קבצי build זמניים

cleanUp

public abstract void cleanUp ( doNotDelete)

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

פרמטרים
doNotDelete

לשכפל

public abstract IBuildInfo clone ()

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

החזרות
IBuildInfo

getAppPackageFiles

public  getAppPackageFiles ()

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

החזרות

getBuildAttributes

public abstract  getBuildAttributes ()

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

החזרות
ERROR(/Map) של מאפייני build. לא יהיה null, אבל יכול להיות שהוא יהיה ריק.

getBuildBranch

public abstract String getBuildBranch ()

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

החזרות
String ההסתעפות של ה-build או null אם לא הוגדרה או לא רלוונטית

getBuildFlavor

public abstract String getBuildFlavor ()

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

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

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

getBuildId

public abstract String getBuildId ()

הפונקציה מחזירה את המזהה הייחודי של ה-build שנמצא בבדיקה. הערך לא יכול להיות null. ברירת המחדל היא UNKNOWN_BUILD_ID.

החזרות
String

getBuildTargetName

public abstract String getBuildTargetName ()

החזרת השם המלא של ה-build שנבדק.

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

החזרות
String

getDeviceSerial

public abstract String getDeviceSerial ()

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

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

הפונקציה מחזירה את כל ה-VersionedFile שמאוחסנים ב-BuildInfo הזה.

החזרות

getProperties

public abstract  getProperties ()

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

החזרות

getRemoteFiles

public  getRemoteFiles ()

הצגת הנתיבים של פריטי המידע שנוצרו בתהליך הפיתוח (artifacts) שההורדה שלהם מושהית.

החזרות

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

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

החזרות

getVersionedFiles

public  getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

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

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

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

הסרת attributeName נתון מהמעקב.

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

setBuildBranch

public abstract void setBuildBranch (String branch)

הגדרת ההסתעפות ל-build

פרמטרים
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 שבו בוצע ה-build הזה.

setFile

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

שמירת קובץ בשם נתון בפרטי ה-build האלה.

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

setFile

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

שמירת קובץ עם BuildInfoFileKey בנתוני ה-build האלה.

פרמטרים
key BuildInfoKey.BuildInfoFileKey: השם הייחודי של הקובץ על סמך BuildInfoFileKey.
file File: ERROR(/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)

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

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: אובייקט ERROR(/File) של הספרייה שבה רוצים להעביר את הקובץ.
החזרות
File האובייקט ERROR(/File) של הקובץ שהועמד ב-workingDir המקומי.

toProto

public BuildInformation.BuildInfo toProto ()

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

החזרות
BuildInformation.BuildInfo