IBuildInfo

public interface IBuildInfo
implements Serializable

com.android.tradefed.build.IBuildInfo


Contém informações sobre o build em teste.

Resumo

Constantes

String REMOTE_FILE_PREFIX

Prefixo usado no nome para indicar que o arquivo está definido para download atrasado.

String REMOTE_FILE_VERSION

O arquivo remoto não tem versão.

String UNKNOWN_BUILD_ID

Valor padrão quando o ID da build é desconhecido.

Métodos públicos

default void addAppPackageFile(File appPackageFile, String version)

Adiciona o arquivo APK local e a versão associada.

abstract void addBuildAttribute(String attributeName, String attributeValue)

Adicione um atributo de build.

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

Adicionar atributos de build

default void allowStagingRemoteFile(boolean stageRemoteFile)

Define a permissão para permitir arquivos remotos de staging.

abstract void cleanUp()

Limpe todos os arquivos de build temporários

abstract void cleanUp(List<File> doNotDelete)

Versão de cleanUp() em que alguns arquivos não são excluídos.

abstract IBuildInfo clone()

Clona o objeto IBuildInfo.

default List<VersionedFile> getAppPackageFiles()

Recebe uma cópia do conjunto de arquivos APK de apps locais e das versões deles.

abstract Map<String, String> getBuildAttributes()

Recebe um conjunto de pares de nome-valor de atributos adicionais que descrevem o build.

abstract String getBuildBranch()

Método opcional para retornar a ramificação do controle de origem de que o build testado foi produzido.

abstract String getBuildFlavor()

Método opcional para retornar o tipo de build que está sendo testado.

abstract String getBuildId()

Retorna o identificador exclusivo do build em teste.

abstract String getBuildTargetName()

Retorna o nome completo do build que está sendo testado.

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

Método auxiliar para recuperar um arquivo com o nome especificado.

default File getFile(BuildInfoKey.BuildInfoFileKey key)

Método auxiliar para recuperar um arquivo com um BuildInfoFileKey específico.

abstract Collection<VersionedFile> getFiles()

Retorna todos os VersionedFiles armazenados neste BuildInfo.

abstract Set<IBuildInfo.BuildInfoProperties> getProperties()

Retorna uma cópia das propriedades definidas no IBuildInfo.

default Set<File> getRemoteFiles()

Recebe os caminhos para artefatos de build que têm download atrasado.

abstract String getTestTag()

Retorna um nome exclusivo para os testes em execução.

default String getVersion(BuildInfoKey.BuildInfoFileKey key)

Método auxiliar para recuperar uma versão de arquivo com um determinado BuildInfoFileKey.

abstract String getVersion(String name)

Método auxiliar para recuperar uma versão de arquivo com o nome especificado.

default VersionedFile getVersionedFile(BuildInfoKey.BuildInfoFileKey key)

Método auxiliar para extrair um VersionedFile com um determinado BuildInfoFileKey.

default VersionedFile getVersionedFile(String name)

Método auxiliar para extrair um VersionedFile com um nome específico.

default Set<String> getVersionedFileKeys()

Retorna o conjunto de chaves disponíveis para consultar VersionedFile usando getFile(BuildInfoFileKey).

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

Método auxiliar para recuperar uma lista de VersionedFiles associados a um determinado BuildInfoFileKey.

default void removeBuildAttribute(String attributeName)

Remove um determinado attributeName do rastreamento.

abstract void setBuildBranch(String branch)

Definir a ramificação de build

abstract void setBuildFlavor(String buildFlavor)

Defina a variação de build.

abstract void setBuildId(String buildId)

Define o identificador exclusivo do build em teste.

abstract void setDeviceSerial(String serial)

Defina o número de série ITestDevice associado a este build.

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

Armazena um arquivo usando um BuildInfoFileKey nessas informações de build.

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

Armazena um arquivo com o nome especificado nessas informações de build.

abstract void setProperties(BuildInfoProperties... properties)

Defina o BuildInfoProperties para a instância IBuildInfo.

abstract void setTestTag(String testTag)

Define o nome exclusivo dos testes em execução.

default File stageRemoteFile(String fileName, File workingDir)

Adicione um arquivo que faz parte de arquivos remotos no diretório raiz das informações de build.

