BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IDeviceActionReceiver, IMetricCollector

java.lang.Object
   ↳ com.android.tradefed.device.metric.BaseDeviceMetricCollector

יישום בסיסי של IMetricCollector שמאפשר להתחיל ולהפסיק את האיסוף ב-onTestRunStart(DeviceMetricData) וב-onTestRunEnd(DeviceMetricData,Map).

סיכום

ערכים קבועים

String TEST_CASE_EXCLUDE_GROUP_OPTION

String TEST_CASE_INCLUDE_GROUP_OPTION

‫Constructors ציבוריים

BaseDeviceMetricCollector()

‫methods ציבוריים

boolean doesModuleContainFailure()

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

void enableDefaultMetricCollection()

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

void extraInit(IInvocationContext context, ITestInvocationListener listener)
IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel()
final List<IBuildInfo> getBuildInfos()

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

final List<ITestDevice> getDevices()

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

File getFileFromTestArtifacts(String fileName)

מאחזרים את הקובץ מהארטיפקטים של הבדיקה או מהארטיפקטים של המודול ומאחסנים אותו במטמון במפה לקריאות הבאות.

final ITestInvocationListener getInvocationListener()

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

String getModuleName()
IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel()
final List<ITestDevice> getRealDevices()

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

String getRunName()

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

String getTestName()

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

final ITestInvocationListener init(IInvocationContext context, 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)

‫Invocation Listeners להעברה

boolean isDefaultMetricCollectionEnabled()

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

final boolean isDisabled()

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

boolean isDisabledReceiver()

האם IDeviceActionReceiver מושבת או לא.

final void logAssociation(String dataName, LogFile logFile)

אין להשתמש בשיטה הזו בהטמעה של כלי לאיסוף מדדים.

void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

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

void onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

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

void onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)

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

void onTestFail(DeviceMetricData testData, TestDescription test)

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

void onTestModuleEnded()

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

void onTestModuleStarted()

מאפשרת ללכוד את אירוע ההתחלה של המודול.

void onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)

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

void onTestRunFailed(DeviceMetricData testData, FailureDescription failure)

קריאה חוזרת (callback) לאירועים מסוג testRunFailed

void onTestRunStart(DeviceMetricData runData)

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

void onTestStart(DeviceMetricData testData)

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

void rebootEnded(ITestDevice device)

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

void rebootStarted(ITestDevice device)

מקבל התראה כשההפעלה מחדש מתחילה במכשיר.

void setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level)

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

final void setDisable(boolean isDisabled)

קובעת אם האובייקט צריך להיות מושבת.

void setDisableReceiver(boolean isDisabled)

הגדרה שקובעת אם צריך להשבית את IDeviceActionReceiver.

final void setLogSaver(ILogSaver logSaver)

אין להשתמש בשיטה הזו בהטמעה של כלי לאיסוף מדדים.

void setModuleContainsFailure()

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

void setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level)

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

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) שבה אפשר לציין את שעת הסיום ישירות.

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

מספק את היומן המשויך או נתוני הניפוי באגים מהפעלת הבדיקה.

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

אין להשתמש בשיטה הזו בהטמעה של כלי לאיסוף מדדים.

final void testModuleEnded()

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

final void testModuleStarted(IInvocationContext moduleContext)

האירוע הזה מדווח על תחילת ההפעלה של מודול.

