BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IDeviceActionReceiver, IMetricCollector

java.lang.Object
   ↳ com.android.tradefed.device.metric.BaseDeviceMetricCollector


Implémentation de base de IMetricCollector qui permet de démarrer et d'arrêter la collecte sur onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) et ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map)).

Résumé

Champs

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

Constructeurs publics

BaseDeviceMetricCollector()

Méthodes publiques

void extraInit(IInvocationContext context, ITestInvocationListener listener)
final getBuildInfos()

Renvoie la liste des informations sur la compilation disponibles dans l'appel.

final getDevices()

Affiche la liste des appareils disponibles dans l'appel.

File getFileFromTestArtifacts(String fileName)

Récupérer le fichier à partir des artefacts de test ou des artefacts du module et du cache dans un mappage pour les appels suivants.

final ITestInvocationListener getInvocationListener()

Renvoie le ITestInvocationListener d'origine où nous transférons les résultats.

String getModuleName()
final getRealDevices()

Renvoie tous les appareils non bouchon de la liste getDevices().

String getRunName()

Renvoie le nom de l'exécution de test mRunName qui déclenche le collecteur.

final ITestInvocationListener init(IInvocationContext context, ITestInvocationListener listener)

Initialisation du collecteur avec le contexte actuel et la destination de transfert des résultats.

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).

boolean isDisabledReceiver()

Indique si IDeviceActionReceiver est désactivé ou non.

final void logAssociation(String dataName, LogFile logFile)

Ne pas utiliser dans l'implémentation du collecteur de métriques.

void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

Rappel lorsqu'un scénario de test échoue avec une hypothèse d'échec.

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)

Rappel lorsque le scénario de test se termine.

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)

Rappel lorsque le scénario de test se termine.

void onTestFail(DeviceMetricData testData, TestDescription test)

Rappel en cas d'échec d'un scénario de test

void onTestModuleEnded()

Autorise la capture de l'événement terminé du module.

void onTestModuleStarted()

Permet de capturer l'événement lancé par le module.

void onTestRunEnd(DeviceMetricData runData, currentRunMetrics)

Rappel à la fin d'une exécution de test

void onTestRunFailed(DeviceMetricData testData, FailureDescription failure)

Rappel pour les événements testRunFailed

void onTestRunStart(DeviceMetricData runData)

Rappel lorsqu'une exécution de test est lancée.

void onTestStart(DeviceMetricData testData)

Rappel lorsqu'un scénario de test est lancé.

void rebootEnded(ITestDevice device)

Reçoit une notification à la fin du redémarrage sur l'appareil.

void rebootStarted(ITestDevice device)

Reçoit une notification au démarrage de l'appareil.

final void setDisable(boolean isDisabled)

Détermine si l'objet doit être désactivé.

void setDisableReceiver(boolean isDisabled)

Détermine si IDeviceActionReceiver doit être désactivé.

final void setLogSaver(ILogSaver logSaver)

Ne pas utiliser dans l'implémentation du collecteur de métriques.

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, testMetrics)

Alternative à ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), où nous pouvons spécifier l'heure de fin directement.

final void testEnded(TestDescription test, testMetrics)

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)

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

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

Ne pas utiliser dans l'implémentation du collecteur de métriques.

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, runMetrics)

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 FailureDescription.

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 à 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.

final void testStarted(TestDescription test)

Rappels des scénarios de test

Champs

OPTION_DE_GROUPE_EXCLURE_DE_TESTS

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

Constructeurs publics

BaseDeviceMetricCollector

public BaseDeviceMetricCollector ()

Méthodes publiques

extraInit

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

Génère
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildInfos

public final  getBuildInfos ()

Renvoie la liste des informations sur la compilation disponibles dans l'appel.

Renvoie

getAppareils

public final  getDevices ()

Affiche la liste des appareils disponibles dans l'appel.

Renvoie

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

Récupérer le fichier à partir des artefacts de test ou des artefacts du module et du cache dans un mappage pour les appels suivants.

Paramètres
fileName String: nom du fichier à rechercher dans les artefacts.

Renvoie
File Fichier de l'artefact de test ou de l'artefact de module. Renvoie la valeur "null" si le fichier est introuvable.

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

Renvoie le ITestInvocationListener d'origine où nous transférons les résultats.

Renvoie
ITestInvocationListener

GetModuleName.

public String getModuleName ()

Renvoie
String

getRealDevices

public final  getRealDevices ()

Renvoie tous les appareils non bouchon de la liste getDevices().

Renvoie

getRunName

public String getRunName ()

Renvoie le nom de l'exécution de test mRunName qui déclenche le collecteur.

Renvoie
String mRunName, le nom de l'exécution de test actuelle.

init

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

Initialisation du collecteur avec le contexte actuel et la destination de transfert des résultats. Volonté n'est appelé qu'une seule fois par instance, et le collecteur doit mettre à jour son niveau le contexte et l'écouteur. La méthode Init n'est jamais appelée lors d'un test.

Ne l'ignorez que si vous savez ce que vous faites.

Paramètres
context IInvocationContext: IInvocationContext de l'appel en cours.

