BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IMetricCollector , IDeviceActionReceiver

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é

Des 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 de construction disponibles dans l'invocation.

final getDevices ()

Renvoie la liste des périphériques disponibles dans l'invocation.

File getFileFromTestArtifacts (String fileName)

Récupérez le fichier des artefacts de test ou des artefacts de module et mettez-le en cache dans une carte 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 périphériques non stub 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 où transférer les résultats.

final void invocationEnded (long elapsedTime)

Signale que l'invocation s'est terminée, que ce soit avec succès ou en raison d'une condition d'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.

final void invocationStarted ( IInvocationContext context)

Écouteurs d'invocation pour le transfert

final boolean isDisabled ()

Renvoie True si l'objet entier est désactivé (ignorez à la fois l'installation et le démontage).

boolean isDisabledReceiver ()

Indique si IDeviceActionReceiver est désactivé ou non.

final void logAssociation (String dataName, LogFile logFile)

N'utilisez pas l'implémentation interne du collecteur de métriques.

void onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test)

Rappel lorsqu'un cas de test échoue avec un échec d'hypothèse.

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

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

void onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics)

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

void onTestFail ( DeviceMetricData testData, TestDescription test)

Rappel lorsqu'un scénario de test échoue.

void onTestModuleEnded ()

Permet de capturer l'événement de fin de module.

void onTestModuleStarted ()

Permet de capturer l'événement de démarrage du module.

void onTestRunEnd ( DeviceMetricData runData, currentRunMetrics) onTestRunEnd ( DeviceMetricData runData, currentRunMetrics)

Rappel lorsqu'un test est terminé.

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)

Obtient une notification lorsque le redémarrage s'est terminé sur l'appareil.

void rebootStarted ( ITestDevice device)

Obtient une notification lorsque le redémarrage a commencé dans l'appareil.

final void setDisable (boolean isDisabled)

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

void setDisableReceiver (boolean isDisabled)

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

final void setLogSaver ( ILogSaver logSaver)

N'utilisez pas l'implémentation interne du collecteur de métriques.

final void testAssumptionFailure ( TestDescription test, String trace)

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

final void testAssumptionFailure ( TestDescription test, FailureDescription failure)

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

final void testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics)

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

final void testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics)

Signale la fin de l'exécution d'un scénario de test individuel.

final void testFailed ( TestDescription test, FailureDescription failure)

Signale l'échec d'un scénario de test individuel.

final void testFailed ( TestDescription test, String trace)

Signale l'échec d'un scénario de test individuel.

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

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

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

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

N'utilisez pas l'implémentation interne du collecteur de métriques.

final void testModuleEnded ()

Signale la fin de l'exécution d'un module.

final void testModuleStarted ( IInvocationContext moduleContext)

Signale le début d'un module en cours d'exécution.

final void testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics)

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

final void testRunFailed ( FailureDescription failure)

L'exécution du test de rapports n'a pas abouti en raison d'un échec décrit par FailureDescription .

final void testRunFailed (String errorMessage)

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

final void testRunStarted (String runName, int testCount, int attemptNumber)

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

final void testRunStarted (String runName, int testCount)

Tester les rappels d'exécution

final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)

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

final void testRunStopped (long elapsedTime)

L'exécution du test des rapports s'est arrêtée avant la fin en raison d'une demande de l'utilisateur.

final void testStarted ( TestDescription test, long startTime)

Alternative à testStarted(com.android.tradefed.result.TestDescription) où nous spécifions également quand le test a été lancé, combiné avec ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) pour une mesure précise .

final void testStarted ( TestDescription test)

Rappels de cas de test

Des champs

TEST_CASE_EXCLUDE_GROUP_OPTION

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)

Lance
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildInfos

public final  getBuildInfos ()

Renvoie la liste des informations de construction disponibles dans l'invocation.

Retour

getDevices

public final  getDevices ()

Renvoie la liste des périphériques disponibles dans l'invocation.

Retour

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

Récupérez le fichier des artefacts de test ou des artefacts de module et mettez-le en cache dans une carte pour les appels suivants.

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

Retour
File Fichier de l'artefact de test ou de l'artefact de module. Renvoie null si le fichier n'est pas trouvé.

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

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

Retour
ITestInvocationListener

getModuleName

public String getModuleName ()

Retour
String

getRealDevices

public final  getRealDevices ()

Renvoie tous les périphériques non stub de la liste getDevices() .

Retour

getRunName

public String getRunName ()

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

Retour
String mRunName, le nom actuel de l'exécution du test.

initialiser

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

Initialisation du collecteur avec le contexte actuel et où transférer les résultats. Ne sera appelé qu'une seule fois par instance, et le collecteur doit mettre à jour son contexte interne et son écouteur. Init ne sera jamais appelé lors d'une exécution de test toujours avant.