final void testRunEnded(long elapsedTime, HashMap<String, MetricMeasurement.Metric> 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 testSkipped(TestDescription test, SkipReason reason)

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

final void testStarted(TestDescription test, long startTime)

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

final void testStarted(TestDescription test)

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

ערכים קבועים

TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

ערך קבוע: "test-case-exclude-group"

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

ערך קבוע: "test-case-include-group"

‫constructors ציבוריים

BaseDeviceMetricCollector

public BaseDeviceMetricCollector ()

‫methods ציבוריים

doesModuleContainFailure

public boolean doesModuleContainFailure ()

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

החזרות
boolean

enableDefaultMetricCollection

public void enableDefaultMetricCollection ()

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

extraInit

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

הקפצת הודעות שגיאה (throw)
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAlwaysOnCollectionLevel

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

החזרות
IMetricCollector.MetricCollectionLevel

getBuildInfos

public final List<IBuildInfo> getBuildInfos ()

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

החזרות
List<IBuildInfo>

getDevices

public final List<ITestDevice> getDevices ()

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

החזרות
List<ITestDevice>

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

מאחזרים את הקובץ מהארטיפקטים של הבדיקה או מהארטיפקטים של המודול ומאחסנים אותו במטמון במפה לקריאות הבאות.

פרמטרים
fileName ‫String: שם הקובץ שצריך לחפש בארטיפקטים.
החזרות
File קובץ מפריט הבדיקה או מפריט המודול. הפונקציה מחזירה ערך null אם הקובץ לא נמצא.

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

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

החזרות
ITestInvocationListener

getModuleName

public String getModuleName ()

החזרות
String

getOnFailureCollectionLevel

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

החזרות
IMetricCollector.MetricCollectionLevel

getRealDevices

public final List<ITestDevice> getRealDevices ()

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

החזרות
List<ITestDevice>

getRunName

public String getRunName ()

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

החזרות
String ‫mRunName, השם של הרצת הבדיקה הנוכחית.

getTestName

public String getTestName ()

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

החזרות
String ‫mTestName, שם הבדיקה הנוכחית.

init

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

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

אל תבטלו את ההגדרה הזו אלא אם אתם יודעים מה אתם עושים.

פרמטרים
context ‫IInvocationContext: ה-IInvocationContext של הקריאה שנמצאת בתהליך.
listener ‫ITestInvocationListener: ה-ITestInvocationListener שבו יוצבו התוצאות.
החזרות
ITestInvocationListener המאזין החדש עוטף את המאזין המקורי.
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

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)

‫Invocation Listeners להעברה

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

isDefaultMetricCollectionEnabled

public boolean isDefaultMetricCollectionEnabled ()

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

החזרות
boolean

isDisabled

public final boolean isDisabled ()

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

החזרות
boolean

isDisabledReceiver

public boolean isDisabledReceiver ()

האם IDeviceActionReceiver מושבת או לא.

החזרות
boolean הפונקציה מחזירה את הערך true אם ההגדרה מושבתת, אחרת היא מחזירה את הערך false.

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

אין להשתמש בשיטה הזו בהטמעה של כלי לאיסוף מדדים. זוהי העברה בלבד.

פרמטרים
dataName String: שם הנתונים
logFile ‫LogFile: LogFile שנרשם קודם וצריך להיות משויך לתרחיש הבדיקה.

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

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

פרמטרים
testData ‫DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה.
test ‫TestDescription: TestDescription של מקרה הבדיקה שנמצא בתהליך.
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

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

פרמטרים
testData ‫DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה. יהיה אותו אובייקט כמו במהלך onTestStart(DeviceMetricData).
currentTestCaseMetrics ‫Map: המפה הנוכחית של המדדים שמועברים אל testEnded(TestDescription,Map).
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, 
                TestDescription test)

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

פרמטרים
testData ‫DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה. יהיה אותו אובייקט כמו במהלך onTestStart(DeviceMetricData).
currentTestCaseMetrics ‫Map: המפה הנוכחית של המדדים שמועברים אל testEnded(TestDescription,Map).
test ‫TestDescription: TestDescription של מקרה הבדיקה שנמצא בתהליך.
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

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

פרמטרים
testData ‫DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה.
test ‫TestDescription: TestDescription של מקרה הבדיקה שנמצא בתהליך.
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

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

הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

מאפשרת ללכוד את אירוע ההתחלה של המודול.

הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                Map<String, MetricMeasurement.Metric> currentRunMetrics)

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

פרמטרים
runData ‫DeviceMetricData: ה-DeviceMetricData שמכיל את הנתונים של ההרצה. יהיה אותו אובייקט כמו במהלך onTestRunStart(DeviceMetricData).
currentRunMetrics ‫Map: המפה הנוכחית של המדדים שמועברים אל testRunEnded(long,Map).
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

קריאה חוזרת (callback) לאירועים מסוג testRunFailed

הקפצת הודעות שגיאה (throw)
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

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

פרמטרים
runData ‫DeviceMetricData: ה-DeviceMetricData שמכיל את הנתונים של ההרצה.
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

onTestStart

public void onTestStart (DeviceMetricData testData)

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

פרמטרים
testData ‫DeviceMetricData: DeviceMetricData שמכיל את הנתונים של תרחיש הבדיקה.
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

rebootEnded

public void rebootEnded (ITestDevice device)

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

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

פרמטרים
device ‫ITestDevice: ITestDevice המקום שבו הסתיימה ההפעלה מחדש.
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

rebootStarted

public void rebootStarted (ITestDevice device)

מקבל התראה כשההפעלה מחדש מתחילה במכשיר.

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

פרמטרים
device ‫ITestDevice: ITestDevice המקום שבו ההפעלה מחדש התחילה.
הקפצת הודעות שגיאה (throw)
DeviceNotAvailableException

setAlwaysOnCollectionLevel

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

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

אם בוחרים ברמה NULL, לא מתבצע איסוף.

פרמטרים
level ‫IMetricCollector.MetricCollectionLevel: MetricCollectionLevel שבו ייאספו היומנים.

setDisable

public final void setDisable (boolean isDisabled)

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

פרמטרים
isDisabled ‫boolean: המצב שאליו צריך להעביר את האובייקט.

setDisableReceiver

public void setDisableReceiver (boolean isDisabled)

הגדרה שקובעת אם צריך להשבית את IDeviceActionReceiver. השבתה של ההגדרה הזו תגרום לכך שהיא לא תירשם במכשיר לקבלת אירועים של פעולות במכשיר.

פרמטרים
isDisabled boolean

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

אין להשתמש בשיטה הזו בהטמעה של כלי לאיסוף מדדים. זוהי העברה בלבד.

פרמטרים
logSaver ILogSaver: ILogSaver

setModuleContainsFailure

public void setModuleContainsFailure ()

האם היו כשלים במודול (מקרה בדיקה, הרצת בדיקה).

setOnFailureCollectionLevel

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

מגדיר את הרמה שבה כלי האיסוף צריך לאסוף יומנים במהלך כשלים.

אם בוחרים ברמה NULL, לא מתבצע איסוף.

פרמטרים
level ‫IMetricCollector.MetricCollectionLevel: MetricCollectionLevel שבו ייאספו היומנים.

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

testLog

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

מספק את היומן המשויך או נתוני הניפוי באגים מהפעלת הבדיקה.

חובה להתקשר לפני ERROR(ITestInvocationListener.invocationFailed(Throwable)/ITestInvocationListener#invocationFailed(java.lang.Throwable) ITestInvocationListener.invocationFailed(Throwable)) או ERROR(/ITestInvocationListener#invocationEnded(long))

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

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

testLogSaved

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

אין להשתמש בשיטה הזו בהטמעה של כלי לאיסוף מדדים. זוהי העברה בלבד.

פרמטרים
dataName ‫String: שם תיאורי של הנתונים. לדוגמה, device_logcat.String הערה יכול להיות ש-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() והיא אופציונלית ברצף. הוא נמצא בשימוש רק במהלך הרצה שמשתמשת במודולים: suite based runners.

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

testRunEnded

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

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

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

בדיקת התקשרות חזרה

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

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

testStarted

public final void testStarted (TestDescription test)

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

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