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) addBuildAttributes ( buildAttributes) ビルド属性を追加する |
default void | allowStagingRemoteFile (boolean stageRemoteFile) リモート ファイルのステージングを許可する権限を設定します。 |
abstract void | cleanUp () 一時ビルド ファイルをクリーンアップする |
abstract void | cleanUp ( doNotDelete) cleanUp ( doNotDelete) 一部のファイルが削除されないバージョンの |
abstract IBuildInfo | clone () |
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) 指定された |
abstract | getFiles () この |
abstract | getProperties () |
default | getRemoteFiles () ダウンロードが遅延されたビルド アーティファクトのパスを取得します。 |
abstract String | getTestTag () 実行中のテストの一意の名前を返します。 |
default String | getVersion ( BuildInfoKey.BuildInfoFileKey key) 指定された |
abstract String | getVersion (String name) 指定された名前のファイル バージョンを取得するヘルパー メソッド。 |
default VersionedFile | getVersionedFile ( BuildInfoKey.BuildInfoFileKey key) 指定された |
default VersionedFile | getVersionedFile (String name) 指定された名前の |
default | getVersionedFileKeys () |
default | getVersionedFiles ( BuildInfoKey.BuildInfoFileKey key) 指定された |
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) このビルドに関連付けられた |
abstract void | setFile (String name, File file, String version) このビルド情報に指定された名前のファイルを保存します。 |
default void | setFile ( BuildInfoKey.BuildInfoFileKey key, File file, String version) |
abstract void | setProperties ( BuildInfoProperties... properties) |
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 |
allowedStagingRemoteFile
public void allowStagingRemoteFile (boolean stageRemoteFile)
リモート ファイルのステージングを許可する権限を設定します。
パラメーター | |
---|---|
stageRemoteFile | boolean |
掃除
public abstract void cleanUp ()
一時ビルド ファイルをクリーンアップする
getAppPackageFiles
publicgetAppPackageFiles ()
ローカル アプリの APK ファイルとそのバージョンのセットのコピーを取得します。返される順序は、apk がIAppBuildInfo
に追加された順序と一致します。
戻り値 | |
---|---|
getBuildAttributes
public abstractgetBuildAttributes ()
ビルドを説明する追加属性の名前と値のペアのセットを取得します。
戻り値 | |
---|---|
ビルド属性のERROR(/Map) 。 null にはなりませんが、空の場合があります。 |
getBuildブランチ
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 ()
テストされているビルドの完全な名前を返します。
一般的な実装では、ビルド フレーバーとブランチ名の組み合わせからビルド ターゲット名を構築します。 [ie (ブランチ名)-(ビルドフレーバー)]戻り値 | |
---|---|
String |
getデバイスシリアル
public abstract String getDeviceSerial ()
戻り値 | |
---|---|
String | このビルドが実行されたITestDevice シリアル。このビルドにデバイスが関連付けられていない場合は、 null を返します。 |
ファイルの取得
public abstract File getFile (String name)
指定された名前のファイルを取得するヘルパー メソッド。
戻り値 | |
---|---|
File | 画像ファイル、または見つからない場合はnull |
ファイルの取得
public File getFile (BuildInfoKey.BuildInfoFileKey key)
指定されたBuildInfoFileKey
を使用してファイルを取得するヘルパー メソッド。
パラメーター | |
---|---|
key | BuildInfoKey.BuildInfoFileKey : 要求されたBuildInfoFileKey 。 |
戻り値 | |
---|---|
File | 画像ファイル、または見つからない場合はnull |
getRemoteFiles
publicgetRemoteFiles ()
ダウンロードが遅延されたビルド アーティファクトのパスを取得します。
戻り値 | |
---|---|
テストタグの取得
public abstract String getTestTag ()
実行中のテストの一意の名前を返します。
戻り値 | |
---|---|
String |
バージョンの取得
public String getVersion (BuildInfoKey.BuildInfoFileKey key)
指定されたBuildInfoFileKey
を使用してファイル バージョンを取得するヘルパー メソッド。
パラメーター | |
---|---|
key | BuildInfoKey.BuildInfoFileKey : 要求されたBuildInfoFileKey 。 |
戻り値 | |
---|---|
String | イメージのバージョン、または見つからない場合はnull |
バージョンの取得
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
publicgetVersionedFileKeys ()
getFile(BuildInfoFileKey)
を介してVersionedFile
のクエリに使用できるキーのセットを返します。
戻り値 | |
---|---|
getVersionedFiles
publicgetVersionedFiles (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 のシリアル番号。 |
セットファイル
public abstract void setFile (String name, File file, String version)
このビルド情報に指定された名前のファイルを保存します。
パラメーター | |
---|---|
name | String : ファイルの一意の名前 |
file | File : ローカルERROR(/File) |
version | String : ファイルのバージョン |
セットファイル
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 : 追加するプロパティのリスト。 |
テストタグを設定
public abstract void setTestTag (String testTag)
実行されるテストの一意の名前を設定します。
パラメーター | |
---|---|
testTag | String |
stageRemoteファイル
public File stageRemoteFile (String fileName, File workingDir)
リモート ファイルの一部であるファイルをビルド情報のルート ディレクトリにステージングします。
TODO(b/138416078): テストに必要なモジュールが適切にビルドされ、テスト モジュールのディレクトリ自体に出力される場合は、このインターフェイスとその呼び出し元を削除します。
パラメーター | |
---|---|
fileName | String : リモート ファイルに配置されるファイルの名前。 |
workingDir | File : ファイルをステージングするディレクトリのERROR(/File) オブジェクト。 |
戻り値 | |
---|---|
File | ローカルの workingDir にステージングされたファイルのERROR(/File) オブジェクト。 |
プロトへ
public BuildInformation.BuildInfo toProto ()
BuildInfo インスタンスを protobuf にシリアル化します。
戻り値 | |
---|---|
BuildInformation.BuildInfo |