BuildInfo

public class BuildInfo
extends Object implements IBuildInfo

java.lang.Object
com.android.tradefed.build.BuildInfo


Универсальная реализация объекта IBuildInfo , который должен быть связан с ITestDevice .

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

Государственные строители

BuildInfo ()

Создает BuildInfo используя значения атрибутов по умолчанию.

BuildInfo (String buildId, String buildTargetName)

Создает BuildInfo

Общедоступные методы

void addAppPackageFile (File appPackageFile, String version)

Добавляет локальный APK-файл и соответствующую ему версию.

void addBuildAttribute (String attributeName, String attributeValue)

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

void addBuildAttributes (Map<String, String> buildAttributes)

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

void allowStagingRemoteFile (boolean stageRemoteFile)

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

void cleanUp ()

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

void cleanUp (List<File> doNotClean)

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

IBuildInfo clone ()

final void copyAllFileFrom ( BuildInfo build)

Скопируйте все файлы VersionedFile из данной сборки в эту.

boolean equals (Object obj)

static IBuildInfo fromProto (BuildInformation.BuildInfo protoBuild)

Обратная операция к toProto() для получения экземпляра.

List< VersionedFile > getAppPackageFiles ()

Получает копию набора локальных APK-файлов приложения и их версий.

Map<String, String> getBuildAttributes ()

Получите набор пар «имя-значение» дополнительных атрибутов, описывающих сборку.

String getBuildBranch ()

Необязательный метод, возвращающий ветку системы контроля версий, из которой была создана тестируемая сборка.

String getBuildFlavor ()

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

String getBuildId ()

Возвращает уникальный идентификатор тестируемой сборки.

String getBuildTargetName ()

Возвращает полное имя тестируемой сборки.

String getDeviceSerial ()

File getFile (String name)

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

File getFile ( BuildInfoKey.BuildInfoFileKey key)

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

Collection< VersionedFile > getFiles ()

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

Set< IBuildInfo.BuildInfoProperties > getProperties ()

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

Set<File> getRemoteFiles ()

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

String getTestTag ()

Возвращает уникальное имя для запускаемых тестов.

String getVersion ( BuildInfoKey.BuildInfoFileKey key)

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

String getVersion (String name)

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

VersionedFile getVersionedFile ( BuildInfoKey.BuildInfoFileKey key)

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

final VersionedFile getVersionedFile (String name)

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

Set<String> getVersionedFileKeys ()

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

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

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

int hashCode ()

void removeBuildAttribute (String attributeName)

Удалить указанный attributeName из системы отслеживания.

void setBuildBranch (String branch)

Установить ветку сборки

void setBuildFlavor (String buildFlavor)

Задайте тип сборки.

void setBuildId (String buildId)

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

void setDeviceSerial (String serial)

Укажите серийный номер ITestDevice , связанный с этой сборкой.

void setFile ( BuildInfoKey.BuildInfoFileKey key, File file, String version)

Сохраняет файл, которому присвоен ключ BuildInfoFileKey в информации о сборке.

void setFile (String name, File file, String version)

Сохраняет файл с заданным именем в информации о сборке.

void setProperties ( BuildInfoProperties... properties)

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

void setTestTag (String testTag)

Задает уникальное имя для запускаемых тестов.

File stageRemoteFile (String fileName, File workingDir)

Добавить в папку файл, являющийся частью удаленных файлов в корневом каталоге информации о сборке.

BuildInformation.BuildInfo toProto ()

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

String toString ()

Защищенные методы

void addAllBuildAttributes ( BuildInfo build)

Вспомогательный метод для копирования атрибутов сборки, ветки и варианта сборки из другой сборки.

void addAllFiles ( BuildInfo build)

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

boolean applyBuildProperties ( VersionedFile origFileConsidered, IBuildInfo build, IBuildInfo receiver)

Разрешить применение некоторых свойств IBuildInfo.BuildInfoProperties и, возможно, использовать другой способ обработки.

MultiMap <String, String> getAttributesMultiMap ()
Map<String, VersionedFile > getVersionedFileMap ()
MultiMap <String, VersionedFile > getVersionedFileMapFull ()

Государственные строители

BuildInfo

public BuildInfo ()

Создает BuildInfo используя значения атрибутов по умолчанию.

BuildInfo

public BuildInfo (String buildId, 
                String buildTargetName)

Создает BuildInfo

Параметры
buildId String : идентификатор сборки

buildTargetName String : имя целевого объекта сборки

Общедоступные методы

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

Добавляет локальный apk-файл и соответствующую ему версию. Обратите внимание, что apk-файлы будут возвращаться из getAppPackageFiles() в том порядке, в котором они были добавлены этим методом.

Параметры
appPackageFile File

version String

addBuildAttribute

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

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

очистка

public void cleanUp (List<File> doNotClean)

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

Параметры
doNotClean List

клон

public IBuildInfo clone ()

Возвраты
IBuildInfo

copyAllFileFrom

public final void copyAllFileFrom (BuildInfo build)

Скопируйте все файлы VersionedFile из данной сборки в эту.

Параметры
build BuildInfo

равно

public boolean equals (Object obj)