default BuildInformation.BuildInfo toProto()

Serializa a instância BuildInfo em um protobuf.

Constantes

REMOTE_FILE_PREFIX

public static final String REMOTE_FILE_PREFIX

Prefixo usado no nome para indicar que o arquivo está definido para download atrasado.

Valor da constante: "remote_file:"

REMOTE_FILE_VERSION

public static final String REMOTE_FILE_VERSION

O arquivo remoto não tem versão.

Valor da constante: ""

UNKNOWN_BUILD_ID

public static final String UNKNOWN_BUILD_ID

Valor padrão quando o ID da build é desconhecido.

Valor da constante: "-1"

Métodos públicos

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

Adiciona o arquivo APK local e a versão associada. Os APKs serão retornados de getAppPackageFiles() na ordem em que foram adicionados por esse método.

Parâmetros
appPackageFile File

version String

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

Adicione um atributo de build. Isso não permite substituir um atributo existente.

Parâmetros
attributeName String: o nome do atributo exclusivo

attributeValue String: o valor do atributo

addBuildAttributes

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

Adicionar atributos de build

Parâmetros
buildAttributes Map: mapa de atributos a serem adicionados

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

Define a permissão para permitir arquivos remotos de staging.

Parâmetros
stageRemoteFile boolean

cleanUp

public abstract void cleanUp ()

Limpe todos os arquivos de build temporários

cleanUp

public abstract void cleanUp (List<File> doNotDelete)

Versão de cleanUp() em que alguns arquivos não são excluídos.

Parâmetros
doNotDelete List

clone

public abstract IBuildInfo clone ()

Clona o objeto IBuildInfo.

Retorna
IBuildInfo

getAppPackageFiles

public List<VersionedFile> getAppPackageFiles ()

Recebe uma cópia do conjunto de arquivos APK de apps locais e das versões deles. A ordem retornada corresponde à ordem em que os APKs foram adicionados ao IAppBuildInfo.

Retorna
List<VersionedFile>

getBuildAttributes

public abstract Map<String, String> getBuildAttributes ()

Recebe um conjunto de pares de nome-valor de atributos adicionais que descrevem o build.

Retorna
Map<String, String> um Map de atributos de build. Não será null, mas poderá estar vazio.

getBuildBranch

public abstract String getBuildBranch ()

Método opcional para retornar a ramificação do controle de origem de que o build testado foi produzido.

Retorna
String o branch de build ou null se não estiver definido/não for aplicável

getBuildFlavor

public abstract String getBuildFlavor ()

Método opcional para retornar o tipo de build que está sendo testado.

Uma implementação comum para builds da plataforma Android é retornar (produto de build)-(SO de build)-(variante de build). ie generic-linux-userdebug

Retorna
String o sabor do build ou null se não estiver definido/não for aplicável

getBuildId

public abstract String getBuildId ()

Retorna o identificador exclusivo do build em teste. Nunca pode ser nulo. O valor padrão é UNKNOWN_BUILD_ID.

Retorna
String

getBuildTargetName

public abstract String getBuildTargetName ()

Retorna o nome completo do build que está sendo testado.

Uma implementação comum é construir o nome da meta de build com uma combinação da variação de build e do nome do branch. [ie (nome da ramificação)-(sabor do build)]

Retorna
String

getDeviceSerial

public abstract String getDeviceSerial ()

Retorna
String o número de série ITestDevice em que o build foi executado. Retorna null se nenhum dispositivo estiver associado a este build.

getFile

public abstract File getFile (String name)

Método auxiliar para recuperar um arquivo com o nome especificado.

Retorna
File o arquivo de imagem ou null se não for encontrado

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

Método auxiliar para recuperar um arquivo com um BuildInfoFileKey específico.

Parâmetros
key BuildInfoKey.BuildInfoFileKey: o BuildInfoFileKey solicitado.

Retorna
File o arquivo de imagem ou null se não for encontrado

getFiles

public abstract Collection<VersionedFile> getFiles ()

Retorna todos os VersionedFiles armazenados neste BuildInfo.

Retorna
Collection<VersionedFile>

getProperties

public abstract Set<IBuildInfo.BuildInfoProperties> getProperties ()

