BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Object
com.android.tradefed.postprocessor.BasePostProcessor


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

סיכום

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

BasePostProcessor ()

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

final ITestInvocationListener init ( ITestInvocationListener listener)

שלב אתחול של ה-post processor.

final void invocationEnded (long elapsedTime)

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

final void invocationFailed ( FailureDescription failure)

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

final void invocationFailed (Throwable cause)

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

final void invocationStarted ( IInvocationContext context)

מאזיני קריאות להעברה

final boolean isDisabled ()

מחזירה True אם האובייקט כולו מושבת (דלג גם על ההגדרה וגם על הפירוק).

final void logAssociation (String dataName, LogFile logFile)

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

מעדכן את שיוך היומן לבדיקה.

processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)

יישם שיטה זו כדי לצבור מדדים ויומנים בכל הבדיקות.

abstract processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs)

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

processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs)

יישם שיטה זו כדי לפרסם מדדי תהליך ויומנים מכל בדיקה.

final void setLogSaver ( ILogSaver logSaver)

הגדר את ILogSaver כדי לאפשר למימוש לשמור קבצים.

void setUp ()

עוקף שיטה זו במעבדי הפוסט-הילדים כדי לאתחל לפני הפעלת הבדיקה.

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)

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

final 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 testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)

השתמש בשיטה זו כדי לרשום קובץ מהטמעת PostProcessor.

final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

נקרא כאשר יומן הבדיקה נשמר.

final void testModuleEnded ()

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

final void testModuleStarted ( IInvocationContext moduleContext)

מדווח על תחילת מודול פועל.

final void testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics)

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

final void testRunFailed ( FailureDescription failure)

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

final void testRunFailed (String errorMessage)

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

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

מדווח על תחילת ריצת מבחן.

final void testRunStarted (String runName, int testCount)

הפעלת התקשרות חזרה

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

מדווח על תחילת ריצת מבחן.

final void testRunStopped (long elapsedTime)

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

final void testStarted ( TestDescription test, long startTime)

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

final void testStarted ( TestDescription test)

התקשרויות למקרי בדיקה

שיטות מוגנות

MetricMeasurement.DataType getMetricType ()

עוקף שיטה זו כדי לשנות את סוג המדד במידת הצורך.

String getRunName ()

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

BasePostProcessor

public BasePostProcessor ()

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

init

public final ITestInvocationListener init (ITestInvocationListener listener)

שלב אתחול של ה-post processor. הובטח שיתקשרו לפני כל אחת מהשיחות חזרה.

פרמטרים
listener ITestInvocationListener

החזרות
ITestInvocationListener

הקריאה הסתיימה

public final void invocationEnded (long elapsedTime)

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

ייקרא אוטומטית על ידי מסגרת TradeFederation.

פרמטרים
elapsedTime long : הזמן שחלף של הקריאה ב-ms

הפניה נכשלה

public final void invocationFailed (FailureDescription failure)

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

ייקרא אוטומטית על ידי מסגרת TradeFederation.

פרמטרים
failure FailureDescription : FailureDescription המתאר את הסיבה לכשל

הפניה נכשלה

public final void invocationFailed (Throwable cause)

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

ייקרא אוטומטית על ידי מסגרת TradeFederation.

פרמטרים
cause לזרוק: הסיבה Throwable Throwable

התראה התחילה

public final void invocationStarted (IInvocationContext context)

מאזיני קריאות להעברה

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

מושבת

public final boolean isDisabled ()

מחזירה True אם האובייקט כולו מושבת (דלג גם על ההגדרה וגם על הפירוק). שקר אחרת.

החזרות
boolean

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 שנרשם קודם לכן ואמור להיות משויך למקרה הבדיקה.

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

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

פרמטרים
allTestMetrics ListMultimap : מפת HashMultimap המאחסנת את המדדים מכל בדיקה מקובצת לפי שמות מדדים.

allTestLogs : מפה המאחסנת את המפה של כל בדיקה של קובצי יומן המפתחות לפי שמות הנתונים שלהם, תוך שימוש ב- TestDescription של כל בדיקה כמפתחות.

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

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

יישם שיטה זו על מנת ליצור קבוצה של מדדים חדשים מהמדדים והיומנים הקיימים. יש להחזיר רק את המדדים החדשים שנוצרו, ועם שם מפתח ייחודי (לא מותרת התנגשות עם מפתחות קיימים).

