ILogSaverListener

public interface ILogSaverListener
implements ITestInvocationListener

com.android.tradefed.result.ILogSaverListener


ITestInvocationListener がログファイルが保存されたタイミングをリッスンできるようにします。

これにより、レポートの生成時に複数の ITestInvocationListener が同じ保存済みログファイルを使用できるようになり、ITestInvocationListener.testLog(String,LogDataType,InputStreamSource) が呼び出されたときに各リスナーがファイルを個別に保存することを回避できます。

このインターフェースを実装するクラスは、ITestInvocationListener.testLog(String,LogDataType,InputStreamSource) が呼び出されるたびに testLogSaved(String,LogDataType,InputStreamSource,LogFile) が呼び出されることを認識しておく必要があります。

このクラスはグローバル ILogSaver インスタンスも渡すため、ITestInvocationListener は同じ場所に他のファイルも保存できます。

概要

パブリック メソッド

default void logAssociation(String dataName, LogFile logFile)

場合によっては、ログをテストケースに強く関連付ける必要がありますが、直接の testLogSaved(String,LogDataType,InputStreamSource,LogFile) コールバックでそれを行うことはできません。

default void setLogSaver(ILogSaver logSaver)

実装者がファイルを保存できるように ILogSaver を設定します。

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

テストログが保存されたときに呼び出されます。

パブリック メソッド

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

ログをテストケースに強く関連付ける必要がある場合もありますが、直接の testLogSaved(String,LogDataType,InputStreamSource,LogFile) コールバックでそれを行うことはできません。したがって、このコールバックを使用すると、強力な関連付けを明示的に指定できます。

パラメータ
dataName String: データの名前

logFile LogFile: 以前にロギングされ、テストケースに関連付ける必要がある LogFile

setLogSaver

public void setLogSaver (ILogSaver logSaver)

実装者がファイルを保存できるように ILogSaver を設定します。

パラメータ
logSaver ILogSaver: ILogSaver

testLogSaved

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

テストログが保存されたときに呼び出されます。

ITestInvocationListener.testLog(String,LogDataType,InputStreamSource) の代わりに使用する必要があります。

パラメータ
dataName String: データの String 説明的な名前(例: device_logcat)。注: dataName は呼び出しごとに一意でない場合があります。つまり、実装者は同じ dataName での複数の呼び出しを処理できる必要があります。

dataType LogDataType: データの LogDataType

dataStream InputStreamSource: データの InputStreamSource。実装者は、createInputStream を呼び出してデータの読み取りを開始し、完了したら結果の InputStream を必ず閉じます。

logFile LogFile: 保存されたファイルのメタデータを含む LogFile