ShardListener
public
class
ShardListener
extends CollectingTestListener
implements
ISupportGranularResults
java.lang.Object | ||
↳ | com.android.tradefed.result.CollectingTestListener | |
↳ | com.android.tradefed.invoker.ShardListener |
ITestInvocationListener
שאוסף תוצאות מחלק של קריאה (קריאה שמפוצלת לצורך הפעלה בכמה משאבים בו-זמנית) ומעביר אותן למאזין אחר.
סיכום
קונסטרוקטורים גלויים לכולם | |
---|---|
ShardListener(ITestInvocationListener main)
יוצרים |
שיטות ציבוריות | |
---|---|
|
getUnderlyingResultReporter()
|
void
|
invocationEnded(long elapsedTime)
האירוע הזה מדווח על סיום ההפעלה, בין שהיא הסתיימה בהצלחה ובין שהיא הסתיימה בגלל תנאי שגיאה כלשהו. |
void
|
invocationFailed(FailureDescription failure)
דיווח על קריאה חלקית עקב תנאי שגיאה כלשהו. |
void
|
invocationFailed(Throwable cause)
דיווח על קריאה חלקית עקב תנאי שגיאה כלשהו. |
void
|
invocationSkipped(SkipReason reason)
דיווח על קריאה כ'דילוג' |
void
|
invocationStarted(IInvocationContext context)
דיווח על התחלת ההפעלה של הבדיקה. |
void
|
logAssociation(String dataName, LogFile logFile)
במקרים מסוימים, צריך לשייך את היומן באופן חזק למקרה בדיקה, אבל אי אפשר לעשות זאת בקריאה החוזרת (callback) הישירה של |
void
|
setSupportGranularResults(boolean enableGranularResults)
|
boolean
|
supportGranularResults()
הפונקציה מחזירה את הערך True אם הכלי לדיווח תומך בתוצאות מפורטות, ואת הערך False במקרים אחרים. |
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
הנתונים המשויכים של היומן או ניפוי הבאגים מהפעלת הבדיקה. |
void
|
testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
|
void
|
testModuleEnded()
דיווח על סיום הרצת מודול. |
void
|
testModuleStarted(IInvocationContext moduleContext)
האירוע הזה מדווח על תחילת ההרצה של מודול. |
void
|
testRunEnded(long elapsedTime,
דיווח על סיום הרצת הבדיקה. |
void
|
testRunFailed(FailureDescription failure)
הרצת הבדיקה של הדוחות נכשלה בגלל כשל שמתואר ב- |
void
|
testRunFailed(String failureMessage)
הרצת הבדיקה של הדוחות נכשלה בגלל שגיאה קטלנית. |
void
|
testRunStarted(String name, int numTests, int attemptNumber, long startTime)
דיווח על התחלת הרצה של בדיקה. |
קונסטרוקטורים גלויים לכולם
ShardListener
public ShardListener (ITestInvocationListener main)
יוצרים ShardListener
.
פרמטרים | |
---|---|
main |
ITestInvocationListener : ה-ITestInvocationListener שאליו צריך להעביר את התוצאות. כדי למנוע התנגשויות עם ShardListener אחרים, האובייקט הזה יסתנכרן ב-main כשיתבצע העברה של תוצאות. התוצאות יישלחו רק אחרי שהפלאגין של הקריאה יושלם. |
שיטות ציבוריות
getUnderlyingResultReporter
publicgetUnderlyingResultReporter ()
החזרות | |
---|---|
|
invocationEnded
public void invocationEnded (long elapsedTime)
האירוע הזה מדווח על סיום ההפעלה, בין שהיא הסתיימה בהצלחה ובין שהיא הסתיימה בגלל תנאי שגיאה כלשהו.
הקריאה תתבצע באופן אוטומטי על ידי מסגרת TradeFederation.
פרמטרים | |
---|---|
elapsedTime |
long : הזמן שחלף מהקריאה, במילישניות |
invocationFailed
public void invocationFailed (FailureDescription failure)
דיווח על קריאה חלקית עקב תנאי שגיאה כלשהו.
הקריאה תתבצע באופן אוטומטי על ידי מסגרת TradeFederation.
פרמטרים | |
---|---|
failure |
FailureDescription : ה-FailureDescription שמתאר את הסיבה לכישלון |
invocationFailed
public void invocationFailed (Throwable cause)
דיווח על קריאה חלקית עקב תנאי שגיאה כלשהו.
הקריאה תתבצע באופן אוטומטי על ידי מסגרת TradeFederation.
פרמטרים | |
---|---|
cause |
Throwable : Throwable הסיבה לכישלון |
invocationSkipped
public void invocationSkipped (SkipReason reason)
דיווח על קריאה כ'דילוג'
פרמטרים | |
---|---|
reason |
SkipReason |
invocationStarted
public void invocationStarted (IInvocationContext context)
דיווח על התחלת ההפעלה של הבדיקה.
הקריאה תתבצע באופן אוטומטי על ידי מסגרת TradeFederation. דיווחים צריכים לשנות את השיטה הזו כדי לתמוך בדיווח ממספר מכשירים.
פרמטרים | |
---|---|
context |
IInvocationContext : מידע על ההפעלה |
logAssociation
public void logAssociation (String dataName, LogFile logFile)
במקרים מסוימים, צריך לשייך את היומן באופן חזק למקרה בדיקה, אבל אי אפשר לעשות זאת בקריאה החוזרת (callback) הישירה של testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
. כך, קריאה חוזרת (callback) מאפשרת לספק באופן מפורש שיוך חזק.
פרמטרים | |
---|---|
dataName |
String : השם של הנתונים |
logFile |
LogFile : ה-LogFile שרשום ביומן קודם וצריך לשייך למקרה הבדיקה. |
setSupportGranularResults
public void setSupportGranularResults (boolean enableGranularResults)
פרמטרים | |
---|---|
enableGranularResults |
boolean |
supportGranularResults
public boolean supportGranularResults ()
הפונקציה מחזירה את הערך True אם הכלי לדיווח תומך בתוצאות מפורטות, ואת הערך False במקרים אחרים.
החזרות | |
---|---|
boolean |
testLog
public void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
הנתונים המשויכים של היומן או ניפוי הבאגים מהפעלת הבדיקה.
צריך להפעיל את הפונקציה לפני ERROR(/ITestInvocationListener#invocationFailed(Throwable))
או ERROR(/ITestInvocationListener#invocationEnded(long))
מסגרת TradeFederation תבצע קריאה אוטומטית לשיטה הזו, ותספק את יומן המארח ואם רלוונטי, את logcat של המכשיר.
פרמטרים | |
---|---|
dataName |
String : String שם תיאורי של הנתונים. לדוגמה, 'device_logcat'. הערה: שם המשתנה dataName לא חייב להיות ייחודי לכל קריאה. כלומר, למטמיעים צריכה להיות אפשרות לטפל בכמה קריאות עם אותו שם משתנה |
dataType |
LogDataType : ה-LogDataType של הנתונים |
dataStream |
InputStreamSource : ה-InputStreamSource של הנתונים. מי שמטמיע את הקוד צריך להפעיל את createInputStream כדי להתחיל לקרוא את הנתונים, ולוודא שהוא סוגר את ה-InputStream שנוצר בסיום. מבצעי הקריאה צריכים לוודא שמקור הנתונים יישאר נוכח וזמין עד להשלמת השיטה testLog. |
testLogSaved
public void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
פרמטרים | |
---|---|
dataName |
String |
dataType |
LogDataType |
dataStream |
InputStreamSource |
logFile |
LogFile |
testModuleEnded
public void testModuleEnded ()
דיווח על סיום הרצת מודול.
testModuleStarted
public void testModuleStarted (IInvocationContext moduleContext)
האירוע הזה מדווח על תחילת ההרצה של מודול. קריאת החזרה (callback) הזו משויכת ל-testModuleEnded()
והיא אופציונלית בסדרה. הוא משמש רק במהלך ריצה שמשתמשת במודולים: כלי ריצה מבוססי-חבילות.
פרמטרים | |
---|---|
moduleContext |
IInvocationContext : ה-IInvocationContext של המודול. |
testRunEnded
public void testRunEnded (long elapsedTime,runMetrics)
דיווח על סיום הרצת הבדיקה.
פרמטרים | |
---|---|
elapsedTime |
long : הזמן שחלף שדווח על ידי המכשיר, באלפיות השנייה |
runMetrics |
: צמדי מפתח/ערך שמדווחים בסוף הרצה של בדיקה |
testRunFailed
public void testRunFailed (FailureDescription failure)
הרצת הבדיקה של הדוחות נכשלה בגלל כשל שמתואר ב-FailureDescription
.
פרמטרים | |
---|---|
failure |
FailureDescription : FailureDescription שמתאר את התקלה ואת ההקשר שלה. |
testRunFailed
public void testRunFailed (String failureMessage)
הרצת הבדיקה של הדוחות נכשלה בגלל שגיאה קטלנית.
פרמטרים | |
---|---|
failureMessage |
String : String שמתאר את הסיבה לכישלון ההרצה. |
testRunStarted
public void testRunStarted (String name, int numTests, int attemptNumber, long startTime)
דיווח על התחלת הרצה של בדיקה.
פרמטרים | |
---|---|
name |
String : שם ההרצה לניסיון |
numTests |
int : המספר הכולל של הבדיקות בהרצה לניסיון |
attemptNumber |
int : מספר הזמנה, שמזהה את הניסיונות השונים של אותו runName שירוצו כמה פעמים. הערך של attemptNumber מתחיל ב-0 וצריך לעלות בכל פעם שמתבצעה הפעלה חדשה. לדוגמה, אם ניסוי מסוים מנסה שוב 3 פעמים ברמת פירוט גבוהה, צריכות להיות לו 4 הפעלות בסך הכול באותו runName, והערך של attemptNumber יהיה בין 0 ל-3. |
startTime |
long : השעה שבה הרצת הקוד התחילה, שנמדדת באמצעות System.currentTimeMillis() |