IBuildInfo

public interface IBuildInfo
implements Serializable

com.android.tradefed.build.IBuildInfo


Contient des informations sur la version en cours de test.

Résumé

Constantes

String REMOTE_FILE_PREFIX

Préfixe utilisé dans le nom pour indiquer que le fichier est défini sur le téléchargement différé.

String REMOTE_FILE_VERSION

Le fichier distant n'est pas versionné.

String UNKNOWN_BUILD_ID

Valeur par défaut lorsque l'ID de compilation est inconnu.

Méthodes publiques

default void addAppPackageFile(File appPackageFile, String version)

Ajoute le fichier APK local et la version associée.

abstract void addBuildAttribute(String attributeName, String attributeValue)

Ajoutez un attribut de compilation.

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

Ajouter des attributs de build

default void allowStagingRemoteFile(boolean stageRemoteFile)

Définit l'autorisation permettant de transférer des fichiers distants.

abstract void cleanUp()

Nettoyez les fichiers de compilation temporaires.

abstract void cleanUp(List<File> doNotDelete)

Version de cleanUp() dans laquelle certains fichiers ne sont pas supprimés.

abstract IBuildInfo clone()

Clone l'objet IBuildInfo.

default List<VersionedFile> getAppPackageFiles()

Obtient une copie de l'ensemble des fichiers APK de l'application locale et de leurs versions.

abstract Map<String, String> getBuildAttributes()

Obtenez un ensemble de paires nom/valeur d'attributs supplémentaires décrivant la compilation.

abstract String getBuildBranch()

Méthode facultative permettant de renvoyer la branche du contrôle du code source à partir de laquelle la compilation testée a été produite.

abstract String getBuildFlavor()

Méthode facultative permettant de renvoyer le type de compilation testé.

abstract String getBuildId()

Renvoie l'identifiant unique du build en cours de test.

abstract String getBuildTargetName()

Renvoie le nom complet de la version testée.

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

Méthode d'assistance pour récupérer un fichier avec un nom donné.

default File getFile(BuildInfoKey.BuildInfoFileKey key)

Méthode d'assistance permettant de récupérer un fichier avec un BuildInfoFileKey donné.

abstract Collection<VersionedFile> getFiles()

Renvoie tous les VersionedFile stockés dans ce BuildInfo.

abstract Set<IBuildInfo.BuildInfoProperties> getProperties()

Renvoie une copie des propriétés actuellement définies sur IBuildInfo.

default Set<File> getRemoteFiles()

Obtenez les chemins d'accès aux artefacts de compilation dont le téléchargement est différé.

abstract String getTestTag()

Renvoie un nom unique pour les tests en cours d'exécution.

default String getVersion(BuildInfoKey.BuildInfoFileKey key)

Méthode d'assistance permettant de récupérer une version de fichier avec un BuildInfoFileKey donné.

abstract String getVersion(String name)

Méthode d'assistance permettant de récupérer une version de fichier avec un nom donné.

default VersionedFile getVersionedFile(BuildInfoKey.BuildInfoFileKey key)

Méthode d'assistance pour récupérer un VersionedFile avec un BuildInfoFileKey donné.

default VersionedFile getVersionedFile(String name)

Méthode d'assistance pour récupérer un VersionedFile avec un nom donné.

default Set<String> getVersionedFileKeys()

Renvoie l'ensemble des clés disponibles pour interroger VersionedFile via getFile(BuildInfoFileKey).

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

Méthode d'assistance permettant de récupérer une liste de VersionedFile associés à un BuildInfoFileKey donné.

default void removeBuildAttribute(String attributeName)

Supprime un attributName donné du suivi.

abstract void setBuildBranch(String branch)

Définir la branche de compilation

abstract void setBuildFlavor(String buildFlavor)

Définissez le type de compilation.

abstract void setBuildId(String buildId)

Définit l'identifiant unique du build en cours de test.

abstract void setDeviceSerial(String serial)

Définissez le numéro de série ITestDevice associé à cette compilation.

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

Stocke un fichier en fonction d'un BuildInfoFileKey dans ces informations de compilation.

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

Stocke un fichier portant le nom indiqué dans ces informations de compilation.

abstract void setProperties(BuildInfoProperties... properties)

Définissez BuildInfoProperties pour l'instance IBuildInfo.

abstract void setTestTag(String testTag)

Définit le nom unique des tests en cours d'exécution.

default File stageRemoteFile(String fileName, File workingDir)

