ShardListener

public class ShardListener
extends CollectingTestListener implements ISupportGranularResults

java.lang.Object
↳	com.android.tradefed.result.CollectingTestListener
	↳	com.android.tradefed.invoker.ShardListener

---

Un ITestInvocationListener qui collecte les résultats d'un shard d'invocation (c'est-à-dire une invocation divisée pour s'exécuter en parallèle sur plusieurs ressources) et les transmet à un autre écouteur.

Résumé

Constructeurs publics
ShardListener(ITestInvocationListener main) Créez un élément ShardListener.

Méthodes publiques
List<ITestInvocationListener>	getUnderlyingResultReporter()
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	invocationSkipped(SkipReason reason) Signale une invocation comme ignorée
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 testLogSaved(String,LogDataType,InputStreamSource,LogFile) direct.
void	setSupportGranularResults(boolean enableGranularResults)
boolean	supportGranularResults() Renvoie "True" si le rapporteur accepte les résultats précis, ou "False" dans le cas contraire.
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	testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
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 elapsedTime, 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 FailureDescription.
void	testRunFailed(String failureMessage) L'exécution du test des rapports n'a pas pu être effectuée en raison d'une erreur fatale.
void	testRunStarted(String name, int numTests, int attemptNumber, long startTime) Indique le début d'un test.

Constructeurs publics

ShardListener

public ShardListener (ITestInvocationListener main)

Créez un élément ShardListener.

Paramètres
main	ITestInvocationListener : ITestInvocationListener auquel les résultats doivent être transférés. Pour éviter les collisions avec d'autres ShardListener, cet objet se synchronise sur main lors du transfert des résultats. Les résultats ne seront envoyés qu'une fois le shard d'invocation terminé.

Méthodes publiques

getUnderlyingResultReporter

public List<ITestInvocationListener> getUnderlyingResultReporter ()

Renvoie
List<ITestInvocationListener>

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

invocationSkipped

public void invocationSkipped (SkipReason reason)

Signale une invocation comme ignorée

Paramètres
reason	SkipReason

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.

setSupportGranularResults

public void setSupportGranularResults (boolean enableGranularResults)

Paramètres
enableGranularResults	boolean

supportGranularResults

public boolean supportGranularResults ()

Renvoie "True" si le rapporteur accepte les résultats précis, ou "False" dans le cas contraire.

Renvoie
boolean

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.

testLogSaved

public void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

Paramètres
dataName	String
dataType	LogDataType
dataStream	InputStreamSource
logFile	LogFile

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 elapsedTime, 
                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
elapsedTime	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 failureMessage)

L'exécution du test des rapports n'a pas pu être effectuée en raison d'une erreur fatale.

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

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber, 
                long startTime)

Indique le début d'un test.

Paramètres
name	String : nom de l'exécution du test
numTests	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()