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(IBuildInfo buildInfo, File rootDir, Integer logRetentionDays, Boolean containInvDir)

LogFileSaver を作成します。

LogFileSaver(File rootDir)

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

パブリック メソッド

File createCompressedLogFile(String dataName, LogDataType origDataType)

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

OutputStream createGZipLogStream(File logFile)

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

InputStream createInputStreamFromFile(File logFile)

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

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

File getFileDir()

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

List<String> 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 (IBuildInfo buildInfo, 
                File rootDir, 
                Integer logRetentionDays, 
                Boolean containInvDir)

LogFileSaver を作成します。

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

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

パラメータ
buildInfo IBuildInfo: IBuildInfo

rootDir File: ルート ファイル システムのパス

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

containInvDir Boolean

LogFileSaver

public LogFileSaver (File rootDir)

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

パブリック メソッド

createCompressedLogFile

public File createCompressedLogFile (String dataName, 
                LogDataType origDataType)

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

パラメータ
dataName String: 保存するデータのわかりやすい名前。String

origDataType LogDataType: 保存する LogDataType のタイプ

戻り値
File File

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

createGZipLogStream

public OutputStream createGZipLogStream (File logFile)

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

パラメータ
logFile File: 書き込む File

戻り値
OutputStream OutputStream を使用してデータを圧縮し、ファイルに書き込みます。このストリームを完了

例外
IOException ストリームを生成できなかった場合

createInputStreamFromFile

public InputStream createInputStreamFromFile (File logFile)

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

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

パラメータ
logFile File: 読み取る File

戻り値
InputStream ファイルデータを読み取るバッファリングされた InputStream。発信者は完了時にこのストリームを呼び出す必要があります

例外
IOException ストリームを生成できなかった場合

getFileDir

public File getFileDir ()

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

戻り値
File File ディレクトリ

getInvocationLogPathSegments

public List<String> getInvocationLogPathSegments ()

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

saveAndGZipLogData

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

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

パラメータ
dataName String: データの String のわかりやすい名前。

dataType LogDataType: ファイルの LogDataType。ログデータ(LogDataType.isCompressed()true など)

dataStream InputStream: データの InputStream

戻り値
File 生成されたデータのファイル

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

saveAndGZipLogFile

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

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

パラメータ
dataName String: データの String のわかりやすい名前。

dataType LogDataType: ファイルの LogDataType。ログデータ(LogDataType.isCompressed()true

fileToLog File: 保存する File

戻り値
File 生成されたデータのファイル

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

saveLogData

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

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

パラメータ
dataName String: データの String のわかりやすい名前。

dataType LogDataType: ファイルの LogDataType

dataStream InputStream: データの InputStream

戻り値
File 生成されたデータのファイル

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

saveLogDataRaw

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

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

パラメータ
dataName String: データの String のわかりやすい名前。

ext String: 日付の拡張

dataStream InputStream: データの InputStream

戻り値
File 生成されたデータのファイル

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

saveLogFile

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

指定されたログファイルを保存する

パラメータ
dataName String: データの String のわかりやすい名前。

dataType LogDataType: ファイルの LogDataType

fileToLog File: ログに記録する File

戻り値
File 生成されたデータのファイル

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