Mettez en scène un fichier qui fait partie des fichiers distants dans le répertoire racine des informations de compilation.

default BuildInformation.BuildInfo toProto()

Sérialisez l'instance BuildInfo dans un fichier protobuf.

Constantes

REMOTE_FILE_PREFIX

public static final String REMOTE_FILE_PREFIX

Préfixe utilisé dans le nom pour indiquer que le fichier est défini sur le téléchargement différé.

Valeur de constante : "remote_file:"

REMOTE_FILE_VERSION

public static final String REMOTE_FILE_VERSION

Le fichier distant n'est pas versionné.

Valeur constante : ""

UNKNOWN_BUILD_ID

public static final String UNKNOWN_BUILD_ID

Valeur par défaut lorsque l'ID de compilation est inconnu.

Valeur constante : "-1"

Méthodes publiques

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

Ajoute le fichier APK local et la version associée. Notez que les APK seront renvoyés à partir de getAppPackageFiles() dans l'ordre dans lequel ils ont été ajoutés par cette méthode.

Paramètres
appPackageFile File

version String

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

Ajoutez un attribut de compilation. Cela ne permet pas de remplacer un attributName existant.

Paramètres
attributeName String : nom unique de l'attribut

attributeValue String : valeur de l'attribut

addBuildAttributes

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

Ajouter des attributs de build

Paramètres
buildAttributes Map : mappage des attributs à ajouter

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

Définit l'autorisation permettant de transférer des fichiers distants.

Paramètres
stageRemoteFile boolean

cleanUp

public abstract void cleanUp ()

Nettoyez les fichiers de compilation temporaires.

cleanUp

public abstract void cleanUp (List<File> doNotDelete)

Version de cleanUp() dans laquelle certains fichiers ne sont pas supprimés.

Paramètres
doNotDelete List

clone

public abstract IBuildInfo clone ()

Clone l'objet IBuildInfo.

Renvoie
IBuildInfo

getAppPackageFiles

public List<VersionedFile> getAppPackageFiles ()

Obtient une copie de l'ensemble des fichiers APK de l'application locale et de leurs versions. L'ordre renvoyé correspond à l'ordre dans lequel les APK ont été ajoutés à IAppBuildInfo.

Renvoie
List<VersionedFile>

getBuildAttributes

public abstract Map<String, String> getBuildAttributes ()

Obtenez un ensemble de paires nom/valeur d'attributs supplémentaires décrivant la compilation.

Renvoie
Map<String, String> un Map d'attributs de compilation. Ne sera pas null, mais peut être vide.

getBuildBranch

public abstract String getBuildBranch ()

Méthode facultative permettant de renvoyer la branche du contrôle du code source à partir de laquelle la compilation testée a été produite.

Renvoie
String la branche de compilation ou null si elle n'est pas définie/applicable.

getBuildFlavor

public abstract String getBuildFlavor ()

Méthode facultative permettant de renvoyer le type de compilation testé.

Une implémentation courante pour les compilations de plate-forme Android consiste à renvoyer (produit de compilation)-(OS de compilation)-(variante de compilation). ie generic-linux-userdebug

Renvoie
String la variante de compilation ou null si elle n'est pas définie/applicable.

getBuildId

public abstract String getBuildId ()

Renvoie l'identifiant unique du build en cours de test. Ne doit jamais être nul. La valeur par défaut est UNKNOWN_BUILD_ID.

Renvoie
String

getBuildTargetName

public abstract String getBuildTargetName ()

Renvoie le nom complet de la version testée.

Une implémentation courante consiste à construire le nom de la cible de compilation à partir d'une combinaison du nom de la branche et de la saveur de compilation. [ie (nom de branche)-(saveur de compilation)]

Renvoie
String

getDeviceSerial

public abstract String getDeviceSerial ()

Renvoie
String Numéro de série ITestDevice sur lequel cette compilation a été exécutée. Renvoie null si aucun appareil n'est associé à cette version.

getFile

public abstract File getFile (String name)

Méthode d'assistance pour récupérer un fichier avec un nom donné.

Renvoie
File le fichier image ou null s'il est introuvable.

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

Méthode d'assistance permettant de récupérer un fichier avec un BuildInfoFileKey donné.

Paramètres
key BuildInfoKey.BuildInfoFileKey : BuildInfoFileKey demandé.

Renvoie
File le fichier image ou null s'il est introuvable.

getFiles

public abstract Collection<VersionedFile> getFiles ()

Renvoie tous les VersionedFile stockés dans ce BuildInfo.

