ResultForwarder

public class ResultForwarder
extends Object implements ITestInvocationListener

java.lang.Object
↳ com.android.tradefed.result.ResultForwarder

ITestInvocationListener שמעביר את תוצאות ההפעלה לרשימה של מאזינים אחרים.

סיכום

בנאים ציבוריים

ResultForwarder(ITestInvocationListener... listeners)

חלופה למבנה ה-constructor של משתנה arg עבור ResultForwarder.

ResultForwarder( listeners)

יוצרים ResultForwarder.

קונסטרוקטורים מוגנים

ResultForwarder()

יצירת ResultForwarder עם הגדרת האזנה מראש.

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

TestSummary getSummary()

מאפשר ל-InvocationListener להחזיר סיכום.

void invocationEnded(long elapsedTime)

האירוע הזה מדווח על סיום ההפעלה, בין שהיא הסתיימה בהצלחה ובין שהיא הסתיימה בגלל תנאי שגיאה כלשהו.

void invocationFailed(FailureDescription failure)

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

void invocationFailed(Throwable cause)

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

void invocationSkipped(SkipReason reason)

דיווח על קריאה כ'דילוג'

void invocationStarted(IInvocationContext context)

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

void testAssumptionFailure(TestDescription test, String trace)

הקריאה מתבצעת כשבדיקה אטומית מסמנת שהיא מניחה תנאי שהוא שקר

void testAssumptionFailure(TestDescription test, FailureDescription failure)

הקריאה מתבצעת כשבדיקה אטומית מסמנת שהיא מניחה תנאי שהוא שקר

void testEnded(TestDescription test, long endTime, testMetrics)

חלופה ל-ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), שבה אפשר לציין את שעת הסיום ישירות.

void testEnded(TestDescription test, testMetrics)

דיווח על סיום הביצוע של מקרה בדיקה ספציפי.

void testFailed(TestDescription test, FailureDescription failure)

דיווח על כשל במקרה בדיקה ספציפי.

void testFailed(TestDescription test, String trace)

דיווח על כשל של מקרה בדיקה ספציפי.

void testIgnored(TestDescription test)

נשלחת קריאה כאשר לא תבוצע בדיקה, בדרך כלל מפני שלשיטת בדיקה יש הערות עם org.junit.ignore.

void testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)

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

void testModuleEnded()

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

void testModuleStarted(IInvocationContext moduleContext)

דיווח על תחילת ההרצה של מודול.

void testRunEnded(long elapsedTime, runMetrics)

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

void testRunFailed(FailureDescription failure)

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

void testRunFailed(String errorMessage)

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

void testRunStarted(String runName, int testCount, int attemptNumber)

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

void testRunStarted(String runName, int testCount)

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

void testRunStarted(String runName, int testCount, int attemptNumber, long startTime)

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

void testRunStopped(long elapsedTime)

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

void testSkipped(TestDescription test, SkipReason reason)

הקריאה מתבצעת כשבדיקה מועברת ולא מתבצעת מסיבה שלא צפויה בדרך כלל.

void testStarted(TestDescription test, long startTime)

חלופה ל-testStarted(com.android.tradefed.result.TestDescription), שבה מציינים גם מתי הבדיקה התחילה, בשילוב עם ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) למדידה מדויקת.

void testStarted(TestDescription test)

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

שיטות מוגנות

getListeners()

הצגת רשימת המאזינים.

void setListeners(ITestInvocationListener... listeners)

מגדירים את המאזינים אחרי היצירה.

void setListeners( listeners)

מגדירים את המאזינים אחרי היצירה.

בנאים ציבוריים

הכלי להעברה של תוצאות

public ResultForwarder (ITestInvocationListener... listeners)

חלופה למבנה ה-constructor של משתנה arg עבור ResultForwarder.

פרמטרים
listeners ITestInvocationListener: הITestInvocationListener האמיתיות שאליהן תעביר את התוצאות

ResultForwarder

public ResultForwarder ( listeners)

יוצרים ResultForwarder.

פרמטרים
listeners : הITestInvocationListener האמיתיות שאליהן תעביר את התוצאות

קונסטרוקטורים מוגנים

הכלי להעברה של תוצאות

protected ResultForwarder ()

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

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

getSummary

public TestSummary getSummary ()

מאפשר ל-InvocationListener להחזיר סיכום.

החזרות
TestSummary TestSummary שמסכם את הריצה, או null

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

ההפעלה התחילה

public void invocationStarted (IInvocationContext context)

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

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

פרמטרים
context IInvocationContext: מידע על ההפעלה

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

מופעלת כשבדיקה אטומית מסמנת שהיא מניחה שהתנאי לא נכון

פרמטרים
test TestDescription: מזהה את הבדיקה
trace String: סטאק טריי של הכישלון

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

מופעלת כשבדיקה אטומית מסמנת שהיא מניחה שהתנאי לא נכון

פרמטרים
test TestDescription: מזהה את הבדיקה
failure FailureDescription: FailureDescription שמתאר את התקלה ואת ההקשר שלה.

testEnded

public void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

חלופה ל-ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) שבה ניתן לציין ישירות את שעת הסיום. כדי לקבל מדידה מדויקת, יש לשלב את הפונקציה עם testStarted(com.android.tradefed.result.TestDescription, long).

פרמטרים
test TestDescription: מזהה את הבדיקה
endTime long: השעה שבה הסתיים הבדיקה, נמדדת באמצעות System.currentTimeMillis()
testMetrics : ERROR(/Map) מהמדדים שצוינו

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

דיווח על סיום הביצוע של מקרה בדיקה ספציפי.

