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

Affiche la liste des informations de compilation disponibles dans l'appel.

final getDevices()

Affiche la liste des appareils disponibles dans l'appel.

File getFileFromTestArtifacts(String fileName)

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

final ITestInvocationListener getInvocationListener()

Renvoie l'ITestInvocationListener d'origine vers laquelle nous transférons les résultats.

String getModuleName()
final getRealDevices()

Renvoie tous les appareils autres que les bouchons 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 l'emplacement où transmettre les résultats.

final void invocationEnded(long elapsedTime)

Indique que l'appel a pris fin, que ce soit avec succès ou en raison d'une condition d'erreur.

final void invocationFailed(FailureDescription failure)

Signale une invocation incomplète en raison d'une condition d'erreur.

final void invocationFailed(Throwable cause)

Signale une invocation incomplète en raison d'une condition d'erreur.

void invocationSkipped(SkipReason reason)

Signale une invocation comme ignorée

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é (ignorez la configuration et le démontage).

boolean isDisabledReceiver()

Indique si l'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)

Appel de rappel en cas d'échec d'un cas de test en raison d'une hypothèse incorrecte.

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)

Rappel lorsque le cas de test est terminé.

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)

Rappel lorsque le cas de test est terminé.

void onTestFail(DeviceMetricData testData, TestDescription test)

Appel de rappel en cas d'échec d'un scénario de test.

void onTestModuleEnded()

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

void onTestModuleStarted()

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

void onTestRunEnd(DeviceMetricData runData, currentRunMetrics)

Rappel lorsque l'exécution d'un test est terminée.

void onTestRunFailed(DeviceMetricData testData, FailureDescription failure)

Rappel pour les événements testRunFailed

void onTestRunStart(DeviceMetricData runData)

Rappel lorsque l'exécution d'un test est lancée.

void onTestStart(DeviceMetricData testData)

Rappel lorsque le cas de test est lancé.

void rebootEnded(ITestDevice device)

Récupère la notification lorsque le redémarrage est terminé sur l'appareil.

void rebootStarted(ITestDevice device)

Récupère la notification lorsque le redémarrage a commencé sur l'appareil.

final void setDisable(boolean isDisabled)

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

void setDisableReceiver(boolean isDisabled)

Indique 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 directement l'heure de fin.

final void testEnded(TestDescription test, testMetrics)

Indique la fin de l'exécution d'un cas de test individuel.

final void testFailed(TestDescription test, FailureDescription failure)

Signale l'échec d'un cas de test individuel.

final void testFailed(TestDescription test, String trace)

Signale l'échec d'un cas 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 à 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()

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

final void testModuleStarted(IInvocationContext moduleContext)

Indique le début de l'exécution d'un module.

final void testRunEnded(long elapsedTime, runMetrics)

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

final void testRunFailed(FailureDescription failure)

L'exécution du test des rapports a échoué en raison d'un échec décrit par FailureDescription.

final void testRunFailed(String errorMessage)

L'exécution du test des rapports a échoué 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 des tests

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 du test des rapports a été arrêtée avant la fin en raison d'une requête de l'utilisateur.

final void testSkipped(TestDescription test, SkipReason reason)

Appelé lorsqu'un test est ignoré et n'a pas été exécuté pour une raison inhabituelle.

final void testStarted(TestDescription test, long startTime)

Alternative à testStarted(com.android.tradefed.result.TestDescription), où nous spécifions également le moment où le test a commencé, combiné à 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

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)

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

getBuildInfos

public final  getBuildInfos ()

Affiche la liste des informations de compilation disponibles dans l'appel.

Renvoie

getDevices

public final  getDevices ()

Affiche la liste des appareils disponibles dans l'appel.

Renvoie

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

Récupérez le fichier à partir des artefacts de test ou des artefacts de module, puis mettez-le en cache dans une carte 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 n'est pas trouvé.

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

Renvoie l'ITestInvocationListener d'origine vers laquelle nous transférons les résultats.

