ResultForwarder

public class ResultForwarder
extends Object implements ITestInvocationListener

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

מחלקות משנה ישירות ידועות ‫FilteredResultForwarder, ‏ JarHostTest.HostTestListener, ‏ LogSaverResultForwarder, ‏ LogcatCrashResultForwarder, ‏ PythonBinaryHostTest.PythonForwarder, ‏ ResultAndLogForwarder, ‏ RetryResultForwarder, ‏ ShardMainResultForwarder, ‏ TestTimeoutEnforcer FilteredResultForwarder וריאציה של ResultForwarder שמאפשרת דיווח רק על TestDescription שנמצאים ברשימת ההיתרים.  JarHostTest.HostTestListener מאזין עוטף שמעביר את כל האירועים, למעט testRunStarted()‎ ו-testRunEnded()‎, אל המאזין המוטמע.  LogSaverResultForwarder ResultForwarder לשמירת יומנים באמצעות הכלי הגלובלי לשמירת קבצים.  LogcatCrashResultForwarder מאזין מיוחד: במקרה של כשלים (קריסה של תהליך המדידה), המאזין ינסה לחלץ את הקריסה מ-logcat ולהוסיף אותה להודעת הכשל שמשויכת לבדיקה.  PythonBinaryHostTest.PythonForwarder העברת תוצאות כדי להחליף את שם ההרצה בשם הבינארי.  ResultAndLogForwarder מעביר תוצאות ואירועים ביומן.  RetryResultForwarder תוסף של ResultForwarder שתמיד דוחף למספר ניסיון נתון.  ShardMainResultForwarder ‫ResultForwarder שמשלב את התוצאות של הפעלות בדיקה עם חלוקה למקטעים.  TestTimeoutEnforcer רכיבי Listener שמאפשרים לבדוק את זמן הביצוע של תרחיש בדיקה מסוים ולסמן אותו כנכשל אם הוא חורג מזמן קצוב מסוים.

מחלקות משנה לא ישירות ידועות ‫GranularRetriableTestWrapper.StartEndCollector, ‏ ModuleResultsAndMetricsForwarder, ‏ RemoteTestTimeOutEnforcer, ‏ RetryLogSaverResultForwarder GranularRetriableTestWrapper.StartEndCollector כלי עזר לשיעור שיעזור לכם לזהות מקרים שבהם חסרים נתוני התחלה וסיום של ריצה.  ModuleResultsAndMetricsForwarder תוסף של ResultAndLogForwarder שמוסיף לממצאי הבדיקה מדדים נוספים שקשורים למודול.  RemoteTestTimeOutEnforcer רכיבי Listener שמאפשרים לבדוק את זמן הביצוע של הגדרת בדיקה מסוימת, ולגרום לכך שהבדיקה תיכשל אם היא חורגת מזמן קצוב מסוים.  RetryLogSaverResultForwarder העברה שמטפלת גם בהעברת הניסיון הנוכחי שאנחנו נמצאים בו.

---

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

סיכום

Constructors ציבוריים
ResultForwarder(ITestInvocationListener... listeners) בנאי חלופי של ארגומנטים משתנים ל-ResultForwarder.
ResultForwarder( listeners) יצירת ResultForwarder.

‫constructors מוגנים
ResultForwarder() יוצרים ResultForwarder עם הגדרת מאזין מושהית.

‫methods ציבוריים
	getListeners() קבלת רשימת ה-listeners.
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) האירוע הזה מדווח על תחילת הרצה של תרחיש בדיקה מסוים.

שיטות מוגנות
void	setListeners(ITestInvocationListener... listeners) מגדירים את מאזיני האירועים אחרי הבנייה.
void	setListeners( listeners) מגדירים את מאזיני האירועים אחרי הבנייה.

Constructors ציבוריים

ResultForwarder

public ResultForwarder (ITestInvocationListener... listeners)

בנאי חלופי של ארגומנטים משתנים עבור ResultForwarder.

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

ResultForwarder

public ResultForwarder ( listeners)

יצירת ResultForwarder.

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

‫constructors מוגנים

ResultForwarder

protected ResultForwarder ()

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

‫methods ציבוריים

getListeners

public  getListeners ()

קבלת רשימת ה-listeners.

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

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

invocationStarted

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) של המדדים שמוצגים

testFailed

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 תיאור הכשל וההקשר שלו.

testRunFailed

public void testRunFailed (String errorMessage)

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

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

testRunStarted

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 שמופעל כמה פעמים. הערך של attemptNumber מתחיל מ-0 וצריך לעלות בכל פעם שמבוצעת ריצה חדשה. לדוגמה, אם מבוצעות 3 פעמים ניסיונות חוזרים של בדיקה, צריכות להיות 4 ריצות בסך הכול תחת אותו runName, והערך של attemptNumber יהיה מ-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: מזהה את הבדיקה

שיטות מוגנות

setListeners

protected void setListeners (ITestInvocationListener... listeners)

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

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

setListeners

protected void setListeners ( listeners)

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

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