IBuildInfo

public interface IBuildInfo
implements Serializable

com.android.tradefed.build.IBuildInfo

Subcategorías indirectas conocidas AppBuildInfo, AppDeviceBuildInfo, BuildInfo, ClusterBuildInfo, DeviceBuildInfo, DeviceFolderBuildInfo, FolderBuildInfo, IAppBuildInfo, IDeviceBuildInfo, IFolderBuildInfo, OtaDeviceBuildInfo, OtatoolsBuildInfo AppBuildInfo Un IBuildInfo que representa una aplicación para Android y sus paquetes de prueba.  AppDeviceBuildInfo Esta clase dejó de estar disponible. Usa IDeviceBuildInfo directamente.  BuildInfo Es la implementación genérica de un IBuildInfo que se debe asociar con un ITestDevice.  ClusterBuildInfo Clase IBuildInfo para compilaciones canalizadas desde TFC.  DeviceBuildInfo Un IBuildInfo que representa una compilación completa de un dispositivo Android y, de manera opcional, sus pruebas.  DeviceFolderBuildInfo Un IDeviceBuildInfo que también contiene otros artefactos de compilación incluidos en un directorio del sistema de archivos local.  FolderBuildInfo Es la implementación concreta de un IFolderBuildInfo.  IAppBuildInfo Esta interfaz dejó de estar disponible. Usa IBuildInfo directamente.  IDeviceBuildInfo Un IBuildInfo que representa una compilación completa de un dispositivo Android y, de manera opcional, sus pruebas.  IFolderBuildInfo Un IBuildInfo abstracto simple cuyos artefactos de compilación se encuentran en un directorio del sistema de archivos local.  OtaDeviceBuildInfo Es un IDeviceBuildInfo que se usa para probar las actualizaciones inalámbricas.  OtatoolsBuildInfo Un IBuildInfo que contiene artefactos de otatools.

---

Contiene información sobre la compilación en prueba.

Resumen

Constantes
String	REMOTE_FILE_PREFIX Prefijo que se usa en el nombre para indicar que el archivo está configurado para descargarse de forma diferida.
String	REMOTE_FILE_VERSION El archivo remoto no tiene versiones.
String	UNKNOWN_BUILD_ID Es el valor predeterminado cuando se desconoce el ID de compilación.

Métodos públicos
default void	addAppPackageFile(File appPackageFile, String version) Agrega el archivo APK local y su versión asociada.
abstract void	addBuildAttribute(String attributeName, String attributeValue) Agrega un atributo de compilación.
default void	addBuildAttributes(Map<String, String> buildAttributes) Agrega atributos de compilación
default void	allowStagingRemoteFile(boolean stageRemoteFile) Establece el permiso para permitir la transferencia de archivos remotos a la etapa de pruebas.
abstract void	cleanUp() Limpia los archivos de compilación temporales.
abstract void	cleanUp(List<File> doNotDelete) Versión de cleanUp() en la que no se borran algunos archivos.
abstract IBuildInfo	clone() Clona el objeto IBuildInfo.
default List<VersionedFile>	getAppPackageFiles() Obtiene una copia del conjunto de archivos APK de la app local y sus versiones.
abstract Map<String, String>	getBuildAttributes() Obtiene un conjunto de pares nombre-valor de atributos adicionales que describen la compilación.
abstract String	getBuildBranch() Es un método opcional para devolver la rama de control de origen desde la que se produjo la compilación que se está probando.
abstract String	getBuildFlavor() Método opcional para devolver el tipo de compilación que se está probando.
abstract String	getBuildId() Devuelve el identificador único de la compilación en prueba.
abstract String	getBuildTargetName() Devuelve el nombre completo de la compilación que se está probando.
abstract String	getDeviceSerial()
abstract File	getFile(String name) Método auxiliar para recuperar un archivo con un nombre determinado.
default File	getFile(BuildInfoKey.BuildInfoFileKey key) Método auxiliar para recuperar un archivo con un BuildInfoFileKey determinado.
abstract Collection<VersionedFile>	getFiles() Devuelve todos los VersionedFile almacenados en este BuildInfo.
abstract Set<IBuildInfo.BuildInfoProperties>	getProperties() Devuelve una copia de las propiedades establecidas actualmente en IBuildInfo.
default Set<File>	getRemoteFiles() Obtiene las rutas de acceso a los artefactos de compilación que tienen una descarga retrasada.
abstract String	getTestTag() Devuelve un nombre único para las pruebas que se ejecutan.
default String	getVersion(BuildInfoKey.BuildInfoFileKey key) Método auxiliar para recuperar una versión de archivo con un BuildInfoFileKey determinado.
abstract String	getVersion(String name) Método auxiliar para recuperar una versión de archivo con un nombre determinado.
default VersionedFile	getVersionedFile(BuildInfoKey.BuildInfoFileKey key) Método auxiliar para recuperar un VersionedFile con un BuildInfoFileKey determinado.
default VersionedFile	getVersionedFile(String name) Método de ayuda para recuperar un VersionedFile con un nombre determinado.
default Set<String>	getVersionedFileKeys() Devuelve el conjunto de claves disponibles para consultar VersionedFile a través de getFile(BuildInfoFileKey).
default List<VersionedFile>	getVersionedFiles(BuildInfoKey.BuildInfoFileKey key) Método de ayuda para recuperar una lista de VersionedFiles asociados a un BuildInfoFileKey determinado.
default void	removeBuildAttribute(String attributeName) Quita un atributo attributeName determinado del seguimiento.
abstract void	setBuildBranch(String branch) Cómo establecer la rama de compilación
abstract void	setBuildFlavor(String buildFlavor) Establece la variante de compilación.
abstract void	setBuildId(String buildId) Establece el identificador único de la compilación en prueba.
abstract void	setDeviceSerial(String serial) Establece el número de serie ITestDevice asociado con esta compilación.
default void	setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version) Almacena un archivo determinado un BuildInfoFileKey en esta información de compilación.
abstract void	setFile(String name, File file, String version) Almacena un archivo con el nombre determinado en esta información de compilación.
abstract void	setProperties(BuildInfoProperties... properties) Establece el BuildInfoProperties para la instancia IBuildInfo.
abstract void	setTestTag(String testTag) Establece el nombre único de las pruebas que se ejecutan.
default File	stageRemoteFile(String fileName, File workingDir) Agrega a la etapa de pruebas un archivo que forma parte de los archivos remotos en el directorio raíz de la información de compilación.
default BuildInformation.BuildInfo	toProto() Serializa una instancia de BuildInfo en un protobuf.

