IBuildInfo
public
interface
IBuildInfo
com.android.tradefed.build.IBuildInfo |
Contient des informations sur le build en cours de test.
Résumé
Constantes | |
---|---|
String |
REMOTE_FILE_PREFIX
Préfixe utilisé dans le nom pour indiquer que le téléchargement du fichier est retardé. |
String |
REMOTE_FILE_VERSION
Le fichier distant n'est pas versionné. |
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(
Ajouter des attributs de compilation |
default
void
|
allowStagingRemoteFile(boolean stageRemoteFile)
Définit l'autorisation permettant de mettre en scène des fichiers distants. |
abstract
void
|
cleanUp()
Nettoyer les fichiers de compilation temporaires |
abstract
void
|
cleanUp(
Version de |
abstract
IBuildInfo
|
clone()
Clone l'objet |
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 le build. |
abstract
String
|
getBuildBranch()
Méthode facultative permettant de renvoyer la branche de contrôle source à partir de laquelle le build testé a été créé. |
abstract
String
|
getBuildFlavor()
Méthode facultative permettant de renvoyer le type de compilation en cours de test. |
abstract
String
|
getBuildId()
Renvoie l'identifiant unique du build en cours de test. |
abstract
String
|
getBuildTargetName()
Renvoie le nom complet du build en cours de test. |
abstract
String
|
getDeviceSerial()
|
abstract
File
|
getFile(String name)
Méthode d'assistance permettant de 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 |
abstract
|
getFiles()
Renvoie tous les |
abstract
|
getProperties()
Renvoie une copie des propriétés actuellement définies sur |
default
|
getRemoteFiles()
Obtenez les chemins d'accès des artefacts de compilation dont le téléchargement est retardé. |
abstract
String
|
getTestTag()
Renvoie un nom unique pour les tests exécutés. |
default
String
|
getVersion(BuildInfoKey.BuildInfoFileKey key)
Méthode d'assistance permettant de récupérer une version de fichier avec un |
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 permettant de récupérer un |
default
VersionedFile
|
getVersionedFile(String name)
Méthode d'assistance permettant de récupérer un |
default
|
getVersionedFileKeys()
Renvoie l'ensemble des clés disponibles pour interroger |
default
|
getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)
Méthode d'assistance permettant de récupérer une liste de |
default
void
|
removeBuildAttribute(String attributeName)
Supprimez un 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 du build en cours de test. |
abstract
void
|
setDeviceSerial(String serial)
Définissez le numéro de série |
abstract
void
|
setFile(String name, File file, String version)
Stocke un fichier avec le nom donné dans ces informations de compilation. |
default
void
|
setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version)
Stocke un fichier donné un |
abstract
void
|
setProperties(BuildInfoProperties... properties)
Définissez |
abstract
void
|
setTestTag(String testTag)
Définit le nom unique des tests exécutés. |
default
File
|
stageRemoteFile(String fileName, File workingDir)
Mettez en scène un fichier qui fait partie de fichiers distants dans le répertoire racine des informations de compilation. |
default
BuildInformation.BuildInfo
|
toProto()
Sérialisez l'instance BuildInfo dans un 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 retardé.
Valeur de constante : "remote_file:"
REMOTE_FILE_VERSION
public static final String REMOTE_FILE_VERSION
Le fichier distant n'est pas versionné.
Valeur de la constante : ""
UNKNOWN_BUILD_ID
public static final String UNKNOWN_BUILD_ID
Valeur par défaut lorsque l'ID de build est inconnu.
Valeur de la 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 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 attributeName existant.
Paramètres | |
---|---|
attributeName |
String : nom unique de l'attribut |
attributeValue |
String : valeur de l'attribut |
addBuildAttributes
public void addBuildAttributes (buildAttributes)
Ajouter des attributs de compilation
Paramètres | |
---|---|
buildAttributes |
: mappage des attributs à ajouter |
allowStagingRemoteFile
public void allowStagingRemoteFile (boolean stageRemoteFile)
Définit l'autorisation permettant de mettre en scène des fichiers distants.
Paramètres | |
---|---|
stageRemoteFile |
boolean |
cleanUp
public abstract void cleanUp ()
Nettoyer les fichiers de compilation temporaires
cleanUp
public abstract void cleanUp (doNotDelete)
Version de cleanUp()
dans laquelle certains fichiers ne sont pas supprimés.
Paramètres | |
---|---|
doNotDelete |
|
getAppPackageFiles
publicgetAppPackageFiles ()
Récupère une copie de l'ensemble des fichiers APK d'application locaux et de leurs versions. L'ordre renvoyé correspond à l'ordre dans lequel les APK ont été ajoutés à IAppBuildInfo
.
Renvoie | |
---|---|
|
getBuildAttributes
public abstractgetBuildAttributes ()
Obtenez un ensemble de paires nom-valeur d'attributs supplémentaires décrivant le build.
Renvoie | |
---|---|
|
un ERROR(/Map) d'attributs de compilation. Ne doit pas être null , mais peut être vide. |
getBuildBranch
public abstract String getBuildBranch ()
Méthode facultative permettant de renvoyer la branche de contrôle source à partir de laquelle le build testé a été créé.
Renvoie | |
---|---|
String |
la branche de compilation ou null si non défini/non applicable |
getBuildFlavor
public abstract String getBuildFlavor ()
Méthode facultative permettant de renvoyer le type de compilation en cours de test.
Une implémentation courante pour les builds de la plate-forme Android consiste à renvoyer (build product)-(build os)-(build variant). ie generic-linux-userdebug
Renvoie | |
---|---|
String |
la saveur de compilation ou null si elle n'est pas définie ou n'est pas applicable |
getBuildId
public abstract String getBuildId ()
Renvoie l'identifiant unique du build en cours de test. Ne doit jamais être "null". La valeur par défaut est UNKNOWN_BUILD_ID
.
Renvoie | |
---|---|
String |
getBuildTargetName
public abstract String getBuildTargetName ()
Renvoie le nom complet du build en cours de test.
Une implémentation courante consiste à créer le nom de la cible de compilation à partir d'une combinaison de la saveur de compilation et du nom de la branche. [ie (nom de la 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é à ce build. |
getFile
public abstract File getFile (String name)
Méthode d'assistance permettant de récupérer un fichier avec un nom donné.
Renvoie | |
---|---|
File |
le fichier image ou null si celui-ci 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 si celui-ci est introuvable |
getFiles
public abstractgetFiles ()
Renvoie tous les VersionedFile
stockés dans cet objet BuildInfo
.
Renvoie | |
---|---|
|
getProperties
public abstractgetProperties ()
Renvoie une copie des propriétés actuellement définies sur IBuildInfo
.
Renvoie | |
---|---|
|
getRemoteFiles
publicgetRemoteFiles ()
Obtenez les chemins d'accès des artefacts de compilation dont le téléchargement est retardé.
Renvoie | |
---|---|
|
getTestTag
public abstract String getTestTag ()
Renvoie un nom unique pour les tests exécutés.
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 |
la 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 |
la version de l'image ou null si elle est introuvable |
getVersionedFile
public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)
Méthode d'assistance permettant de récupérer un VersionedFile
avec un BuildInfoFileKey
donné.
Paramètres | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : BuildInfoFileKey demandé. |
Renvoie | |
---|---|
VersionedFile |
Le fichier versionné ou null , le cas échéant |
getVersionedFile
public VersionedFile getVersionedFile (String name)
Méthode d'assistance permettant de récupérer un VersionedFile
avec un nom donné.
Renvoie | |
---|---|
VersionedFile |
Le fichier versionné ou null , le cas échéant |
getVersionedFileKeys
publicgetVersionedFileKeys ()
Renvoie l'ensemble des clés disponibles pour interroger VersionedFile
via getFile(BuildInfoFileKey)
.
Renvoie | |
---|---|
|
getVersionedFiles
publicgetVersionedFiles (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 | |
---|---|
|
Le fichier versionné ou null , le cas échéant |
removeBuildAttribute
public void removeBuildAttribute (String attributeName)
Supprimez un attributeName donné du suivi.
Paramètres | |
---|---|
attributeName |
String : attribut à arrêter de 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 "null".
Paramètres | |
---|---|
buildId |
String |
setDeviceSerial
public abstract void setDeviceSerial (String serial)
Définissez le numéro de série ITestDevice
associé à ce build.
Paramètres | |
---|---|
serial |
String : numéro de série de l'ITestDevice avec lequel cette compilation a été exécutée. |
setFile
public abstract void setFile (String name, File file, String version)
Stocke un fichier avec le nom donné dans ces informations de compilation.
Paramètres | |
---|---|
name |
String : nom unique du fichier |
file |
File : ERROR(/File) local |
version |
String : version du fichier |
setFile
public void setFile (BuildInfoKey.BuildInfoFileKey key, File file, String version)
Stocke un fichier donné un BuildInfoFileKey
dans ces informations de compilation.
Paramètres | |
---|---|
key |
BuildInfoKey.BuildInfoFileKey : nom unique du fichier basé sur BuildInfoFileKey . |
file |
File : ERROR(/File) local |
version |
String : version du fichier |
setProperties
public abstract void setProperties (BuildInfoProperties... properties)
Définissez BuildInfoProperties
pour l'instance IBuildInfo
. Remplacez toutes 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 exécutés.
Paramètres | |
---|---|
testTag |
String |
stageRemoteFile
public File stageRemoteFile (String fileName, File workingDir)
Mettez en scène un fichier qui fait partie de fichiers distants dans le répertoire racine des informations de compilation.
À FAIRE(b/138416078): Supprimez cette interface et son appelant lorsque les modules requis par un test peuvent être correctement compilés et exportés vers le répertoire du module de test lui-même.
Paramètres | |
---|---|
fileName |
String : nom du fichier à rechercher dans les fichiers distants. |
workingDir |
File : objet ERROR(/File) du répertoire à mettre en scène. |
Renvoie | |
---|---|
File |
l'objet ERROR(/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 protobuf.
Renvoie | |
---|---|
BuildInformation.BuildInfo |