Informations sur la compilation

public interface IBuildInfo

com.android.tradefed.build.IBuildInfo

Contient des informations sur la compilation testée.

Résumé

Constantes

String REMOTE_FILE_PREFIX

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

String REMOTE_FILE_VERSION

Le fichier distant ne possède pas de version.

String UNKNOWN_BUILD_ID

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

Méthodes publiques

default void addAppPackageFile(File appPackageFile, String version)

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

abstract void addBuildAttribute(String attributeName, String attributeValue)

Ajoutez un attribut de compilation.

default void addBuildAttributes( buildAttributes)

Ajouter des attributs de compilation

default void allowStagingRemoteFile(boolean stageRemoteFile)

Définit l'autorisation d'autoriser la préproduction des fichiers distants.

abstract void cleanUp()

Nettoyez tous les fichiers de compilation temporaires

abstract void cleanUp( doNotDelete)

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

abstract IBuildInfo clone()

Il clone l'objet IBuildInfo.

default getAppPackageFiles()

Récupère une copie de l'ensemble des fichiers APK d'application locaux et de leurs versions.

abstract getBuildAttributes()

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

abstract String getBuildBranch()

Méthode facultative pour renvoyer la branche de contrôle du code source avec laquelle la compilation en cours de test a été à partir duquel elles sont produites.

abstract String getBuildFlavor()

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

abstract String getBuildId()

Renvoie l'identifiant unique de la compilation testée.

abstract String getBuildTargetName()

Renvoyez le nom complet de la compilation en cours de test.

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

Méthode d'assistance permettant de récupérer un fichier portant le nom donné.

default File getFile(BuildInfoKey.BuildInfoFileKey key)

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

abstract getFiles()

Renvoie toutes les VersionedFile stockées dans ce BuildInfo.

abstract getProperties()

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

default getRemoteFiles()

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

abstract String getTestTag()

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

default String getVersion(BuildInfoKey.BuildInfoFileKey key)

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

abstract String getVersion(String name)

Méthode d'assistance pour récupérer une version de fichier portant le 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 getVersionedFileKeys()

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

default getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)

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

default void removeBuildAttribute(String attributeName)

Supprimez un attribut "attributeName" 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 de la compilation testée.

abstract void setDeviceSerial(String serial)

Définissez le série ITestDevice associé à ce build.

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

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

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

Stocke un fichier associé à un BuildInfoFileKey dans ces informations de compilation.

abstract void setProperties(BuildInfoProperties... properties)

Définissez le paramètre 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)

Préparez un fichier faisant partie de fichiers distants dans le répertoire racine des informations de compilation.

default BuildInformation.BuildInfo toProto()

Sérialiser une instance BuildInfo en protobuf

Constantes

REMOTE_FILE_PREFIX

public static final String REMOTE_FILE_PREFIX

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

Valeur constante: "remote_file:"

REMOTE_FILE_VERSION

public static final String REMOTE_FILE_VERSION

Le fichier distant ne possède pas de version.

Valeur constante: « »

ID_DÉVELOPPEMENT INCONNU

public static final String UNKNOWN_BUILD_ID

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

Valeur constante: "-1"

Méthodes publiques

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

Ajoute le fichier APK local et sa version associée. Notez que les APK sont renvoyés depuis 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. Cette règle ne permet pas de remplacer un nom d'attribut existant.

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

addBuildAttributes

public void addBuildAttributes ( buildAttributes)

Ajouter des attributs de compilation

Paramètres
buildAttributes : carte des attributs à ajouter.

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

Définit l'autorisation d'autoriser la préproduction des fichiers distants.

Paramètres
stageRemoteFile boolean

nettoyage

public abstract void cleanUp ()

Nettoyez tous les fichiers de compilation temporaires

nettoyage

public abstract void cleanUp ( doNotDelete)

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

Paramètres
doNotDelete

cloner

public abstract IBuildInfo clone ()

Il clone l'objet IBuildInfo.

Renvoie
IBuildInfo

getAppPackageFiles

public  getAppPackageFiles ()

Récupère une copie de l'ensemble des fichiers APK d'application locaux et de leurs versions. La commande retournée correspond à l'ordre dans lequel les APK ont été ajoutés à IAppBuildInfo.

Renvoie

getBuildAttributes

public abstract  getBuildAttributes ()

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

Renvoie
Une ERROR(/Map) d'attributs de compilation. Ne correspond pas à null, mais peut être vide.

