IBuildInfo

public interface IBuildInfo

com.android.tradefed.build.IBuildInfo

既知の間接的なサブクラス AppBuildInfo、AppDeviceBuildInfo、BuildInfo、ClusterBuildInfo、DeviceBuildInfo、DeviceFolderBuildInfo、FolderBuildInfo、IAppBuildInfo、IDeviceBuildInfo、IFolderBuildInfo、OtaDeviceBuildInfo、OtatoolsBuildInfo AppBuildInfo Android アプリとそのテストパッケージを表す IBuildInfo。  AppDeviceBuildInfo このクラスは非推奨になりました。 IDeviceBuildInfo を直接使用します。  BuildInfo ITestDevice に関連付ける必要がある IBuildInfo の一般的な実装。  ClusterBuildInfo TFC からパイプされたビルド用の IBuildInfo クラス。  DeviceBuildInfo 完全な Android デバイス ビルドと（必要に応じて）そのテストを表す IBuildInfo。  DeviceFolderBuildInfo ローカル ファイル システムのディレクトリに含まれる他のビルド アーティファクトも含まれている IDeviceBuildInfo。  FolderBuildInfo IFolderBuildInfo の具体的な実装。  IAppBuildInfo このインターフェースは非推奨になりました。 IBuildInfo を直接使用します。  IDeviceBuildInfo 完全な Android デバイス ビルドと（必要に応じて）そのテストを表す IBuildInfo。  IFolderBuildInfo ビルド アーティファクトがローカル ファイル システム ディレクトリに含まれているシンプルな抽象 IBuildInfo。  OtaDeviceBuildInfo 無線（OTA）アップデートのテストに使用される IDeviceBuildInfo。  OtatoolsBuildInfo otatools アーティファクトを含む 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( buildAttributes) ビルド属性を追加する
default void	allowStagingRemoteFile(boolean stageRemoteFile) リモート ファイルのステージングを許可する権限を設定します。
abstract void	cleanUp() 一時的なビルドファイルをクリーンアップします。
abstract void	cleanUp( doNotDelete) 一部のファイルが削除されない cleanUp() のバージョン。
abstract IBuildInfo	clone() IBuildInfo オブジェクトのクローンを作成します。
default	getAppPackageFiles() ローカルアプリ APK ファイルのセットとそのバージョンのコピーを取得します。
abstract	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	getFiles() この BuildInfo に保存されているすべての VersionedFile を返します。
abstract	getProperties() IBuildInfo に現在設定されているプロパティのコピーを返します。
default	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	getVersionedFileKeys() getFile(BuildInfoFileKey) を介して VersionedFile をクエリするために使用できるキーセットを返します。
default	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 シリアルを設定します。
abstract void	setFile(String name, File file, String version) 指定した名前のファイルをこのビルド情報に保存します。
default void	setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version) このビルド情報に BuildInfoFileKey を指定してファイルを保存します。
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 ファイルとそれに関連付けられたバージョンを追加します。apk は、このメソッドによって追加された順序で getAppPackageFiles() から返されます。

パラメータ
appPackageFile	File
version	String

addBuildAttribute

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

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

cleanUp

public abstract void cleanUp ( doNotDelete)

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

パラメータ
doNotDelete

clone

public abstract IBuildInfo clone ()

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

戻り値
IBuildInfo

getAppPackageFiles

public  getAppPackageFiles ()

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

戻り値

getBuildAttributes

public abstract  getBuildAttributes ()

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

戻り値
	ビルド属性の ERROR(/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  getFiles ()

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

戻り値

getProperties

public abstract  getProperties ()

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

戻り値

getRemoteFiles

public  getRemoteFiles ()

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

戻り値

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

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

戻り値

getVersionedFiles

public  getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

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

パラメータ
key	BuildInfoKey.BuildInfoFileKey: リクエストされた BuildInfoFileKey。

戻り値
	バージョニングされたファイル、または見つからない場合は 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 abstract 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 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: ファイルをステージングするディレクトリの ERROR(/File) オブジェクト。

戻り値
File	ローカルの workingDir にステージングされたファイルの ERROR(/File) オブジェクト。

toProto

public BuildInformation.BuildInfo toProto ()

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

戻り値
BuildInformation.BuildInfo