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

init

public void init (IInvocationContext context)

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

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

invocationEnded

public abstract void invocationEnded (long elapsedTime)

呼び出しが終了したことを報告します(成功した場合も、エラー条件が原因で終了した場合も同様です)。

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

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

invocationStarted

public abstract void invocationStarted (IInvocationContext context)

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

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

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

saveLogData

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

例外
ログファイルを生成できなかった場合

saveLogFile

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

例外
ログファイルを生成できなかった場合