IBuildInfo

public interface IBuildInfo
implements Serializable

com.android.tradefed.build.IBuildInfo

テスト対象のビルドに関する情報を保持します。

概要

定数

String REMOTE_FILE_PREFIX

ファイルが遅延ダウンロードに設定されていることを示すために名前で使用される接頭辞。
String REMOTE_FILE_VERSION

リモート ファイルはバージョン管理されていません。
String UNKNOWN_BUILD_ID

ビルド ID が不明な場合のデフォルト値。

パブリック メソッド

default void addAppPackageFile(File appPackageFile, String version)

ローカルの APK ファイルとそれに関連付けられたバージョンを追加します。
abstract void addBuildAttribute(String attributeName, String attributeValue)

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

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

ビルド属性を追加する

default void allowStagingRemoteFile(boolean stageRemoteFile)

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

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

abstract void cleanUp(List<File> doNotDelete)

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

abstract IBuildInfo clone()

IBuildInfo オブジェクトのクローンを作成します。
default List<VersionedFile> getAppPackageFiles()

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

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

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

abstract String getBuildFlavor()

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

abstract String getBuildId()

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

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

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

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

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

IBuildInfo に現在設定されているプロパティのコピーを返します。
default Set<File> getRemoteFiles()

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

実行中のテストの一意の名前を返します。
default String getVersion(BuildInfoKey.BuildInfoFileKey key)

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

指定された名前のファイル バージョンを取得するヘルパー メソッド。
default VersionedFile getVersionedFile(BuildInfoKey.BuildInfoFileKey key)

指定された BuildInfoFileKey を持つ VersionedFile を取得するヘルパー メソッド。
default VersionedFile getVersionedFile(String name)

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

getFile(BuildInfoFileKey) を介して VersionedFile をクエリできるキーのセットを返します。
default List<VersionedFile> getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)

特定の BuildInfoFileKey に関連付けられた VersionedFile のリストを取得するヘルパー メソッド。
default void removeBuildAttribute(String attributeName)

トラッキングから指定された attributeName を削除します。
abstract void setBuildBranch(String branch)

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

abstract void setBuildFlavor(String buildFlavor)

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

abstract void setBuildId(String buildId)

テスト対象のビルドの一意の識別子を設定します。
abstract void setDeviceSerial(String serial)

このビルドに関連付けられた ITestDevice シリアルを設定します。
default void setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version)

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

指定された名前のファイルをこのビルド情報に保存します。
abstract void setProperties(BuildInfoProperties... properties)

IBuildInfo インスタンスの BuildInfoProperties を設定します。
abstract void setTestTag(String testTag)

実行するテストの一意の名前を設定します。
default File stageRemoteFile(String fileName, File workingDir)

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

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

定数

REMOTE_FILE_PREFIX

public static final String REMOTE_FILE_PREFIX

ファイルが遅延ダウンロードに設定されていることを示すために名前で使用される接頭辞。

定数値: "remote_file:"

REMOTE_FILE_VERSION

public static final String REMOTE_FILE_VERSION

リモート ファイルがバージョン管理されていません。

定数値: ""

UNKNOWN_BUILD_ID

public static final String UNKNOWN_BUILD_ID

ビルド ID が不明な場合のデフォルト値。

定数値: "-1"

パブリック メソッド

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

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

パラメータ
appPackageFile File

version String

addBuildAttribute

public abstract 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 abstract void cleanUp ()

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

cleanUp

public abstract void cleanUp (List<File> doNotDelete)

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

パラメータ
doNotDelete List

clone

public abstract IBuildInfo clone ()

IBuildInfo オブジェクトのクローンを作成します。

戻り値
IBuildInfo

getAppPackageFiles

public List<VersionedFile> getAppPackageFiles ()

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

戻り値
List<VersionedFile>

getBuildAttributes

public abstract Map<String, String> getBuildAttributes ()

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

戻り値
Map<String, String> ビルド属性の Map。null にはなりませんが、空になる可能性があります。

getBuildBranch

public abstract String getBuildBranch ()

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

戻り値
String ビルドブランチまたは null（設定されていない場合/該当しない場合）

getBuildFlavor

public abstract String getBuildFlavor ()

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

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

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

getBuildId

public abstract String getBuildId ()

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

戻り値
String

getBuildTargetName

public abstract String getBuildTargetName ()

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

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

戻り値
String

getDeviceSerial

public abstract String getDeviceSerial ()

戻り値
String このビルドが実行された ITestDevice シリアル。このビルドに関連付けられているデバイスがない場合は、null を返します。

getFile

public abstract File getFile (String name)

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

戻り値
File 画像ファイル。見つからない場合は null

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

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

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

getFiles

public abstract Collection<VersionedFile> getFiles ()

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

戻り値
Collection<VersionedFile>

getProperties

public abstract Set<IBuildInfo.BuildInfoProperties> getProperties ()

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

戻り値
Set<IBuildInfo.BuildInfoProperties>

getRemoteFiles

public Set<File> getRemoteFiles ()

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

戻り値
Set<File>

getTestTag

public abstract String getTestTag ()

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

戻り値
String

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

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

パラメータ
key BuildInfoKey.BuildInfoFileKey: リクエストされた BuildInfoFileKey。
戻り値
String 画像モード。見つからない場合は null

getVersion

public abstract String getVersion (String name)

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

戻り値
String 画像モード。見つからない場合は null

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

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

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

getVersionedFile

public VersionedFile getVersionedFile (String name)

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

戻り値
VersionedFile バージョン管理されたファイル。見つからない場合は null

getVersionedFileKeys

public Set<String> getVersionedFileKeys ()

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

戻り値
Set<String>

getVersionedFiles

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

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

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

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

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

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

setBuildBranch

public abstract void setBuildBranch (String branch)

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

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

setBuildFlavor

public abstract void setBuildFlavor (String buildFlavor)

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

setBuildId

public abstract void setBuildId (String buildId)

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

パラメータ
buildId String

setDeviceSerial

public abstract 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 abstract void setFile (String name, 
                File file, 
                String version)

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

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

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

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

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

setTestTag

public abstract 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