LogSaverResultForwarder

public class LogSaverResultForwarder
extends ResultForwarder implements ILogSaverListener

java.lang.Object
   ↳ com.android.tradefed.result.ResultForwarder
     ↳ com.android.tradefed.result.LogSaverResultForwarder

ResultForwarder לשמירת יומנים באמצעות שומר הקבצים הגלובלי.

סיכום

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

LogSaverResultForwarder(ILogSaver logSaver, listeners, IConfiguration config)

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

void invocationEnded(long elapsedTime)

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

void invocationStarted(IInvocationContext context)

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

void logAssociation(String dataName, LogFile logFile)

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

static void logFile( listeners, ILogSaver saver, InputStreamSource source, String name, LogDataType type)

רישום קובץ סופי ביומן לפני השלמת התהליך

static void reportEndHostLog( listeners, ILogSaver saver, String name)

דוח host_log מהסשן הנוכחי.

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

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

בנוסף, שומרים את קובץ היומן באמצעות ILogSaver הגלובלי ומפעילים את ILogSaverListener.testLogSaved(String, LogDataType, InputStreamSource, LogFile) למאזינים שמטמיעים את הממשק ILogSaverListener.

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

מעבירים רק את testLog במקום לשמור את היומן קודם.

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

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

אם LogSaverResultForwarder עטוף ב-wrap אחר, צריך לוודא שאנחנו מעבירים את הקריאה החוזרת (callback) של testLogSaved למאזינים שמתחתיו.

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

LogSaverResultForwarder

public LogSaverResultForwarder (ILogSaver logSaver, 
                 listeners, 
                IConfiguration config)

פרמטרים
logSaver ILogSaver

listeners

config IConfiguration

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

invocationEnded

public void invocationEnded (long elapsedTime)

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

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

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

invocationStarted

public void invocationStarted (IInvocationContext context)

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

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

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

logAssociation

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

logFile

public static void logFile ( listeners, 
                ILogSaver saver, 
                InputStreamSource source, 
                String name, 
                LogDataType type)

רישום קובץ סופי ביומן לפני השלמת התהליך

פרמטרים
listeners

saver ILogSaver

source InputStreamSource

name String

type LogDataType

reportEndHostLog

public static void reportEndHostLog ( listeners, 
                ILogSaver saver, 
                String name)

דוח host_log מהסשן הנוכחי.

פרמטרים
listeners

saver ILogSaver

name String

testLog

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

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

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

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

בנוסף, שומרים את קובץ היומן באמצעות ILogSaver הגלובלי ומפעילים את ILogSaverListener.testLogSaved(String, LogDataType, InputStreamSource, LogFile) למאזינים שמטמיעים את הממשק ILogSaverListener.

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

testLogForward

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

מעבירים רק את testLog במקום לשמור את היומן קודם.

פרמטרים
dataName String

dataType LogDataType

dataStream InputStreamSource

testLogSaved

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

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

צריך להשתמש בו במקום ב-ITestInvocationListener.testLog(String, LogDataType, InputStreamSource).

אם LogSaverResultForwarder עטוף ב-wrap אחר, צריך לוודא שאנחנו מעבירים את הקריאה החוזרת (callback) של testLogSaved למאזינים שמתחתיו.

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