IMetricCollector
public
interface
IMetricCollector
implements
IDisableable,
ILogSaverListener
| com.android.tradefed.device.metric.IMetricCollector |
הממשק הזה יתווסף כ-decorator כשמדווחים על תוצאות של בדיקות, כדי לאסוף מדדים תואמים.
אי אפשר להשתמש בממשק הזה בתור ITestInvocationListener. בדיקת ההגדרות תדחה את ההגדרה. חובה להשתמש בו כ-metrics_collector.
לא מצפים שאוספי נתונים ישמרו מצב פנימי, כי יכול להיות שיהיה שימוש חוזר בהם בכמה מקומות. אם באמת צריך להשתמש במצב פנימי, צריך לנקות אותו ב-init(IInvocationContext,ITestInvocationListener).
סיכום
methods ציבוריים | |
|---|---|
default
boolean
|
captureModuleLevel()
האם הכלי לאיסוף נתונים רלוונטי לתיעוד ברמת המודול, והאם צריך להפעיל אותו. |
default
boolean
|
doesModuleContainFailure()
הפונקציה מחזירה True אם המודול הנוכחי הכיל מקרה בדיקה או הפעלת בדיקה שנכשלו. |
default
void
|
enableDefaultMetricCollection()
מאפשר לאוספים להפעיל איסוף מדדים כברירת מחדל. |
default
IMetricCollector.MetricCollectionLevel
|
getAlwaysOnCollectionLevel()
|
abstract
List<IBuildInfo>
|
getBuildInfos()
מחזירה את רשימת פרטי הגרסה שזמינים בקריאה לפונקציה. |
abstract
List<ITestDevice>
|
getDevices()
מחזירה את רשימת המכשירים שזמינים בהפעלה. |
abstract
ITestInvocationListener
|
getInvocationListener()
מחזירה את |
default
IMetricCollector.MetricCollectionLevel
|
getOnFailureCollectionLevel()
|
abstract
ITestInvocationListener
|
init(IInvocationContext context, ITestInvocationListener listener)
הפעלה ראשונית של כלי האיסוף עם ההקשר הנוכחי והמקום שאליו יש להעביר את התוצאות. |
default
boolean
|
isDefaultMetricCollectionEnabled()
האם כלי האיסוף אוסף מדדים כחלק מאיסוף מדדים שמוגדר כברירת מחדל. |
abstract
void
|
onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)
התקשרות חזרה כשמקרה בדיקה נכשל בגלל כשל בהנחה. |
abstract
void
|
onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)
קריאה חוזרת כשמקרה בדיקה מסתיים. |
abstract
void
|
onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)
קריאה חוזרת כשמקרה בדיקה מסתיים. |
abstract
void
|
onTestFail(DeviceMetricData testData, TestDescription test)
התקשרות חזרה כשמקרה בדיקה נכשל. |
default
void
|
onTestModuleEnded()
מאפשרת ללכוד את האירוע של סיום המודול. |
default
void
|
onTestModuleStarted()
מאפשרת ללכוד את אירוע ההתחלה של המודול. |
abstract
void
|
onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)
קריאה חוזרת כשמסתיימת הרצה של בדיקה. |
abstract
void
|
onTestRunStart(DeviceMetricData runData)
קריאה חוזרת כשמתחילים הרצת בדיקה. |
default
void
|
onTestRunStart(DeviceMetricData runData, int testCount)
קריאה חוזרת כשמתחילים הרצת בדיקה. |
default
void
|
onTestRunStartBlocking()
קריאה חוזרת מפורשת כדי להפעיל מאסף באופן ידני אם הוא תומך בכך. |
abstract
void
|
onTestStart(DeviceMetricData testData)
קריאה חוזרת כשמתחילים תרחיש בדיקה. |
default
void
|
setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level)
מגדירה את הרמה שבה כלי האיסוף צריך לאסוף יומנים, ללא קשר לכשלים. |
default
void
|
setModuleContainsFailure()
הגדרת מצב המודול (נכשל או לא נכשל) (תרחיש בדיקה, הרצת בדיקה). |
default
void
|
setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level)
ההגדרה הזו קובעת את הרמה שבה כלי האיסוף צריך לאסוף יומנים במהלך כשלים. |
methods ציבוריים
captureModuleLevel
public boolean captureModuleLevel ()
האם הכלי לאיסוף נתונים רלוונטי לתיעוד ברמת המודול, והאם צריך להפעיל אותו.
| החזרות | |
|---|---|
boolean |
|
doesModuleContainFailure
public boolean doesModuleContainFailure ()
הפונקציה מחזירה True אם המודול הנוכחי הכיל מקרה בדיקה או הפעלת בדיקה שנכשלו.
| החזרות | |
|---|---|
boolean |
|
enableDefaultMetricCollection
public void enableDefaultMetricCollection ()
מאפשר לאוספים להפעיל איסוף מדדים כברירת מחדל. כשאוסף מדדים שמוגדר כברירת מחדל מופעל, הכלי לאיסוף נתונים אמור לאסוף נתונים רק ברמת האיסוף שצוינה.
getAlwaysOnCollectionLevel
public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()
| החזרות | |
|---|---|
IMetricCollector.MetricCollectionLevel |
|
getBuildInfos
public abstract List<IBuildInfo> getBuildInfos ()
מחזירה את רשימת פרטי הגרסה שזמינים בקריאה לפונקציה.
| החזרות | |
|---|---|
List<IBuildInfo> |
|
getDevices
public abstract List<ITestDevice> getDevices ()
מחזירה את רשימת המכשירים שזמינים בהפעלה.
| החזרות | |
|---|---|
List<ITestDevice> |
|
getInvocationListener
public abstract ITestInvocationListener getInvocationListener ()
מחזירה את ITestInvocationListener המקורית שאליה מועברות התוצאות.
| החזרות | |
|---|---|
ITestInvocationListener |
|
getOnFailureCollectionLevel
public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()
| החזרות | |
|---|---|
IMetricCollector.MetricCollectionLevel |
|
init
public abstract ITestInvocationListener init (IInvocationContext context, ITestInvocationListener listener)
הפעלה ראשונית של כלי האיסוף עם ההקשר הנוכחי והמקום שאליו יש להעביר את התוצאות. הפונקציה הזו תיקרא רק פעם אחת לכל מופע, והמערכת מצפה שהאוסף יעודכן בהקשר הפנימי ובמאזין שלו. הפונקציה Init אף פעם לא תופעל במהלך הרצת בדיקה, תמיד לפני.
אל תבטלו את ההגדרה הזו אלא אם אתם יודעים מה אתם עושים.
| פרמטרים | |
|---|---|
context |
IInvocationContext: ה-IInvocationContext של הקריאה שנמצאת בתהליך. |
listener |
ITestInvocationListener: ה-ITestInvocationListener שבו יוצבו התוצאות. |
| החזרות | |
|---|---|
ITestInvocationListener |
המאזין החדש עוטף את המאזין המקורי. |
| הקפצת הודעות שגיאה (throw) | |
|---|---|
DeviceNotAvailableException |
|
isDefaultMetricCollectionEnabled
public boolean isDefaultMetricCollectionEnabled ()
האם כלי האיסוף אוסף מדדים כחלק מאיסוף מדדים שמוגדר כברירת מחדל.
| החזרות | |
|---|---|
boolean |
|
onTestAssumptionFailure
public abstract void onTestAssumptionFailure (DeviceMetricData testData, TestDescription test)
התקשרות חזרה כשמקרה בדיקה נכשל בגלל כשל בהנחה.
| פרמטרים | |
|---|---|
testData |
DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה. |
test |
TestDescription: TestDescription של מקרה הבדיקה שנמצא בתהליך. |
| הקפצת הודעות שגיאה (throw) | |
|---|---|
DeviceNotAvailableException |
|
onTestEnd
public abstract void onTestEnd (DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)
קריאה חוזרת כשמקרה בדיקה מסתיים. זה הזמן לנקות את המידע.
| פרמטרים | |
|---|---|
testData |
DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה. יהיה אותו אובייקט כמו במהלך onTestStart(DeviceMetricData). |
currentTestCaseMetrics |
Map: המפה הנוכחית של המדדים שמועברים אל testEnded(TestDescription,Map). |
test |
TestDescription: TestDescription של מקרה הבדיקה שנמצא בתהליך. |
| הקפצת הודעות שגיאה (throw) | |
|---|---|
DeviceNotAvailableException |
|
onTestEnd
public abstract void onTestEnd (DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)
קריאה חוזרת כשמקרה בדיקה מסתיים. זה הזמן לנקות את המידע.
| פרמטרים | |
|---|---|
testData |
DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה. יהיה אותו אובייקט כמו במהלך onTestStart(DeviceMetricData). |
currentTestCaseMetrics |
Map: המפה הנוכחית של המדדים שמועברים אל testEnded(TestDescription,Map). |
| הקפצת הודעות שגיאה (throw) | |
|---|---|
DeviceNotAvailableException |
|
onTestFail
public abstract void onTestFail (DeviceMetricData testData, TestDescription test)
התקשרות חזרה כשמקרה בדיקה נכשל.
| פרמטרים | |
|---|---|
testData |
DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה. |
test |
TestDescription: TestDescription של מקרה הבדיקה שנמצא בתהליך. |
| הקפצת הודעות שגיאה (throw) | |
|---|---|
DeviceNotAvailableException |
|
onTestModuleEnded
public void onTestModuleEnded ()
מאפשרת ללכוד את האירוע של סיום המודול.
| הקפצת הודעות שגיאה (throw) | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestModuleStarted
public void onTestModuleStarted ()
מאפשרת ללכוד את אירוע ההתחלה של המודול.
| הקפצת הודעות שגיאה (throw) | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestRunEnd
public abstract void onTestRunEnd (DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)
קריאה חוזרת כשמסתיימת הרצה של בדיקה. זה הזמן לנקות את המידע.
| פרמטרים | |
|---|---|
runData |
DeviceMetricData: ה-DeviceMetricData שמכיל את הנתונים של ההרצה. יהיה אותו אובייקט כמו במהלך onTestRunStart(DeviceMetricData). |
currentRunMetrics |
Map: המפה הנוכחית של המדדים שמועברים אל testRunEnded(long,Map). |
| הקפצת הודעות שגיאה (throw) | |
|---|---|
DeviceNotAvailableException |
|
onTestRunStart
public abstract void onTestRunStart (DeviceMetricData runData)
קריאה חוזרת כשמתחילים הרצת בדיקה.
| פרמטרים | |
|---|---|
runData |
DeviceMetricData: ה-DeviceMetricData שמכיל את הנתונים של ההרצה. |
| הקפצת הודעות שגיאה (throw) | |
|---|---|
DeviceNotAvailableException |
|
onTestRunStart
public void onTestRunStart (DeviceMetricData runData, int testCount)
קריאה חוזרת כשמתחילים הרצת בדיקה.
| פרמטרים | |
|---|---|
runData |
DeviceMetricData: ה-DeviceMetricData שמכיל את הנתונים של ההרצה. |
testCount |
int: מספר תרחישי הבדיקה בהרצת הבדיקה הזו. |
| הקפצת הודעות שגיאה (throw) | |
|---|---|
DeviceNotAvailableException |
|
onTestRunStartBlocking
public void onTestRunStartBlocking ()
קריאה חוזרת מפורשת כדי להפעיל מאסף באופן ידני אם הוא תומך בכך. כך נוכל לוודא שאנחנו לא נמצאים במחזור חיים של בדיקה מסוימת שהיא אסינכרונית.
| הקפצת הודעות שגיאה (throw) | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestStart
public abstract void onTestStart (DeviceMetricData testData)
קריאה חוזרת כשמתחילים תרחיש בדיקה.
| פרמטרים | |
|---|---|
testData |
DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה. |
| הקפצת הודעות שגיאה (throw) | |
|---|---|
DeviceNotAvailableException |
|
setAlwaysOnCollectionLevel
public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)
מגדירה את הרמה שבה כלי האיסוף צריך לאסוף יומנים, ללא קשר לכשלים.
אם בוחרים ברמה NULL, לא מתבצע איסוף.
| פרמטרים | |
|---|---|
level |
IMetricCollector.MetricCollectionLevel: MetricCollectionLevel שבו ייאספו היומנים. |
setModuleContainsFailure
public void setModuleContainsFailure ()
הגדרת מצב המודול (נכשל או לא נכשל) (תרחיש בדיקה, הרצת בדיקה).
setOnFailureCollectionLevel
public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)
ההגדרה הזו קובעת את הרמה שבה כלי האיסוף צריך לאסוף יומנים במהלך כשלים.
אם בוחרים ברמה NULL, לא מתבצע איסוף.
| פרמטרים | |
|---|---|
level |
IMetricCollector.MetricCollectionLevel: MetricCollectionLevel שבו ייאספו היומנים. |