getBuildBranch

public abstract String getBuildBranch ()

Méthode facultative pour renvoyer la branche de contrôle du code source avec laquelle la compilation en cours de test a été à partir duquel elles sont produites.

Renvoie
String Branche de compilation ou null s'il n'est pas défini/non applicable

getBuildFlavor

public abstract String getBuildFlavor ()

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

Une implémentation courante pour les builds de plate-forme Android consiste à renvoyer (build produit)-(build os)-(version de compilation). Exemple d'application générique : linux-userdebug

Renvoie
String Type de compilation ou null s'il n'est pas défini/non applicable

getBuildId

public abstract String getBuildId ()

Renvoie l'identifiant unique de la compilation testée. Ne doit jamais être nulle. La valeur par défaut est UNKNOWN_BUILD_ID.

Renvoie
String

getBuildTargetName

public abstract String getBuildTargetName ()

Renvoyez le nom complet de la compilation en cours de test.

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

Renvoie
String

getDeviceSerial

public abstract String getDeviceSerial ()

Renvoie
String série ITestDevice sur laquelle cette compilation a été exécutée. Renvoie null si aucun appareil n'est associé à ce build.

getFile

public abstract File getFile (String name)

Méthode d'assistance permettant de récupérer un fichier portant le nom donné.

Renvoie
File Le fichier image ou null s'il est introuvable

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

Méthode d'assistance pour 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  getFiles ()

Renvoie toutes les VersionedFile stockées dans ce BuildInfo.

Renvoie

getProperties

public abstract  getProperties ()

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

Renvoie

getRemoteFiles

public  getRemoteFiles ()

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

Renvoie

getTestTag

public abstract String getTestTag ()

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

Renvoie
String

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

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

Paramètres
key BuildInfoKey.BuildInfoFileKey: BuildInfoFileKey demandé.
Renvoie
String la version de l'image ou null si elle est introuvable.

getVersion

public abstract String getVersion (String name)

Méthode d'assistance pour récupérer une version de fichier portant le nom donné.

Renvoie
String la 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 avec gestion des versions ou null s'il est introuvable

getVersionedFile

public VersionedFile getVersionedFile (String name)

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

Renvoie
VersionedFile Fichier avec gestion des versions ou null s'il est introuvable

getVersionedFileKeys

public  getVersionedFileKeys ()

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

Renvoie

getVersionedFiles

public  getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

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

Paramètres
key BuildInfoKey.BuildInfoFileKey: BuildInfoFileKey demandé.
Renvoie
Fichier avec gestion des versions ou null s'il est introuvable

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

Supprimez un attribut "attributeName" donné du suivi.

Paramètres
attributeName String: attribut permettant d'arrêter le suivi

setBuildBranch

public abstract void setBuildBranch (String branch)

Définir la branche de compilation

Paramètres
branch String: nom de la branche

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 de la compilation testée. Ne doit jamais être nulle.

Paramètres
buildId String

setDeviceSerial

public abstract void setDeviceSerial (String serial)

Définissez le série ITestDevice associé à ce build.

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

Définir un fichier

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

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

Paramètres
name String: nom unique du fichier
file File: ERROR(/File) locale
version String: version du fichier

Définir un fichier

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

Stocke un fichier associé à un BuildInfoFileKey dans ces informations de compilation.

Paramètres
key BuildInfoKey.BuildInfoFileKey: nom unique du fichier basé sur BuildInfoFileKey.
file File: ERROR(/File) locale
version String: version du fichier

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

Définissez le paramètre BuildInfoProperties pour l'instance IBuildInfo. Remplacer au choix les propriétés existantes.

Paramètres
properties BuildInfoProperties: liste des établissements à ajouter.

setTestTag

public abstract void setTestTag (String testTag)

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

Paramètres
testTag String

imageRemoteFile

public File stageRemoteFile (String fileName, 
                File workingDir)

Préparez un fichier faisant partie de fichiers distants dans le répertoire racine des informations de compilation.

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

Paramètres
fileName String: nom du fichier qui se trouvera dans les fichiers distants.
workingDir File: objet ERROR(/File) du répertoire dans lequel placer le fichier.
Renvoie
File L'objet ERROR(/File) du fichier stocké dans le workDir local.

toProto

public BuildInformation.BuildInfo toProto ()

Sérialiser une instance BuildInfo en protobuf

Renvoie
BuildInformation.BuildInfo