IBuildInfo

public interface IBuildInfo

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

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

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（ビルド 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 String: 一意の属性名
attributeValue String: 属性値

addBuildAttributes

public void addBuildAttributes ( buildAttributes)

ビルド属性を追加する

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

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

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

パラメータ
stageRemoteFile boolean

クリーンアップ

public abstract void cleanUp ()

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

クリーンアップ

public abstract void cleanUp ( doNotDelete)

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

パラメータ
doNotDelete

クローンを作成

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）-（ビルド バリアント）。 例: 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

getFile

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

ビルド属性を削除する

public void removeBuildAttribute (String 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 ローカルの workDir にステージングされたファイルの ERROR(/File) オブジェクト。

toProto

public BuildInformation.BuildInfo toProto ()

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

戻り値
BuildInformation.BuildInfo