ShardListener

public class ShardListener
extends CollectingTestListener implements ISupportGranularResults

java.lang.Object
   ↳ com.android.tradefed.result.CollectingTestListener
     ↳ com.android.tradefed.invoker.ShardListener

‫ITestInvocationListener שאוסף תוצאות משבר הפעלה (כלומר, הפעלה שפוצלה כדי לפעול במקביל בכמה משאבים) ומעביר אותן למאזין אחר.

סיכום

‫constructors ציבוריים

ShardListener(ITestInvocationListener main)

יצירת ShardListener.

‫methods ציבוריים

List<ITestInvocationListener> 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)

במקרים מסוימים, צריך לשייך את היומן באופן חזק לתרחישי בדיקה, אבל אי אפשר לעשות את זה באמצעות הקריאה החוזרת הישירה testLogSaved(String,LogDataType,InputStreamSource,LogFile).

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, HashMap<String, MetricMeasurement.Metric> runMetrics)

דוחות על סיום הרצת הבדיקה.

void testRunFailed(FailureDescription failure)

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

void testRunFailed(String failureMessage)

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

void testRunStarted(String name, int numTests, int attemptNumber, long startTime)

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

‫constructors ציבוריים

ShardListener

public ShardListener (ITestInvocationListener main)

יצירת ShardListener.

פרמטרים
main ‫ITestInvocationListener: כתובת האימייל שאליה יועברו התוצאות.ITestInvocationListener כדי למנוע התנגשויות עם ShardListener אחרים, האובייקט הזה יסנכרן עם main כשמעבירים תוצאות. התוצאות יישלחו רק אחרי שרסיס ההפעלה יסיים את הפעולה.

‫methods ציבוריים

getUnderlyingResultReporter

public List<ITestInvocationListener> getUnderlyingResultReporter ()

החזרות
List<ITestInvocationListener>

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)

במקרים מסוימים, צריך לשייך את היומן באופן חזק לתרחישי בדיקה, אבל אי אפשר לעשות את זה באמצעות הקריאה החוזרת הישירה testLogSaved(String,LogDataType,InputStreamSource,LogFile). לכן, פונקציית הקריאה החוזרת הזו מאפשרת לספק שיוך חזק באופן מפורש.

פרמטרים
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)/ITestInvocationListener#invocationFailed(java.lang.Throwable) ITestInvocationListener.invocationFailed(Throwable)) או ERROR(/ITestInvocationListener#invocationEnded(long))

השיטה הזו נקראת אוטומטית על ידי מסגרת TradeFederation, ומספקת את יומן המארח ואת יומן ה-logcat של המכשיר, אם רלוונטי.

פרמטרים
dataName ‫String: שם תיאורי של הנתונים. לדוגמה, device_logcat.String הערה יכול להיות ש-dataName לא יהיה ייחודי לכל הפעלה. כלומר, המטמיעים צריכים להיות מסוגלים לטפל בכמה קריאות עם אותו 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)

האירוע הזה מדווח על תחילת ההפעלה של מודול. הקריאה החוזרת הזו משויכת ל-testModuleEnded() והיא אופציונלית ברצף. הוא נמצא בשימוש רק במהלך הרצה שמשתמשת במודולים: suite based runners.

פרמטרים
moduleContext ‫IInvocationContext: IInvocationContext של המודול.

testRunEnded

public void testRunEnded (long elapsedTime, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

דוחות על סיום הרצת הבדיקה. FIXME: We cannot have two Map<> interfaces with different type, so we have to use HashMap here.

פרמטרים
elapsedTime ‫long: הזמן שחלף שדווח על ידי המכשיר, באלפיות השנייה
runMetrics ‫HashMap: צמדי מפתח/ערך שמדווחים בסוף הרצת בדיקה עם Metric.

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