CollectingTestListener
public class CollectingTestListener
extends Object
implements ITestInvocationListener , ILogSaverListener , IDisableable
java.lang.Object | |
↳ | com.android.tradefed.result.CollectingTestListener |
ITestInvocationListener
שיאסוף את כל תוצאות הבדיקה.
למרות שמבני הנתונים המשמשים באובייקט זה בטוחים לשרשור, יש לקרוא להתקשרות חזרה של ITestInvocationListener
בסדר הנכון.
סיכום
בנאים ציבוריים | |
---|---|
CollectingTestListener () |
שיטות ציבוריות | |
---|---|
IBuildInfo | getBuildInfo () שיטה זו הוצאה משימוש. הסתמכו על |
TestRunResult | getCurrentRunResults () מקבל את התוצאות עבור ריצת הבדיקה הנוכחית. |
int | getExpectedTests () מחזירה את מספר הבדיקות הצפויות. |
IInvocationContext | getInvocationContext () החזר את הקשר ההתקשרות שדווח באמצעות |
getMergedTestRunResults () החזר את אוסף התוצאות הממוזג עבור כל הריצות על פני ניסיונות שונים. | |
IInvocationContext | getModuleContextForRunResult (String testRunName) מחזירה את |
MultiMap <String, LogFile > | getModuleLogFiles () מחזירה עותק של המפה המכילה את כל הקבצים הרשום המשויכים למודול |
MultiMap <String, LogFile > | getNonAssociatedLogFiles () מחזירה עותק של המפה המכילה את כל הקובץ המתועד שאינו משויך להפעלת מבחן או למודול. |
int | getNumAllFailedTestRuns () מחזירה את המספר הכולל של ריצות בדיקה במצב כשל |
int | getNumAllFailedTests () מחזירה את המספר הכולל של בדיקות במצב כשל (רק נכשל, כשלים בהנחה אינם נחשבים כלפיו). |
int | getNumTestsInState (TestResult.TestStatus status) מחזירה את מספר הבדיקות במצב נתון עבור ריצה זו. |
int | getNumTotalTests () מחזירה את המספר הכולל של בדיקות שלמות עבור כל הריצות. |
IBuildInfo | getPrimaryBuildInfo () החזר את פרטי הבנייה הראשיים שדווחו באמצעות |
getRunResults () שיטה זו הוצאה משימוש. השתמש | |
TestRunResult | getTestRunAtAttempt (String testRunName, int attempt) החזר את |
int | getTestRunAttemptCount (String testRunName) מחזירה את מספר הניסיונות עבור שם נתון של ריצת בדיקה. |
getTestRunAttempts (String testRunName) מקבל את כל הניסיונות ל- | |
getTestRunForAttempts (int attempt) מקבל את כל התוצאות עבור ניסיון נתון. | |
getTestRunNames () החזר את כל השמות עבור כל ריצות הבדיקה. | |
boolean | hasFailedTests () מחזירה אם הפנייה נכשלה במבחנים כלשהם או בהנחה שנכשלו. |
boolean | hasTestRunResultsForName (String testRunName) מחזירה אם לשם ריצת בדיקה נתון יש תוצאות כלשהן. |
void | invocationEnded (long elapsedTime) מדווח שהפנייה הסתיימה, בין אם בהצלחה ובין אם עקב מצב שגיאה כלשהו. |
void | invocationFailed (Throwable cause) מדווח על הזמנה לא מלאה עקב מצב שגיאה כלשהו. |
void | invocationStarted ( IInvocationContext context) מדווח על תחילת הפעלת הבדיקה. |
boolean | isDisabled () מחזירה True אם האובייקט כולו מושבת (דלג גם על ההגדרה וגם על הפירוק). |
void | logAssociation (String dataName, LogFile logFile) במקרים מסוימים, יומן חייב להיות משויך מאוד למקרי בדיקה, אך ההזדמנות לעשות זאת ב- |
void | setBuildInfo ( IBuildInfo buildInfo) שיטה זו הוצאה משימוש. לא הכרחי לבדיקה יותר. |
void | setDisable (boolean isDisabled) קובע אם יש לבטל את האובייקט. |
void | setMergeStrategy ( MergeStrategy strategy) מגדיר את |
void | testAssumptionFailure ( TestDescription test, String trace) נקרא כאשר בדיקה אטומית מסמנת שהיא מניחה מצב שהוא שקרי |
void | testAssumptionFailure ( TestDescription test, FailureDescription failure) נקרא כאשר בדיקה אטומית מסמנת שהיא מניחה מצב שהוא שקרי |
void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) חלופה ל- |
void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) מדווח על סיום הביצוע של מקרה בדיקה בודד. |
void | testFailed ( TestDescription test, FailureDescription failure) מדווח על כישלון של מקרה בדיקה בודד. |
void | testFailed ( TestDescription test, String trace) מדווח על כישלון של מקרה בדיקה בודד. |
void | testIgnored ( TestDescription test) נקרא כאשר בדיקה לא תופעל, בדרך כלל מכיוון ששיטת בדיקה מסומנת ב-org.junit.Ignore. |
void | testModuleEnded () מדווח על סיום הפעלת מודול. |
void | testModuleStarted ( IInvocationContext moduleContext) מדווח על תחילת מודול פועל. |
void | testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) מדווח על סיום ריצת המבחן. |
void | testRunFailed ( FailureDescription failure) ריצת בדיקת הדוחות לא הושלמה עקב כשל המתואר על ידי |
void | testRunFailed (String errorMessage) ריצת בדיקת הדוחות לא הושלמה עקב שגיאה קטלנית. |
void | testRunStarted (String name, int numTests, int attemptNumber) מדווח על תחילת ריצת מבחן. |
void | testRunStarted (String name, int numTests) מדווח על תחילת ריצת מבחן. |
void | testRunStarted (String name, int numTests, int attemptNumber, long startTime) מדווח על תחילת ריצת מבחן. |
void | testRunStopped (long elapsedTime) הפעלת בדיקת הדוחות הופסקה לפני השלמתה עקב בקשת משתמש. |
void | testStarted ( TestDescription test, long startTime) חלופה ל- |
void | testStarted ( TestDescription test) מדווח על תחילת מקרה בדיקה בודד. |
שיטות מוגנות | |
---|---|
final void | clearModuleLogFiles () מאפשר ניקוי קובץ המודול, כך שאנו נמנעים מלשאת אותם זמן רב מדי. |
final void | clearResultsForName (String testRunName) מאפשר לנקות את התוצאות עבור שם ריצה נתון. |
void | setIsAggregrateMetrics (boolean aggregate) החלף את האפשרות 'מדדים מצטברים' |
בנאים ציבוריים
CollectingTestListener
public CollectingTestListener ()
שיטות ציבוריות
getBuildInfo
public IBuildInfo getBuildInfo ()
שיטה זו הוצאה משימוש.
הסתמכו על IBuildInfo
מ- getInvocationContext()
.
מחזיר את פרטי הבנייה.
החזרות | |
---|---|
IBuildInfo |
getCurrentRunResults
public TestRunResult getCurrentRunResults ()
מקבל את התוצאות עבור ריצת הבדיקה הנוכחית.
שימו לב, ייתכן שהתוצאות אינן שלמות. מומלץ לבדוק את הערך של TestRunResult.isRunComplete()
ו/או (@link TestRunResult#isRunFailure()} לפי המתאים לפני עיבוד התוצאות.
החזרות | |
---|---|
TestRunResult | ה- TestRunResult המייצג נתונים שנאספו במהלך ריצת הבדיקה האחרונה |
getExpectedTests
public int getExpectedTests ()
מחזירה את מספר הבדיקות הצפויות. יכול להיות שונה מ getNumTotalTests()
אם חלק מהבדיקות לא פעלו.
החזרות | |
---|---|
int |
getInvocationContext
public IInvocationContext getInvocationContext ()
החזר את הקשר ההתקשרות שדווח באמצעות invocationStarted(com.android.tradefed.invoker.IInvocationContext)
החזרות | |
---|---|
IInvocationContext |
getMergedTestRunResults
publicgetMergedTestRunResults ()
החזר את אוסף התוצאות הממוזג עבור כל הריצות על פני ניסיונות שונים.
אם יש מספר תוצאות, כל ריצת בדיקה מתמזגת, כאשר תוצאת הבדיקה האחרונה מחליפה את תוצאות הבדיקה של ריצות קודמות. ריצות המבחן מסודרות לפי מספר הניסיון.
מדדים עבור אותו ניסיון ימוזגו על סמך ההעדפה שנקבעה על ידי aggregate-metrics
. המדדים הסופיים יהיו המדדים של הניסיון האחרון.
החזרות | |
---|---|
getModuleContextForRunResult
public IInvocationContext getModuleContextForRunResult (String testRunName)
מחזירה את IInvocationContext
של המודול המשויך לתוצאות.
פרמטרים | |
---|---|
testRunName | String : השם שניתן על ידי { testRunStarted(String, int) . |
החזרות | |
---|---|
IInvocationContext | IInvocationContext של המודול עבור שם ריצת בדיקה נתון null אם אין תוצאות עבור השם הזה. |
getModuleLogFiles
public MultiMap<String, LogFile> getModuleLogFiles ()
מחזירה עותק של המפה המכילה את כל הקבצים הרשום המשויכים למודול
החזרות | |
---|---|
MultiMap <String, LogFile > |
getNonAssociatedLogFiles
public MultiMap<String, LogFile> getNonAssociatedLogFiles ()
מחזירה עותק של המפה המכילה את כל הקובץ המתועד שאינו משויך להפעלת מבחן או למודול.
החזרות | |
---|---|
MultiMap <String, LogFile > |
getNumAllFailedTestRuns
public int getNumAllFailedTestRuns ()
מחזירה את המספר הכולל של ריצות בדיקה במצב כשל
החזרות | |
---|---|
int |
getNumAllFailedTests
public int getNumAllFailedTests ()
מחזירה את המספר הכולל של בדיקות במצב כשל (רק נכשל, כשלים בהנחה אינם נחשבים כלפיו).
החזרות | |
---|---|
int |
getNumTestsInState
public int getNumTestsInState (TestResult.TestStatus status)
מחזירה את מספר הבדיקות במצב נתון עבור ריצה זו.
פרמטרים | |
---|---|
status | TestResult.TestStatus |
החזרות | |
---|---|
int |
getNumTotalTests
public int getNumTotalTests ()
מחזירה את המספר הכולל של בדיקות שלמות עבור כל הריצות.
החזרות | |
---|---|
int |
getPrimaryBuildInfo
public IBuildInfo getPrimaryBuildInfo ()
החזר את פרטי הבנייה הראשיים שדווחו באמצעות invocationStarted(com.android.tradefed.invoker.IInvocationContext)
. Build ראשי הוא ה-Build המוחזר על ידי ספק ה-Build הראשון של התצורה הפועלת. מחזירה null אם אין הקשר (ללא בנייה למקרה בדיקה).
החזרות | |
---|---|
IBuildInfo |
getRunResults
publicgetRunResults ()
שיטה זו הוצאה משימוש.
השתמש getMergedTestRunResults()
מחזיר את התוצאות עבור כל ריצות הבדיקה.
החזרות | |
---|---|
getTestRunAttempt
public TestRunResult getTestRunAtAttempt (String testRunName, int attempt)
החזר את TestRunResult
עבור ניסיון בודד.
פרמטרים | |
---|---|
testRunName | String : השם שניתן על ידי { testRunStarted(String, int) . |
attempt | int : מזהה הניסיון. |
החזרות | |
---|---|
TestRunResult | ה- TestRunResult עבור השם הנתון ומזהה הניסיון או null אם הוא לא קיים. |
getTestRunAttemptCount
public int getTestRunAttemptCount (String testRunName)
מחזירה את מספר הניסיונות עבור שם נתון של ריצת בדיקה.
פרמטרים | |
---|---|
testRunName | String : השם שניתן על ידי { testRunStarted(String, int) . |
החזרות | |
---|---|
int |
getTestRunAttempts
publicgetTestRunAttempts (String testRunName)
מקבל את כל הניסיונות ל- TestRunResult
של ריצת בדיקה נתונה.
פרמטרים | |
---|---|
testRunName | String : השם שניתן על ידי { testRunStarted(String, int) . |
החזרות | |
---|---|
כל TestRunResult עבור ריצת בדיקה נתונה, מסודרים לפי ניסיונות. |
getTestRunForAttempts
publicgetTestRunForAttempts (int attempt)
מקבל את כל התוצאות עבור ניסיון נתון.
פרמטרים | |
---|---|
attempt | int : הניסיון שאנו רוצים תוצאות עבורו. |
החזרות | |
---|---|
כל TestRunResult עבור ניסיון נתון. |
getTestRunNames
publicgetTestRunNames ()
החזר את כל השמות עבור כל ריצות הבדיקה.
ייתכן שהרצות בדיקה אלו רצו מספר פעמים עם ניסיונות שונים.
החזרות | |
---|---|
hasFailedTests
public boolean hasFailedTests ()
מחזירה אם הפנייה נכשלה במבחנים כלשהם או בהנחה שנכשלו.
החזרות | |
---|---|
boolean |
hasTestRunResultsForName
public boolean hasTestRunResultsForName (String testRunName)
מחזירה אם לשם ריצת בדיקה נתון יש תוצאות כלשהן.
פרמטרים | |
---|---|
testRunName | String : השם שניתן על ידי { testRunStarted(String, int) . |
החזרות | |
---|---|
boolean |
הקריאה הסתיימה
public void invocationEnded (long elapsedTime)
מדווח שהפנייה הסתיימה, בין אם בהצלחה ובין אם עקב מצב שגיאה כלשהו.
ייקרא אוטומטית על ידי מסגרת TradeFederation.
פרמטרים | |
---|---|
elapsedTime | long : הזמן שחלף של הקריאה ב-ms |
הפניה נכשלה
public void invocationFailed (Throwable cause)
מדווח על הזמנה לא מלאה עקב מצב שגיאה כלשהו.
ייקרא אוטומטית על ידי מסגרת TradeFederation.
פרמטרים | |
---|---|
cause | Throwable : הגורם Throwable לכשל |
התראה התחילה
public void invocationStarted (IInvocationContext context)
מדווח על תחילת הזמנת הבדיקה.
ייקרא אוטומטית על ידי מסגרת TradeFederation. כתבים צריכים לעקוף שיטה זו כדי לתמוך בדיווח על מספר מכשירים.
פרמטרים | |
---|---|
context | IInvocationContext : מידע על הפנייה |
מושבת
public boolean isDisabled ()
מחזירה True אם האובייקט כולו מושבת (דלג גם על ההגדרה וגם על הפירוק). שקר אחרת.
החזרות | |
---|---|
boolean |
logAssociation
public 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 שנרשם קודם לכן ואמור להיות משויך למקרה הבדיקה. |
setBuildInfo
public void setBuildInfo (IBuildInfo buildInfo)
שיטה זו הוצאה משימוש.
לא הכרחי לבדיקה יותר.
הגדר את פרטי הבנייה. צריך לשמש רק לבדיקה.
פרמטרים | |
---|---|
buildInfo | IBuildInfo |
setDisable
public void setDisable (boolean isDisabled)
מגדיר אם יש לבטל את האובייקט. מושבת פירושו שיש לדלג על שלבי ההגדרה וההפסקה. ניתן להשתמש כדי להפוך אובייקט לבלתי זמין כברירת מחדל בבנאי ברירת המחדל.
פרמטרים | |
---|---|
isDisabled | boolean : המצב שבו יש להכניס את האובייקט. |
setMergeStrategy
public void setMergeStrategy (MergeStrategy strategy)
מגדיר את MergeStrategy
לשימוש בעת מיזוג תוצאות.
פרמטרים | |
---|---|
strategy | MergeStrategy |
testAssumption Failure
public void testAssumptionFailure (TestDescription test, String trace)
נקרא כאשר בדיקה אטומית מסמנת שהיא מניחה מצב שהוא שקרי
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
trace | String : עקבות מחסנית של כישלון |
testAssumption Failure
public void testAssumptionFailure (TestDescription test, FailureDescription failure)
נקרא כאשר בדיקה אטומית מסמנת שהיא מניחה מצב שהוא שקרי
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
failure | FailureDescription : FailureDescription המתאר את הכישלון ואת ההקשר שלו. |
הבדיקה הסתיים
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) של המדדים הנפלטים |
הבדיקה הסתיים
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 המתאר את הכישלון ואת ההקשר שלו. |
מבחן נכשל
public void testFailed (TestDescription test, String trace)
מדווח על כישלון של מקרה בדיקה בודד.
ייקרא בין testStarted לבין testEnded.
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
trace | String : עקבות מחסנית של כישלון |
התעלמו מהבדיקה
public void testIgnored (TestDescription test)
נקרא כאשר בדיקה לא תופעל, בדרך כלל מכיוון ששיטת בדיקה מסומנת ב-org.junit.Ignore.
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
testModuleEnded
public void testModuleEnded ()
מדווח על סיום הפעלת מודול.
testModuleStarted
public void testModuleStarted (IInvocationContext moduleContext)
מדווח על תחילת מודול פועל. התקשרות חוזרת זו משויכת ל- testModuleEnded()
והיא אופציונלית ברצף. הוא משמש רק במהלך ריצה המשתמשת במודולים: רצים מבוססי סוויטה.
פרמטרים | |
---|---|
moduleContext | IInvocationContext : IInvocationContext של המודול. |
testRunEnded
public void testRunEnded (long elapsedTime,runMetrics)
מדווח על סיום ריצת המבחן. FIXME: אין לנו שני ממשקי Map<> עם סוג שונה, אז עלינו להשתמש ב-HashMap כאן.
פרמטרים | |
---|---|
elapsedTime | long : המכשיר דיווח על זמן שחלף, באלפיות שניות |
runMetrics | Metric . |
testRunFailed
public void testRunFailed (FailureDescription failure)
ריצת בדיקת הדוחות לא הושלמה עקב כשל המתואר על ידי FailureDescription
.
פרמטרים | |
---|---|
failure | FailureDescription : FailureDescription המתאר את הכישלון ואת ההקשר שלו. |
testRunFailed
public void testRunFailed (String errorMessage)
ריצת בדיקת הדוחות לא הושלמה עקב שגיאה קטלנית.
פרמטרים | |
---|---|
errorMessage | String : String המתארת את הסיבה לכישלון הריצה. |
testRunStarted
public void testRunStarted (String name, int numTests, int attemptNumber)
מדווח על תחילת ריצת מבחן.
פרמטרים | |
---|---|
name | String : שם ריצת הבדיקה |
numTests | int : המספר הכולל של בדיקות בריצת מבחן |
attemptNumber | int : מספר הזמנה, מזהה את הניסיונות השונים של אותו runName הפועלים מספר פעמים. ה-probyNumber הוא 0 באינדקס ואמור לעלות בכל פעם שמתרחשת ריצה חדשה. לדוגמה, בדיקה מפורטת חוזרת 3 פעמים, היא צריכה לכלול 4 ריצות בסך הכל תחת אותו runName וה-probationNumber הוא מ-0 עד 3. |
testRunStarted
public void testRunStarted (String name, int numTests)
מדווח על תחילת ריצת מבחן.
פרמטרים | |
---|---|
name | String : שם ריצת הבדיקה |
numTests | int : המספר הכולל של בדיקות בריצת מבחן |
testRunStarted
public void testRunStarted (String name, int numTests, int attemptNumber, long startTime)
מדווח על תחילת ריצת מבחן.
פרמטרים | |
---|---|
name | String : שם ריצת הבדיקה |
numTests | int : המספר הכולל של בדיקות בריצת מבחן |
attemptNumber | int : מספר הזמנה, מזהה את הניסיונות השונים של אותו runName הפועלים מספר פעמים. ה-probyNumber הוא 0 באינדקס ואמור לעלות בכל פעם שמתרחשת ריצה חדשה. לדוגמה, בדיקה מפורטת חוזרת 3 פעמים, היא צריכה לכלול 4 ריצות בסך הכל תחת אותו runName וה-probationNumber הוא מ-0 עד 3. |
startTime | long : הזמן שבו התחילה הריצה, נמדד באמצעות System.currentTimeMillis() |
testRunStopped
public void testRunStopped (long elapsedTime)
הפעלת בדיקת הדוחות הופסקה לפני השלמתה עקב בקשת משתמש.
מטלה: לא בשימוש כרגע, שקול להסיר
פרמטרים | |
---|---|
elapsedTime | long : המכשיר דיווח על זמן שחלף, באלפיות שניות |
הבדיקה התחילה
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() |
הבדיקה התחילה
public void testStarted (TestDescription test)
מדווח על תחילת מקרה בדיקה בודד. ממשק ישן יותר, צריך להשתמש testStarted(com.android.tradefed.result.TestDescription)
במידת האפשר.
פרמטרים | |
---|---|
test | TestDescription : מזהה את הבדיקה |
שיטות מוגנות
clearModuleLogFiles
protected final void clearModuleLogFiles ()
מאפשר ניקוי קובץ המודול, כך שאנו נמנעים מלשאת אותם זמן רב מדי.
clearResultsForName
protected final void clearResultsForName (String testRunName)
מאפשר לנקות את התוצאות עבור שם ריצה נתון. צריך לשמש רק במקרים מסוימים כמו אגרגטור התוצאות.
פרמטרים | |
---|---|
testRunName | String |
setIsAggregrateMetrics
protected void setIsAggregrateMetrics (boolean aggregate)
החלף את האפשרות 'מדדים מצטברים'
פרמטרים | |
---|---|
aggregate | boolean |