BugreportCollector

public class BugreportCollector
extends Object implements ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.BugreportCollector

---

ITestInvocationListener de passthrough qui collecte les rapports de bugs lorsque des événements configurables se produisent, puis appelle ITestInvocationListener.testLog sur ses enfants après chaque rapport de bug collecté.

Comportements: (FIXME: terminer cette section)

• Capturer après chaque échec de test
• Capturer après chaque test
• Capturer après chaque test de cas ayant échoué
• Filmez

Résumé

Classes imbriquées
class	BugreportCollector.Predicate Prédicat complet décrivant quand capturer un rapport de bug.
interface	BugreportCollector.SubPredicate

Champs
public static final BugreportCollector.Predicate	AFTER_FAILED_TESTCASES Prédicat prédéfini qui se déclenche après chaque échec de test
public static final BugreportCollector.Predicate	AT_START Prédicat prédéfini qui se déclenche au début de la première invocation

Constructeurs publics
BugreportCollector(ITestInvocationListener listener, ITestDevice testDevice)

Méthodes publiques
void	addPredicate(BugreportCollector.Predicate p)
void	blockUntilIdle() Bloquer jusqu'à ce que le collecteur ne collecte plus de rapports de bugs.
TestSummary	getSummary() Permet à InvocationListener de renvoyer un récapitulatif.
void	invocationEnded(long elapsedTime) Indique que l'appel a pris fin, que ce soit avec succès ou en raison d'une condition d'erreur.
void	invocationFailed(Throwable cause) Signale une invocation incomplète en raison d'une condition d'erreur.
void	invocationStarted(IInvocationContext context) Indique le début de l'appel du test.
void	setAsynchronous(boolean asynchronous) Définissez si la collecte du rapport de bug doit le collecter dans un autre thread (asynchronous = true) ou bloquer l'appelant jusqu'à ce que le rapport de bug soit capturé (asynchronous = false).
void	setDescriptiveName(String name) Définissez le nom descriptif à utiliser lors de l'enregistrement des rapports de bugs.
void	setDeviceWaitTime(int waitTime) Définissez le délai (en secondes) d'attente pour que l'appareil soit en ligne avant d'essayer de capturer un rapport de bug.
void	testAssumptionFailure(TestDescription test, String trace) Appelé lorsqu'un test atomique indique qu'il suppose une condition fausse
void	testEnded(TestDescription test, testMetrics) Indique la fin de l'exécution d'un cas de test individuel.
void	testFailed(TestDescription test, String trace) Signale l'échec d'un cas de test individuel.
void	testIgnored(TestDescription test) Appelé lorsqu'un test ne sera pas exécuté, généralement parce qu'une méthode de test est annotée avec org.junit.Ignore.
void	testLog(String dataName, LogDataType dataType, InputStreamSource dataStream) Fournit les données de journal ou de débogage associées à l'appel de test.
void	testRunEnded(long elapsedTime, runMetrics) Signale la fin de l'exécution du test.
void	testRunFailed(String errorMessage) L'exécution du test des rapports a échoué en raison d'une erreur fatale.
void	testRunStarted(String runName, int testCount) Indique le début d'une exécution de test.
void	testRunStopped(long elapsedTime) L'exécution du test des rapports s'est arrêtée avant d'être terminée en raison d'une requête de l'utilisateur.
void	testStarted(TestDescription test) Indique le début d'un scénario de test individuel.

Champs

AFTER_FAILED_TESTCASES

public static final BugreportCollector.Predicate AFTER_FAILED_TESTCASES

Prédicat prédéfini qui se déclenche après chaque échec de test

AT_START

public static final BugreportCollector.Predicate AT_START

Prédicat prédéfini qui se déclenche au début de la première invocation

Constructeurs publics

BugreportCollector

public BugreportCollector (ITestInvocationListener listener, 
                ITestDevice testDevice)

Paramètres
listener	ITestInvocationListener
testDevice	ITestDevice

Méthodes publiques

addPredicate

public void addPredicate (BugreportCollector.Predicate p)

Paramètres
p	BugreportCollector.Predicate

blockUntilIdle

public void blockUntilIdle ()

Bloquer jusqu'à ce que le collecteur ne collecte plus de rapports de bugs. Si le collecteur ne collecte pas activement un rapport de bug, renvoyez immédiatement

getSummary

public TestSummary getSummary ()

Permet à InvocationListener de renvoyer un récapitulatif.

Renvoie
TestSummary	TestSummary résumant l'exécution ou valeur nulle

invocationEnded

public void invocationEnded (long elapsedTime)

Indique que l'appel a pris fin, que ce soit avec succès ou en raison d'une condition d'erreur.

Appelé automatiquement par le framework TradeFederation.

Paramètres
elapsedTime	long: temps écoulé de l'appel en ms

invocationFailed

