BasePostProcessor
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
java.lang.Object | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
Le IPostProcessor
de base que chaque implémentation doit étendre. Assurez-vous que le post
méthodes de traitement des données sont appelées avant les rapporteurs de résultats finaux.
Résumé
Constructeurs publics | |
---|---|
BasePostProcessor()
|
Méthodes publiques | |
---|---|
final
ITestInvocationListener
|
init(ITestInvocationListener listener)
Étape d'initialisation du post-traitement. |
final
void
|
invocationEnded(long elapsedTime)
Indique que l'appel s'est arrêté, que ce soit avec succès ou en raison d'une erreur . |
final
void
|
invocationFailed(FailureDescription failure)
Signale un appel incomplet en raison d'une condition d'erreur. |
final
void
|
invocationFailed(Throwable cause)
Signale un appel incomplet en raison d'une condition d'erreur. |
void
|
invocationSkipped(SkipReason reason)
Signale un appel comme ignoré |
final
void
|
invocationStarted(IInvocationContext context)
Écouteurs d'appel pour le transfert |
final
boolean
|
isDisabled()
Renvoie la valeur "True" si l'objet entier est désactivé (ignorer la configuration et la suppression). |
final
void
|
logAssociation(String dataName, LogFile logFile)
Dans certains cas, le journal doit être fortement associé à un scénario test, mais la possibilité de
Ainsi, sur la ligne directe Met à jour l'association log-to-test. |
|
processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,
Implémentez cette méthode pour agréger les métriques et les journaux de tous les tests. |
abstract
|
processRunMetricsAndLogs(
Implémentez cette méthode pour générer un ensemble de nouvelles métriques à partir des métriques existantes et journaux. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Implémentez cette méthode pour publier les métriques et les journaux de processus de chaque test. |
final
void
|
setLogSaver(ILogSaver logSaver)
Définissez |
void
|
setUp()
Remplacez cette méthode dans les post-processeurs enfants pour s'initialiser avant l'exécution du test. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Appelé lorsqu'un test atomique indique qu'il suppose une condition fausse |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Appelé lorsqu'un test atomique indique qu'il suppose une condition fausse |
final
void
|
testEnded(TestDescription test, long endTime,
Alternative à |
final
void
|
testEnded(TestDescription test,
Indique la fin de l'exécution d'un scénario de test individuel. |
final
void
|
testFailed(TestDescription test, FailureDescription failure)
Indique l'échec d'un scénario de test individuel. |
final
void
|
testFailed(TestDescription test, String trace)
Indique l'échec d'un scénario de test individuel. |
final
void
|
testIgnored(TestDescription test)
Appelé lorsqu'un test n'est pas exécuté, généralement parce qu'une méthode de test est annotée avec org.junit.Ignore. |
final
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
Utilisez cette méthode pour consigner un fichier à partir de l'implémentation de PostProcessor. |
final
void
|
testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Appelé lorsque le journal de test est enregistré. |
final
void
|
testModuleEnded()
Indique la fin d'une exécution de module. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
Indique le début d'un module en cours d'exécution. |
final
void
|
testRunEnded(long elapsedTime,
Signale la fin de l'exécution du test. |
final
void
|
testRunFailed(FailureDescription failure)
Échec de l'exécution du test des rapports en raison d'un échec décrit par |
final
void
|
testRunFailed(String errorMessage)
Échec de l'exécution du test des rapports en raison d'une erreur fatale. |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Indique le début d'une exécution de test. |
final
void
|
testRunStarted(String runName, int testCount)
Rappels d'exécution de test |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Indique le début d'une exécution de test. |
final
void
|
testRunStopped(long elapsedTime)
L'exécution des tests des rapports a été interrompue en raison d'une demande de l'utilisateur. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Appelé lorsqu'un test est ignoré et ne s'est pas exécuté pour une raison inattendue. |
final
void
|
testStarted(TestDescription test, long startTime)
Alternative à |
final
void
|
testStarted(TestDescription test)
Rappels des scénarios de test |
Méthodes protégées | |
---|---|
void
|
cleanUp()
|
MetricMeasurement.DataType
|
getMetricType()
Ignorez cette méthode pour modifier le type de métrique si nécessaire. |
String
|
getRunName()
|
Constructeurs publics
BasePostProcessor
public BasePostProcessor ()
Méthodes publiques
init
public final ITestInvocationListener init (ITestInvocationListener listener)
Étape d'initialisation du post-traitement. Appelée avant tout test .
Paramètres | |
---|---|
listener |
ITestInvocationListener |
Renvoie | |
---|---|
ITestInvocationListener |
invocationEnded
public final void invocationEnded (long elapsedTime)
Indique que l'appel s'est arrêté, que ce soit avec succès ou en raison d'une erreur .
Sera automatiquement appelée par le framework TradeFederation.
Paramètres | |
---|---|
elapsedTime |
long : temps écoulé de l'appel en ms |
échec de l'appel
public final void invocationFailed (FailureDescription failure)
Signale un appel incomplet en raison d'une condition d'erreur.
Sera automatiquement appelée par le framework TradeFederation.
Paramètres | |
---|---|
failure |
FailureDescription : le FailureDescription décrivant la cause de l'échec |
échec de l'appel
public final void invocationFailed (Throwable cause)
Signale un appel incomplet en raison d'une condition d'erreur.
Sera automatiquement appelée par le framework TradeFederation.
Paramètres | |
---|---|
cause |
Throwable : cause de l'échec (Throwable ) |
Appel ignoré
public void invocationSkipped (SkipReason reason)
Signale un appel comme ignoré
Paramètres | |
---|---|
reason |
SkipReason |
appel démarré
public final void invocationStarted (IInvocationContext context)
Écouteurs d'appel pour le transfert
Paramètres | |
---|---|
context |
IInvocationContext : informations sur l'appel |
est désactivé
public final boolean isDisabled ()
Renvoie la valeur "True" si l'objet entier est désactivé (ignorer la configuration et la suppression). Sinon, cette valeur est "false".
Renvoie | |
---|---|
boolean |
association log
public final void logAssociation (String dataName, LogFile logFile)
Dans certains cas, le journal doit être fortement associé à un scénario test, mais la possibilité de
Ainsi, sur la ligne directe testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
n'est pas possible. Ainsi, ce rappel permet de fournir une association forte
explicitement.
Met à jour l'association log-to-test. Si cette méthode est appelée lors d'un test, fait partie du test ; sinon ce sera un journal d'exécution.
Paramètres | |
---|---|
dataName |
String : nom des données |
logFile |
LogFile : le LogFile qui a été consigné précédemment et doit être associé à
scénario de test. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Implémentez cette méthode pour agréger les métriques et les journaux de tous les tests. Métriques provenant de cette méthode est rapportée en tant que métrique d'exécution. Seules les nouvelles métriques générées renvoyé et avec un nom de clé unique (aucun conflit avec des clés existantes n'est autorisé).
Paramètres | |
---|---|
allTestMetrics |
ListMultimap : un objet HashMultimap stockant les métriques de chaque test, regroupées par métrique
noms. |
allTestLogs |
: une carte stockant la carte des fichiers journaux de chaque test associés aux noms de leurs données.
en utilisant le TestDescription de chaque test comme clés. |
Renvoie | |
---|---|
|
Ensemble de métriques nouvellement générées pour toutes les métriques de test. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Implémentez cette méthode pour générer un ensemble de nouvelles métriques à partir des métriques existantes et journaux. Seules les nouvelles métriques générées doivent être renvoyées, avec un nom de clé unique (pas des conflits avec des clés existantes).
Paramètres | |
---|---|
rawMetrics |
: ensemble de métriques brutes disponibles pour l'exécution. |
runLogs |
: ensemble des fichiers journaux pour l'exécution du test. |
Renvoie | |
---|---|
|
Ensemble des nouvelles métriques générées à partir des métriques d'exécution. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Implémentez cette méthode pour publier les métriques et les journaux de processus de chaque test. Seuls les nouveaux les métriques générées doivent être renvoyées, avec un nom de clé unique (sans conflit avec les sont autorisées).
Paramètres | |
---|---|
testDescription |
TestDescription : objet TestDescription décrivant le test. |
testMetrics |
: ensemble de métriques du test. |
testLogs |
: ensemble de fichiers consignés pendant le test. |
Renvoie | |
---|---|
|
Ensemble de métriques nouvellement générées à partir des métriques de test. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Définissez ILogSaver
pour permettre à l'outil d'implémentation d'enregistrer des fichiers.
Paramètres | |
---|---|
logSaver |
ILogSaver : ILogSaver |
Configurer
public void setUp ()
Remplacez cette méthode dans les post-processeurs enfants pour s'initialiser avant l'exécution du test.
TestAssumptionFailure
public final 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 défaillance |
TestAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Appelé lorsqu'un test atomique indique qu'il suppose une condition fausse
Paramètres | |
---|---|
test |
TestDescription : identifie le test. |
failure |
FailureDescription : FailureDescription décrivant l'échec et son contexte. |
Terminé
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternative à ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
, où nous pouvons spécifier l'heure de fin
directement. Combinez-le avec testStarted(com.android.tradefed.result.TestDescription, long)
pour obtenir des mesures précises.
Paramètres | |
---|---|
test |
TestDescription : identifie le test. |
endTime |
long : heure de fin du test, mesurée via System.currentTimeMillis() |
testMetrics |
: ERROR(/Map) des métriques émises |
Terminé
public final void testEnded (TestDescription test,testMetrics)
Indique la fin de l'exécution d'un scénario de test individuel.
Si testFailed(TestDescription, FailureDescription)
n'a pas été appelé, le test a réussi. Renvoie également toute clé-valeur
qui ont pu être émises lors de l'exécution du scénario de test.
Paramètres | |
---|---|
test |
TestDescription : identifie le test. |
testMetrics |
: ERROR(/Map) des métriques émises |
Échec du test
public final void testFailed (TestDescription test, FailureDescription failure)
Indique l'échec d'un scénario de test individuel.
Sera appelé entre testStarted et testEnded.
Paramètres | |
---|---|
test |
TestDescription : identifie le test. |
failure |
FailureDescription : FailureDescription décrivant l'échec et son contexte. |
Échec du test
public final void testFailed (TestDescription test, String trace)
Indique l'échec d'un scénario de test individuel.
Sera appelé entre testStarted et testEnded.
Paramètres | |
---|---|
test |
TestDescription : identifie le test. |
trace |
String : trace de la pile de défaillance |
TestIgnoré
public final void testIgnored (TestDescription test)
Appelé lorsqu'un test n'est 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. |
JournalTest
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Utilisez cette méthode pour consigner un fichier à partir de l'implémentation de PostProcessor.
Paramètres | |
---|---|
dataName |
String : nom descriptif String des données. Ex. : "device_logcat". Remarque
Le nom dataName ne peut pas être unique par appel. Autrement dit, les responsables de la mise en œuvre doivent
plusieurs appels avec le même dataName |
dataType |
LogDataType : LogDataType des données |
dataStream |
InputStreamSource : InputStreamSource des données. Les responsables de la mise en œuvre doivent appeler
createInputStream pour commencer à lire les données, et veillez à fermer le résultat
InputStream une fois l'opération terminée. Les appelants doivent s'assurer que la source des données est conservée
et accessibles jusqu'à ce que la méthode testLog soit terminée. |
JournalTest enregistré
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Appelé lorsque le journal de test est enregistré.
Doit être utilisé à la place de ITestInvocationListener#testLog(String, LogDataType,
InputStreamSource)
.
Paramètres | |
---|---|
dataName |
String : nom descriptif String des données. Ex. : "device_logcat". Remarque
Le nom dataName ne peut pas être unique par appel. Autrement dit, les responsables de la mise en œuvre doivent
plusieurs appels avec le même dataName |
dataType |
LogDataType : LogDataType des données |
dataStream |
InputStreamSource : InputStreamSource des données. Les responsables de la mise en œuvre doivent appeler
createInputStream pour commencer à lire les données, et veillez à fermer le résultat
InputStream une fois l'opération terminée. |
logFile |
LogFile : le LogFile contenant les métadonnées du fichier enregistré. |
TestModuleEnded
public final void testModuleEnded ()
Indique la fin d'une exécution de module.
Module de test démarré
public final void testModuleStarted (IInvocationContext moduleContext)
Indique le début d'un module en cours d'exécution. Ce rappel est associé à testModuleEnded()
et est facultatif dans la séquence. Il n'est utilisé que lors d'une exécution qui utilise
modules: exécuteurs basés sur une suite.
Paramètres | |
---|---|
moduleContext |
IInvocationContext : IInvocationContext du module. |
TestRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
Signale la fin de l'exécution du test. FIXME: Nous ne pouvons pas avoir deux éléments Map<> des interfaces de différents types, donc nous devons utiliser HashMap ici.
Paramètres | |
---|---|
elapsedTime |
long : temps écoulé indiqué par l'appareil, en millisecondes |
runMetrics |
: paires clé/valeur signalées à la fin d'un test avec Metric . |
TestRunFailed
public final void testRunFailed (FailureDescription failure)
Échec de l'exécution du test des rapports en raison d'un échec décrit par FailureDescription
.
Paramètres | |
---|---|
failure |
FailureDescription : FailureDescription décrivant l'échec et son contexte. |
TestRunFailed
public final void testRunFailed (String errorMessage)
Échec de l'exécution du test des rapports en raison d'une erreur fatale.
Paramètres | |
---|---|
errorMessage |
String : String décrivant la raison de l'échec de l'exécution. |
Exécution du test démarrée
public final void testRunStarted (String runName, int testCount, int attemptNumber)
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 en cours d'exécution |
attemptNumber |
int : numéro de commande identifiant les différentes tentatives du même runName
qui sont exécutées plusieurs fois. Le numéro tryNumber est indexé par 0 et doit s'incrémenter à chaque fois.
une nouvelle exécution. Ex. : Un test est relancé trois fois de manière précise. Il doit en comporter quatre au total.
s'exécute sous le même runName, et le tryNumber est compris entre 0 et 3. |
Exécution du test démarrée
public final void testRunStarted (String runName, int testCount)
Rappels d'exécution de test
Paramètres | |
---|---|
runName |
String : nom de l'exécution du test |
testCount |
int : nombre total de tests en cours d'exécution |
Exécution du test démarrée
public final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
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 en cours d'exécution |
attemptNumber |
int : numéro de commande identifiant les différentes tentatives du même runName
qui sont exécutées plusieurs fois. La valeur tryNumber est indexée par 0 et doit s'incrémenter chaque fois qu'une
une nouvelle exécution. Ex. : Un test est relancé trois fois de manière précise et doit comporter quatre exécutions au total.
sous le même nom d'exécution, et le numéro de tentative est compris entre 0 et 3. |
startTime |
long : heure de début de l'exécution, mesurée via System.currentTimeMillis() |
Exécution de test arrêtée
public final void testRunStopped (long elapsedTime)
L'exécution des tests des rapports a été interrompue en raison d'une demande de l'utilisateur.
À FAIRE: actuellement non utilisé, pensez à le supprimer
Paramètres | |
---|---|
elapsedTime |
long : temps écoulé indiqué par l'appareil, en millisecondes |
Test ignoré
public final void testSkipped (TestDescription test, SkipReason reason)
Appelé lorsqu'un test est ignoré et ne s'est pas exécuté pour une raison inattendue. Ces tests feront l'objet d'une nouvelle tentative pour tenter d'obtenir une exécution correcte.
Paramètres | |
---|---|
test |
TestDescription : identifie le test. |
reason |
SkipReason : SkipReason |
Démarrage du test démarré
public final void testStarted (TestDescription test, long startTime)
Alternative à testStarted(com.android.tradefed.result.TestDescription)
, où nous spécifions également quand le test a été
et ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
pour une mesure précise.
Paramètres | |
---|---|
test |
TestDescription : identifie le test. |
startTime |
long : heure de début du test, mesurée via System.currentTimeMillis() |
Démarrage du test démarré
public final void testStarted (TestDescription test)
Rappels des scénarios de test
Paramètres | |
---|---|
test |
TestDescription : identifie le test. |
Méthodes protégées
nettoyage
protected void cleanUp ()
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Ignorez cette méthode pour modifier le type de métrique si nécessaire. Par défaut, la métrique est définie sur du type traité.
Renvoie | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Renvoie | |
---|---|
String |