IMetricCollector

public interface IMetricCollector
implements IDisableable, ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector


Cette interface sera ajoutée en tant que décorateur lors de la création de rapports sur les résultats des tests afin de collecter les métriques correspondantes.

Cette interface ne peut pas être utilisée comme même si elle étend ITestInvocationListener. La vérification de la configuration le refusera. Il doit être utilisé comme "metrics_collector".

Les collecteurs ne sont pas censés conserver un état interne, car ils peuvent être réutilisés à plusieurs endroits. Si un état interne doit vraiment être utilisé, il doit être nettoyé sur init(IInvocationContext,ITestInvocationListener).

Résumé

Méthodes publiques

default boolean captureModuleLevel()

Indique si le collecteur s'applique à la capture au niveau du module et doit être initialisé.

default boolean doesModuleContainFailure()

Renvoie "true" si le module actuel contient des échecs de scénarios de test ou d'exécution de tests.

default void enableDefaultMetricCollection()

Permet aux collecteurs d'activer la collecte de métriques par défaut.

default IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel()
abstract List<IBuildInfo> getBuildInfos()

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

abstract List<ITestDevice> getDevices()

Renvoie la liste des appareils disponibles dans l'invocation.

abstract ITestInvocationListener getInvocationListener()

Renvoie le ITestInvocationListener d'origine vers lequel nous transférons les résultats.

default IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel()
abstract ITestInvocationListener init(IInvocationContext context, ITestInvocationListener listener)

Initialisation du collecteur avec le contexte actuel et l'emplacement où transférer les résultats.

default boolean isDefaultMetricCollectionEnabled()

Indique si le collecteur collecte des métriques dans le cadre de la collecte de métriques par défaut.

abstract void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

Callback lorsqu'un cas de test échoue en raison d'un échec d'hypothèse.

abstract void onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)

Rappel lorsqu'un cas de test est terminé.

abstract void onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

Rappel lorsqu'un cas de test est terminé.

abstract void onTestFail(DeviceMetricData testData, TestDescription test)

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

default void onTestModuleEnded()

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

default void onTestModuleStarted()

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

abstract void onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)

Rappel lorsqu'une série de tests est terminée.

abstract void onTestRunStart(DeviceMetricData runData)

Rappel lorsqu'une série de tests est lancée.

default void onTestRunStart(DeviceMetricData runData, int testCount)

Rappel lorsqu'une série de tests est lancée.

default void onTestRunStartBlocking()

Rappel explicite pour démarrer manuellement un collecteur s'il le prend en charge.

abstract void onTestStart(DeviceMetricData testData)

Rappel lorsqu'un cas de test est lancé.

default void setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level)

Définit le niveau auquel le collecteur doit collecter les journaux, quels que soient les échecs.

default void setModuleContainsFailure()

Indique si le module a rencontré des échecs (scénario de test, exécution de test).

default void setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level)

Définit le niveau auquel le collecteur doit collecter les journaux en cas d'échec.

Méthodes publiques

captureModuleLevel

public boolean captureModuleLevel ()

Indique si le collecteur s'applique à la capture au niveau du module et doit être initialisé.

Renvoie
boolean

doesModuleContainFailure

public boolean doesModuleContainFailure ()

Renvoie "true" si le module actuel contient des échecs de scénarios de test ou d'exécution de tests.

Renvoie
boolean

enableDefaultMetricCollection

public void enableDefaultMetricCollection ()

Permet aux collecteurs d'activer la collecte de métriques par défaut. Lorsque la collecte de métriques par défaut est activée, le collecteur ne doit collecter les données qu'au niveau de collecte spécifié.

getAlwaysOnCollectionLevel

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

Renvoie
IMetricCollector.MetricCollectionLevel

getBuildInfos

public abstract List<IBuildInfo> getBuildInfos ()

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

Renvoie
List<IBuildInfo>

getDevices

public abstract List<ITestDevice> getDevices ()

