ビルド情報

public class BuildInfo
extends Object implements IBuildInfo

java.lang.Object
   ↳ com.android.tradefed.build.BuildInfo

ITestDevice に関連付ける必要がある IBuildInfo の一般的な実装。

概要

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

BuildInfo()

デフォルトの属性値を使用して BuildInfo を作成します。

BuildInfo(String buildId, String buildTargetName)

BuildInfo を作成します。

パブリック メソッド

void addAppPackageFile(File appPackageFile, String version)

ローカル APK ファイルとそれに関連付けられたバージョンを追加します。

void addBuildAttribute(String attributeName, String attributeValue)

ビルド属性を追加します。

void addBuildAttributes( buildAttributes)

ビルド属性を追加する

void allowStagingRemoteFile(boolean stageRemoteFile)

リモート ファイルのステージングを許可する権限を設定します。
void cleanUp()

一時的なビルドファイルをクリーンアップします。

void cleanUp( doNotClean)

一部のファイルが削除されない cleanUp() のバージョン。

IBuildInfo clone()

final void copyAllFileFrom(BuildInfo build)

特定のビルドからこのビルドにすべての VersionedFile をコピーします。

boolean equals(Object obj)

static IBuildInfo fromProto(BuildInformation.BuildInfo protoBuild)

toProto() の逆オペレーションでインスタンスを復元します。

getAppPackageFiles()

ローカルアプリ APK ファイルのセットとそのバージョンのコピーを取得します。

getBuildAttributes()

ビルドを記述する追加属性の名前と値のペアのセットを取得します。

String getBuildBranch()

テスト対象のビルドが生成されたソース管理ブランチを返すオプション メソッド。
String getBuildFlavor()

テスト対象のビルドのタイプを返すオプションのメソッド。

String getBuildId()

テスト対象のビルドの一意の識別子を返します。

String getBuildTargetName()

テスト中のビルドの完全名を返します。

String getDeviceSerial()

File getFile(String name)

指定された名前のファイルを取得するヘルパー メソッド。

File getFile(BuildInfoKey.BuildInfoFileKey key)

指定された BuildInfoFileKey を使用してファイルを取得するヘルパー メソッド。

getFiles()

この BuildInfo に保存されているすべての VersionedFile を返します。

getProperties()

IBuildInfo に現在設定されているプロパティのコピーを返します。

getRemoteFiles()

ダウンロードが遅れているビルド アーティファクトのパスを取得します。

String getTestTag()

実行中のテストの一意の名前を返します。

String getVersion(BuildInfoKey.BuildInfoFileKey key)

指定された BuildInfoFileKey を使用してファイル バージョンを取得するヘルパー メソッド。

String getVersion(String name)

指定された名前のファイル バージョンを取得するヘルパー メソッド。

VersionedFile getVersionedFile(BuildInfoKey.BuildInfoFileKey key)

指定された BuildInfoFileKey で VersionedFile を取得するヘルパー メソッド。

final VersionedFile getVersionedFile(String name)

指定された名前の VersionedFile を取得するヘルパー メソッド。
getVersionedFileKeys()

getFile(BuildInfoFileKey) を介して VersionedFile をクエリするために使用できるキーセットを返します。

final getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)

特定の BuildInfoFileKey に関連付けられている VersionedFile のリストを取得するヘルパー メソッド。

int hashCode()

void removeBuildAttribute(String attributeName)

特定の attributeName をトラッキングから削除します。

void setBuildBranch(String branch)

ビルドブランチを設定する

void setBuildFlavor(String buildFlavor)

ビルド フレーバーを設定します。

void setBuildId(String buildId)

テスト対象のビルドの一意の識別子を設定します。

void setDeviceSerial(String serial)

このビルドに関連付けられた ITestDevice シリアルを設定します。

void setFile(String name, File file, String version)

指定した名前のファイルをこのビルド情報に保存します。

void setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version)

このビルド情報に BuildInfoFileKey を指定してファイルを保存します。

void setProperties(BuildInfoProperties... properties)

IBuildInfo インスタンスの BuildInfoProperties を設定します。

void setTestTag(String testTag)

実行されるテストの一意の名前を設定します。

File stageRemoteFile(String fileName, File workingDir)

リモート ファイルの一部であるファイルをビルド情報のルート ディレクトリにステージングします。

BuildInformation.BuildInfo toProto()

BuildInfo インスタンスを protobuf にシリアル化します。

String toString()

保護されたメソッド

void addAllBuildAttributes(BuildInfo build)

他のビルドからビルド属性、ブランチ、フレーバーをコピーするヘルパー メソッド。

void addAllFiles(BuildInfo build)

他のビルドからすべてのファイルをコピーするヘルパー メソッド。

boolean applyBuildProperties(VersionedFile origFileConsidered, IBuildInfo build, IBuildInfo receiver)

IBuildInfo.BuildInfoProperties の一部を適用し、必要に応じて別の処理を行うことを許可します。

MultiMap<String, String> getAttributesMultiMap()
getVersionedFileMap()
MultiMap<String, VersionedFile> getVersionedFileMapFull()

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

