ビルド情報

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(Map<String, String> buildAttributes)

ビルド属性を追加する

void allowStagingRemoteFile(boolean stageRemoteFile)

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

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

void cleanUp(List<File> doNotClean)

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

IBuildInfo clone()

final void copyAllFileFrom(BuildInfo build)

指定されたビルドからこのビルドにすべての VersionedFile をコピーします。
boolean equals(Object obj)

static IBuildInfo fromProto(BuildInformation.BuildInfo protoBuild)

インスタンスを元に戻すための toProto() の逆演算。
List<VersionedFile> getAppPackageFiles()

ローカルアプリの apk ファイルとそのバージョンのセットのコピーを取得します。
Map<String, String> getBuildAttributes()

ビルドを説明する追加属性の名前と値のペアのセットを取得します。
String getBuildBranch()

テスト対象のビルドが生成されたソース管理ブランチを返す省略可能なメソッド。

String getBuildFlavor()

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

String getBuildId()

テスト中のビルドの一意の識別子を返します。
String getBuildTargetName()

テスト中のビルドの完全な名前を返します。
String getDeviceSerial()

File getFile(String name)

指定された名前のファイルを取得するヘルパー メソッド。
File getFile(BuildInfoKey.BuildInfoFileKey key)

指定された BuildInfoFileKey を使用してファイルを取得するヘルパー メソッド。
Collection<VersionedFile> getFiles()

この BuildInfo に保存されているすべての VersionedFile を返します。
Set<IBuildInfo.BuildInfoProperties> getProperties()

IBuildInfo に現在設定されているプロパティのコピーを返します。
Set<File> 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 を取得するヘルパー メソッド。
Set<String> getVersionedFileKeys()

getFile(BuildInfoFileKey) を介して VersionedFile をクエリできるキーのセットを返します。
final List<VersionedFile> 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(BuildInfoKey.BuildInfoFileKey key, File file, String version)

このビルド情報に BuildInfoFileKey を指定してファイルを保存します。
void setFile(String name, File file, String version)

指定された名前のファイルをこのビルド情報に保存します。
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()
Map<String, VersionedFile> 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 ファイルとそれに関連付けられたバージョンを追加します。このメソッドで追加された順に、getAppPackageFiles() から apk が返されます。

パラメータ
appPackageFile File

version String

addBuildAttribute

public void addBuildAttribute (String attributeName, 
                String attributeValue)

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

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

addBuildAttributes

public void addBuildAttributes (Map<String, String> buildAttributes)

ビルド属性を追加する

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

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

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

パラメータ
stageRemoteFile boolean

cleanUp

public void cleanUp ()

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

cleanUp

public void cleanUp (List<File> doNotClean)

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

パラメータ
doNotClean List

clone

public IBuildInfo clone ()

戻り値
IBuildInfo

copyAllFileFrom

public final void copyAllFileFrom (BuildInfo build)

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

パラメータ
build BuildInfo

等しい

public boolean equals (Object obj)

パラメータ
obj Object

戻り値
boolean

fromProto

public static IBuildInfo fromProto (BuildInformation.BuildInfo protoBuild)

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

パラメータ
protoBuild BuildInformation.BuildInfo

戻り値
IBuildInfo

getAppPackageFiles

public List<VersionedFile> getAppPackageFiles ()

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

戻り値
List<VersionedFile>

getBuildAttributes

public Map<String, String> getBuildAttributes ()

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

戻り値
Map<String, String> ビルド属性の 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 Collection<VersionedFile> getFiles ()

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

戻り値
Collection<VersionedFile>

getProperties

public Set<IBuildInfo.BuildInfoProperties> getProperties ()

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

戻り値
Set<IBuildInfo.BuildInfoProperties>

getRemoteFiles

public Set<File> getRemoteFiles ()

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

戻り値
Set<File>

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 Set<String> getVersionedFileKeys ()

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

戻り値
Set<String>

getVersionedFiles

public final List<VersionedFile> getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

特定の BuildInfoFileKey に関連付けられた VersionedFile のリストを取得するヘルパー メソッド。キーでリストを保存できる場合。

パラメータ
key BuildInfoKey.BuildInfoFileKey: リクエストされた BuildInfoFileKey。
戻り値
List<VersionedFile> バージョン管理されたファイル。見つからない場合は 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 (BuildInfoKey.BuildInfoFileKey key, 
                File file, 
                String version)

このビルド情報で BuildInfoFileKey が指定されたファイルを保存します。

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

setFile

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

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

パラメータ
name String: ファイルの一意の名前
file File: ローカル 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: ファイルをステージングするディレクトリの File オブジェクト。
戻り値
File ローカル workingDir にステージングされたファイルの 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

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

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 Map<String, VersionedFile> getVersionedFileMap ()

戻り値
Map<String, VersionedFile>

getVersionedFileMapFull

protected MultiMap<String, VersionedFile> getVersionedFileMapFull ()

戻り値
MultiMap<String, VersionedFile>