Renvoie la liste des appareils disponibles dans l'invocation.

Renvoie
List<ITestDevice>

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

Renvoie le ITestInvocationListener d'origine vers lequel nous transférons les résultats.

Renvoie
ITestInvocationListener

getOnFailureCollectionLevel

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

Renvoie
IMetricCollector.MetricCollectionLevel

init

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

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

Ne remplacez pas cette fonction, sauf 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

isDefaultMetricCollectionEnabled

public boolean isDefaultMetricCollectionEnabled ()

Indique si le collecteur collecte des métriques dans le cadre de la collecte de métriques par défaut.

Renvoie
boolean

onTestAssumptionFailure

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

Callback lorsqu'un cas de test échoue en raison d'un échec d'hypothèse.

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

test TestDescription : TestDescription du cas de test en cours.

Génère
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, 
                TestDescription test)

Rappel lorsqu'un cas de test est terminé. Cela devrait être le moment de faire le ménage.

Paramètres
testData DeviceMetricData : DeviceMetricData contenant les données du cas de test. Sera le même objet que pendant onTestStart(DeviceMetricData).

currentTestCaseMetrics Map : carte actuelle des métriques transmises à testEnded(TestDescription,Map).

test TestDescription : TestDescription du cas de test en cours.

Génère
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

Rappel lorsqu'un cas de test est terminé. Cela devrait être le moment de faire le ménage.

Paramètres
testData DeviceMetricData : DeviceMetricData contenant les données du cas de test. Sera le même objet que pendant onTestStart(DeviceMetricData).

currentTestCaseMetrics Map : carte actuelle des métriques transmises à testEnded(TestDescription,Map).

Génère
DeviceNotAvailableException

onTestFail

public abstract void onTestFail (DeviceMetricData testData, 
                TestDescription test)

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

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

test TestDescription : TestDescription du cas 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
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

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

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

onTestRunEnd

public abstract void onTestRunEnd (DeviceMetricData runData, 
                Map<String, MetricMeasurement.Metric> currentRunMetrics)

Rappel lorsqu'une série de tests est terminée. Cela devrait être le moment de faire le ménage.

Paramètres
runData DeviceMetricData : DeviceMetricData contenant les données de l'exécution. Sera le même objet que lors de onTestRunStart(DeviceMetricData).

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

Génère
DeviceNotAvailableException

onTestRunStart

public abstract void onTestRunStart (DeviceMetricData runData)

Rappel lorsqu'une série de tests est lancée.

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

Génère
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData, 
                int testCount)

Rappel lorsqu'une série de tests est lancée.

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

testCount int : nombre de cas de test dans cette exécution de test.

Génère
DeviceNotAvailableException

onTestRunStartBlocking

public void onTestRunStartBlocking ()

Rappel explicite pour démarrer manuellement un collecteur s'il le prend en charge. Cela permet de s'assurer que nous sommes en dehors de certains cycles de vie de test qui sont asynchrones.

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

onTestStart

public abstract void onTestStart (DeviceMetricData testData)

Rappel lorsqu'un cas de test est lancé.

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

Génère
DeviceNotAvailableException

setAlwaysOnCollectionLevel

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

Définit le niveau auquel le collecteur doit collecter les journaux, quels que soient les échecs.

Si le niveau est défini sur NULL, aucune collection ne sera créée.

Paramètres
level IMetricCollector.MetricCollectionLevel : MetricCollectionLevel à laquelle les journaux seront collectés.

setModuleContainsFailure

public void setModuleContainsFailure ()

Indique si le module a rencontré des échecs (scénario de test, exécution de test).

setOnFailureCollectionLevel

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

Définit le niveau auquel le collecteur doit collecter les journaux en cas d'échec.

Si le niveau est défini sur NULL, aucune collection ne sera créée.

Paramètres
level IMetricCollector.MetricCollectionLevel : MetricCollectionLevel à laquelle les journaux seront collectés.