listener ITestInvocationListener: ITestInvocationListener où placer les résultats.

Renvoie
ITestInvocationListener le nouvel écouteur qui encapsule l'original.

Génère
DeviceNotAvailableException

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

isDisabledReceiver

public boolean isDisabledReceiver ()

Indique si IDeviceActionReceiver est désactivé ou non.

Renvoie
boolean renvoie la valeur "true" en cas de désactivation, ou la valeur "false" dans le cas contraire.

association log

public final void logAssociation (String dataName, 
                LogFile logFile)

Ne pas utiliser dans l'implémentation du collecteur de métriques. Il s'agit d'un simple transfert.

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.

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

Rappel lorsqu'un scénario de test échoue avec une hypothèse d'échec.

Paramètres
testData DeviceMetricData: DeviceMetricData contenant les données du scénario de test.

test TestDescription: TestDescription du scénario de test en cours.

Génère
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics, 
                TestDescription test)

Rappel lorsque le scénario de test se termine. C'est le moment du nettoyage.

Paramètres
testData DeviceMetricData: DeviceMetricData contenant les données du scénario de test. Sera la même objet que pendant onTestStart(com.android.tradefed.device.metric.DeviceMetricData).

currentTestCaseMetrics : carte actuelle des métriques transmises à ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)).

test TestDescription: TestDescription du scénario de test en cours.

Génère
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

Rappel lorsque le scénario de test se termine. C'est le moment du nettoyage.

Paramètres
testData DeviceMetricData: DeviceMetricData contenant les données du scénario de test. Sera la même objet que pendant onTestStart(com.android.tradefed.device.metric.DeviceMetricData).

currentTestCaseMetrics : carte actuelle des métriques transmises à ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)).

Génère
DeviceNotAvailableException

Échec du test

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

Rappel en cas d'échec d'un scénario de test

Paramètres
testData DeviceMetricData: DeviceMetricData contenant les données du scénario de test.

test TestDescription: TestDescription du scénario de test en cours.

Génère
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

Autorise la capture de l'événement terminé du module.

Génère
DeviceNotAvailableException

onTestModuleStarted (OnTestModuleStarted)

public void onTestModuleStarted ()

Permet de capturer l'événement lancé par le module.

Génère
DeviceNotAvailableException

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

Rappel à la fin d'une exécution de test C'est le moment du nettoyage.

Paramètres
runData DeviceMetricData: DeviceMetricData contenant les données pour l'exécution. Identique comme pendant onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData).

currentRunMetrics : carte actuelle des métriques transmises à ERROR(/#testRunEnded(long,Map)).

Génère
DeviceNotAvailableException

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

Rappel pour les événements testRunFailed

Génère
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

Démarrage de l'exécution du test

public void onTestRunStart (DeviceMetricData runData)

Rappel lorsqu'une exécution de test est lancée.

Paramètres
runData DeviceMetricData: DeviceMetricData contenant les données pour l'exécution.

Génère
DeviceNotAvailableException

DébutTest

public void onTestStart (DeviceMetricData testData)

Rappel lorsqu'un scénario de test est lancé.

Paramètres
testData DeviceMetricData: DeviceMetricData contenant les données du scénario de test.

Génère
DeviceNotAvailableException

redémarrée

public void rebootEnded (ITestDevice device)

Reçoit une notification à la fin du redémarrage sur l'appareil.

REMARQUE: Les destinataires doivent éviter de redémarrer pendant ce rappel. Toute tentative de redémarrage sera sont ignorées.

Paramètres
device ITestDevice: ITestDevice où le redémarrage s'est terminé.

Génère
DeviceNotAvailableException

redémarré

public void rebootStarted (ITestDevice device)

Reçoit une notification au démarrage de l'appareil.

REMARQUE: Les destinataires doivent éviter de redémarrer pendant ce rappel. Toute tentative de redémarrage sera sont ignorées.

Paramètres
device ITestDevice: ITestDevice où le redémarrage a commencé.

Génère
DeviceNotAvailableException

DéfinirDésactiver

public final void setDisable (boolean isDisabled)

Détermine si l'objet doit être désactivé. "Désactivé" signifie que les étapes de configuration et de suppression doivent être ignorées. Permet de désactiver un objet par défaut d'un constructeur.

Paramètres
isDisabled boolean: état dans lequel l'objet doit être placé.

setDisableReceiver

public void setDisableReceiver (boolean isDisabled)

Détermine si IDeviceActionReceiver doit être désactivé. La désactivation signifie ne pas être enregistrés sur l'appareil pour recevoir des événements d'action sur celui-ci.

Paramètres
isDisabled boolean

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

Ne pas utiliser dans l'implémentation du collecteur de métriques. Il s'agit d'un simple transfert.

Paramètres
logSaver ILogSaver: ILogSaver

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)

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 Tradefédération appelle automatiquement cette méthode et fournit le journal de l'hôte. et, le cas échéant, le fichier logcat de l'appareil.

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)

Ne pas utiliser dans l'implémentation du collecteur de métriques. Il s'agit d'un simple transfert.

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.