NameMangleListener

public abstract class NameMangleListener
extends Object implements ITestInvocationListener

java.lang.Object
   ↳ com.android.tradefed.result.NameMangleListener


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

סיכום

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

NameMangleListener(ITestInvocationListener listener)

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

TestSummary getSummary()

מאפשר ל-InvocationListener להחזיר סיכום.

void invocationEnded(long elapsedTime)

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

void invocationFailed(Throwable cause)

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

void invocationStarted(IInvocationContext context)

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

void testAssumptionFailure(TestDescription test, String trace)

מופעלת כשבדיקה אטומית מסמנת שהיא מניחה שהתנאי לא נכון

void testEnded(TestDescription test, testMetrics)

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

void testFailed(TestDescription test, String trace)

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

void testIgnored(TestDescription test)

הקריאה מתבצעת כשבדיקה לא מופעלת, בדרך כלל כי השיטה לבדיקה מסומנת ב-org.junit.Ignore.

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

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

void testRunEnded(long elapsedTime, runMetrics)

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

void testRunFailed(String errorMessage)

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

void testRunStarted(String runName, int testCount)

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

void testRunStopped(long elapsedTime)

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

void testStarted(TestDescription test)

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

שיטות מוגנות

TestDescription mangleTestId(TestDescription test)

השיטה הזו פועלת בכל ערכי ה-TestDescription שמועברים אל הקריאות החוזרות (callback) של testStarted(com.android.tradefed.result.TestDescription), testFailed(com.android.tradefed.result.TestDescription, String) ו-ERROR(/#testEnded(com.android.tradefed.result.TestDescription,HashMap)).

String mangleTestRunName(String name)

השיטה הזו פועלת בכל שמות הרצאות הבדיקה שמועברים ל-callback‏ testRunStarted(String, int).

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

NameMangleListener

public NameMangleListener (ITestInvocationListener listener)

פרמטרים
listener ITestInvocationListener

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

getSummary

public TestSummary getSummary ()

מאפשר ל-InvocationListener להחזיר סיכום.

החזרות
TestSummary TestSummary שמסכם את ההרצה, או null

ההפעלה הסתיימה

public void invocationEnded (long elapsedTime)

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

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

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

invocationFailed

public void invocationFailed (Throwable cause)

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

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

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

invocationStarted

public void invocationStarted (IInvocationContext context)

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

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

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

מופעלת כשבדיקה אטומית מסמנת שהיא מניחה שהתנאי לא נכון

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

trace String: סטאק טריי של הכישלון

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

public void testEnded (TestDescription test, 
                 testMetrics)

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

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

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

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

testFailed

public void testFailed (TestDescription test, 
                String trace)

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

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

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

trace String: דוח קריסות של כשל

testIgnored

public void testIgnored (TestDescription test)

נשלחת קריאה כאשר לא תבוצע בדיקה, בדרך כלל מפני שלשיטת בדיקה יש הערות עם org.junit.ignore.

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

testLog

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

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

צריך להפעיל את הפונקציה לפני ERROR(/ITestInvocationListener#invocationFailed(Throwable)) או ERROR(/ITestInvocationListener#invocationEnded(long))

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

פרמטרים
dataName String: שם תיאורי של הנתונים String. למשל, 'device_logcat'. הערה: שם המשתנה dataName לא חייב להיות ייחודי לכל קריאה. כלומר, למטמיעים צריכה להיות אפשרות לטפל בכמה קריאות עם אותו שם משתנה.

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

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

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

public void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

runMetrics : צמדי מפתח/ערך שמדווחים בסוף הרצה של בדיקה

testRunFailed

public void testRunFailed (String errorMessage)

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

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

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

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

פרמטרים
runName String: שם ההרצה לניסיון

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

testRunStopped

public void testRunStopped (long elapsedTime)

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

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

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

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

public void testStarted (TestDescription test)

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

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

שיטות מוגנות

mangleTestId

protected TestDescription mangleTestId (TestDescription test)

השיטה הזו פועלת בכל הערכים של TestDescription שמועברים ל-callbacks של testStarted(com.android.tradefed.result.TestDescription), testFailed(com.android.tradefed.result.TestDescription, String) ו-ERROR(/#testEnded(com.android.tradefed.result.TestDescription,HashMap)). השיטה צריכה להחזיר TestDescription שעשוי להיות שונה, שיעבור ל-ITestInvocationListener במורד הזרם שצוין במהלך היצירה.

חשוב להקפיד שלא לשנות את TestDescription המקורי במהלך ההטמעה.

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

פרמטרים
test TestDescription

החזרות
TestDescription

mangleTestRunName

protected String mangleTestRunName (String name)

השיטה הזו פועלת בכל שמות הרצאות הבדיקה שמועברים ל-callback‏ testRunStarted(String, int). ה-method אמורה להחזיר שם של הרצת בדיקה, שיכול להיות שונה שיועבר אל ITestInvocationListener במורד הזרם (downstream) שצוין במהלך הבנייה.

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

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

פרמטרים
name String

החזרות
String