ILogSaver

public interface ILogSaver

com.android.tradefed.result.ILogSaver


このインターフェイスを実装するクラスは、ログを中央の場所に保存するためのメソッドを提供します。

ILogSaverは構成で宣言され、ログを中央の場所に保存する役割を果たします。また、 ILogSaverListenerが追加のファイルを同じ場所に保存できるようにするメソッドも公開します。

まとめ

パブリックメソッド

abstract LogFile getLogReportDir ()

ログが保存されているディレクトリのパスや URL を含むLogFile取得します。

default void init ( IInvocationContext context)

ビルド情報が利用可能になる前に、初期化を早期に通知します。

abstract void invocationEnded (long elapsedTime)

正常に終了したか、何らかのエラー条件により呼び出しが終了したことを報告します。

abstract void invocationStarted ( IInvocationContext context)

テスト呼び出しの開始を報告します。

abstract LogFile saveLogData (String dataName, LogDataType dataType, InputStream dataStream)

ログデータを保存します。

default LogFile saveLogDataRaw (String dataName, LogDataType dataType, InputStream dataStream)

このメソッドは廃止されました。代わりにsaveLogData(String, com.android.tradefed.result.LogDataType, InputStream)を使用してください

default LogFile saveLogFile (String dataName, LogDataType dataType, File fileToLog)

ログファイルを保存します。

パブリックメソッド

getLogReportDir

public abstract LogFile getLogReportDir ()

ログが保存されているディレクトリのパスや URL を含むLogFile取得します。

戻り値
LogFile LogFile

初期化

public void init (IInvocationContext context)

ビルド情報が利用可能になる前に、初期化を早期に通知します。これにより、ログを受信するための要件を設定できます。

パラメーター
context IInvocationContext : 呼び出しに関する情報。

呼び出し終了

public abstract void invocationEnded (long elapsedTime)

正常に終了したか、何らかのエラー条件により呼び出しが終了したことを報告します。

ITestInvocationListener#invocationEnded(long)が呼び出された後、TradeFederation フレームワークによって自動的に呼び出されます。

パラメーター
elapsedTime long : 呼び出しの経過時間 (ミリ秒)

呼び出し開始

public abstract void invocationStarted (IInvocationContext context)

テスト呼び出しの開始を報告します。

ITestInvocationListener#invocationStarted(IInvocationContext)呼び出される前に、TradeFederation フレームワークによって自動的に呼び出されます。

パラメーター
context IInvocationContext : 呼び出しに関する情報。

ログデータの保存

public abstract LogFile saveLogData (String dataName, 
                LogDataType dataType, 
                InputStream dataStream)

ログデータを保存します。

ITestLogger.testLog(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource)呼び出されるたびに、TradeFederation フレームワークによって自動的に呼び出されます。追加のログ データを保存するためのヘルパー メソッドとしても使用できます。

実装とポリシーによっては、ログが圧縮形式で保存される場合があります。ログは Tradefed がアクセスできない場所に保存される場合もあります。

パラメーター
dataName String : データを説明するString名。例:「device_logcat」

dataType LogDataType : ファイルのLogDataType

dataStream InputStream : データのERROR(/InputStream)

戻り値
LogFile保存されたファイルのパスと URL を含むLogFile

投げる
ログファイルを生成できなかった場合

saveLogDataRaw

public LogFile saveLogDataRaw (String dataName, 
                LogDataType dataType, 
                InputStream dataStream)

このメソッドは廃止されました。
代わりにsaveLogData(String, com.android.tradefed.result.LogDataType, InputStream)を使用してください

ログ データを変更せずに保存するヘルパー メソッド。

ログは Tradefed がアクセスできない場所に保存される場合があります。

パラメーター
dataName String : データを説明するString名。たとえば、「device_logcat」。

dataType LogDataType : ファイルのタイプと拡張子を含むLogDataType

dataStream InputStream : データのERROR(/InputStream)

戻り値
LogFile保存されたファイルのパスと URL を含むLogFile

投げる
ログファイルを生成できなかった場合

ログファイルの保存

public LogFile saveLogFile (String dataName, 
                LogDataType dataType, 
                File fileToLog)

ログファイルを保存します。

ITestLogger.testLog(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource)呼び出され、ストリームがファイルを参照するたびに、TradeFederation フレームワークによって自動的に呼び出されます。

実装とポリシーによっては、ログが圧縮形式で保存される場合があります。ログは Tradefed がアクセスできない場所に保存される場合もあります。

パラメーター
dataName String : データを説明するString名。例:「device_logcat」

dataType LogDataType : ファイルのLogDataType

fileToLog File : 保存するERROR(/File)

戻り値
LogFile保存されたファイルのパスと URL を含むLogFile

投げる
ログファイルを生成できなかった場合