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)

ビルド属性を追加する

abstract void cleanUp ()

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

abstract void cleanUp ( doNotDelete) 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 : 追加する属性のマップ

掃除

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

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

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

戻り値
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 : ファイルのバージョン

プロパティの設定

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