Retorna uma cópia das propriedades definidas no IBuildInfo.

Retorna
Set<IBuildInfo.BuildInfoProperties>

getRemoteFiles

public Set<File> getRemoteFiles ()

Recebe os caminhos para artefatos de build que têm download atrasado.

Retorna
Set<File>

getTestTag

public abstract String getTestTag ()

Retorna um nome exclusivo para os testes em execução.

Retorna
String

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

Método auxiliar para recuperar uma versão de arquivo com um determinado BuildInfoFileKey.

Parâmetros
key BuildInfoKey.BuildInfoFileKey: o BuildInfoFileKey solicitado.

Retorna
String a versão de imagem ou null se não for encontrada

getVersion

public abstract String getVersion (String name)

Método auxiliar para recuperar uma versão de arquivo com o nome especificado.

Retorna
String a versão de imagem ou null se não for encontrada

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

Método auxiliar para extrair um VersionedFile com um determinado BuildInfoFileKey.

Parâmetros
key BuildInfoKey.BuildInfoFileKey: o BuildInfoFileKey solicitado.

Retorna
VersionedFile O arquivo com versão ou null, se não for encontrado

getVersionedFile

public VersionedFile getVersionedFile (String name)

Método auxiliar para extrair um VersionedFile com um nome específico.

Retorna
VersionedFile O arquivo com versão ou null, se não for encontrado

getVersionedFileKeys

public Set<String> getVersionedFileKeys ()

Retorna o conjunto de chaves disponíveis para consultar VersionedFile usando getFile(BuildInfoFileKey).

Retorna
Set<String>

getVersionedFiles

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

Método auxiliar para recuperar uma lista de VersionedFiles associados a um determinado BuildInfoFileKey. Se a chave permitir armazenar uma lista.

Parâmetros
key BuildInfoKey.BuildInfoFileKey: o BuildInfoFileKey solicitado.

Retorna
List<VersionedFile> O arquivo com versão ou null, se não for encontrado

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

Remove um determinado attributeName do rastreamento.

Parâmetros
attributeName String: o atributo a ser interrompido

setBuildBranch

public abstract void setBuildBranch (String branch)

Definir a ramificação de build

Parâmetros
branch String: o nome da ramificação

setBuildFlavor

public abstract void setBuildFlavor (String buildFlavor)

Defina a variação de build.

setBuildId

public abstract void setBuildId (String buildId)

Define o identificador exclusivo do build em teste. Nunca pode ser nulo.

Parâmetros
buildId String

setDeviceSerial

public abstract void setDeviceSerial (String serial)

Defina o número de série ITestDevice associado a este build.

Parâmetros
serial String: o número de série do ITestDevice com que esta build foi executada.

setFile

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

Armazena um arquivo usando um BuildInfoFileKey nessas informações de build.

Parâmetros
key BuildInfoKey.BuildInfoFileKey: o nome exclusivo do arquivo com base em BuildInfoFileKey.

file File: o File local

version String: a versão do arquivo

setFile

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

Armazena um arquivo com o nome especificado nessas informações de build.

Parâmetros
name String: o nome exclusivo do arquivo.

file File: o File local

version String: a versão do arquivo

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

Defina o BuildInfoProperties para a instância IBuildInfo. Substitua as propriedades definidas anteriormente.

Parâmetros
properties BuildInfoProperties: a lista de propriedades a serem adicionadas.

setTestTag

public abstract void setTestTag (String testTag)

Define o nome exclusivo dos testes em execução.

Parâmetros
testTag String

stageRemoteFile

public File stageRemoteFile (String fileName, 
                File workingDir)

Adicione um arquivo que faz parte de arquivos remotos no diretório raiz das informações de build.

TODO(b/138416078): remover essa interface e o caller dela quando os módulos exigidos por um teste puderem ser criados corretamente no próprio diretório do módulo de teste.

Parâmetros
fileName String: nome do arquivo a ser localizado em arquivos remotos.

workingDir File: um objeto File do diretório para armazenar o arquivo temporariamente.

Retorna
File o objeto File do arquivo armazenado em workingDir local.

toProto

public BuildInformation.BuildInfo toProto ()

Serializa a instância BuildInfo em um protobuf.

Retorna
BuildInformation.BuildInfo