Параметры
obj Object

Возвраты
boolean

изПрото

public static IBuildInfo fromProto (BuildInformation.BuildInfo protoBuild)

Обратная операция к toProto() для получения экземпляра.

Параметры
protoBuild BuildInformation.BuildInfo

Возвраты
IBuildInfo

getAppPackageFiles

public List<VersionedFile> getAppPackageFiles ()

Получает копию набора локальных APK-файлов приложения и их версий. Возвращаемый порядок соответствует порядку добавления APK-файлов в IAppBuildInfo .

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

getBuildAttributes

public Map<String, String> getBuildAttributes ()

Получите набор пар «имя-значение» дополнительных атрибутов, описывающих сборку.

Возвраты
Map<String, String> Map атрибутов сборки. Не будет null , но может быть пустым.

getBuildBranch

public String getBuildBranch ()

Необязательный метод, возвращающий ветку системы контроля версий, из которой была создана тестируемая сборка.

Возвраты
String Ветка сборки или null , если не задано/неприменимо

getBuildFlavor

public String getBuildFlavor ()

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

Распространенный способ реализации сборки для платформы Android — это возврат значения (продукт сборки) - (операционная система сборки) - (вариант сборки). Например, generic-linux-userdebug

Возвраты
String Тип сборки или null , если не задано/неприменимо

getBuildId

public String getBuildId ()

Возвращает уникальный идентификатор тестируемой сборки. Никогда не должен быть равен null. По умолчанию используется UNKNOWN_BUILD_ID .

Возвраты
String

getBuildTargetName

public String getBuildTargetName ()

Возвращает полное имя тестируемой сборки.

Распространенный способ реализации — формирование имени цели сборки из комбинации типа сборки и имени ветки. [например, (имя ветки)-(тип сборки)]

Возвраты
String

getDeviceSerial

public String getDeviceSerial ()

Возвраты
String

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

public File getFile (String name)

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

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

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

public File getFile (BuildInfoKey.BuildInfoFileKey key)

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

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

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

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

public Collection<VersionedFile> getFiles ()

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

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

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

public Set<IBuildInfo.BuildInfoProperties> getProperties ()

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

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

getRemoteFiles

public Set<File> getRemoteFiles ()

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

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

getTestTag

public String getTestTag ()

Возвращает уникальное имя для запускаемых тестов.

Возвраты
String

получитьВерсию

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

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

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

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

получитьВерсию

public String getVersion (String name)

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

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

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

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

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

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

getVersionedFile

public final VersionedFile getVersionedFile (String name)

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

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

getVersionedFileKeys

public Set<String> getVersionedFileKeys ()

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

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

getVersionedFiles

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

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

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

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

хешкод

public int hashCode ()

Возвраты
int

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

Удалить указанный attributeName из системы отслеживания.

Параметры
attributeName String : атрибут, отслеживание которого необходимо прекратить.

setBuildBranch

public void setBuildBranch (String branch)

Установить ветку сборки

Параметры
branch String : название ветки

setBuildFlavor

public void setBuildFlavor (String buildFlavor)

Задайте тип сборки.

setBuildId

public void setBuildId (String buildId)

Устанавливает уникальный идентификатор тестируемой сборки. Никогда не должен быть пустым (null).

Параметры
buildId String

setDeviceSerial

public 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 void setFile (String name, 
                File file, 
                String version)

Сохраняет файл с заданным именем в информации о сборке.

Параметры
name String : уникальное имя файла

file File : локальный File

version String : версия файла

setProperties

public void setProperties (BuildInfoProperties... properties)

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

Параметры
properties BuildInfoProperties : Список свойств для добавления.

setTestTag

public 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

toString

public String toString ()

Возвраты
String

Защищенные методы

addAllBuildAttributes

protected void addAllBuildAttributes (BuildInfo build)

Вспомогательный метод для копирования атрибутов сборки, ветки и варианта сборки из другой сборки.

Параметры
build BuildInfo

addAllFiles

protected void addAllFiles (BuildInfo build)

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

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

Параметры
build BuildInfo

Броски
IOException если при создании жесткой ссылки возникнет исключение.

applyBuildProperties

protected boolean applyBuildProperties (VersionedFile origFileConsidered, 
                IBuildInfo build, 
                IBuildInfo receiver)

Разрешить применение некоторых свойств IBuildInfo.BuildInfoProperties и, возможно, использовать другой способ обработки.

Параметры
origFileConsidered VersionedFile : В данный момент рассматривается VersionedFile .

build IBuildInfo : исходная сборка, которая клонируется.

receiver IBuildInfo : сборка, получающая информацию.

Возвраты
boolean Если свойства применены, то значение true, и дальнейшая обработка должна быть пропущена. В противном случае значение false.

getAttributesMultiMap

protected MultiMap<String, String> getAttributesMultiMap ()

Возвраты
MultiMap <String, String>

getVersionedFileMap

protected Map<String, VersionedFile> getVersionedFileMap ()

Возвраты
Map<String, VersionedFile >

getVersionedFileMapFull

protected MultiMap<String, VersionedFile> getVersionedFileMapFull ()

Возвраты
MultiMap <String, VersionedFile >