ビルド情報

public BuildInfo ()

デフォルトの属性値を使用して BuildInfo を作成します。

ビルド情報

public BuildInfo (String buildId, 
                String buildTargetName)

BuildInfo を作成します。

パラメータ
buildId String: ビルド ID
buildTargetName String: ビルド ターゲット名

パブリック メソッド

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

ローカル APK ファイルとそれに関連付けられたバージョンを追加します。apk は、このメソッドによって追加された順序で getAppPackageFiles() から返されます。

パラメータ
appPackageFile File

version String

addBuildAttribute

public void addBuildAttribute (String attributeName, 
                String attributeValue)

ビルド属性を追加します。これにより、既存の attributeName のオーバーライドは許可されません。

パラメータ
attributeName String: 一意の属性名
attributeValue String: 属性値

addBuildAttributes

public void addBuildAttributes ( buildAttributes)

ビルド属性を追加する

パラメータ
buildAttributes : 追加する属性のマップ

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

リモート ファイルのステージングを許可する権限を設定します。

パラメータ
stageRemoteFile boolean

cleanUp

public void cleanUp ()

一時的なビルドファイルをクリーンアップする

cleanUp

public void cleanUp ( doNotClean)

一部のファイルが削除されない cleanUp() のバージョン。

パラメータ
doNotClean

clone

public IBuildInfo clone ()

戻り値
IBuildInfo

copyAllFileFrom

public final void copyAllFileFrom (BuildInfo build)

特定のビルドからこのビルドにすべての VersionedFile をコピーします。

パラメータ
build BuildInfo

equals

public boolean equals (Object obj)

パラメータ
obj Object

戻り値
boolean

fromProto

public static IBuildInfo fromProto (BuildInformation.BuildInfo protoBuild)

toProto() の逆オペレーションを実行してインスタンスを復元します。

パラメータ
protoBuild BuildInformation.BuildInfo

戻り値
IBuildInfo

getAppPackageFiles

public  getAppPackageFiles ()

ローカルアプリの APK ファイルのセットとそのバージョンのコピーを取得します。返される順序は、apk が IAppBuildInfo に追加された順序と一致します。

戻り値

getBuildAttributes

public  getBuildAttributes ()

ビルドを記述する追加属性の名前と値のペアのセットを取得します。

戻り値
ビルド属性の ERROR(/Map)。null ではありませんが、空にすることもできます。

getBuildBranch

public String getBuildBranch ()

テスト対象のビルドが生成されたソース管理ブランチを返すオプション メソッド。

戻り値
String ビルドブランチ、または未設定または該当しない場合は null

getBuildFlavor

public String getBuildFlavor ()

テスト対象のビルドのタイプを返すオプションのメソッド。

Android プラットフォーム ビルドの一般的な実装では、（ビルド プロダクト）-（ビルド OS）-（ビルド バリアント）を返します。ie generic-linux-userdebug

戻り値
String ビルド フレーバー、または未設定または該当しない場合は null

getBuildId

public String getBuildId ()

テスト対象のビルドの一意の識別子を返します。null にすることはできません。デフォルトは UNKNOWN_BUILD_ID です。

戻り値
String

getBuildTargetName

public String getBuildTargetName ()

テスト中のビルドの完全名を返します。

一般的な実装では、ビルド フレーバーとブランチ名を組み合わせてビルド ターゲット名を作成します。[例: (ブランチ名)-(ビルド フレーバー)]

戻り値
String

getDeviceSerial

public String getDeviceSerial ()

戻り値
String

getFile

public File getFile (String name)

指定された名前のファイルを取得するヘルパー メソッド。

戻り値
File イメージ ファイル、または見つからない場合は null

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

指定された BuildInfoFileKey を使用してファイルを取得するヘルパー メソッド。

パラメータ
key BuildInfoKey.BuildInfoFileKey: リクエストされた BuildInfoFileKey。
戻り値
File イメージ ファイル、または見つからない場合は null

getFiles

public  getFiles ()

この BuildInfo に保存されているすべての VersionedFile を返します。

戻り値

getProperties

public  getProperties ()

IBuildInfo に現在設定されているプロパティのコピーを返します。

戻り値

getRemoteFiles

public  getRemoteFiles ()

ダウンロードが遅れているビルド アーティファクトのパスを取得します。

戻り値

getTestTag

public String getTestTag ()

実行中のテストの一意の名前を返します。

戻り値
String

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

指定された BuildInfoFileKey を使用してファイル バージョンを取得するヘルパー メソッド。

パラメータ
key BuildInfoKey.BuildInfoFileKey: リクエストされた BuildInfoFileKey。
戻り値
String イメージ バージョン（見つからない場合は null）

getVersion

public String getVersion (String name)

指定された名前のファイル バージョンを取得するヘルパー メソッド。

戻り値
String イメージ バージョン（見つからない場合は null）

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

指定された BuildInfoFileKey で VersionedFile を取得するヘルパー メソッド。

パラメータ
key BuildInfoKey.BuildInfoFileKey: リクエストされた BuildInfoFileKey。
戻り値
VersionedFile バージョニングされたファイル、または見つからない場合は null

