Proto resultReporter (דיווח על תוצאות)

public abstract class ProtoResultReporter
extends Object implements ILogSaverListener, ISupportGranularResults, ITestInvocationListener

JavaScript.lang.Object
   ↳ com.android.tradefed.result.proto.ProtoresultsReporter

דיווח על תוצאות יוצר protobuf של TestRecord עם כל התוצאות בפנים. צריך להרחיב את היכולות כדי לטפל במה שאפשר לעשות עם ה-Proto הסופי ב-processFinalProto(com.android.tradefed.result.proto.TestRecordProto.TestRecord).

סיכום

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

ProtoResultReporter()

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

final void invocationEnded(long elapsedTime)

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

void invocationFailed(FailureDescription failure)

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

void invocationFailed(Throwable cause)

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

void invocationSkipped(SkipReason reason)

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

final void invocationStarted(IInvocationContext context)

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

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

void processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs)

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

void processFinalProto(TestRecordProto.TestRecord finalRecord)

טיפול ב-proto הסופי עם כל התוצאות.

void processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)

טיפול בפרוטו של רשומת הבדיקה של ההפעלה החלקית אחרי שאירוע invocationStarted(com.android.tradefed.invoker.IInvocationContext) התרחש.

void processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord)

טיפול בפרוטו של רשומת מקרה הבדיקה הסופי לאחר ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap)).

void processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord)

טיפול בפרוטו של רשומת מקרה הבדיקה החלקי אחרי שאירוע testStarted(com.android.tradefed.result.TestDescription, long) התרחש.

void processTestModuleEnd(TestRecordProto.TestRecord moduleRecord)

טיפול ב-proto של רשומת המודול הסופית אחרי ש-testModuleEnded() התרחש.

void processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord)

טיפול בפרוטו של רשומת המודול החלקי אחרי שאירוע testModuleStarted(com.android.tradefed.invoker.IInvocationContext) התרחש.

void processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress)

טיפול ב-proto של רשומת הריצה הסופית אחרי ERROR(/#testRunEnded(long,HashMap)) התרחש.

void processTestRunStarted(TestRecordProto.TestRecord runStartedRecord)

טיפול בפרוטו של רשומת הרצת הבדיקה החלקית אחרי testRunStarted(String, int) התרחש.

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)

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

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

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

final void testModuleStarted(IInvocationContext moduleContext)

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

final void testRunEnded(long elapsedTimeMillis, runMetrics)

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

final void testRunFailed(FailureDescription failure)

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

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

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

שיטות מוגנות

void afterModuleEnd()
void beforeModuleStart()
TestRecordProto.ChildReference createModuleChildReference(TestRecordProto.TestRecord record)

יוצרת הפניית צאצא למודול.

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

Proto resultReporter (דיווח על תוצאות)

public ProtoResultReporter ()

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

invocationEnded

public final 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 final void invocationStarted (IInvocationContext context)

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

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

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

שיוך (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 שרשום ביומן קודם וצריך לשייך למקרה הבדיקה.

processFinalInvocationLogs

public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)

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

פרמטרים
invocationLogs TestRecordProto.TestRecord: קובץ ה-proto הסופי שמייצג את ההפעלה.

processFinalProto

public void processFinalProto (TestRecordProto.TestRecord finalRecord)

טיפול בפרוטו הסופי עם כל התוצאות.

פרמטרים
finalRecord TestRecordProto.TestRecord: קובץ ה-proto הסופי עם כל תוצאות ההפעלה.

processStartInvocation

public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, 
                IInvocationContext invocationContext)

טיפול בפרוטו של רשומת הבדיקה החלקית של הבדיקה אחרי invocationStarted(com.android.tradefed.invoker.IInvocationContext).

פרמטרים
invocationStartRecord TestRecordProto.TestRecord: ה-proto החלקי מאוכלס אחרי 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: ה-proto החלקי שמייצג את מקרה הבדיקה.

processTestModuleEnd

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

טיפול ב-proto של רשומת המודול הסופית אחרי ש-testModuleEnded() התרחש.

פרמטרים
moduleRecord TestRecordProto.TestRecord: האב הסופי שמייצג את המודול.

processTestModuleStarted

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

טיפול בפרוטו של רשומת המודול החלקי אחרי שאירוע testModuleStarted(com.android.tradefed.invoker.IInvocationContext) התרחש.

פרמטרים
moduleStartRecord TestRecordProto.TestRecord: ה-proto החלקי שמייצג את המודול.

לעבדTestRunEnded

public void processTestRunEnded (TestRecordProto.TestRecord runRecord, 
                boolean moduleInProgress)

הטיפול בפרוטו של רשומת ההרצה הסופית אחרי ERROR(/#testRunEnded(long,HashMap)).

פרמטרים
runRecord TestRecordProto.TestRecord: קובץ ה-proto הסופי שמייצג את ההרצה.
moduleInProgress boolean: אם מודול מסוים נמצא בטיפול או לא.

processTestRunStarted

public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)

טיפול בפרוטו של רשומת הרצת הבדיקה החלקית אחרי testRunStarted(String, int) התרחשה.

פרמטרים
runStartedRecord TestRecordProto.TestRecord: ה-Proto החלקי שמייצג את הריצה.

setGranularResults

public void setGranularResults (boolean granularResults)

פרמטרים
granularResults boolean

setInlineRecordOfChildren

public void setInlineRecordOfChildren (boolean inline)

פרמטרים
inline boolean

supportGranularResults

public boolean supportGranularResults ()

מחזירה את הערך True אם המדווח תומך בתוצאות מפורטות. אחרת, הוא מקבל את הערך false.

החזרות
boolean

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

הבדיקה הסתיימה

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

הבדיקה נכשלה

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

testModuleEnded

public final void testModuleEnded ()

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

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded

public final void testRunEnded (long elapsedTimeMillis, 
                 runMetrics)

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

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

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

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

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

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

public final void testStarted (TestDescription test)

דיווח על התחלת מקרה בדיקה ספציפי. ממשק ישן יותר, עדיף להשתמש ב-testStarted(com.android.tradefed.result.TestDescription) כשהדבר אפשרי.

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

שיטות מוגנות

לאחר מכן

protected void afterModuleEnd ()

beforeModuleStart (לפני מודולים)

protected void beforeModuleStart ()

createModuleChildReference

protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)

יוצרת הפניית צאצא למודול.

פרמטרים
record TestRecordProto.TestRecord

החזרות
TestRecordProto.ChildReference