FileSystemLogSaver
public
class
FileSystemLogSaver
extends Object
implements
ILogSaver
| java.lang.Object | |
| ↳ | com.android.tradefed.result.FileSystemLogSaver |
ログをファイル システムに保存します。
概要
パブリック コンストラクタ | |
|---|---|
FileSystemLogSaver()
|
|
パブリック メソッド | |
|---|---|
LogFile
|
getLogReportDir()
ログが保存されるディレクトリのパスまたは URL を含む |
void
|
invocationEnded(long elapsedTime)
呼び出しが正常に終了したか、エラー 条件が原因で終了したかを報告します。 |
void
|
invocationStarted(IInvocationContext context)
テスト呼び出しの開始を報告します。 また、ログを保存するために、 |
LogFile
|
saveLogData(String dataName, LogDataType dataType, InputStream dataStream)
ログデータを保存します。
が false を返し、 |
LogFile
|
saveLogFile(String dataName, LogDataType dataType, File fileToLog)
ログファイルを保存します。 |
void
|
setCompressFiles(boolean compress)
|
void
|
testModuleEnded()
テスト モジュールが終了したことを報告します。 |
void
|
testModuleStarted(IInvocationContext moduleContext)
テスト モジュールの開始を報告します。 |
保護されたメソッド | |
|---|---|
File
|
createBuildDir(IBuildInfo buildInfo, File reportDir, String moduleName)
呼び出しのビルド情報に基づいてビルド ディレクトリを取得または作成するヘルパー メソッド。 |
File
|
generateLogReportDir(IBuildInfo buildInfo, File reportDir, String moduleName)
サブクラスがパス生成ロジックをカスタマイズできるようにする公開メソッド。 |
パブリック コンストラクタ
FileSystemLogSaver
public FileSystemLogSaver ()
パブリック メソッド
getLogReportDir
public LogFile getLogReportDir ()
ログが保存されるディレクトリのパスまたは URL を含む LogFile を取得します。
| 戻り値 | |
|---|---|
LogFile |
LogFile。 |
invocationEnded
public void invocationEnded (long elapsedTime)
呼び出しが正常に終了したか、エラー 条件が原因で終了したかを報告します。
ITestInvocationListener.invocationEnded(long) が呼び出された後、TradeFederation フレームワークによって自動的に呼び出されます。
| パラメータ | |
|---|---|
elapsedTime |
long: 呼び出しの経過時間(ミリ秒) |
invocationStarted
public void invocationStarted (IInvocationContext context)
テスト呼び出しの開始を報告します。
ITestInvocationListener.invocationStarted(IInvocationContext) が呼び出される前に、TradeFederation フレームワークによって自動的に呼び出されます。
また、ログを保存するために、report-dir/[branch/]build-id/test-tag/unique_dir の下に一意のファイル システム ディレクトリを作成します。ディレクトリの作成に失敗した場合は、ローカル ファイル システムの一時ディレクトリにログを書き込みます。
| パラメータ | |
|---|---|
context |
IInvocationContext: 呼び出しに関する情報。 |
saveLogData
public LogFile saveLogData (String dataName, LogDataType dataType, InputStream dataStream)
ログデータを保存します。
ITestInvocationListener.testLog(String,LogDataType,InputStreamSource) が呼び出されるたびに、TradeFederation フレームワークによって自動的に呼び出されます。追加のログデータを保存するヘルパー メソッドとしても使用できます。
実装とポリシーによっては、ログが圧縮形式で保存されることがあります。 ログは、Tradefed からアクセスできない場所に保存されることもあります。
が false を返し、compressed-files が設定されている場合は、ログファイルが圧縮されて保存されます。それ以外の場合は、ストリームは圧縮されずに保存されます。
LogDataType.isCompressed()dataType
| パラメータ | |
|---|---|
dataName |
String: データの説明的な String 名(例: "device_logcat") |
dataType |
LogDataType: ファイルの LogDataType。 |
dataStream |
InputStream: データの InputStream。 |
| 戻り値 | |
|---|---|
LogFile |
保存されたファイルのパスと URL を含む LogFile。 |
| 例外 | |
|---|---|
IOException |
|
saveLogFile
public LogFile saveLogFile (String dataName, LogDataType dataType, File fileToLog)
ログファイルを保存します。
ITestInvocationListener.testLog(String,LogDataType,InputStreamSource) が呼び出され、
ストリームがファイルを参照するたびに、TradeFederation フレームワークによって自動的に呼び出されます。
実装とポリシーによっては、ログが圧縮形式で保存されることがあります。 ログは、Tradefed からアクセスできない場所に保存されることもあります。
| パラメータ | |
|---|---|
dataName |
String: データの説明的な String 名(例: "device_logcat") |
dataType |
LogDataType: ファイルの LogDataType。 |
fileToLog |
File: 保存する File。 |
| 戻り値 | |
|---|---|
LogFile |
保存されたファイルのパスと URL を含む LogFile。 |
| 例外 | |
|---|---|
IOException |
|
setCompressFiles
public void setCompressFiles (boolean compress)
| パラメータ | |
|---|---|
compress |
boolean |
testModuleEnded
public void testModuleEnded ()
テスト モジュールが終了したことを報告します。
testModuleStarted
public void testModuleStarted (IInvocationContext moduleContext)
テスト モジュールの開始を報告します。
| パラメータ | |
|---|---|
moduleContext |
IInvocationContext: モジュールに関する情報。 |
保護されたメソッド
createBuildDir
protected File createBuildDir (IBuildInfo buildInfo, File reportDir, String moduleName)
呼び出しのビルド情報に基づいてビルド ディレクトリを取得または作成するヘルパー メソッド。
ログを保存するために、report-dir/[branch/]build-id/test-tag という構造で一意のファイル システム ディレクトリを作成します。
| パラメータ | |
|---|---|
buildInfo |
IBuildInfo: IBuildInfo |
reportDir |
File: レポート ディレクトリの File。 |
moduleName |
String: テスト モジュールの名前 |
| 戻り値 | |
|---|---|
File |
同じビルドの呼び出しを保存するディレクトリ。 |
| 例外 | |
|---|---|
IOException |
同じ名前のファイル が存在するため、または書き込み権限がないためにディレクトリを作成できなかった場合。 |
generateLogReportDir
protected File generateLogReportDir (IBuildInfo buildInfo, File reportDir, String moduleName)
サブクラスがパス生成ロジックをカスタマイズできるようにする公開メソッド。
| パラメータ | |
|---|---|
buildInfo |
IBuildInfo: IBuildInfo |
reportDir |
File: レポート ディレクトリの File。 |
moduleName |
String: テスト モジュールの名前 |
| 戻り値 | |
|---|---|
File |
作成されたディレクトリ。 |
| 例外 | |
|---|---|
IOException |
|