אם לא הופעל testFailed(TestDescription, FailureDescription), הבדיקה הזו עברה. הפונקציה מחזירה גם מדדים מסוג מפתח/ערך שעשויים להופיע במהלך ביצוע מקרה הבדיקה.

פרמטרים
test TestDescription: מזהה את הבדיקה
testMetrics : ERROR(/Map) של המדדים שמונפקים

הבדיקה נכשלה

public void testFailed (TestDescription test, 
                FailureDescription failure)

דיווח על כשל של מקרה בדיקה ספציפי.

הקריאה תתבצע בין testStarted ל-testEnded.

פרמטרים
test TestDescription: מזהה את הבדיקה
failure FailureDescription: FailureDescription שמתאר את התקלה ואת ההקשר שלה.

testFailed

public void testFailed (TestDescription test, 
                String trace)

דיווח על כשל של מקרה בדיקה ספציפי.

הקריאה תתבצע בין testStarted ל-testEnded.

פרמטרים
test TestDescription: מזהה את הבדיקה
trace String: דוח קריסות של כשל

testIgnored

public void testIgnored (TestDescription test)

נשלחת קריאה כאשר לא תבוצע בדיקה, בדרך כלל מפני שלשיטת בדיקה יש הערות עם org.junit.ignore.

פרמטרים
test TestDescription: מזהה את הבדיקה

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 לא יכול להיות ייחודי בכל הפעלה. כלומר, מטמיעים צריכים להיות מסוגלים לטפל בקריאות מרובות עם אותו dataName
dataType LogDataType: ה-LogDataType של הנתונים
dataStream InputStreamSource: ה-InputStreamSource של הנתונים. מי שמטמיע את הקוד צריך להפעיל את createInputStream כדי להתחיל לקרוא את הנתונים, ולוודא שהוא סוגר את ה-InputStream שנוצר בסיום. מבצעי הקריאה צריכים לוודא שמקור הנתונים יישאר נוכח ונגיש עד להשלמת השיטה testLog.

testModuleEnded

public void testModuleEnded ()

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

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

testRunFailed

public void testRunFailed (FailureDescription failure)

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

פרמטרים
failure FailureDescription: FailureDescription שמתאר את התקלה ואת ההקשר שלה.

הבדיקה נכשלה

public void testRunFailed (String errorMessage)

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

פרמטרים
errorMessage String: String שמתאר את הסיבה לכישלון ההרצה.

בדיקת ההרצה

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

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

פרמטרים
runName String: שם הרצת הבדיקה
testCount int: המספר הכולל של הבדיקות בהרצה לניסיון
attemptNumber int: מספר הזמנה, שמזהה את הניסיונות השונים של אותו runName שמוצגים כמה פעמים. הערך של attemptNumber מתחיל ב-0 וצריך לעלות בכל פעם שמתבצעה הפעלה חדשה. לדוגמה, אם מתבצעות 3 ניסיונות מפורטים של בדיקה, צריכות להיות לה 4 הפעלות בסך הכול באותו runName, והערך של attemptNumber יהיה בין 0 ל-3.

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

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

פרמטרים
runName String: שם הרצת הבדיקה
testCount int: המספר הכולל של הבדיקות בהרצה לניסיון

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

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

פרמטרים
runName String: שם הרצת הבדיקה
testCount int: המספר הכולל של הבדיקות בהרצה לניסיון
attemptNumber int: מספר הזמנה, שמזהה את הניסיונות השונים של אותו runName שמוצגים כמה פעמים. ה-TryNumber כולל 0 אינדקס, והוא אמור לגדול בכל פעם שמתרחשת הפעלה חדשה. למשל, בדיקה מפורטת מתבצעת שוב 3 פעמים, והבדיקה צריכה לכלול 4 הפעלות בסך הכל תחת אותו runName, ו-TryNumber הוא בין 0 ל-3.
startTime long: משך הזמן שבו התחילה הריצה, שנמדדת באמצעות System.currentTimeMillis()

testRunStopped

public void testRunStopped (long elapsedTime)

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

TODO: currently unused, consider removing

פרמטרים
elapsedTime long: הזמן שחלף שדווח על ידי המכשיר, באלפיות השנייה

testSkipped

public void testSkipped (TestDescription test, 
                SkipReason reason)

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

פרמטרים
test TestDescription: מזהה את הבדיקה
reason SkipReason: SkipReason

testStarted

public void testStarted (TestDescription test, 
                long startTime)

חלופה ל-testStarted(com.android.tradefed.result.TestDescription), שבה מציינים גם מתי הבדיקה התחילה, בשילוב עם ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) למדידה מדויקת.

פרמטרים
test TestDescription: מזהה את הבדיקה
startTime long: השעה שבה הבדיקה התחילה, נמדדת באמצעות System.currentTimeMillis()

testStarted

public void testStarted (TestDescription test)

דיווח על התחלת מקרה בדיקה ספציפי. ממשק ישן יותר, עדיף להשתמש ב-testStarted(com.android.tradefed.result.TestDescription) כשהדבר אפשרי.

פרמטרים
test TestDescription: מזהה את הבדיקה

שיטות מוגנות

getListeners

protected  getListeners ()

לקבל את רשימת המאזינים. מיועד לשימוש רק בתת-כיתות.

החזרות
הרשימה של ITestInvocationListener.

setListeners

protected void setListeners (ITestInvocationListener... listeners)

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

פרמטרים
listeners ITestInvocationListener: הערכים האמיתיים של ITestInvocationListener להעברת התוצאות אליהם

setListeners

protected void setListeners ( listeners)

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

פרמטרים
listeners : הערכים האמיתיים של ITestInvocationListener להעברת התוצאות אליהם