Renvoie
ITestInvocationListener

getModuleName

public String getModuleName ()

Renvoie
String

getRealDevices

public final  getRealDevices ()

Renvoie tous les appareils autres que les bouchons 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, 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 l'emplacement où transmettre les résultats. Ne sera appelé qu'une seule fois par instance, et le collecteur doit mettre à jour son contexte et son écouteur internes. Init n'est jamais appelé lors d'une exécution de test, toujours avant.

Ne remplacez pas ce paramètre 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 encapsulant l'écouteur d'origine.

Génère
DeviceNotAvailableException

invocationEnded

public final void invocationEnded (long elapsedTime)

Indique que l'appel a pris fin, que ce soit avec succès ou en raison d'une condition d'erreur.

Appelé automatiquement par le framework TradeFederation.

Paramètres
elapsedTime long: temps écoulé de l'appel en ms

invocationFailed

public final void invocationFailed (FailureDescription failure)

Signale une invocation incomplète en raison d'une condition d'erreur.

Appelé automatiquement par le framework TradeFederation.

Paramètres
failure FailureDescription: FailureDescription décrivant la cause de l'échec

invocationFailed

public final void invocationFailed (Throwable cause)

Signale une invocation incomplète en raison d'une condition d'erreur.

Appelé automatiquement 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 final void invocationStarted (IInvocationContext context)

Écouteurs d'appel pour le transfert

Paramètres
context IInvocationContext: informations sur l'appel

isDisabled

public final boolean isDisabled ()

Renvoie la valeur "True" si l'objet entier est désactivé (ignorez la configuration et le démontage). Sinon, cette valeur est "false".

Renvoie
boolean

isDisabledReceiver

public boolean isDisabledReceiver ()

Indique si l'IDeviceActionReceiver est désactivé ou non.

Renvoie
boolean Renvoie "true" si la fonctionnalité est désactivée, ou "false" dans le cas contraire.

logAssociation

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 transfert pur.

Paramètres
dataName String: nom des données

logFile LogFile: LogFile enregistré précédemment et qui doit être associé au cas de test.

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

Appel de rappel en cas d'échec d'un cas de test en raison d'une hypothèse incorrecte.

Paramètres
testData DeviceMetricData: DeviceMetricData contenant les données du cas 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 cas de test est terminé. C'est le moment de nettoyer.

Paramètres
testData DeviceMetricData: DeviceMetricData contenant les données du cas de test. Il s'agit du même objet que lors de 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 cas de test est terminé. C'est le moment de nettoyer.

Paramètres
testData DeviceMetricData: DeviceMetricData contenant les données du cas de test. Il s'agit du même objet que lors de 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

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

Appel de rappel en cas d'échec d'un scénario de test.

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

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

Génère
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

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

Génère
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

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

Génère
DeviceNotAvailableException

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

Rappel lorsque l'exécution d'un test est terminée. C'est le moment de nettoyer.

Paramètres
runData DeviceMetricData: DeviceMetricData contenant les données de l'exécution. Il s'agit du même objet que lors de 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

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

Rappel lorsque l'exécution d'un test est lancée.

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

Génère
DeviceNotAvailableException

onTestStart

public void onTestStart (DeviceMetricData testData)

Rappel lorsque le cas de test est lancé.

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

Génère
DeviceNotAvailableException

rebootEnded

public void rebootEnded (ITestDevice device)

Récupère la notification lorsque le redémarrage 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é.

Génère
DeviceNotAvailableException

rebootStarted

public void rebootStarted (ITestDevice device)

Récupère la notification lorsque le redémarrage a commencé 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 à partir duquel le redémarrage a commencé.

Génère
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 désactiver un objet par défaut dans le constructeur par défaut.

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

setDisableReceiver

public void setDisableReceiver (boolean isDisabled)

Indique si IDeviceActionReceiver doit être désactivé. Si vous la désactivez, elle ne sera pas enregistrée sur l'appareil pour recevoir les événements d'action de l'appareil.

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 transfert pur.

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

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.

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-le à testStarted(com.android.tradefed.result.TestDescription, long) pour obtenir une mesure précise.

