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

קבלת הנתיבים לפריטי מידע שנוצרו בתהליך פיתוח (Artifact) של ה-build שיש עיכוב בהורדה.

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)

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

default void removeBuildAttribute(String 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 שמשויך ל-build הזה.

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)

מעבירים קובץ כחלק מקבצים מרוחקים ב-Root dir של פרטי ה-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 המקומי והגרסה המשויכת אליו. הערה: חבילות ה-APK יוחזרו מ- getAppPackageFiles() בסדר שבו הם נוספו בשיטה הזו.

פרמטרים
appPackageFile File

version String

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

צריך להוסיף מאפיין build. הפעולה הזאת לא מאפשרת לשנות שם מאפיין קיים.

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

addBuildAttributes

public void addBuildAttributes ( buildAttributes)

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

פרמטרים
buildAttributes : מפת המאפיינים להוספה

AllowStagingremoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

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

פרמטרים
stageRemoteFile boolean

ניקוי

public abstract void cleanUp ()

מחיקת קובצי build זמניים

ניקוי

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 version). למשל, 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 ואת שם ההסתעפות. [כלומר (שם הסניף)-(בניית טעם)]

החזרות
String

getDeviceSeries

public abstract String getDeviceSerial ()

החזרות
String המספר הסידורי של ITestDevice שעליו בוצעה ה-build הזה. הפונקציה מחזירה את הערך 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  getFiles ()

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

החזרות

getProperties

public abstract  getProperties ()

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

החזרות

getremoteFiles

public  getRemoteFiles ()

קבלת הנתיבים לפריטי מידע שנוצרו בתהליך פיתוח (Artifact) של ה-build שיש עיכוב בהורדה.

החזרות

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)

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

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

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

מסירים שם מאפיין נתון מהמעקב.

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

setBuildBranch

public abstract void setBuildBranch (String branch)

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

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

setBuildFlavor (הגדרת BuildFlavor)

public abstract void setBuildFlavor (String buildFlavor)

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

setBuildId

public abstract void setBuildId (String buildId)

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

פרמטרים
buildId String

setDeviceSeries

public abstract void setDeviceSerial (String serial)

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

פרמטרים
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

St Remote File

public File stageRemoteFile (String fileName, 
                File workingDir)

מעבירים קובץ כחלק מקבצים מרוחקים ב-Root dir של פרטי ה-build.

TODO(b/138416078): הסרת הממשק הזה ואת הקריאה שלו כאשר מודולים נדרשים על ידי בדיקה יכול להיות מובנה כפלט לספרייה של מודול הבדיקה עצמה.

פרמטרים
fileName String: שם הקובץ שימוקם בקבצים מרוחקים.
workingDir File: אובייקט ERROR(/File) של הספרייה לצורך אחסון הקובץ.
החזרות
File אובייקט ERROR(/File) של הקובץ ב-Staging המקומי של workDir.

לפרוטו

public BuildInformation.BuildInfo toProto ()

מארגנים את המכונה של BuildInfo בתור ה-protobuf.

החזרות
BuildInformation.BuildInfo