getVersionedFile

public final VersionedFile getVersionedFile (String name)

指定された名前の VersionedFile を取得するヘルパー メソッド。

戻り値
VersionedFile バージョニングされたファイル、または見つからない場合は null

getVersionedFileKeys

public  getVersionedFileKeys ()

getFile(BuildInfoFileKey) を介して VersionedFile をクエリするために使用できるキーセットを返します。

戻り値

getVersionedFiles

public final  getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

特定の BuildInfoFileKey に関連付けられている VersionedFile のリストを取得するヘルパー メソッド。キーがリストの保存を許可しているかどうか。

パラメータ
key BuildInfoKey.BuildInfoFileKey: リクエストされた BuildInfoFileKey。
戻り値
バージョニングされたファイル、または見つからない場合は null

hashCode

public int hashCode ()

戻り値
int

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

指定した attributeName をトラッキングから削除します。

パラメータ
attributeName String: トラッキングを停止する属性

setBuildBranch

public void setBuildBranch (String branch)

ビルドブランチを設定する

パラメータ
branch String: ブランチ名

setBuildFlavor

public void setBuildFlavor (String buildFlavor)

ビルド フレーバーを設定します。

setBuildId

public void setBuildId (String buildId)

テスト対象のビルドの一意の識別子を設定します。null にすることはできません。

パラメータ
buildId String

setDeviceSerial

public void setDeviceSerial (String serial)

このビルドに関連付けられた ITestDevice シリアルを設定します。

パラメータ
serial String: このビルドが実行された ITestDevice のシリアル番号。

setFile

public void setFile (String name, 
                File file, 
                String version)

指定された名前のファイルをこのビルド情報に保存します。

パラメータ
name String: ファイルの一意の名前
file File: ローカルの ERROR(/File)
version String: ファイルのバージョン

setFile

public void setFile (BuildInfoKey.BuildInfoFileKey key, 
                File file, 
                String version)

このビルド情報に BuildInfoFileKey を指定してファイルを保存します。

パラメータ
key BuildInfoKey.BuildInfoFileKey: BuildInfoFileKey に基づくファイルの一意の名前。
file File: ローカル ERROR(/File)
version String: ファイルのバージョン

setProperties

public void setProperties (BuildInfoProperties... properties)

IBuildInfo インスタンスの BuildInfoProperties を設定します。前に設定した既存のプロパティをオーバーライドします。

パラメータ
properties BuildInfoProperties: 追加するプロパティのリスト。

setTestTag

public void setTestTag (String testTag)

実行されるテストの一意の名前を設定します。

パラメータ
testTag String

stageRemoteFile

public File stageRemoteFile (String fileName, 
                File workingDir)

リモート ファイルの一部であるファイルをビルド情報のルート ディレクトリにステージングします。

TODO(b/138416078): テストに必要なモジュールをテスト モジュールのディレクトリ自体に正常にビルドして出力できる場合は、このインターフェースとその呼び出し元を削除します。

パラメータ
fileName String: リモート ファイルに配置するファイルの名前。
workingDir File: ファイルをステージングするディレクトリの ERROR(/File) オブジェクト。
戻り値
File ローカルの workingDir にステージングされたファイルの ERROR(/File) オブジェクト。

toProto

public BuildInformation.BuildInfo toProto ()

BuildInfo インスタンスを protobuf にシリアル化します。

戻り値
BuildInformation.BuildInfo

toString

public String toString ()

戻り値
String

保護されたメソッド

addAllBuildAttributes

protected void addAllBuildAttributes (BuildInfo build)

他のビルドからビルド属性、ブランチ、フレーバーをコピーするヘルパー メソッド。

パラメータ
build BuildInfo

addAllFiles

protected void addAllFiles (BuildInfo build)

他のビルドからすべてのファイルをコピーするヘルパー メソッド。

ファイルへの新しいハードリンクを作成して、各ビルドにファイルの一意のファイルパスが割り当てられるようにします。

パラメータ
build BuildInfo

例外
ハードリンクの作成時に例外がスローされた場合。

applyBuildProperties

protected boolean applyBuildProperties (VersionedFile origFileConsidered, 
                IBuildInfo build, 
                IBuildInfo receiver)

IBuildInfo.BuildInfoProperties の一部を適用し、必要に応じて別の処理を行うことができます。

パラメータ
origFileConsidered VersionedFile: 現在表示されている VersionedFile。
build IBuildInfo: クローンを作成する元のビルド
receiver IBuildInfo: 情報を受信するビルド。
戻り値
boolean プロパティが適用され、それ以上の処理をスキップする必要がある場合は true です。それ以外の場合は False。

getAttributesMultiMap

protected MultiMap<String, String> getAttributesMultiMap ()

戻り値
MultiMap<String, String>

getVersionedFileMap

protected  getVersionedFileMap ()

戻り値

getVersionedFileMapFull

protected MultiMap<String, VersionedFile> getVersionedFileMapFull ()

戻り値
MultiMap<String, VersionedFile>