Constantes

REMOTE_FILE_PREFIX

public static final String REMOTE_FILE_PREFIX

Prefijo que se usa en el nombre para indicar que el archivo está configurado para descargarse de forma diferida.

Valor constante: "remote_file:"

REMOTE_FILE_VERSION

public static final String REMOTE_FILE_VERSION

El archivo remoto no tiene versiones.

Valor de la constante: ""

UNKNOWN_BUILD_ID

public static final String UNKNOWN_BUILD_ID

Es el valor predeterminado cuando se desconoce el ID de compilación.

Valor de la constante: "-1"

Métodos públicos

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

Agrega el archivo APK local y su versión asociada. Ten en cuenta que los APKs se devolverán desde getAppPackageFiles() en el orden en que se agregaron con este método.

Parámetros
appPackageFile	File
version	String

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

Agrega un atributo de compilación. Esto no permite anular un atributo attributeName existente.

Parámetros
attributeName	String: Es el nombre único del atributo.
attributeValue	String: El valor del atributo

addBuildAttributes

public void addBuildAttributes (Map<String, String> buildAttributes)

Agrega atributos de compilación

Parámetros
buildAttributes	Map: Mapa de los atributos que se agregarán

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

Establece el permiso para permitir la transferencia de archivos remotos a la etapa de pruebas.

Parámetros
stageRemoteFile	boolean

cleanUp

public abstract void cleanUp ()

Limpia los archivos de compilación temporales.

cleanUp

public abstract void cleanUp (List<File> doNotDelete)

Versión de cleanUp() en la que no se borran algunos archivos.

Parámetros
doNotDelete	List

clone

public abstract IBuildInfo clone ()

Clona el objeto IBuildInfo.

Muestra
IBuildInfo

getAppPackageFiles

public List<VersionedFile> getAppPackageFiles ()

Obtiene una copia del conjunto de archivos APK de la app local y sus versiones. El orden devuelto coincide con el orden en que se agregaron los APKs al IAppBuildInfo.

Muestra
List<VersionedFile>

getBuildAttributes

public abstract Map<String, String> getBuildAttributes ()

Obtiene un conjunto de pares nombre-valor de atributos adicionales que describen la compilación.

Muestra
Map<String, String>	Es un Map de atributos de compilación. No será null, pero puede estar vacío.

getBuildBranch

public abstract String getBuildBranch ()

Es un método opcional para devolver la rama de control de origen desde la que se produjo la compilación que se está probando.

Muestra
String	La rama de compilación o null si no se configuró o no corresponde

getBuildFlavor

public abstract String getBuildFlavor ()

Método opcional para devolver el tipo de compilación que se está probando.

Una implementación común para las compilaciones de la plataforma de Android es devolver (producto de compilación)-(SO de compilación)-(variante de compilación). ie generic-linux-userdebug

Muestra
String	La variante de compilación o null si no se establece o no es aplicable

getBuildId

public abstract String getBuildId ()

Devuelve el identificador único de la compilación en prueba. Nunca debe ser nulo. La configuración predeterminada es UNKNOWN_BUILD_ID.

Muestra
String

getBuildTargetName

public abstract String getBuildTargetName ()

Devuelve el nombre completo de la compilación que se está probando.

Una implementación común es construir el nombre del destino de compilación a partir de una combinación de la variante de compilación y el nombre de la rama. [es decir, (nombre de la rama)-(variante de compilación)]

Muestra
String

getDeviceSerial

public abstract String getDeviceSerial ()

Muestra
String	El ITestDevice número de serie en el que se ejecutó esta compilación. Devuelve null si no hay ningún dispositivo asociado a esta compilación.

getFile

public abstract File getFile (String name)