פרמטרים
rawMetrics : קבוצת המדדים הגולמיים הזמינים להרצה.

runLogs : קבוצת קובצי היומן להפעלת המבחן.

החזרות
קבוצת המדדים החדשים שנוצרו מדדי הריצה.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

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

פרמטרים
testDescription TestDescription : האובייקט TestDescription המתאר את הבדיקה.

testMetrics : קבוצת המדדים מהבדיקה.

testLogs : קבוצת הקבצים שנרשמה במהלך הבדיקה.

החזרות
קבוצת המדדים החדשים שנוצרו מדדי הבדיקה.

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

הגדר את ILogSaver כדי לאפשר למימוש לשמור קבצים.

פרמטרים
logSaver ILogSaver : ה- ILogSaver

להכין

public void setUp ()

עוקף שיטה זו במעבדי הפוסט-הילדים כדי לאתחל לפני הפעלת הבדיקה.

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 : הזמן שבו הסתיימה הבדיקה, נמדד באמצעות System.currentTimeMillis()

testMetrics : ERROR(/Map) של המדדים הנפלטים

הבדיקה הסתיים

public final 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 : מזהה את הבדיקה

testLog

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

השתמש בשיטה זו כדי לרשום קובץ מהטמעת PostProcessor.

פרמטרים
dataName String : שם תיאורי של String של הנתונים. למשל "device_logcat". הערה ייתכן ש-dataName אינו ייחודי לכל הזמנה. כלומר, המיישמים חייבים להיות מסוגלים לטפל במספר שיחות עם אותו dataName

dataType LogDataType : ה- LogDataType של הנתונים

dataStream InputStreamSource : InputStreamSource של הנתונים. על המיישמים להתקשר ל-createInputStream כדי להתחיל לקרוא את הנתונים, ולהבטיח לסגור את ה-InputStream שהתקבל לאחר השלמתו. המתקשרים צריכים לוודא שמקור הנתונים נשאר קיים ונגיש עד להשלמת שיטת testLog.

testLogSaved

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

נקרא כאשר יומן הבדיקה נשמר.

יש להשתמש במקום ITestInvocationListener#testLog(String, LogDataType, InputStreamSource) .

פרמטרים
dataName String : שם תיאורי של String של הנתונים. למשל "device_logcat". הערה ייתכן ש-dataName אינו ייחודי לכל הזמנה. כלומר, המיישמים חייבים להיות מסוגלים לטפל במספר שיחות עם אותו dataName

dataType LogDataType : ה- LogDataType של הנתונים

dataStream InputStreamSource : InputStreamSource של הנתונים. על המיישמים להתקשר ל-createInputStream כדי להתחיל לקרוא את הנתונים, ולהבטיח לסגור את ה-InputStream שהתקבל לאחר השלמתו.

logFile LogFile : LogFile המכיל את המטא נתונים של הקובץ השמור.

testModuleEnded

public final void testModuleEnded ()

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

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

מדווח על סיום ריצת המבחן. FIXME: אין לנו שני ממשקי Map<> עם סוג שונה, אז עלינו להשתמש ב-HashMap כאן.

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

runMetrics : צמדי מפתח-ערך שדווחו בסוף ריצת מבחן עם Metric .

testRunFailed

public final void testRunFailed (FailureDescription failure)

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

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

testRunFailed

public final void testRunFailed (String errorMessage)

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

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

testRunStarted

public final 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 final 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 : הזמן שבו התחילה הריצה, נמדד באמצעות System.currentTimeMillis()

testRunStopped

public final void testRunStopped (long elapsedTime)

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

TODO: כרגע לא בשימוש, שקול להסיר

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

הבדיקה התחילה

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 : הזמן שבו הבדיקה התחילה, נמדד באמצעות System.currentTimeMillis()

הבדיקה התחילה

public final void testStarted (TestDescription test)

התקשרויות למקרי בדיקה

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

שיטות מוגנות

getMetricType

protected MetricMeasurement.DataType getMetricType ()

עוקף שיטה זו כדי לשנות את סוג המדד במידת הצורך. כברירת מחדל, המדד מוגדר לסוג מעובד.

החזרות
MetricMeasurement.DataType

getRunName

protected String getRunName ()

החזרות
String