Renvoie
Collection<VersionedFile>

getProperties

public abstract Set<IBuildInfo.BuildInfoProperties> getProperties ()

Renvoie une copie des propriétés actuellement définies sur IBuildInfo.

Renvoie
Set<IBuildInfo.BuildInfoProperties>

getRemoteFiles

public Set<File> getRemoteFiles ()

Obtenez les chemins d'accès aux artefacts de compilation dont le téléchargement est différé.

Renvoie
Set<File>

getTestTag

public abstract String getTestTag ()

Renvoie un nom unique pour les tests en cours d'exécution.

Renvoie
String

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

Méthode d'assistance permettant de récupérer une version de fichier avec un BuildInfoFileKey donné.

Paramètres
key BuildInfoKey.BuildInfoFileKey : BuildInfoFileKey demandé.

Renvoie
String Version de l'image ou null si elle est introuvable

getVersion

public abstract String getVersion (String name)

Méthode d'assistance permettant de récupérer une version de fichier avec un nom donné.

Renvoie
String Version de l'image ou null si elle est introuvable

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

Méthode d'assistance pour récupérer un VersionedFile avec un BuildInfoFileKey donné.

Paramètres
key BuildInfoKey.BuildInfoFileKey : BuildInfoFileKey demandé.

Renvoie
VersionedFile Fichier versionné ou null si introuvable

getVersionedFile

public VersionedFile getVersionedFile (String name)

Méthode d'assistance pour récupérer un VersionedFile avec un nom donné.

Renvoie
VersionedFile Fichier versionné ou null si introuvable

getVersionedFileKeys

public Set<String> getVersionedFileKeys ()

Renvoie l'ensemble des clés disponibles pour interroger VersionedFile via getFile(BuildInfoFileKey).

Renvoie
Set<String>

getVersionedFiles

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

Méthode d'assistance permettant de récupérer une liste de VersionedFile associés à un BuildInfoFileKey donné. Si la clé permet de stocker une liste.

Paramètres
key BuildInfoKey.BuildInfoFileKey : BuildInfoFileKey demandé.

Renvoie
List<VersionedFile> Fichier versionné ou null si introuvable

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

Supprime un attributName donné du suivi.

Paramètres
attributeName String : attribut à ne plus suivre

setBuildBranch

public abstract void setBuildBranch (String branch)

Définir la branche de compilation

Paramètres
branch String : nom de l'agence

setBuildFlavor

public abstract void setBuildFlavor (String buildFlavor)

Définissez le type de compilation.

setBuildId

public abstract void setBuildId (String buildId)

Définit l'identifiant unique du build en cours de test. Ne doit jamais être nul.

Paramètres
buildId String

setDeviceSerial

public abstract void setDeviceSerial (String serial)

Définissez le numéro de série ITestDevice associé à cette compilation.

Paramètres
serial String : numéro de série du ITestDevice avec lequel cette compilation a été exécutée.

setFile

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

Stocke un fichier en fonction d'un BuildInfoFileKey dans ces informations de compilation.

Paramètres
key BuildInfoKey.BuildInfoFileKey : nom unique du fichier basé sur BuildInfoFileKey.

file File : File local

version String : version du fichier

setFile

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

Stocke un fichier portant le nom indiqué dans ces informations de compilation.

Paramètres
name String : nom unique du fichier

file File : File local

version String : version du fichier

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

Définissez BuildInfoProperties pour l'instance IBuildInfo. Remplacez les propriétés existantes définies précédemment.

Paramètres
properties BuildInfoProperties : liste des propriétés à ajouter.

setTestTag

public abstract void setTestTag (String testTag)

Définit le nom unique des tests en cours d'exécution.

Paramètres
testTag String

stageRemoteFile

public File stageRemoteFile (String fileName, 
                File workingDir)

Mettez en scène un fichier qui fait partie des fichiers distants dans le répertoire racine des informations de compilation.

TODO(b/138416078) : Supprimez cette interface et son appelant lorsque les modules requis par un test peuvent être correctement compilés dans le répertoire du module de test lui-même.

Paramètres
fileName String : nom du fichier à localiser dans les fichiers distants.

workingDir File : objet File du répertoire dans lequel le fichier doit être transféré.

Renvoie
File Objet File du fichier mis en scène dans le répertoire de travail local.

toProto

public BuildInformation.BuildInfo toProto ()

Sérialisez l'instance BuildInfo dans un fichier protobuf.

Renvoie
BuildInformation.BuildInfo