LogFileSaver

public class LogFileSaver
extends Object

java.lang.Object
   ↳ com.android.tradefed.result.LogFileSaver

ログデータをファイルに保存する ITestInvocationListener のヘルパー

概要

パブリック コンストラクタ

LogFileSaver(IBuildInfo buildInfo, File rootDir)

LogFileSaver を作成します。
LogFileSaver(IBuildInfo buildInfo, File rootDir, Integer logRetentionDays)

LogFileSaver を作成します。
LogFileSaver(File rootDir)

指定されたディレクトリをログ ストレージ ディレクトリとしてのみ使用する別の LogFileSaver コンストラクタ。

パブリック メソッド

File createCompressedLogFile(String dataName, LogDataType origDataType)

圧縮されたログデータを保存するための空のファイルを作成します。

OutputStream createGZipLogStream(File logFile)

GZIP 圧縮されたデータをファイルに書き込む出力ストリームを作成します。
InputStream createInputStreamFromFile(File logFile)

特定のログファイルの内容を読み取る入力ストリームを作成するヘルパー メソッド。

TODO: このメソッドを別の場所に移動することを検討してください。

File getFileDir()

ファイルの保存に使用されるディレクトリを取得します。

getInvocationLogPathSegments()
File saveAndGZipLogData(String dataName, LogDataType dataType, InputStream dataStream)

ログデータを保存し、必要に応じて gzip ファイルに圧縮します。
File saveAndGZipLogFile(String dataName, LogDataType dataType, File fileToLog)

ログデータを保存し、必要に応じて gzip ファイルに圧縮します。
File saveLogData(String dataName, LogDataType dataType, InputStream dataStream)

ログデータをファイルに保存します。
File saveLogDataRaw(String dataName, String ext, InputStream dataStream)

元データをファイルに保存する

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

特定のログファイルを保存する

パブリック コンストラクタ

LogFileSaver

public LogFileSaver (IBuildInfo buildInfo, 
                File rootDir)

LogFileSaver を作成します。

rootDir/branch/build_id/uniqueDir に一意のファイル システム ディレクトリを作成します。

パラメータ
buildInfo IBuildInfo: IBuildInfo
rootDir File: ルート ファイル システムのパス

LogFileSaver

public LogFileSaver (IBuildInfo buildInfo, 
                File rootDir, 
                Integer logRetentionDays)

LogFileSaver を作成します。

rootDir/branch/build_id/testTag/uniqueDir に一意のファイル システム ディレクトリを作成します。

ディレクトリの作成に失敗した場合は、一時ディレクトリが使用されます。

パラメータ
buildInfo IBuildInfo: IBuildInfo
rootDir File: ルート ファイル システムのパス
logRetentionDays Integer: 指定すると、現在の時刻 + logRetentionDays に等しいタイムスタンプを含む「.retention」ファイルがログディレクトリに書き込まれます。外部クリーンアップ スクリプトは、このファイルを使用してログ ディレクトリを削除するタイミングを判断できます。

LogFileSaver

public LogFileSaver (File rootDir)

指定されたディレクトリをログ ストレージ ディレクトリとして使用する、別の LogFileSaver コンストラクタ。

パブリック メソッド

createCompressedLogFile

public File createCompressedLogFile (String dataName, 
                LogDataType origDataType)

圧縮されたログデータを保存するための空のファイルを作成します。

パラメータ
dataName String: 保存するデータのわかりやすい名前。String
origDataType LogDataType: 保存する LogDataType のタイプ
戻り値
File ERROR(/File)
例外
ログファイルを作成できなかった場合

createGZipLogStream

public OutputStream createGZipLogStream (File logFile)

GZIP 圧縮されたデータをファイルに書き込む出力ストリームを作成します。

パラメータ
logFile File: 書き込む ERROR(/File)
戻り値
OutputStream ERROR(/OutputStream) は、データを圧縮してファイルに書き込むためのものです。このストリームを完了する
例外
ストリームを生成できなかった場合

createInputStreamFromFile

public InputStream createInputStreamFromFile (File logFile)

特定のログファイルの内容を読み取る入力ストリームを作成するヘルパー メソッド。

TODO: このメソッドを別の場所に移動することを検討してください。現時点では、このクラスのユーザーがモックできるようにここに配置しています。

パラメータ
logFile File: 読み取り元の ERROR(/File)
戻り値
InputStream ファイルデータを読み取るためのバッファリングされた ERROR(/InputStream)。呼び出し元は、完了時にこのストリームを呼び出す必要があります。
例外
ストリームを生成できなかった場合

getFileDir

public File getFileDir ()

ファイルの保存に使用されるディレクトリを取得します。

戻り値
File ERROR(/File) ディレクトリ

getInvocationLogPathSegments

public  getInvocationLogPathSegments ()

戻り値
一意の呼び出しログパス セグメント。

saveAndGZipLogData

public File saveAndGZipLogData (String dataName, 
                LogDataType dataType, 
                InputStream dataStream)

ログデータを保存し、必要に応じて gzip ファイルに圧縮します。

パラメータ
dataName String: データのわかりやすい名前。String
dataType LogDataType: ファイルの LogDataType。ログデータ（LogDataType.isCompressed() は true）
dataStream InputStream: データの ERROR(/InputStream)。
戻り値
File 生成されたデータのファイル
例外
ログファイルを生成できなかった場合

saveAndGZipLogFile

public File saveAndGZipLogFile (String dataName, 
                LogDataType dataType, 
                File fileToLog)

ログデータを保存し、必要に応じて gzip ファイルに圧縮する

パラメータ
dataName String: データのわかりやすい名前。String
dataType LogDataType: ファイルの LogDataType。ログデータ（LogDataType.isCompressed() は true）
fileToLog File: 保存する ERROR(/File)
戻り値
File 生成されたデータのファイル
例外
ログファイルを生成できなかった場合

saveLogData

public File saveLogData (String dataName, 
                LogDataType dataType, 
                InputStream dataStream)

ログデータをファイルに保存する

パラメータ
dataName String: データのわかりやすい名前。String
dataType LogDataType: ファイルの LogDataType。
dataStream InputStream: データの ERROR(/InputStream)。
戻り値
File 生成されたデータのファイル
例外
ログファイルを生成できなかった場合

saveLogDataRaw

public File saveLogDataRaw (String dataName, 
                String ext, 
                InputStream dataStream)

元データをファイルに保存する

パラメータ
dataName String: データのわかりやすい名前。String
ext String: 日付の拡張子
dataStream InputStream: データの ERROR(/InputStream)。
戻り値
File 生成されたデータのファイル
例外
ログファイルを生成できなかった場合

saveLogFile

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

特定のログファイルを保存する

パラメータ
dataName String: データのわかりやすい名前。String
dataType LogDataType: ファイルの LogDataType。
fileToLog File: ログに記録される ERROR(/File)
戻り値
File 生成されたデータのファイル
例外
ログファイルを生成できなかった場合