IBuildInfo

public interface IBuildInfo

com.android.tradefed.build.IBuildInfo

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

Resumen

Constantes

String REMOTE_FILE_PREFIX

Es el prefijo que se usa en el nombre para indicar que el archivo se configurará para retrasar la descarga.

String REMOTE_FILE_VERSION

El archivo remoto no tiene control de 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( buildAttributes)

Cómo agregar atributos de compilación

default void allowStagingRemoteFile(boolean stageRemoteFile)

Establece el permiso para permitir la etapa de preparación de archivos remotos.

abstract void cleanUp()

Limpia los archivos de compilación temporales.

abstract void cleanUp( doNotDelete)

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

abstract IBuildInfo clone()

Clona el objeto IBuildInfo.

default getAppPackageFiles()

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

abstract getBuildAttributes()

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

abstract String getBuildBranch()

Es un método opcional para mostrar la rama del control de código fuente de la que se produjo la compilación que se está probando.

abstract String getBuildFlavor()

Es un método opcional para mostrar el tipo de compilación que se está probando.

abstract String getBuildId()

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

abstract String getBuildTargetName()

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

abstract String getDeviceSerial()
abstract File getFile(String name)

Es un método auxiliar para recuperar un archivo con un nombre determinado.

default File getFile(BuildInfoKey.BuildInfoFileKey key)

Es un método auxiliar para recuperar un archivo con un BuildInfoFileKey determinado.

abstract getFiles()

Muestra todos los VersionedFile almacenados en este BuildInfo.

abstract getProperties()

Devuelve una copia de las propiedades configuradas actualmente en IBuildInfo.

default getRemoteFiles()

Obtén las rutas de acceso de los artefactos de compilación cuya descarga se retrasa.

abstract String getTestTag()

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

default String getVersion(BuildInfoKey.BuildInfoFileKey key)

Es un 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 getVersionedFileKeys()

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

default getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)

Método de ayuda para recuperar una lista de VersionedFile asociadas con un BuildInfoFileKey determinado.

default void removeBuildAttribute(String attributeName)

Quita un atributo de seguimiento determinado.

abstract void setBuildBranch(String branch)

Cómo configurar la rama de compilación

abstract void setBuildFlavor(String buildFlavor)

Establece el tipo 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.

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

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

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

Almacena un archivo con un BuildInfoFileKey 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)

Prepara un archivo que forme parte de los archivos remotos en el directorio raíz de la información de compilación.

default BuildInformation.BuildInfo toProto()

Serializa la instancia de BuildInfo en un protobuf.

Constantes

REMOTE_FILE_PREFIX

public static final String REMOTE_FILE_PREFIX

Es el prefijo que se usa en el nombre para indicar que el archivo se configurará para retrasar la descarga.

Valor constante: "remote_file:"

REMOTE_FILE_VERSION

public static final String REMOTE_FILE_VERSION

El archivo remoto no tiene control de versiones.

Valor constante: ""

UNKNOWN_BUILD_ID

public static final String UNKNOWN_BUILD_ID

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

Valor 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 mostrará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 de nombre existente.

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

addBuildAttributes

public void addBuildAttributes ( buildAttributes)

Cómo agregar atributos de compilación

Parámetros
buildAttributes : Es el mapa de los atributos que se agregarán.

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

Establece el permiso para permitir la etapa de preparación de archivos remotos.

Parámetros
stageRemoteFile boolean

cleanUp

public abstract void cleanUp ()

Limpia los archivos de compilación temporales.

cleanUp

public abstract void cleanUp ( doNotDelete)

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

Parámetros
doNotDelete

clonar

public abstract IBuildInfo clone ()

Clona el objeto IBuildInfo.

Muestra
IBuildInfo

getAppPackageFiles

public  getAppPackageFiles ()

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

Muestra

getBuildAttributes

public abstract  getBuildAttributes ()

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

Muestra
un ERROR(/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 mostrar la rama del control de código fuente de la que se produjo la compilación que se está probando.

Muestra
String la rama de compilación o null si no se establece o no corresponde

getBuildFlavor

public abstract String getBuildFlavor ()

Es un método opcional para mostrar el tipo de compilación que se está probando.

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

Muestra
String El tipo de compilación o null si no se establece o no es aplicable

getBuildId

public abstract String getBuildId ()

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

Muestra 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)-(sabor de compilación)]

Muestra
String

getDeviceSerial

public abstract String getDeviceSerial ()

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

getFile

public abstract File getFile (String name)

Es un 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)

Es un 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  getFiles ()

Muestra todos los VersionedFile almacenados en este BuildInfo.

Muestra

getProperties

public abstract  getProperties ()

Devuelve una copia de las propiedades configuradas actualmente en IBuildInfo.

Muestra

getRemoteFiles

public  getRemoteFiles ()

Obtén las rutas de acceso de los artefactos de compilación cuya descarga se retrasa.

Muestra

getTestTag

public abstract String getTestTag ()

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

Muestra
String

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

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

Parámetros
key BuildInfoKey.BuildInfoFileKey: 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: El BuildInfoFileKey solicitado.
Muestra
VersionedFile El archivo con control de versiones 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 con control de versiones o null si no se encuentra

getVersionedFileKeys

public  getVersionedFileKeys ()

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

Muestra

getVersionedFiles

public  getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

Método de ayuda para recuperar una lista de VersionedFile asociadas con un BuildInfoFileKey determinado. Si la clave permite almacenar una lista.

Parámetros
key BuildInfoKey.BuildInfoFileKey: El BuildInfoFileKey solicitado.
Muestra
El archivo con control de versiones o null si no se encuentra

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

Quita un atributo de seguimiento determinado.

Parámetros
attributeName String: Es el atributo para el que se detendrá el seguimiento.

setBuildBranch

public abstract void setBuildBranch (String branch)

Cómo configurar la rama de compilación

Parámetros
branch String: El nombre de la rama

setBuildFlavor

public abstract void setBuildFlavor (String buildFlavor)

Establece el tipo 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 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 ERROR(/File) local
version String: Es la versión del archivo.

setFile

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

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

Parámetros
key BuildInfoKey.BuildInfoFileKey: El nombre único del archivo basado en BuildInfoFileKey.
file File: El ERROR(/File) local
version String: Es la versión del archivo.

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

Establece el BuildInfoProperties para la instancia IBuildInfo. Anula las propiedades existentes que se hayan configurado antes.

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)

Prepara un archivo que forme 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 que requiere una prueba se puedan compilar correctamente en el directorio del módulo de prueba.

Parámetros
fileName String: Es el nombre del archivo que se ubicará en los archivos remotos.
workingDir File: Es un objeto ERROR(/File) del directorio para preparar el archivo.
Muestra
File el objeto ERROR(/File) del archivo preparado en workingDir local

toProto

public BuildInformation.BuildInfo toProto ()

Serializa la instancia de BuildInfo en un protobuf.

Muestra
BuildInformation.BuildInfo