BuildInfo

public class BuildInfo
extends Object implements IBuildInfo

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

Implémentation générique d'un IBuildInfo qui doit être associé à un ITestDevice.

Résumé

Constructeurs publics

BuildInfo()

Crée un BuildInfo à l'aide des valeurs d'attribut par défaut.

BuildInfo(String buildId, String buildTargetName)

Crée un BuildInfo.

Méthodes publiques

void addAppPackageFile(File appPackageFile, String version)

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

void addBuildAttribute(String attributeName, String attributeValue)

Ajoutez un attribut de compilation.

void addBuildAttributes(Map<String, String> buildAttributes)

Ajouter des attributs de build

void allowStagingRemoteFile(boolean stageRemoteFile)

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

void cleanUp()

Nettoyez les fichiers de compilation temporaires.

void cleanUp(List<File> doNotClean)

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

IBuildInfo clone()

final void copyAllFileFrom(BuildInfo build)

Copiez tous les VersionedFile d'une version donnée vers celle-ci.

boolean equals(Object obj)

static IBuildInfo fromProto(BuildInformation.BuildInfo protoBuild)

Opération inverse de toProto() pour récupérer l'instance.

List<VersionedFile> getAppPackageFiles()

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

Map<String, String> getBuildAttributes()

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

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.

String getBuildFlavor()

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

String getBuildId()

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

String getBuildTargetName()

Renvoie le nom complet de la version testée.

String getDeviceSerial()

File getFile(String name)

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

File getFile(BuildInfoKey.BuildInfoFileKey key)

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

Collection<VersionedFile> getFiles()

Renvoie tous les VersionedFile stockés dans ce BuildInfo.

Set<IBuildInfo.BuildInfoProperties> getProperties()

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

Set<File> getRemoteFiles()

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

String getTestTag()

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

String getVersion(BuildInfoKey.BuildInfoFileKey key)

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

String getVersion(String name)

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

VersionedFile getVersionedFile(BuildInfoKey.BuildInfoFileKey key)

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

final VersionedFile getVersionedFile(String name)

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

Set<String> getVersionedFileKeys()

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

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

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

int hashCode()

void removeBuildAttribute(String attributeName)

Supprime un attributName donné du suivi.

void setBuildBranch(String branch)

Définir la branche de compilation

void setBuildFlavor(String buildFlavor)

Définissez le type de compilation.

void setBuildId(String buildId)

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

void setDeviceSerial(String serial)

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

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

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

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

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

void setProperties(BuildInfoProperties... properties)

Définissez BuildInfoProperties pour l'instance IBuildInfo.

void setTestTag(String testTag)

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

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.

BuildInformation.BuildInfo toProto()

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

String toString()

Méthodes protégées

void addAllBuildAttributes(BuildInfo build)

Méthode d'assistance permettant de copier les attributs de compilation, la branche et la saveur d'une autre compilation.

void addAllFiles(BuildInfo build)

Méthode d'assistance permettant de copier tous les fichiers de l'autre build.

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

Permet d'appliquer certains IBuildInfo.BuildInfoProperties et éventuellement d'effectuer un traitement différent.

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

Constructeurs publics

BuildInfo

public BuildInfo ()

Crée un BuildInfo à l'aide des valeurs d'attribut par défaut.

BuildInfo

public BuildInfo (String buildId, 
                String buildTargetName)

Crée un BuildInfo.

Paramètres
buildId String : ID de la compilation
buildTargetName String : nom de la cible de compilation

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

Nettoyez les fichiers de compilation temporaires.

cleanUp

public void cleanUp (List<File> doNotClean)

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

Paramètres
doNotClean List

clone

public IBuildInfo clone ()

Renvoie
IBuildInfo

copyAllFileFrom

public final void copyAllFileFrom (BuildInfo build)

Copiez tous les VersionedFile d'une version donnée vers celle-ci.

Paramètres
build BuildInfo

est égal à

public boolean equals (Object obj)

Paramètres
obj Object

Renvoie
boolean

fromProto

public static IBuildInfo fromProto (BuildInformation.BuildInfo protoBuild)

Opération inverse de toProto() pour récupérer l'instance.

Paramètres
protoBuild BuildInformation.BuildInfo

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

Renvoie
String

getFile

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

Renvoie tous les VersionedFile stockés dans ce BuildInfo.

Renvoie
Collection<VersionedFile>

getProperties

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

hashCode

public int hashCode ()

Renvoie
int

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

Supprime un attributName donné du suivi.

Paramètres
attributeName String : attribut à ne plus suivre

setBuildBranch

public void setBuildBranch (String branch)

Définir la branche de compilation

Paramètres
branch String : nom de l'agence

setBuildFlavor

public void setBuildFlavor (String buildFlavor)

Définissez le type de compilation.

setBuildId

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

toString

public String toString ()

Renvoie
String

Méthodes protégées

addAllBuildAttributes

protected void addAllBuildAttributes (BuildInfo build)

Méthode d'assistance pour copier les attributs de compilation, la branche et la saveur à partir d'une autre compilation.

Paramètres
build BuildInfo

addAllFiles

protected void addAllFiles (BuildInfo build)

Méthode d'assistance permettant de copier tous les fichiers de l'autre build.

Crée des liens physiques vers les fichiers afin que chaque build dispose d'un chemin d'accès unique au fichier.

Paramètres
build BuildInfo

Génère
IOException si une exception est générée lors de la création du lien physique.

applyBuildProperties

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

Permet d'appliquer certains IBuildInfo.BuildInfoProperties et éventuellement d'effectuer un traitement différent.

Paramètres
origFileConsidered VersionedFile : VersionedFile actuellement consulté.
build IBuildInfo : build d'origine en cours de clonage
receiver IBuildInfo : compilation recevant les informations.
Renvoie
boolean True si nous avons appliqué les propriétés et que le traitement ultérieur doit être ignoré. False otherwise.

getAttributesMultiMap

protected MultiMap<String, String> getAttributesMultiMap ()

Renvoie
MultiMap<String, String>

getVersionedFileMap

protected Map<String, VersionedFile> getVersionedFileMap ()

Renvoie
Map<String, VersionedFile>

getVersionedFileMapFull

protected MultiMap<String, VersionedFile> getVersionedFileMapFull ()

Renvoie
MultiMap<String, VersionedFile>