IBuildInfo
public
interface
IBuildInfo
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 de 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(
Adicionar atributos de build |
default
void
|
allowStagingRemoteFile(boolean stageRemoteFile)
Define a permissão para permitir a preparação de arquivos remotos. |
abstract
void
|
cleanUp()
Limpar todos os arquivos de build temporários |
abstract
void
|
cleanUp(
Versão de |
abstract
IBuildInfo
|
clone()
Clona o objeto |
default
|
getAppPackageFiles()
Recebe uma cópia do conjunto de arquivos APK do app local e das versões deles. |
abstract
|
getBuildAttributes()
Receba 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 de controle de origem em 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 |
abstract
|
getFiles()
Retorna todos os |
abstract
|
getProperties()
Retorna uma cópia das propriedades definidas no |
default
|
getRemoteFiles()
Receba os caminhos para artefatos de build que são de 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 |
abstract
String
|
getVersion(String name)
Método auxiliar para recuperar uma versão de arquivo com o nome fornecido. |
default
VersionedFile
|
getVersionedFile(BuildInfoKey.BuildInfoFileKey key)
Método auxiliar para extrair um |
default
VersionedFile
|
getVersionedFile(String name)
Método auxiliar para extrair um |
default
|
getVersionedFileKeys()
Retorna o conjunto de chaves disponível para consultar |
default
|
getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)
Método auxiliar para recuperar uma lista de |
default
void
|
removeBuildAttribute(String attributeName)
Remove um determinado attributeName do rastreamento. |
abstract
void
|
setBuildBranch(String branch)
Definir a ramificação do build |
abstract
void
|
setBuildFlavor(String buildFlavor)
Defina o sabor do 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 |
abstract
void
|
setFile(String name, File file, String version)
Armazena um arquivo com o nome fornecido nessas informações de build. |
default
void
|
setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version)
Armazena um arquivo com um |
abstract
void
|
setProperties(BuildInfoProperties... properties)
Defina o |
abstract
void
|
setTestTag(String testTag)
Define o nome exclusivo dos testes que estão sendo executados. |
default
File
|
stageRemoteFile(String fileName, File workingDir)
Colocar um arquivo que faz parte de arquivos remotos no diretório raiz das informações de build em estágio. |
default
BuildInformation.BuildInfo
|
toProto()
Serializa a instância do 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á configurado 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 de 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 attributeName existente.
Parâmetros | |
---|---|
attributeName |
String : o nome do atributo exclusivo |
attributeValue |
String : o valor do atributo |
addBuildAttributes
public void addBuildAttributes (buildAttributes)
Adicionar atributos de build
Parâmetros | |
---|---|
buildAttributes |
: mapeamento de atributos a serem adicionados |
allowStagingRemoteFile
public void allowStagingRemoteFile (boolean stageRemoteFile)
Define a permissão para permitir a preparação de arquivos remotos.
Parâmetros | |
---|---|
stageRemoteFile |
boolean |
cleanUp
public abstract void cleanUp ()
Limpar todos os arquivos de build temporários
cleanUp
public abstract void cleanUp (doNotDelete)
Versão de cleanUp()
em que alguns arquivos não são excluídos.
Parâmetros | |
---|---|
doNotDelete |
|
getAppPackageFiles
publicgetAppPackageFiles ()
Recebe uma cópia do conjunto de arquivos APK do app local e das versões deles. A ordem retornada
corresponde à ordem em que os APKs foram adicionados ao IAppBuildInfo
.
Retorna | |
---|---|
|
getBuildAttributes
public abstractgetBuildAttributes ()
Receba um conjunto de pares de nome-valor de atributos adicionais que descrevem o build.
Retorna | |
---|---|
|
um ERROR(/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 de controle de origem em que o build testado foi produzido.
Retorna | |
---|---|
String |
o branch de build ou null , se não definido/não 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 (build product)-(build os)-(build variant). ie generic-linux-userdebug
Retorna | |
---|---|
String |
o tipo de build ou null , se não definido/não 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 é criar o nome do destino de build a partir de uma combinação do sabor do build e do nome do branch. [por exemplo, (nome da ramificação)-(variação de build)]
Retorna | |
---|---|
String |
getDeviceSerial
public abstract String getDeviceSerial ()
Retorna | |
---|---|
String |
o número de série ITestDevice em que este build foi executado. Retorna null
se nenhum dispositivo estiver associado a esse 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
fornecido.
Parâmetros | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : o BuildInfoFileKey solicitado. |
Retorna | |
---|---|
File |
o arquivo de imagem ou null se não for encontrado |
getFiles
public abstractgetFiles ()
Retorna todos os VersionedFile
s armazenados neste BuildInfo
.
Retorna | |
---|---|
|
getProperties
public abstractgetProperties ()
Retorna uma cópia das propriedades definidas no IBuildInfo
.
Retorna | |
---|---|
|
getRemoteFiles
publicgetRemoteFiles ()
Receba os caminhos para artefatos de build que são de download atrasado.
Retorna | |
---|---|
|
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 BuildInfoFileKey
fornecido.
Parâmetros | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : o BuildInfoFileKey solicitado. |
Retorna | |
---|---|
String |
a versão da 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 fornecido.
Retorna | |
---|---|
String |
a versão da imagem ou null se não for encontrada |
getVersionedFile
public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)
Método auxiliar para extrair um VersionedFile
com um BuildInfoFileKey
específico.
Parâmetros | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : o BuildInfoFileKey solicitado. |
Retorna | |
---|---|
VersionedFile |
O arquivo com versão ou null , se não 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 encontrado |
getVersionedFileKeys
publicgetVersionedFileKeys ()
Retorna o conjunto de chaves disponível para consultar VersionedFile
usando getFile(BuildInfoFileKey)
.
Retorna | |
---|---|
|
getVersionedFiles
publicgetVersionedFiles (BuildInfoKey.BuildInfoFileKey key)
Método auxiliar para recuperar uma lista de VersionedFile
s associadas a uma determinada BuildInfoFileKey
. Se a chave permite armazenar uma lista.
Parâmetros | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : o BuildInfoFileKey solicitado. |
Retorna | |
---|---|
|
O arquivo com versão ou null , se não 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 do build
Parâmetros | |
---|---|
branch |
String : o nome da ramificação |
setBuildFlavor
public abstract void setBuildFlavor (String buildFlavor)
Defina o sabor do 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 o build foi executado. |
setFile
public abstract void setFile (String name, File file, String version)
Armazena um arquivo com o nome fornecido nessas informações de build.
Parâmetros | |
---|---|
name |
String : o nome exclusivo do arquivo |
file |
File : o ERROR(/File) local |
version |
String : a versão do arquivo |
setFile
public void setFile (BuildInfoKey.BuildInfoFileKey key, File file, String version)
Armazena um arquivo com um BuildInfoFileKey
nessas informações de build.
Parâmetros | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : o nome exclusivo do arquivo baseado em BuildInfoFileKey . |
file |
File : o ERROR(/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 todas
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 que estão sendo executados.
Parâmetros | |
---|---|
testTag |
String |
stageRemoteFile
public File stageRemoteFile (String fileName, File workingDir)
Colocar um arquivo que faz parte de arquivos remotos no diretório raiz das informações de build em estágio.
Tarefa a fazer(b/138416078): remova essa interface e o chamador dela quando os módulos exigidos por um teste puderem ser criados corretamente no diretório do próprio módulo de teste.
Parâmetros | |
---|---|
fileName |
String : nome do arquivo que será localizado em arquivos remotos. |
workingDir |
File : um objeto ERROR(/File) do diretório para preparar o arquivo. |
Retorna | |
---|---|
File |
o objeto ERROR(/File) do arquivo preparado no workingDir local. |
toProto
public BuildInformation.BuildInfo toProto ()
Serializa a instância do BuildInfo em um protobuf.
Retorna | |
---|---|
BuildInformation.BuildInfo |