ProtoResultReporter
public abstract class ProtoResultReporter
extends Object
implements ITestInvocationListener , ILogSaverListener , ISupportGranularResults
java.lang.Object | |
↳ | com.android.tradefed.result.proto.ProtoResultReporter |
כתב תוצאות בנה פרוטובוף TestRecord
עם כל התוצאות בפנים. יש להרחיב אותו כדי לטפל במה לעשות עם הפרוטו הסופי ב- processFinalProto(com.android.tradefed.result.proto.TestRecordProto.TestRecord)
.
סיכום
בנאים ציבוריים | |
---|---|
ProtoResultReporter () |
שיטות ציבוריות | |
---|---|
final void | invocationEnded (long elapsedTime) מדווח שהפנייה הסתיימה, בין אם בהצלחה ובין אם עקב מצב שגיאה כלשהו. |
void | invocationFailed ( FailureDescription failure) מדווח על הזמנה לא מלאה עקב מצב שגיאה כלשהו. |
void | invocationFailed (Throwable cause) מדווח על הזמנה לא מלאה עקב מצב שגיאה כלשהו. |
final void | invocationStarted ( IInvocationContext context) מדווח על תחילת הפעלת הבדיקה. |
final void | logAssociation (String dataName, LogFile logFile) במקרים מסוימים, יומן חייב להיות משויך מאוד למקרי בדיקה, אך ההזדמנות לעשות זאת ב- |
void | processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs) השתמש ברשומת הפנייה כדי לשלוח בזה אחר זה את כל היומנים הסופיים של ההזמנה. |
void | processFinalProto (TestRecordProto.TestRecord finalRecord) טיפול בפרוטו הסופי עם כל התוצאות. |
void | processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext) טיפול בפרוטו של רשומת הבדיקה החלקית לאחר התרחשות |
void | processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord) טיפול בפרוטו הרשומה הסופית של מקרה הבדיקה לאחר התרחשה |
void | processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord) טיפול בפרוטו של רשומת מקרה הבדיקה החלקית לאחר |
void | processTestModuleEnd (TestRecordProto.TestRecord moduleRecord) טיפול בפרוטו הרשומה הסופית של המודול לאחר שהתרחש |
void | processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord) טיפול בפרוטו החלקי של רשומת המודול לאחר שהתרחש |
void | processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress) טיפול בפרוטו רשומת הריצה הסופית לאחר התרחשה |
void | processTestRunStarted (TestRecordProto.TestRecord runStartedRecord) טיפול בפרוטו רשומת ריצת הבדיקה החלקית לאחר שהתרחש |
void | setGranularResults (boolean granularResults) |
void | setInlineRecordOfChildren (boolean inline) |
boolean | supportGranularResults () מחזירה True אם הכתב תומך בתוצאות מפורטות, false אחרת. |
final void | testAssumptionFailure ( TestDescription test, String trace) נקרא כאשר בדיקה אטומית מסמנת שהיא מניחה מצב שהוא שקרי |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) נקרא כאשר בדיקה אטומית מסמנת שהיא מניחה מצב שהוא שקרי |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) חלופה ל- |
void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) מדווח על סיום הביצוע של מקרה בדיקה בודד. |
final void | testFailed ( TestDescription test, FailureDescription failure) מדווח על כישלון של מקרה בדיקה בודד. |
final void | testFailed ( TestDescription test, String trace) מדווח על כישלון של מקרה בדיקה בודד. |
final void | testIgnored ( TestDescription test) נקרא כאשר בדיקה לא תופעל, בדרך כלל מכיוון ששיטת בדיקה מסומנת ב-org.junit.Ignore. |
final void | testModuleEnded () מדווח על סיום הפעלת מודול. |
final void | testModuleStarted ( IInvocationContext moduleContext) מדווח על תחילת מודול פועל. |
final void | testRunEnded (long elapsedTimeMillis, runMetrics) testRunEnded (long elapsedTimeMillis, runMetrics) מדווח על סיום ריצת המבחן. |
final void | testRunFailed ( FailureDescription failure) ריצת בדיקת הדוחות לא הושלמה עקב כשל המתואר על ידי |
final void | testRunFailed (String errorMessage) ריצת בדיקת הדוחות לא הושלמה עקב שגיאה קטלנית. |
void | testRunStarted (String runName, int testCount, int attemptNumber) מדווח על תחילת ריצת מבחן. |
final void | testRunStarted (String runName, int testCount) מדווח על תחילת ריצת מבחן. |
void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) מדווח על תחילת ריצת מבחן. |
final void | testStarted ( TestDescription test, long startTime) חלופה ל- |
final void | testStarted ( TestDescription test) מדווח על תחילת מקרה בדיקה בודד. |
שיטות מוגנות | |
---|---|
TestRecordProto.ChildReference | createModuleChildReference (TestRecordProto.TestRecord record) יוצר הפניה צאצא עבור מודול. |
בנאים ציבוריים
ProtoResultReporter
public ProtoResultReporter ()
שיטות ציבוריות
הקריאה הסתיימה
public final void invocationEnded (long elapsedTime)
מדווח שהפנייה הסתיימה, בין אם בהצלחה ובין אם עקב מצב שגיאה כלשהו.
ייקרא אוטומטית על ידי מסגרת TradeFederation.
פרמטרים | |
---|---|
elapsedTime | long : הזמן שחלף של הקריאה ב-ms |
הפניה נכשלה
public void invocationFailed (FailureDescription failure)
מדווח על הזמנה לא מלאה עקב מצב שגיאה כלשהו.
ייקרא אוטומטית על ידי מסגרת TradeFederation.
פרמטרים | |
---|---|
failure | FailureDescription : FailureDescription המתאר את הסיבה לכשל |
הפניה נכשלה
public void invocationFailed (Throwable cause)
מדווח על הזמנה לא מלאה עקב מצב שגיאה כלשהו.
ייקרא אוטומטית על ידי מסגרת TradeFederation.
פרמטרים | |
---|---|
cause | Throwable : הגורם ERROR(/Throwable) לכשל |
התראה התחילה
public final void invocationStarted (IInvocationContext context)
מדווח על תחילת הזמנת הבדיקה.
ייקרא אוטומטית על ידי מסגרת TradeFederation. כתבים צריכים לעקוף שיטה זו כדי לתמוך בדיווח על מספר מכשירים.
פרמטרים | |
---|---|
context | IInvocationContext : מידע על הפנייה |
logAssociation
public final void logAssociation (String dataName, LogFile logFile)
במקרים מסוימים, יומן חייב להיות משויך מאוד למקרי בדיקה, אך ההזדמנות לעשות זאת ב- testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
התקשרות חוזרת אינה אפשרית. לפיכך, התקשרות חוזרת זו מאפשרת לספק קשר חזק במפורש.
פרמטרים | |
---|---|
dataName | String : שם הנתונים |
logFile | LogFile : LogFile שנרשם קודם לכן ואמור להיות משויך למקרה הבדיקה. |
processFinalInvocationLogs
public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)
השתמש ברשומת הפנייה כדי לשלוח בזה אחר זה את כל היומנים הסופיים של ההזמנה.
פרמטרים | |
---|---|
invocationLogs | TestRecordProto.TestRecord : הפרוטו הסופי המייצג את ההזמנה. |
processFinalProto
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
טיפול בפרוטו הסופי עם כל התוצאות.
פרמטרים | |
---|---|
finalRecord | TestRecordProto.TestRecord : הפרוטו הסופי עם כל תוצאות ההתקשרות. |
processStartInvocation
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
טיפול בפרוטו של רשומת הבדיקה החלקית לאחר התרחשות invocationStarted(com.android.tradefed.invoker.IInvocationContext)
.
פרמטרים | |
---|---|
invocationStartRecord | TestRecordProto.TestRecord : הפרוטו החלקי המאוכלס לאחר ה-invocationStart. |
invocationContext | IInvocationContext : הקריאה IInvocationContext . |
processTestCaseEnded
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
טיפול בפרוטו הרשומה הסופית של מקרה הבדיקה לאחר התרחשה ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))
.
פרמטרים | |
---|---|
testCaseRecord | TestRecordProto.TestRecord : הפרוטו הסופי המייצג מקרה בדיקה. |
processTestCaseStarted
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
טיפול בפרוטו של רשומת מקרה הבדיקה החלקית לאחר testStarted(com.android.tradefed.result.TestDescription, long)
התרחש.
פרמטרים | |
---|---|
testCaseStartedRecord | TestRecordProto.TestRecord : הפרוטו החלקי המייצג את מקרה הבדיקה. |
processTestModuleEnd
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
טיפול בפרוטו הרשומה הסופית של המודול לאחר שהתרחש testModuleEnded()
.
פרמטרים | |
---|---|
moduleRecord | TestRecordProto.TestRecord : הפרוטו הסופי המייצג את המודול. |
processTestModuleStarted
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
טיפול בפרוטו החלקי של רשומת המודול לאחר שהתרחש testModuleStarted(com.android.tradefed.invoker.IInvocationContext)
.
פרמטרים | |
---|---|
moduleStartRecord | TestRecordProto.TestRecord : הפרוטו החלקי המייצג את המודול. |
processTestRunEnded
public void processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
טיפול בפרוטו רשומת הריצה הסופית לאחר התרחשה ERROR(/#testRunEnded(long,HashMap))
.
פרמטרים | |
---|---|
runRecord | TestRecordProto.TestRecord : פרוטו הסופי המייצג את הריצה. |
moduleInProgress | boolean : אם מודול נמצא בתהליך או לא. |
processTestRunStarted
public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)
טיפול בפרוטו רשומת ריצת הבדיקה החלקית לאחר שהתרחש testRunStarted(String, int)
.
פרמטרים | |
---|---|
runStartedRecord | TestRecordProto.TestRecord : הפרוטו החלקי המייצג את הריצה. |
setGranularResults
public void setGranularResults (boolean granularResults)
פרמטרים | |
---|---|
granularResults | boolean |
setInlineRecordOfChildren
public void setInlineRecordOfChildren (boolean inline)
פרמטרים | |
---|---|
inline | boolean |
תומך ב-GranularResults
public boolean supportGranularResults ()
מחזירה True אם הכתב תומך בתוצאות מפורטות, false אחרת.
החזרות | |
---|---|
boolean |
testAssumption Failure
public final void testAssumptionFailure (TestDescription test, String trace)
נקרא כאשר בדיקה אטומית מסמנת שהיא מניחה מצב שהוא שקרי
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
trace | String : עקבות מחסנית של כישלון |
testAssumption Failure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
נקרא כאשר בדיקה אטומית מסמנת שהיא מניחה מצב שהוא שקרי
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
failure | FailureDescription : FailureDescription המתאר את הכישלון ואת ההקשר שלו. |
הבדיקה הסתיים
public final 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 : הזמן שבו הסתיימה הבדיקה, נמדד באמצעות ERROR(/System#currentTimeMillis()) |
testMetrics | ERROR(/Map) של המדדים הנפלטים |
הבדיקה הסתיים
public void testEnded (TestDescription test,testMetrics)
מדווח על סיום הביצוע של מקרה בדיקה בודד.
אם testFailed(TestDescription, FailureDescription)
לא הופעל, מבחן זה עבר. מחזירה גם מדדי מפתח/ערך שייתכן שנפלטו במהלך ביצוע מקרה הבדיקה.
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
testMetrics | ERROR(/Map) של המדדים הנפלטים |
מבחן נכשל
public final void testFailed (TestDescription test, FailureDescription failure)
מדווח על כישלון של מקרה בדיקה בודד.
ייקרא בין testStarted לבין testEnded.
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
failure | FailureDescription : FailureDescription המתאר את הכישלון ואת ההקשר שלו. |
מבחן נכשל
public final void testFailed (TestDescription test, String trace)
מדווח על כישלון של מקרה בדיקה בודד.
ייקרא בין testStarted לבין testEnded.
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
trace | String : עקבות מחסנית של כישלון |
התעלמו מהבדיקה
public final void testIgnored (TestDescription test)
נקרא כאשר בדיקה לא תופעל, בדרך כלל מכיוון ששיטת בדיקה מסומנת ב-org.junit.Ignore.
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
testModuleEnded
public final void testModuleEnded ()
מדווח על סיום הפעלת מודול.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
מדווח על תחילת מודול פועל. התקשרות חוזרת זו משויכת ל- testModuleEnded()
והיא אופציונלית ברצף. הוא משמש רק במהלך ריצה המשתמשת במודולים: רצים מבוססי סוויטה.
פרמטרים | |
---|---|
moduleContext | IInvocationContext : IInvocationContext של המודול. |
testRunEnded
public final void testRunEnded (long elapsedTimeMillis,runMetrics)
מדווח על סיום ריצת המבחן. FIXME: אין לנו שני ממשקי Map<> עם סוג שונה, אז עלינו להשתמש ב-HashMap כאן.
פרמטרים | |
---|---|
elapsedTimeMillis | long : המכשיר דיווח על זמן שחלף, באלפיות שניות |
runMetrics | Metric . |
testRunFailed
public final void testRunFailed (FailureDescription failure)
ריצת בדיקת הדוחות לא הושלמה עקב כשל המתואר על ידי FailureDescription
.
פרמטרים | |
---|---|
failure | FailureDescription : FailureDescription המתאר את הכישלון ואת ההקשר שלו. |
testRunFailed
public final void testRunFailed (String errorMessage)
ריצת בדיקת הדוחות לא הושלמה עקב שגיאה קטלנית.
פרמטרים | |
---|---|
errorMessage | String : ERROR(/String) המתאר את הסיבה לכישלון הריצה. |
testRunStarted
public void testRunStarted (String runName, int testCount, int attemptNumber)
מדווח על תחילת ריצת מבחן.
פרמטרים | |
---|---|
runName | String : שם ריצת המבחן |
testCount | int : המספר הכולל של בדיקות בריצת מבחן |
attemptNumber | int : מספר הזמנה, מזהה את הניסיונות השונים של אותו runName הפועלים מספר פעמים. ה-probyNumber הוא 0 באינדקס ואמור לעלות בכל פעם שמתרחשת ריצה חדשה. לדוגמה, בדיקה מפורטת חוזרת 3 פעמים, היא צריכה לכלול 4 ריצות בסך הכל תחת אותו runName וה-probationNumber הוא מ-0 עד 3. |
testRunStarted
public final 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 הפועלים מספר פעמים. ה-probyNumber הוא 0 באינדקס ואמור לעלות בכל פעם שמתרחשת ריצה חדשה. לדוגמה, בדיקה מפורטת חוזרת 3 פעמים, היא צריכה לכלול 4 ריצות בסך הכל תחת אותו runName וה-probationNumber הוא מ-0 עד 3. |
startTime | long : הזמן שבו התחילה הריצה, נמדד באמצעות ERROR(/System#currentTimeMillis()) |
הבדיקה התחילה
public final 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 : הזמן שבו הבדיקה התחילה, נמדד באמצעות ERROR(/System#currentTimeMillis()) |
הבדיקה התחילה
public final void testStarted (TestDescription test)
מדווח על תחילת מקרה בדיקה בודד. ממשק ישן יותר, צריך להשתמש testStarted(com.android.tradefed.result.TestDescription)
במידת האפשר.
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
שיטות מוגנות
createModuleChildReference
protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)
יוצר הפניה צאצא עבור מודול.
פרמטרים | |
---|---|
record | TestRecordProto.TestRecord |
החזרות | |
---|---|
TestRecordProto.ChildReference |