BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

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

תת-כיתות ישירות ידועות AggregatePostProcessor, ‏ AveragePostProcessor, ‏ BluetoothConnectionSuccessRatePostProcessor, ‏ MetricFilePostProcessor, ‏ PerfettoGenericPostProcessor, ‏ StatsdGenericPostProcessor AggregatePostProcessor צובר מדדים שמציג את הערכים המינימלי, המקסימלי, הממוצע, השונות, סטיית התקן, הסכום, המספר והפרסנטילים (אופציונלי) של מדדים מספריים שנאספו במהלך מספר סבבי בדיקה, ומתייחס אליהם כאל מספרים כפולים.  AveragePostProcessor הטמעה של מעבד נתונים לאחר העיבוד שמחשב את הממוצע של רשימת המדדים.  BluetoothConnectionSuccessRatePostProcessor הטמעה של מעבד נתונים לאחר העיבוד שמחשב את שיעור ההצלחה של פרופיל Bluetooth משתמשים ב-metric-key-match כדי לציין מדדים שמכילים מצבי חיבור Bluetooth במערך מספרי. דוגמה: [0, 1, 2, 3, 0, 1, 2, 3].  MetricFilePostProcessor משמש להעלאת קובץ יומן המדדים שנאסף במהלך הבדיקה וברמת ההרצה.  PerfettoGenericPostProcessor מעבד פוסט שממיר קובץ proto של מדד טקסט/בינארי של perfetto לזוגות מפתח/ערך על ידי הרחבה רפרסיבית של הודעות ה-proto והשדות עם ערכי מחרוזות, עד שמגיעים לשדה עם ערך מספרי.  StatsdGenericPostProcessor מעבד פוסט שממיר דוחות בינאריים של proto statsd לזוגות מפתח/ערך על ידי הרחבת הדוח כמבנה עץ.

תת-כיתות עקיפות ידועות StatsdBeforeAfterGaugeMetricPostProcessor, ‏ StatsdEventMetricPostProcessor StatsdBeforeAfterGaugeMetricPostProcessor מעבד נתונים לאחר האיסוף, שמטפל במדדי מדדים שנאספים בשיטה של 'לפני/אחרי', כלומר:  StatsdEventMetricPostProcessor מעבד פוסט שממיר מדדי אירועים בדוחות של statsd לצמדי מפתח/ערך, באמצעות הפורמטרים שצוינו במעבד.

---

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

סיכום

יוצרים ציבוריים
BasePostProcessor()

שיטות ציבוריות
final ITestInvocationListener	init(ITestInvocationListener listener) שלב האתחול של מעבד הנתונים.
final void	invocationEnded(long elapsedTime) האירוע הזה מדווח על סיום ההפעלה, בין שהיא הסתיימה בהצלחה ובין שהיא הסתיימה בגלל תנאי שגיאה כלשהו.
final void	invocationFailed(FailureDescription failure) דיווח על קריאה חלקית עקב תנאי שגיאה כלשהו.
final void	invocationFailed(Throwable cause) דיווח על קריאה חלקית עקב תנאי שגיאה כלשהו.
void	invocationSkipped(SkipReason reason) דיווח על קריאה כ'דילוג'
final void	invocationStarted(IInvocationContext context) Listeners להפעלה להעברה
final boolean	isDisabled() הפונקציה מחזירה את הערך True אם האובייקט כולו מושבת (מחמיצים את ההגדרה וההסרה).
final void	logAssociation(String dataName, LogFile logFile) במקרים מסוימים, צריך לשייך את היומן באופן חזק למקרה בדיקה, אבל אי אפשר לעשות זאת בקריאה החוזרת (callback) הישירה של testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile). עדכון השיוך של היומן לבדיקה.
	processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) מטמיעים את השיטה הזו כדי לצבור מדדים ולוגים מכל הבדיקות.
abstract	processRunMetricsAndLogs( rawMetrics, runLogs) מטמיעים את השיטה הזו כדי ליצור קבוצה של מדדים חדשים מהיומנים והמדדים הקיימים.
	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) חלופה ל-ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), שבה אפשר לציין את שעת הסיום ישירות.
final void	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) דיווח על סיום הרצת הבדיקה.
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) בדיקת קריאות חזרה (callbacks) להרצה
final void	testRunStarted(String runName, int testCount, int attemptNumber, long startTime) דיווח על התחלת הרצה של בדיקה.
final void	testRunStopped(long elapsedTime) הרצת הבדיקה של הדוחות הופסקה לפני שהסתיימה עקב בקשה של משתמש.
final void	testSkipped(TestDescription test, SkipReason reason) הקריאה מתבצעת כשבדיקה מועברת ולא מתבצעת מסיבה שלא צפויה בדרך כלל.
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) קריאות חזרה (callbacks) של תרחישי בדיקה

שיטות מוגנות
void	cleanUp()
MetricMeasurement.DataType	getMetricType() אם צריך, משנים את סוג המדד באמצעות שינוי השיטה הזו.
String	getRunName()

יוצרים ציבוריים

BasePostProcessor

public BasePostProcessor ()

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

init

public final ITestInvocationListener init (ITestInvocationListener listener)

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

פרמטרים
listener	ITestInvocationListener

החזרות
ITestInvocationListener

invocationEnded

public final void invocationEnded (long elapsedTime)

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

הקריאה תתבצע באופן אוטומטי על ידי מסגרת TradeFederation.

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

invocationFailed

public final void invocationFailed (FailureDescription failure)

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

הקריאה תתבצע באופן אוטומטי על ידי מסגרת TradeFederation.

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

invocationFailed

public final void invocationFailed (Throwable cause)

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

הקריאה תתבצע באופן אוטומטי על ידי מסגרת TradeFederation.

פרמטרים
cause	Throwable: Throwable הסיבה לכישלון

invocationSkipped

public void invocationSkipped (SkipReason reason)

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

פרמטרים
reason	SkipReason

invocationStarted

public final void invocationStarted (IInvocationContext context)

Listeners להפעלה להעברה

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

isDisabled

public final boolean isDisabled ()

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

החזרות
boolean

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

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

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

פרמטרים
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

setUp

public void setUp ()

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

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

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

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

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

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

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

testEnded

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) של המדדים שמונפקים

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

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

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

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

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

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

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

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

testFailed

public final void testFailed (TestDescription test, 
                String trace)

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

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

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

testIgnored

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

testModuleEnded

public final void testModuleEnded ()

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

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

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

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

בדיקת קריאות חזרה (callbacks) להרצה

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

testRunStarted

public final 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 final void testRunStopped (long elapsedTime)

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

TODO: currently unused, consider removing

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

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

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

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

testStarted

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()

testStarted

public final void testStarted (TestDescription test)

קריאות חזרה של תרחישים לבדיקה

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

שיטות מוגנות

cleanUp

protected void cleanUp ()

getMetricType

protected MetricMeasurement.DataType getMetricType ()

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

החזרות
MetricMeasurement.DataType

getRunName

protected String getRunName ()

החזרות
String