Paramètres
test TestDescription: identifie le test

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

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

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

Indique la fin de l'exécution d'un cas de test individuel.

Si testFailed(TestDescription, FailureDescription) n'a pas été appelé, ce test est 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
test TestDescription: identifie le test

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

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

Signale l'échec d'un cas de test individuel.

Appelé entre testStarted et testEnded.

Paramètres
test TestDescription: identifie le test

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

testFailed

public final void testFailed (TestDescription test, 
                String trace)

Signale l'échec d'un cas de test individuel.

Appelé entre testStarted et testEnded.

Paramètres
test TestDescription: identifie le test

trace String: trace de la 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 à l'appel de test.

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

Le framework TradeFederation appelle 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 : Le nom de données ne doit pas nécessairement être unique par appel. Autrement dit, les implémentateurs doivent pouvoir gérer plusieurs appels avec le même nom de données.

dataType LogDataType: LogDataType des données

dataStream InputStreamSource: InputStreamSource des données. Les implémentateurs doivent appeler createInputStream pour commencer à lire les données et s'assurer de fermer l'InputStream généré une fois la lecture terminée. Les appelants doivent s'assurer que la source des données reste présente et accessible jusqu'à la fin de la méthode testLog.

testLogSaved

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 transfert pur.

Paramètres
dataName String: nom descriptif String des données (par exemple, "device_logcat"). Remarque : Le nom de données ne doit pas nécessairement être unique par appel. Autrement dit, les implémentateurs doivent pouvoir gérer plusieurs appels avec le même nom de données.

dataType LogDataType: LogDataType des données

dataStream InputStreamSource: InputStreamSource des données. Les implémentateurs doivent appeler createInputStream pour commencer à lire les données et s'assurer de fermer l'InputStream généré une fois la lecture terminée.

logFile LogFile: 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)

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

Paramètres
elapsedTime long: durée écoulée, en millisecondes, indiquée par l'appareil

runMetrics : paires clé-valeur signalées à la fin d'une exécution de test

testRunFailed

public final void testRunFailed (FailureDescription failure)

L'exécution du test des rapports a échoué 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 a échoué en raison d'une erreur fatale.

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

testRunStarted

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 dans l'exécution du test

attemptNumber int: numéro de commande, identifiant les différentes tentatives du même runName exécutées plusieurs fois. Le nombre d'essais est indexé à 0 et doit augmenter à chaque exécution. Par exemple, si un test est réessayé trois fois, il doit comporter quatre exécutions au total sous le même nom d'exécution, et le nombre d'essais doit être compris entre 0 et 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Rappels d'exécution des tests

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 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 dans l'exécution du test

attemptNumber int: numéro de commande, identifiant les différentes tentatives du même runName exécutées plusieurs fois. Le nombre d'essais est indexé à 0 et doit augmenter à chaque nouvelle exécution. Par exemple, si un test est réessayé trois fois, il doit comporter quatre exécutions au total sous le même nom d'exécution, et le nombre d'essais doit être compris entre 0 et 3.

startTime long: heure de début de l'exécution, mesurée via System.currentTimeMillis()

testRunStopped

public final void testRunStopped (long elapsedTime)

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

TODO: currently unused, consider removing

Paramètres
elapsedTime long: durée écoulée, en millisecondes, indiquée par l'appareil

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

Appelé lorsqu'un test est ignoré et n'a pas été exécuté pour une raison inhabituelle. Nous allons tenter de réexécuter ces tests pour obtenir une exécution correcte.

Paramètres
test TestDescription: identifie le test

reason SkipReason : SkipReason

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

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

Paramètres
test TestDescription: identifie le test

startTime long: heure à laquelle le test a commencé, mesurée via System.currentTimeMillis()

testStarted

public final void testStarted (TestDescription test)

Rappels des scénarios de test

Paramètres
test TestDescription: identifie le test