N'annulez pas à moins que vous ne sachiez ce que vous faites.

Paramètres
context IInvocationContext : le IInvocationContext pour l'invocation en cours.

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

Retour
ITestInvocationListener le nouvel écouteur enveloppant celui d'origine.

Lance
DeviceNotAvailableException

invocationEnded

public final void invocationEnded (long elapsedTime)

Signale 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 : le temps écoulé de l'invocation en ms

invocationFailed

public final 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 : la FailureDescription décrivant la cause de l'échec

invocationFailed

public final 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 : la cause ERROR(/Throwable) de l'échec

invocationStarted

public final void invocationStarted (IInvocationContext context)

Écouteurs d'invocation pour le transfert

Paramètres
context IInvocationContext : informations sur l'invocation

est désactivé

public final boolean isDisabled ()

Renvoie True si l'objet entier est désactivé (ignorez à la fois l'installation et le démontage). Faux sinon.

Retour
boolean

isDisabledReceiver

public boolean isDisabledReceiver ()

Indique si IDeviceActionReceiver est désactivé ou non.

Retour
boolean renvoie vrai si désactivé, faux sinon.

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

N'utilisez pas l'implémentation interne du collecteur de métriques. C'est de la pure transmission.

Paramètres
dataName String : Le nom des données

logFile LogFile : le LogFile qui a été enregistré auparavant et qui doit être associé au cas de test.

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

Rappel lorsqu'un cas de test échoue avec un échec d'hypothèse.

Paramètres
testData DeviceMetricData : le DeviceMetricData contenant les données pour le cas de test.

test TestDescription : la TestDescription du cas de test en cours.

Lance
DeviceNotAvailableException

onTestEnd

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

Rappel lorsqu'un scénario de test est terminé. Ce devrait être le moment du nettoyage.

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

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

test TestDescription : la TestDescription du cas de test en cours.

Lance
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

Rappel lorsqu'un scénario de test est terminé. Ce devrait être le moment du nettoyage.

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

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

Lance
DeviceNotAvailableException

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

Rappel lorsqu'un scénario de test échoue.

Paramètres
testData DeviceMetricData : le DeviceMetricData contenant les données pour le cas de test.

test TestDescription : la TestDescription du cas de test en cours.

Lance
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

Permet de capturer l'événement de fin de module.

Lance
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

Permet de capturer l'événement de démarrage du module.

Lance
DeviceNotAvailableException

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

Rappel lorsqu'un test est terminé. Ce devrait être le moment du nettoyage.

Paramètres
runData DeviceMetricData : le DeviceMetricData contenant les données pour l'exécution. Sera le même objet que pendant onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) .

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

Lance
DeviceNotAvailableException

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

Rappel pour les événements testRunFailed

Lance
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

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

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

Lance
DeviceNotAvailableException

onTestStart

public void onTestStart (DeviceMetricData testData)

Rappel lorsqu'un scénario de test est démarré.

Paramètres
testData DeviceMetricData : le DeviceMetricData contenant les données pour le cas de test.

Lance
DeviceNotAvailableException

redémarrageEnd

public void rebootEnded (ITestDevice device)

Obtient une notification lorsque le redémarrage s'est terminé sur l'appareil.

REMARQUE : Les récepteurs doivent éviter de redémarrer pendant ce rappel. Toute tentative de redémarrage sera ignorée.

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

Lance
DeviceNotAvailableException

redémarrageDémarré

public void rebootStarted (ITestDevice device)

Obtient une notification lorsque le redémarrage a commencé dans l'appareil.

REMARQUE : Les récepteurs doivent éviter de redémarrer pendant ce rappel. Toute tentative de redémarrage sera ignorée.

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

Lance
DeviceNotAvailableException

setDisable

public final void setDisable (boolean isDisabled)

Définit si l'objet doit être désactivé. Désactivé signifie que les étapes de configuration et de démontage doivent être ignorées. Peut être utilisé pour rendre un objet désactivé par défaut dans le constructeur par défaut.

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

setDisableReceiver

public void setDisableReceiver (boolean isDisabled)

Définit si IDeviceActionReceiver doit être désactivé. La désactivation signifie qu'il ne sera pas enregistré sur l'appareil pour recevoir les événements d'action de l'appareil.

Paramètres
isDisabled boolean

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

N'utilisez pas l'implémentation interne du collecteur de métriques. C'est de la pure transmission.

Paramètres
logSaver ILogSaver : l' ILogSaver

testAssumptionFailuretestAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

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

Paramètres
test TestDescription : identifie le test

trace String : trace de pile de l'échec

testAssumptionFailuretestAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

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

Paramètres
test TestDescription : identifie le test

failure FailureDescription : FailureDescription décrivant l'échec et son contexte.

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

Alternative à ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) où nous pouvons spécifier directement l'heure de fin. Combinez avec testStarted(com.android.tradefed.result.TestDescription, long) pour une mesure précise.