public void invocationFailed (Throwable cause)

Signale une invocation incomplète en raison d'une condition d'erreur.

Appelé automatiquement par le framework TradeFederation.

Paramètres
cause	Throwable: cause Throwable de l'échec

invocationStarted

public void invocationStarted (IInvocationContext context)

Indique le début de l'appel du test.

Appelé automatiquement par le framework TradeFederation. Les rapporteurs doivent remplacer cette méthode pour prendre en charge les rapports sur plusieurs appareils.

Paramètres
context	IInvocationContext: informations sur l'appel

setAsynchronous

public void setAsynchronous (boolean asynchronous)

Définissez si la collecte de rapports de bugs doit collecter le rapport de bug dans un autre thread (asynchronous = true) ou bloquer l'appelant jusqu'à ce que le rapport de bug soit capturé (asynchronous = false).

Paramètres
asynchronous	boolean

setDescriptiveName

public void setDescriptiveName (String name)

Définissez le nom descriptif à utiliser lors de l'enregistrement des rapports de bugs. Si null, BugreportCollector utilisera le comportement par défaut consistant à sérialiser le nom de l'événement ayant entraîné la collecte du rapport de bug.

Paramètres
name	String

setDeviceWaitTime

public void setDeviceWaitTime (int waitTime)

Définissez le délai (en secondes) d'attente pour que l'appareil soit en ligne avant d'essayer de capturer un rapport de bug. Si la valeur est négative, aucune vérification n'est effectuée. Tout DeviceNotAvailableException rencontré lors de cette vérification sera consigné et ignoré.

Paramètres
waitTime	int

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

Appelé lorsqu'un test atomique indique qu'il suppose une condition fausse

Paramètres
test	TestDescription: identifie le test
trace	String: trace de la pile de l'échec

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

Indique la fin de l'exécution d'un cas de test individuel.

Si testFailed(TestDescription, FailureDescription) n'a pas été appelé, ce test est réussi. Renvoie également toutes les métriques clé/valeur qui ont pu être émises lors de l'exécution du cas de test.

Paramètres
test	TestDescription: identifie le test
testMetrics	: ERROR(/Map) des métriques émises

testFailed

public void testFailed (TestDescription test, 
                String trace)

Signale l'échec d'un cas de test individuel.

Appelé entre testStarted et testEnded.

Paramètres
test	TestDescription: identifie le test
trace	String: trace de la pile de l'échec

testIgnored

public void testIgnored (TestDescription test)

Appelé lorsqu'un test ne sera pas exécuté, généralement parce qu'une méthode de test est annotée avec org.junit.Ignore.

Paramètres
test	TestDescription: identifie le test

testLog

public void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

Fournit les données de journal ou de débogage associées à l'appel de test.

Doit être appelé avant ERROR(/ITestInvocationListener#invocationFailed(Throwable)) ou ERROR(/ITestInvocationListener#invocationEnded(long))

Le framework TradeFederation appelle automatiquement cette méthode, en fournissant le journal de l'hôte et, le cas échéant, le logcat de l'appareil.

Paramètres
dataName	String: nom descriptif String des données (par exemple, "device_logcat"). Remarque : Le nom de données ne doit pas nécessairement être unique par appel. Autrement dit, les implémentateurs doivent pouvoir gérer plusieurs appels avec le même nom de données.
dataType	LogDataType: LogDataType des données
dataStream	InputStreamSource: InputStreamSource des données. Les implémentateurs doivent appeler createInputStream pour commencer à lire les données et s'assurer de fermer l'InputStream généré une fois la lecture terminée. Les appelants doivent s'assurer que la source des données reste présente et accessible jusqu'à la fin de la méthode testLog.

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

Signale la fin de l'exécution du test.

Paramètres
elapsedTime	long: durée écoulée, en millisecondes, indiquée par l'appareil
runMetrics	: paires clé-valeur signalées à la fin d'une exécution de test

testRunFailed

public void testRunFailed (String errorMessage)

L'exécution du test des rapports a échoué en raison d'une erreur fatale.

Paramètres
errorMessage	String: String décrivant la raison de l'échec de l'exécution.

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

Indique le début d'une exécution de test.

Paramètres
runName	String: nom de l'exécution du test
testCount	int: nombre total de tests dans l'exécution de test

testRunStopped

public void testRunStopped (long elapsedTime)

L'exécution du test des rapports s'est arrêtée avant d'être terminée en raison d'une requête de l'utilisateur.

TODO: currently unused, consider removing

Paramètres
elapsedTime	long: durée écoulée, en millisecondes, indiquée par l'appareil

testStarted

public void testStarted (TestDescription test)

Indique le début d'un scénario de test individuel. Interface plus ancienne. Utilisez testStarted(com.android.tradefed.result.TestDescription) dans la mesure du possible.

Paramètres
test	TestDescription: identifie le test