NameMangleListener

public abstract class NameMangleListener
extends Object implements ITestInvocationListener

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

---

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

סיכום

‫constructors ציבוריים
NameMangleListener(ITestInvocationListener listener)

‫methods ציבוריים
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, HashMap<String, MetricMeasurement.Metric> 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, HashMap<String, MetricMeasurement.Metric> runMetrics) דוחות על סיום הרצת הבדיקה.
void	testRunFailed(String errorMessage) הפעלת הבדיקה של הדוחות נכשלה בגלל שגיאה חמורה.
void	testRunStarted(String runName, int testCount) הפונקציה מדווחת על התחלה של הרצת בדיקה.
void	testRunStopped(long elapsedTime) הפעלת הבדיקה של הדוחות הופסקה לפני שהסתיימה בגלל בקשה של משתמש.
void	testStarted(TestDescription test) הפונקציה מדווחת על תחילת בדיקה של תרחיש בדיקה מסוים.

שיטות מוגנות
TestDescription	mangleTestId(TestDescription test) ה-method הזה מופעל בכל TestDescription שמועבר לקריאות החוזרות (callback) של testStarted(TestDescription), testFailed(TestDescription,String) ו-testEnded(TestDescription,HashMap).
String	mangleTestRunName(String name) השיטה הזו מופעלת על כל השמות של הרצות הבדיקה שמועברים לקריאה החוזרת testRunStarted(String,int).

‫constructors ציבוריים

NameMangleListener

public NameMangleListener (ITestInvocationListener listener)

פרמטרים
listener	ITestInvocationListener

‫methods ציבוריים

getSummary

public TestSummary getSummary ()

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

החזרות
TestSummary	מחרוזת TestSummary שמסכמת את ההפעלה, או ערך null

invocationEnded

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: דוח קריסות של הכשל

testEnded

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

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

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

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

testRunEnded

public 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 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: currently unused, consider removing

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

testStarted

public void testStarted (TestDescription test)

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

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

שיטות מוגנות

mangleTestId

protected TestDescription mangleTestId (TestDescription test)

ה-method הזה מופעל בכל TestDescription שמועבר לקריאות החוזרות (callback) של testStarted(TestDescription), testFailed(TestDescription,String) ו-testEnded(TestDescription,HashMap). השיטה צריכה להחזיר TestDescription שאולי שונה, שיועבר ל-ITestInvocationListener במורד הזרם שצוין במהלך הבנייה.

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

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

פרמטרים
test	TestDescription

החזרות
TestDescription

mangleTestRunName

protected String mangleTestRunName (String name)

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

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

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

פרמטרים
name	String

חזרה לרצף השגרה
String