BuildInfo

public class BuildInfo
extends Object implements IBuildInfo

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

Es la implementación genérica de un IBuildInfo que se debe asociar con un ITestDevice.

Resumen

Constructores públicos

BuildInfo()

Crea un BuildInfo con valores de atributos predeterminados.

BuildInfo(String buildId, String buildTargetName)

Crea un BuildInfo.

Métodos públicos

void addAppPackageFile(File appPackageFile, String version)

Agrega el archivo APK local y su versión asociada.

void addBuildAttribute(String attributeName, String attributeValue)

Agrega un atributo de compilación.

void addBuildAttributes(Map<String, String> buildAttributes)

Agrega atributos de compilación

void allowStagingRemoteFile(boolean stageRemoteFile)

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

void cleanUp()

Limpia los archivos de compilación temporales.

void cleanUp(List<File> doNotClean)

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

IBuildInfo clone()

final void copyAllFileFrom(BuildInfo build)

Copia todos los VersionedFile de una compilación determinada a esta.

boolean equals(Object obj)

static IBuildInfo fromProto(BuildInformation.BuildInfo protoBuild)

Operación inversa a toProto() para recuperar la instancia.

List<VersionedFile> getAppPackageFiles()

Obtiene una copia del conjunto de archivos APK de la app local y sus versiones.

Map<String, String> getBuildAttributes()

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

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.

String getBuildFlavor()

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

String getBuildId()

Devuelve el identificador único de la compilación en prueba.

String getBuildTargetName()

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

String getDeviceSerial()

File getFile(String name)

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

File getFile(BuildInfoKey.BuildInfoFileKey key)

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

Collection<VersionedFile> getFiles()

Devuelve todos los VersionedFile almacenados en este BuildInfo.

Set<IBuildInfo.BuildInfoProperties> getProperties()

Devuelve una copia de las propiedades establecidas actualmente en IBuildInfo.

Set<File> getRemoteFiles()

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

String getTestTag()

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

String getVersion(BuildInfoKey.BuildInfoFileKey key)

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

String getVersion(String name)

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

VersionedFile getVersionedFile(BuildInfoKey.BuildInfoFileKey key)

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

final VersionedFile getVersionedFile(String name)

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

Set<String> getVersionedFileKeys()

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

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

Método de ayuda para recuperar una lista de VersionedFiles asociados a un BuildInfoFileKey determinado.

int hashCode()

void removeBuildAttribute(String attributeName)

Quita un atributo attributeName determinado del seguimiento.

void setBuildBranch(String branch)

Cómo establecer la rama de compilación

void setBuildFlavor(String buildFlavor)

Establece la variante de compilación.

void setBuildId(String buildId)

Establece el identificador único de la compilación en prueba.

void setDeviceSerial(String serial)

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

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

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

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

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

void setProperties(BuildInfoProperties... properties)

Establece el BuildInfoProperties para la instancia IBuildInfo.

void setTestTag(String testTag)

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

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.

BuildInformation.BuildInfo toProto()

Serializa una instancia de BuildInfo en un protobuf.

String toString()

Métodos protegidos

void addAllBuildAttributes(BuildInfo build)

Método auxiliar para copiar atributos de compilación, rama y variante de otra compilación.

void addAllFiles(BuildInfo build)

Método auxiliar para copiar todos los archivos de la otra compilación.

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

Permite aplicar algunos de los IBuildInfo.BuildInfoProperties y, posiblemente, realizar un control diferente.

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

Constructores públicos

BuildInfo

public BuildInfo ()

Crea un BuildInfo con valores de atributos predeterminados.

BuildInfo

public BuildInfo (String buildId, 
                String buildTargetName)

Crea un BuildInfo.

Parámetros
buildId String: ID de compilación
buildTargetName String: El nombre del destino de compilación

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

Limpia los archivos de compilación temporales.

cleanUp

public void cleanUp (List<File> doNotClean)

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

Parámetros
doNotClean List

clone

public IBuildInfo clone ()

Muestra
IBuildInfo

copyAllFileFrom

public final void copyAllFileFrom (BuildInfo build)

Copia todos los VersionedFile de una compilación determinada a esta.

Parámetros
build BuildInfo

es igual a

public boolean equals (Object obj)

Parámetros
obj Object

Muestra
boolean

fromProto

public static IBuildInfo fromProto (BuildInformation.BuildInfo protoBuild)

Operación inversa a toProto() para recuperar la instancia.

Parámetros
protoBuild BuildInformation.BuildInfo

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

Muestra
String

getFile

public 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 Collection<VersionedFile> getFiles ()

Devuelve todos los VersionedFile almacenados en este BuildInfo.

Muestra
Collection<VersionedFile>

getProperties

public 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 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 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 final 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 final 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

hashCode

public int hashCode ()

Muestra
int

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 void setBuildBranch (String branch)

Cómo establecer la rama de compilación

Parámetros
branch String: El nombre de la rama

setBuildFlavor

public void setBuildFlavor (String buildFlavor)

Establece la variante de compilación.

setBuildId

public void setBuildId (String buildId)

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

Parámetros
buildId String

setDeviceSerial

public 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 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 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 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

toString

public String toString ()

Muestra
String

Métodos protegidos

addAllBuildAttributes

protected void addAllBuildAttributes (BuildInfo build)

Método auxiliar para copiar atributos de compilación, rama y variante de otra compilación.

Parámetros
build BuildInfo

addAllFiles

protected void addAllFiles (BuildInfo build)

Método auxiliar para copiar todos los archivos de la otra compilación.

Crea vínculos físicos nuevos a los archivos para que cada compilación tenga una ruta de acceso única al archivo.

Parámetros
build BuildInfo

Arroja
IOException Si se arroja una excepción cuando se crea la vinculación física.

applyBuildProperties

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

Permite aplicar algunos de los IBuildInfo.BuildInfoProperties y, posiblemente, realizar un control diferente.

Parámetros
origFileConsidered VersionedFile: Es el VersionedFile que se está viendo actualmente.
build IBuildInfo: Es la compilación original que se clona.
receiver IBuildInfo: Es la compilación que recibe la información.
Muestra
boolean Es verdadero si aplicamos las propiedades y se debe omitir el procesamiento adicional. De lo contrario, es falso.

getAttributesMultiMap

protected MultiMap<String, String> getAttributesMultiMap ()

Muestra
MultiMap<String, String>

getVersionedFileMap

protected Map<String, VersionedFile> getVersionedFileMap ()

Muestra
Map<String, VersionedFile>

getVersionedFileMapFull

protected MultiMap<String, VersionedFile> getVersionedFileMapFull ()

Muestra
MultiMap<String, VersionedFile>