Método auxiliar para recuperar un archivo con un nombre determinado.

Muestra
File	El archivo de imagen o null si no se encuentra

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

Método auxiliar para recuperar un archivo con un BuildInfoFileKey determinado.

Parámetros
key	BuildInfoKey.BuildInfoFileKey: Es el BuildInfoFileKey que se solicita.

Muestra
File	El archivo de imagen o null si no se encuentra

getFiles

public abstract Collection<VersionedFile> getFiles ()

Devuelve todos los VersionedFile almacenados en este BuildInfo.

Muestra
Collection<VersionedFile>

getProperties

public abstract Set<IBuildInfo.BuildInfoProperties> getProperties ()

Devuelve una copia de las propiedades establecidas actualmente en IBuildInfo.

Muestra
Set<IBuildInfo.BuildInfoProperties>

getRemoteFiles

public Set<File> getRemoteFiles ()

Obtiene las rutas de acceso a los artefactos de compilación que tienen una descarga retrasada.

Muestra
Set<File>

getTestTag

public abstract String getTestTag ()

Devuelve un nombre único para las pruebas que se ejecutan.

Muestra
String

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

Método auxiliar para recuperar una versión de archivo con un BuildInfoFileKey determinado.

Parámetros
key	BuildInfoKey.BuildInfoFileKey: Es el BuildInfoFileKey solicitado.

Muestra
String	La versión de la imagen o null si no se encuentra

getVersion

public abstract String getVersion (String name)

Método auxiliar para recuperar una versión de archivo con un nombre determinado.

Muestra
String	La versión de la imagen o null si no se encuentra

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

Método auxiliar para recuperar un VersionedFile con un BuildInfoFileKey determinado.

Parámetros
key	BuildInfoKey.BuildInfoFileKey: Es el BuildInfoFileKey solicitado.

Muestra
VersionedFile	El archivo versionado o null si no se encuentra

getVersionedFile

public VersionedFile getVersionedFile (String name)

Método de ayuda para recuperar un VersionedFile con un nombre determinado.

Muestra
VersionedFile	El archivo versionado o null si no se encuentra

getVersionedFileKeys

public Set<String> getVersionedFileKeys ()

Devuelve el conjunto de claves disponibles para consultar VersionedFile a través de getFile(BuildInfoFileKey).

Muestra
Set<String>

getVersionedFiles

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

Método de ayuda para recuperar una lista de VersionedFiles asociados a un BuildInfoFileKey determinado. Si la clave permite almacenar una lista.

Parámetros
key	BuildInfoKey.BuildInfoFileKey: Es el BuildInfoFileKey solicitado.

Muestra
List<VersionedFile>	El archivo versionado o null si no se encuentra

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

Quita un atributo attributeName determinado del seguimiento.

Parámetros
attributeName	String: Es el atributo del que se dejará de hacer un seguimiento.

setBuildBranch

public abstract void setBuildBranch (String branch)

Cómo establecer la rama de compilación

Parámetros
branch	String: El nombre de la rama

setBuildFlavor

public abstract void setBuildFlavor (String buildFlavor)

Establece la variante de compilación.

setBuildId

public abstract void setBuildId (String buildId)

Establece el identificador único de la compilación en prueba. Nunca debe ser nulo.

Parámetros
buildId	String

setDeviceSerial

public abstract void setDeviceSerial (String serial)

Establece el número de serie ITestDevice asociado con esta compilación.

Parámetros
serial	String: Es el número de serie del ITestDevice con el que se ejecutó esta compilación.

setFile

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

Almacena un archivo determinado un BuildInfoFileKey en esta información de compilación.

Parámetros
key	BuildInfoKey.BuildInfoFileKey: Es el nombre único del archivo basado en BuildInfoFileKey.
file	File: El File local
version	String: La versión del archivo

setFile

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

Almacena un archivo con el nombre determinado en esta información de compilación.

Parámetros
name	String: El nombre único del archivo
file	File: El File local
version	String: La versión del archivo

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

Establece el BuildInfoProperties para la instancia IBuildInfo. Anula cualquier propiedad existente establecida anteriormente.

Parámetros
properties	BuildInfoProperties: Es la lista de propiedades que se agregarán.

setTestTag

public abstract void setTestTag (String testTag)

Establece el nombre único de las pruebas que se ejecutan.

Parámetros
testTag	String

stageRemoteFile

public File stageRemoteFile (String fileName, 
                File workingDir)

Agrega a la etapa de pruebas un archivo que forma parte de los archivos remotos en el directorio raíz de la información de compilación.

TODO(b/138416078): Quita esta interfaz y su llamador cuando los módulos requeridos por una prueba se puedan compilar correctamente en el directorio del módulo de prueba.

Parámetros
fileName	String: Nombre del archivo que se ubicará en los archivos remotos.
workingDir	File: Es un objeto File del directorio en el que se almacenará el archivo.

Muestra
File	Es el objeto File del archivo que se preparó en workingDir local.

toProto

public BuildInformation.BuildInfo toProto ()

Serializa una instancia de BuildInfo en un protobuf.

Muestra
BuildInformation.BuildInfo