SubprocessResultsReporter
public
class
SubprocessResultsReporter
extends Object
implements
AutoCloseable,
ILogSaverListener,
ISupportGranularResults,
ITestInvocationListener
| java.lang.Object | |
| ↳ | com.android.tradefed.result.SubprocessResultsReporter |
Implémente ITestInvocationListener à spécifier en tant que result_reporter et transmet à partir du sous-processus les résultats des tests, des exécutions de tests et des appels de tests.
Résumé
Constructeurs publics | |
|---|---|
SubprocessResultsReporter()
|
|
Méthodes publiques | |
|---|---|
void
|
close()
|
TestSummary
|
getSummary()
Permet à InvocationListener de renvoyer un récapitulatif. |
void
|
invocationEnded(long elapsedTime)
Indique que l'invocation s'est terminée, que ce soit avec succès ou en raison d'une condition d'erreur. |
void
|
invocationFailed(FailureDescription failure)
Signale un appel incomplet en raison d'une condition d'erreur. |
void
|
invocationFailed(Throwable cause)
Signale un appel incomplet en raison d'une condition d'erreur. |
void
|
invocationStarted(IInvocationContext context)
Indique le début de l'appel de test. |
void
|
logAssociation(String dataName, LogFile logFile)
Dans certains cas, le journal doit être fortement associé à des cas de test, mais il n'est pas possible de le faire sur le rappel |
void
|
printEvent(String key, Object event)
Assistant pour imprimer la clé d'événement, puis l'objet JSON. |
void
|
setOutputTestLog(boolean outputTestLog)
Indique si le test doit être consigné ou non. |
boolean
|
supportGranularResults()
Renvoie "True" si le rapporteur accepte les résultats précis, ou "False" dans le cas contraire. |
void
|
testAssumptionFailure(TestDescription testId, String trace)
Appelé lorsqu'un test atomique signale qu'il suppose une condition qui est fausse |
void
|
testAssumptionFailure(TestDescription testId, FailureDescription failure)
Appelé lorsqu'un test atomique signale qu'il suppose une condition qui est fausse |
void
|
testEnded(TestDescription testId, long endTime, HashMap<String, MetricMeasurement.Metric> metrics)
Alternative à |
void
|
testEnded(TestDescription testId, HashMap<String, MetricMeasurement.Metric> metrics)
Indique la fin de l'exécution d'un cas de test individuel. |
void
|
testFailed(TestDescription testId, FailureDescription failure)
Signalement de l'échec d'un cas de test individuel. |
void
|
testFailed(TestDescription testId, String reason)
Signalement de l'échec d'un cas de test individuel. |
void
|
testIgnored(TestDescription testId)
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
|
testModuleEnded()
Indique la fin de l'exécution d'un module. |
void
|
testModuleStarted(IInvocationContext moduleContext)
Indique le début de l'exécution d'un module. |
void
|
testRunEnded(long time, HashMap<String, MetricMeasurement.Metric> runMetrics)
Rapports de fin de série de tests. |
void
|
testRunFailed(FailureDescription failure)
L'exécution du test des rapports n'a pas pu être effectuée en raison d'un échec décrit par |
void
|
testRunFailed(String reason)
L'exécution du test des rapports n'a pas pu être effectuée en raison d'une erreur fatale. |
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Indique le début d'un test. |
void
|
testRunStarted(String runName, int testCount)
Indique le début d'un test. |
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Indique le début d'un test. |
void
|
testRunStopped(long arg0)
Indique que l'exécution du test a été arrêtée avant la fin à la demande de l'utilisateur. |
void
|
testSkipped(TestDescription testId, SkipReason reason)
Appelé lorsqu'un test est ignoré et ne s'est pas exécuté pour une raison généralement inattendue. |
void
|
testStarted(TestDescription testId, long startTime)
Alternative à |
void
|
testStarted(TestDescription testId)
Indique le début d'un scénario de test individuel. |
Constructeurs publics
SubprocessResultsReporter
public SubprocessResultsReporter ()
Méthodes publiques
fermer
public void close ()
getSummary
public TestSummary getSummary ()
Permet à InvocationListener de renvoyer un récapitulatif.
| Renvoie | |
|---|---|
TestSummary |
TestSummary résumant l'exécution, ou null |
invocationEnded
public void invocationEnded (long elapsedTime)
Indique que l'invocation s'est terminée, que ce soit avec succès ou en raison d'une condition d'erreur.
Sera automatiquement appelé par le framework TradeFederation.
| Paramètres | |
|---|---|
elapsedTime |
long : temps écoulé de l'appel en ms |
invocationFailed
public void invocationFailed (FailureDescription failure)
Signale un appel incomplet en raison d'une condition d'erreur.
Sera automatiquement appelé par le framework TradeFederation.
| Paramètres | |
|---|---|
failure |
FailureDescription : FailureDescription décrivant la cause de l'échec |
invocationFailed
public void invocationFailed (Throwable cause)
Signale un appel incomplet en raison d'une condition d'erreur.
Sera automatiquement appelé 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 de test.
Sera automatiquement appelé par le framework TradeFederation. Les reporters doivent remplacer cette méthode pour prendre en charge le reporting sur plusieurs appareils.
| Paramètres | |
|---|---|
context |
IInvocationContext : informations sur l'appel |
logAssociation
public void logAssociation (String dataName,
LogFile logFile)Dans certains cas, le journal doit être fortement associé à des cas de test, mais il n'est pas possible de le faire sur le rappel testLogSaved(String,LogDataType,InputStreamSource,LogFile) direct. Ce rappel permet donc de fournir explicitement une association forte.
| Paramètres | |
|---|---|
dataName |
String : nom des données |
logFile |
LogFile : le LogFile qui a été enregistré précédemment et qui doit être associé au scénario de test. |
printEvent
public void printEvent (String key,
Object event)Assistant pour imprimer la clé d'événement, puis l'objet JSON.
| Paramètres | |
|---|---|
key |
String |
event |
Object |
setOutputTestLog
public void setOutputTestLog (boolean outputTestLog)
Indique si le test doit être consigné ou non.
| Paramètres | |
|---|---|
outputTestLog |
boolean |
supportGranularResults
public boolean supportGranularResults ()
Renvoie "True" si le rapporteur accepte les résultats précis, ou "False" dans le cas contraire.
| Renvoie | |
|---|---|
boolean |
|
testAssumptionFailure
public void testAssumptionFailure (TestDescription testId, String trace)
Appelé lorsqu'un test atomique signale qu'il suppose une condition qui est fausse
| Paramètres | |
|---|---|
testId |
TestDescription : identifie le test |
trace |
String : trace de la pile d'échec |
testAssumptionFailure
public void testAssumptionFailure (TestDescription testId, FailureDescription failure)
Appelé lorsqu'un test atomique signale qu'il suppose une condition qui est fausse
| Paramètres | |
|---|---|
testId |
TestDescription : identifie le test |
failure |
FailureDescription : FailureDescription décrivant l'échec et son contexte. |
testEnded
public void testEnded (TestDescription testId, long endTime, HashMap<String, MetricMeasurement.Metric> metrics)
Alternative à testEnded(TestDescription,Map) où nous pouvons spécifier directement l'heure de fin. Combinez-le avec testStarted(TestDescription,long) pour obtenir une mesure précise.
| Paramètres | |
|---|---|
testId |
TestDescription : identifie le test |
endTime |
long : heure à laquelle le test s'est terminé, mesurée via System.currentTimeMillis() |
metrics |
HashMap : Map des métriques émises. |
testEnded
public void testEnded (TestDescription testId, HashMap<String, MetricMeasurement.Metric> metrics)
Indique la fin de l'exécution d'un cas de test individuel.
Si testFailed(TestDescription, FailureDescription) n'a pas été appelé, ce test a 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 | |
|---|---|
testId |
TestDescription : identifie le test |
metrics |
HashMap : Map des métriques émises. |
testFailed
public void testFailed (TestDescription testId, FailureDescription failure)
Signalement de l'échec d'un cas de test individuel.
Sera appelé entre testStarted et testEnded.
| Paramètres | |
|---|---|
testId |
TestDescription : identifie le test |
failure |
FailureDescription : FailureDescription décrivant l'échec et son contexte. |
testFailed
public void testFailed (TestDescription testId, String reason)
Signalement de l'échec d'un cas de test individuel.
Sera appelé entre testStarted et testEnded.
| Paramètres | |
|---|---|
testId |
TestDescription : identifie le test |
reason |
String : trace de la pile d'échec |
testIgnored
public void testIgnored (TestDescription testId)
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 | |
|---|---|
testId |
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)/ITestInvocationListener#invocationFailed(java.lang.Throwable) ITestInvocationListener.invocationFailed(Throwable)) ou ERROR(/ITestInvocationListener#invocationEnded(long))
Le framework TradeFederation appellera 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 : dataName peut ne pas être unique par invocation. Autrement dit, les implémenteurs doivent pouvoir gérer plusieurs appels avec le même dataName. |
dataType |
LogDataType : LogDataType des données |
dataStream |
InputStreamSource : InputStreamSource des données. Les développeurs doivent appeler createInputStream pour commencer à lire les données et s'assurer de fermer l'InputStream résultant une fois l'opération terminée. Les appelants doivent s'assurer que la source des données reste présente et accessible jusqu'à ce que la méthode testLog soit terminée. |
testModuleEnded
public void testModuleEnded ()
Indique la fin de l'exécution d'un module.
testModuleStarted
public void testModuleStarted (IInvocationContext moduleContext)
Indique le début de l'exécution d'un module. Ce rappel est associé à testModuleEnded() et est facultatif dans la séquence. Il n'est utilisé que lors d'une exécution qui utilise des modules : les runners basés sur des suites.
| Paramètres | |
|---|---|
moduleContext |
IInvocationContext : IInvocationContext du module. |
testRunEnded
public void testRunEnded (long time,
HashMap<String, MetricMeasurement.Metric> runMetrics)Rapports de fin de série de tests. FIXME: We cannot have two Map<> interfaces with different type, so we have to use HashMap here.
| Paramètres | |
|---|---|
time |
long : temps écoulé indiqué par l'appareil, en millisecondes |
runMetrics |
HashMap : paires clé-valeur signalées à la fin d'une série de tests avec Metric. |
testRunFailed
public void testRunFailed (FailureDescription failure)
L'exécution du test des rapports n'a pas pu être effectuée en raison d'un échec décrit par FailureDescription.
| Paramètres | |
|---|---|
failure |
FailureDescription : FailureDescription décrivant l'échec et son contexte. |
testRunFailed
public void testRunFailed (String reason)
L'exécution du test des rapports n'a pas pu être effectuée en raison d'une erreur fatale.
| Paramètres | |
|---|---|
reason |
String : String décrivant la raison de l'échec de l'exécution. |
testRunStarted
public void testRunStarted (String runName,
int testCount,
int attemptNumber)Indique le début d'un test.
| Paramètres | |
|---|---|
runName |
String : nom de l'exécution du test |
testCount |
int : nombre total de tests dans l'exécution du test |
attemptNumber |
int : numéro de commande, identifiant les différentes tentatives du même runName
qui s'exécutent plusieurs fois. Le numéro de tentative est indexé sur 0 et doit être incrémenté à chaque nouvelle exécution. Par exemple, si un test est retenté de manière précise trois fois, il doit comporter quatre exécutions au total sous le même runName, et le numéro de tentative doit être compris entre 0 et 3. |
testRunStarted
public void testRunStarted (String runName,
int testCount)Indique le début d'un test.
| Paramètres | |
|---|---|
runName |
String : nom de l'exécution du test |
testCount |
int : nombre total de tests dans l'exécution du test |
testRunStarted
public void testRunStarted (String runName,
int testCount,
int attemptNumber,
long startTime)Indique le début d'un test.
| Paramètres | |
|---|---|
runName |
String : nom de l'exécution du test |
testCount |
int : nombre total de tests dans l'exécution du test |
attemptNumber |
int : numéro de commande, identifiant les différentes tentatives du même runName
qui s'exécutent plusieurs fois. Le numéro de tentative est indexé sur 0 et doit être incrémenté à chaque nouvelle exécution. Par exemple, si un test est retenté de manière précise trois fois, il doit comporter quatre exécutions au total sous le même runName, et le numéro de tentative doit être compris entre 0 et 3. |
startTime |
long : heure de début de l'exécution, mesurée via System.currentTimeMillis() |
testRunStopped
public void testRunStopped (long arg0)
Indique que l'exécution du test a été arrêtée avant la fin à la demande de l'utilisateur.
TODO: currently unused, consider removing
| Paramètres | |
|---|---|
arg0 |
long : temps écoulé indiqué par l'appareil, en millisecondes |
testSkipped
public void testSkipped (TestDescription testId, SkipReason reason)
Appelé lorsqu'un test est ignoré et ne s'est pas exécuté pour une raison généralement inattendue. Nous allons tenter de relancer ces tests pour essayer de les exécuter correctement.
| Paramètres | |
|---|---|
testId |
TestDescription : identifie le test |
reason |
SkipReason : SkipReason |
testStarted
public void testStarted (TestDescription testId, long startTime)
Alternative à testStarted(TestDescription) où nous spécifions également la date de début du test, combinée à testEnded(TestDescription,long,Map) pour une mesure précise.
| Paramètres | |
|---|---|
testId |
TestDescription : identifie le test |
startTime |
long : heure à laquelle le test a commencé, mesurée via System.currentTimeMillis() |
testStarted
public void testStarted (TestDescription testId)
Indique le début d'un scénario de test individuel. Ancienne interface. Utilisez testStarted(TestDescription) autant que possible.
| Paramètres | |
|---|---|
testId |
TestDescription : identifie le test |