ProtoResultReporter

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

java.lang.Object
   ↳ com.android.tradefed.result.proto.ProtoResultReporter

הכלי Result reporter יוצר TestRecord protobuf עם כל התוצאות. צריך להרחיב את הפונקציה כדי שתטפל במה שצריך לעשות עם הפרוטו הסופי ב-processFinalProto(TestRecord).

סיכום

‫constructors ציבוריים

ProtoResultReporter()

‫methods ציבוריים

final void invocationEnded(long elapsedTime)

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

void invocationFailed(FailureDescription failure)

הפונקציה מחזירה קריאה לא שלמה בגלל תנאי שגיאה מסוים.

void invocationFailed(Throwable cause)

הפונקציה מחזירה קריאה לא שלמה בגלל תנאי שגיאה מסוים.

void invocationSkipped(SkipReason reason)

דיווח על הפעלה שנדלגה

void invocationStarted(IInvocationContext context)

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

final void logAssociation(String dataName, LogFile logFile)

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

void processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs)

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

void processFinalProto(TestRecordProto.TestRecord finalRecord)

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

void processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)

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

void processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord)

טיפול בפרוטוקול של רשומת תרחיש הבדיקה הסופית אחרי שקרה testEnded(TestDescription,long,HashMap).

void processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord)

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

void processTestModuleEnd(TestRecordProto.TestRecord moduleRecord)

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

void processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord)

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

void processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress)

טיפול בפרוטו של רשומת הריצה הסופית אחרי שהתרחש 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, HashMap<String, MetricMeasurement.Metric> testMetrics)

חלופה ל-testEnded(TestDescription,Map) שבה אפשר לציין את שעת הסיום ישירות.

void testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> 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, HashMap<String, MetricMeasurement.Metric> 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(TestDescription) שבה מציינים גם את תאריך ההתחלה של הבדיקה, בשילוב עם testEnded(TestDescription,long,Map) למדידה מדויקת.

final void testStarted(TestDescription test)

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

שיטות מוגנות

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

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

‫constructors ציבוריים

ProtoResultReporter

public ProtoResultReporter ()

‫methods ציבוריים

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

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

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

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

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

במקרים מסוימים, צריך לשייך את היומן באופן חזק לתרחישי בדיקה, אבל אי אפשר לעשות את זה באמצעות הקריאה החוזרת הישירה testLogSaved(String,LogDataType,InputStreamSource,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: קובץ ה-proto הסופי עם כל תוצאות ההפעלה.

processStartInvocation

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

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

פרמטרים
invocationStartRecord ‫TestRecordProto.TestRecord: פרוטו חלקי שאוכלס אחרי invocationStart.
invocationContext ‫IInvocationContext: הקריאה לפונקציה IInvocationContext.

processTestCaseEnded

public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)

טיפול בפרוטוקול של רשומת תרחיש הבדיקה הסופית אחרי שקרה testEnded(TestDescription,long,HashMap).

פרמטרים
testCaseRecord ‫TestRecordProto.TestRecord: פרוטו סופי שמייצג מקרה בדיקה.

processTestCaseStarted

public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)

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

פרמטרים
testCaseStartedRecord ‫TestRecordProto.TestRecord: פרוטו חלקי שמייצג את מקרה הבדיקה.

processTestModuleEnd

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

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

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

processTestModuleStarted

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

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

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

processTestRunEnded

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

טיפול בפרוטו של רשומת הריצה הסופית אחרי שהתרחש 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

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, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

חלופה ל-testEnded(TestDescription,Map) שבה אפשר לציין את שעת הסיום ישירות. אפשר לשלב עם testStarted(TestDescription,long) כדי לקבל מדידה מדויקת.

פרמטרים
test ‫TestDescription: מזהה את הבדיקה
endTime ‫long: השעה שבה הבדיקה הסתיימה, נמדדת באמצעות System.currentTimeMillis()
testMetrics HashMap: Map של המדדים שנפלטים

testEnded

public void testEnded (TestDescription test, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

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

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

פרמטרים
test ‫TestDescription: מזהה את הבדיקה
testMetrics HashMap: 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: מזהה את הבדיקה

testModuleEnded

public final void testModuleEnded ()

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

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded

public final void testRunEnded (long elapsedTimeMillis, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

דוחות על סיום הרצת הבדיקה. FIXME: We cannot have two Map<> interfaces with different type, so we have to use HashMap here.

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

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(TestDescription) שבה מציינים גם את תאריך ההתחלה של הבדיקה, בשילוב עם testEnded(TestDescription,long,Map) למדידה מדויקת.

פרמטרים
test ‫TestDescription: מזהה את הבדיקה
startTime ‫long: השעה שבה הבדיקה התחילה, נמדדת באמצעות System.currentTimeMillis()

testStarted

public final void testStarted (TestDescription test)

הפונקציה מדווחת על תחילת בדיקה של תרחיש בדיקה מסוים. בממשק הישן, מומלץ להשתמש ב-testStarted(TestDescription) בכל הזדמנות.

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

שיטות מוגנות

afterModuleEnd

protected void afterModuleEnd ()

beforeModuleStart

protected void beforeModuleStart ()

createModuleChildReference

protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)

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

פרמטרים
record TestRecordProto.TestRecord

חזרה לרצף השגרה
TestRecordProto.ChildReference