Paramètres
test TestDescription : identifie le test

endTime long : l'heure à laquelle le test s'est terminé, mesurée via ERROR(/System#currentTimeMillis())

testMetrics : une ERROR(/Map) des métriques émises

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

Signale la fin de l'exécution d'un scénario de test individuel.

Si testFailed(TestDescription, FailureDescription) n'a pas été appelé, ce test a réussi. Renvoie également toute métrique clé/valeur qui peut avoir été émise lors de l'exécution du cas de test.

Paramètres
test TestDescription : identifie le test

testMetrics : une ERROR(/Map) des métriques émises

test échoué

public final void testFailed (TestDescription test, 
                FailureDescription failure)

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

test échoué

public final void testFailed (TestDescription test, 
                String trace)

Signale 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 pile de l'échec

testIgnored

public final 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 final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

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

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

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

Paramètres
dataName String : un nom descriptif ERROR(/String) des données. par exemple "device_logcat". Remarque dataName peut ne pas être unique par appel. c'est-à-dire que les implémenteurs doivent être capables de gérer plusieurs appels avec le même dataName

dataType LogDataType : le LogDataType des données

dataStream InputStreamSource : le InputStreamSource des données. Les implémenteurs doivent appeler createInputStream pour commencer à lire les données et s'assurer de fermer le InputStream résultant une fois terminé. Les appelants doivent s'assurer que la source des données reste présente et accessible jusqu'à ce que la méthode testLog se termine.

testLogEnregistré

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

N'utilisez pas l'implémentation interne du collecteur de métriques. C'est de la pure transmission.

Paramètres
dataName String : un nom descriptif ERROR(/String) des données. par exemple "device_logcat". Remarque dataName peut ne pas être unique par appel. c'est-à-dire que les implémenteurs doivent être capables de gérer plusieurs appels avec le même dataName

dataType LogDataType : le LogDataType des données

dataStream InputStreamSource : le InputStreamSource des données. Les implémenteurs doivent appeler createInputStream pour commencer à lire les données et s'assurer de fermer le InputStream résultant une fois terminé.

logFile LogFile : le LogFile contenant les métadonnées du fichier enregistré.

testModuleEnded

public final void testModuleEnded ()

Signale la fin de l'exécution d'un module.

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

Signale 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 des modules : les exécuteurs basés sur la suite.

Paramètres
moduleContext IInvocationContext : le 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 interfaces Map<> de type différent, nous devons donc utiliser HashMap ici.

Paramètres
elapsedTime long : temps écoulé signalé par l'appareil, en millisecondes

runMetrics : paires clé-valeur rapportées à la fin d'un test avec Metric .

testRunFailed

public final void testRunFailed (FailureDescription failure)

L'exécution du test de rapports n'a pas abouti 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)

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

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

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

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

Paramètres
runName String : le nom de l'exécution du test

testCount int : nombre total de tests en cours de test

attemptNumber int : numéro de commande, identifiant les différentes tentatives du même runName qui s'exécutent plusieurs fois. Le tryNumber est indexé à 0 et doit s'incrémenter à chaque fois qu'une nouvelle exécution se produit. Par exemple, un test est réessayé 3 fois de manière granulaire, il doit avoir 4 exécutions au total sous le même nom d'exécution et le nombre de tentatives est compris entre 0 et 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Tester les rappels d'exécution

Paramètres
runName String : le nom de l'exécution du test

testCount int : nombre total de tests en cours de test

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

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

Paramètres
runName String : le nom de l'exécution du test

testCount int : nombre total de tests en cours de test

attemptNumber int : numéro de commande, identifiant les différentes tentatives du même runName qui s'exécutent plusieurs fois. Le tryNumber est indexé à 0 et doit s'incrémenter à chaque fois qu'une nouvelle exécution se produit. Par exemple, un test est réessayé 3 fois de manière granulaire, il doit avoir 4 exécutions au total sous le même nom d'exécution et le nombre de tentatives est compris entre 0 et 3.

startTime long : l'heure à laquelle l'exécution a commencé, mesurée via ERROR(/System#currentTimeMillis())

testRunStopped

public final void testRunStopped (long elapsedTime)

L'exécution du test des rapports s'est arrêtée avant la fin en raison d'une demande de l'utilisateur.

TODO : actuellement inutilisé, pensez à supprimer

Paramètres
elapsedTime long : temps écoulé signalé par l'appareil, en millisecondes

testStarted

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é lancé, combiné avec ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) pour une mesure précise .

Paramètres
test TestDescription : identifie le test

startTime long : l'heure à laquelle le test a commencé, mesurée via ERROR(/System#currentTimeMillis())

testStarted

public final void testStarted (TestDescription test)

Rappels de cas de test

Paramètres
test TestDescription : identifie le test