IBuildInfo

public interface IBuildInfo
implements Serializable

com.android.tradefed.build.IBuildInfo

Содержит информацию о тестируемой сборке.

Краткое содержание

Константы

String REMOTE_FILE_PREFIX

Префикс, используемый в имени файла, указывает на то, что загрузка файла будет отложенной.

String REMOTE_FILE_VERSION

Удаленный файл не имеет версии.

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

Возвращает все файлы VersionedFile , хранящиеся в этом BuildInfo .

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)

Вспомогательный метод для получения объекта VersionedFile с заданным BuildInfoFileKey .

default VersionedFile getVersionedFile (String name)

Вспомогательный метод для получения объекта VersionedFile с заданным именем.

default Set<String> getVersionedFileKeys ()

Возвращает набор ключей, доступных для запроса VersionedFile с помощью getFile(BuildInfoFileKey) .

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

Вспомогательный метод для получения списка файлов VersionedFile , связанных с заданным BuildInfoFileKey .

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)

Задайте параметры BuildInfoProperties для экземпляра IBuildInfo .

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

Значение по умолчанию, если идентификатор сборки неизвестен.

Постоянное значение: "-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 (Map<String, String> buildAttributes)

Добавить атрибуты сборки

Параметры
buildAttributes Map : Карта атрибутов, которые необходимо добавить.

allowStagingRemoteFile 

public void allowStagingRemoteFile (boolean stageRemoteFile)

Устанавливает разрешение на размещение удаленных файлов в промежуточном хранилище.

Параметры
stageRemoteFile boolean

очистка 

public abstract void cleanUp ()

Удалите все временные файлы сборки.

очистка 

public abstract void cleanUp (List<File> doNotDelete)

Версия функции cleanUp() в которой некоторые файлы не удаляются.

Параметры
doNotDelete List

клон 

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 — это возврат значения (продукт сборки) - (операционная система сборки) - (вариант сборки). Например, 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 если к этой сборке не привязано ни одно устройство.

получить файл 

public abstract File getFile (String name)

Вспомогательный метод для получения файла с заданным именем.

Возвраты
File файл изображения или null , если не найден

получить файл 

public File getFile (BuildInfoKey.BuildInfoFileKey key)

Вспомогательный метод для получения файла по заданному параметру BuildInfoFileKey .

Параметры
key BuildInfoKey.BuildInfoFileKey : запрашиваемый ключ BuildInfoFileKey .

Возвраты
File файл изображения или null , если не найден

получитьФайлы 

public abstract Collection<VersionedFile> getFiles ()

Возвращает все файлы VersionedFile , хранящиеся в этом BuildInfo .

Возвраты
Collection< VersionedFile >

получитьСвойства 

public abstract Set<IBuildInfo.BuildInfoProperties> getProperties ()

Возвращает копию свойств, которые в данный момент установлены для объекта IBuildInfo .

Возвраты
Set< IBuildInfo.BuildInfoProperties >

getRemoteFiles 

public Set<File> getRemoteFiles ()

Получите пути к артефактам сборки, загрузка которых отложена.

Возвраты
Set<File>

getTestTag 

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)

Вспомогательный метод для получения объекта VersionedFile с заданным BuildInfoFileKey .

Параметры
key BuildInfoKey.BuildInfoFileKey : Запрошенный ключ BuildInfoFileKey .

Возвраты
VersionedFile Версионированный файл или null , если файл не найден.

getVersionedFile 

public VersionedFile getVersionedFile (String name)

Вспомогательный метод для получения объекта VersionedFile с заданным именем.

Возвраты
VersionedFile Версионированный файл или null , если файл не найден.

getVersionedFileKeys 

public Set<String> getVersionedFileKeys ()

Возвращает набор ключей, доступных для запроса VersionedFile с помощью getFile(BuildInfoFileKey) .

Возвраты
Set<String>

getVersionedFiles 

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

Вспомогательный метод для получения списка файлов VersionedFile , связанных с заданным ключом BuildInfoFileKey . Если ключ позволяет хранить список.

Параметры
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)

Задайте BuildInfoProperties для экземпляра IBuildInfo . Переопределите все ранее установленные свойства.

Параметры
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 Объект File — это файл, помещенный в локальную рабочую директорию.

toProto 

public BuildInformation.BuildInfo toProto ()

Сериализуйте экземпляр BuildInfo в файл protobuf.

Возвраты
BuildInformation.BuildInfo