Postprocesador base
public abstract class BasePostProcessor
extends Object
implements IPostProcessor
java.lang.Objeto | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
El IPostProcessor
base que toda implementación debe extender. Asegúrese de que los métodos de posprocesamiento se llamen antes que los reporteros de resultados finales.
Resumen
Constructores públicos | |
---|---|
BasePostProcessor () |
Métodos públicos | |
---|---|
final ITestInvocationListener | init ( ITestInvocationListener listener) Paso de inicialización del postprocesador. |
final void | invocationEnded (long elapsedTime) Informa que la invocación ha terminado, ya sea con éxito o debido a alguna condición de error. |
final void | invocationFailed ( FailureDescription failure) Informa una invocación incompleta debido a alguna condición de error. |
final void | invocationFailed (Throwable cause) Informa una invocación incompleta debido a alguna condición de error. |
final void | invocationStarted ( IInvocationContext context) Oyentes de invocación para reenvío |
final boolean | isDisabled () Devuelve True si todo el objeto está deshabilitado (omita tanto la instalación como el desmontaje). |
final void | logAssociation (String dataName, LogFile logFile) En algunos casos, el registro debe estar fuertemente asociado con casos de prueba, pero la oportunidad de hacerlo directamente Actualiza la asociación de registro a prueba. |
processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) Implemente este método para agregar métricas y registros en todas las pruebas. | |
abstract | processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) Implemente este método para generar un conjunto de nuevas métricas a partir de las métricas y registros existentes. |
processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) Implemente este método para publicar métricas de proceso y registros de cada prueba. | |
final void | setLogSaver ( ILogSaver logSaver) Configure |
void | setUp () Anule este método en los posprocesadores secundarios para inicializar antes de que se ejecute la prueba. |
final void | testAssumptionFailure ( TestDescription test, String trace) Llamado cuando una prueba atómica marca que asume una condición que es falsa |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) Llamado cuando una prueba atómica marca que asume una condición que es falsa |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) Alternativa a |
final void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) Informa el final de la ejecución de un caso de prueba individual. |
final void | testFailed ( TestDescription test, FailureDescription failure) Informa de la falla de un caso de prueba individual. |
final void | testFailed ( TestDescription test, String trace) Informa de la falla de un caso de prueba individual. |
final void | testIgnored ( TestDescription test) Se llama cuando no se ejecutará una prueba, generalmente porque un método de prueba está anotado con org.junit.Ignore. |
final void | testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) Utilice este método para registrar un archivo desde la implementación de PostProcessor. |
final void | testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile) Se llama cuando se guarda el registro de prueba. |
final void | testModuleEnded () Informa del final de la ejecución de un módulo. |
final void | testModuleStarted ( IInvocationContext moduleContext) Informa el comienzo de un módulo en ejecución. |
final void | testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) Informa el final de la ejecución de la prueba. |
final void | testRunFailed ( FailureDescription failure) La ejecución de la prueba de informes no se pudo completar debido a una falla descrita por |
final void | testRunFailed (String errorMessage) La ejecución de la prueba de informes no se pudo completar debido a un error fatal. |
final void | testRunStarted (String runName, int testCount, int attemptNumber) Informa del inicio de una ejecución de prueba. |
final void | testRunStarted (String runName, int testCount) Prueba de ejecución de devoluciones de llamada |
final void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Informa del inicio de una ejecución de prueba. |
final void | testRunStopped (long elapsedTime) La ejecución de la prueba de informes se detuvo antes de completarse debido a una solicitud del usuario. |
final void | testStarted ( TestDescription test, long startTime) Alternativa a |
final void | testStarted ( TestDescription test) Devoluciones de llamadas de casos de prueba |
Métodos protegidos | |
---|---|
MetricMeasurement.DataType | getMetricType () Anule este método para cambiar el tipo de métrica si es necesario. |
String | getRunName () |
Constructores públicos
Postprocesador base
public BasePostProcessor ()
Métodos públicos
en eso
public final ITestInvocationListener init (ITestInvocationListener listener)
Paso de inicialización del postprocesador. Se aseguró de ser llamado antes de cualquiera de las devoluciones de llamada de las pruebas.
Parámetros | |
---|---|
listener | ITestInvocationListener |
Devoluciones | |
---|---|
ITestInvocationListener |
invocaciónTerminada
public final void invocationEnded (long elapsedTime)
Informa que la invocación ha terminado, ya sea con éxito o debido a alguna condición de error.
Será llamado automáticamente por el marco TradeFederation.Parámetros | |
---|---|
elapsedTime | long : el tiempo transcurrido de la invocación en ms |
invocaciónError
public final void invocationFailed (FailureDescription failure)
Informa una invocación incompleta debido a alguna condición de error.
Será llamado automáticamente por el marco TradeFederation.
Parámetros | |
---|---|
failure | FailureDescription : la FailureDescription que describe la causa de la falla |
invocaciónError
public final void invocationFailed (Throwable cause)
Informa una invocación incompleta debido a alguna condición de error.
Será llamado automáticamente por el marco TradeFederation.Parámetros | |
---|---|
cause | Throwable : el ERROR(/Throwable) causa de la falla |
invocaciónEmpezó
public final void invocationStarted (IInvocationContext context)
Oyentes de invocación para reenvío
Parámetros | |
---|---|
context | IInvocationContext : información sobre la invocación |
está desactivado
public final boolean isDisabled ()
Devuelve True si todo el objeto está deshabilitado (omita tanto la instalación como el desmontaje). Falso en caso contrario.
Devoluciones | |
---|---|
boolean |
asociación de registro
public final void logAssociation (String dataName, LogFile logFile)
En algunos casos, el registro debe estar fuertemente asociado con casos de prueba, pero la oportunidad de hacerlo directamente testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
la devolución de llamada no es posible. Por lo tanto, esta devolución de llamada permite proporcionar explícitamente una asociación sólida.
Actualiza la asociación de registro a prueba. Si se llama a este método durante una prueba, entonces el registro pertenece a la prueba; de lo contrario, será un registro de ejecución.
Parámetros | |
---|---|
dataName | String : el nombre de los datos |
logFile | LogFile : el LogFile que se registró antes y debe asociarse con el caso de prueba. |
procesoAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Implemente este método para agregar métricas y registros en todas las pruebas. Las métricas que surjan de este método se informarán como métricas de ejecución. Solo se deben devolver las métricas recién generadas y con un nombre de clave único (no se permiten colisiones con las claves existentes).
Parámetros | |
---|---|
allTestMetrics | ListMultimap : un HashMultimap que almacena las métricas de cada prueba agrupadas por nombres de métricas. |
allTestLogs | TestDescription de cada prueba como claves. |
Devoluciones | |
---|---|
El conjunto de métricas recién generadas a partir de todas las métricas de prueba. |
procesoRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Implemente este método para generar un conjunto de nuevas métricas a partir de las métricas y registros existentes. Solo se deben devolver las métricas recién generadas y con un nombre de clave único (no se permiten colisiones con las claves existentes).
Parámetros | |
---|---|
rawMetrics | |
runLogs |
Devoluciones | |
---|---|
El conjunto de métricas recién generadas a partir de las métricas de ejecución. |
procesoTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Implemente este método para publicar métricas de proceso y registros de cada prueba. Solo se deben devolver las métricas recién generadas y con un nombre de clave único (no se permiten colisiones con las claves existentes).
Parámetros | |
---|---|
testDescription | TestDescription : el objeto TestDescription que describe la prueba. |
testMetrics | |
testLogs |
Devoluciones | |
---|---|
El conjunto de métricas recién generadas a partir de las métricas de prueba. |
establecerLogSaver
public final void setLogSaver (ILogSaver logSaver)
Configure ILogSaver
para permitir que el implementador guarde archivos.
Parámetros | |
---|---|
logSaver | ILogSaver : el ILogSaver |
configuración
public void setUp ()
Anule este método en los posprocesadores secundarios para inicializar antes de que se ejecute la prueba.
pruebaAsunciónFalla
public final void testAssumptionFailure (TestDescription test, String trace)
Llamado cuando una prueba atómica marca que asume una condición que es falsa
Parámetros | |
---|---|
test | TestDescription : identifica la prueba |
trace | String : rastro de pila de falla |
pruebaAsunciónFalla
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Llamado cuando una prueba atómica marca que asume una condición que es falsa
Parámetros | |
---|---|
test | TestDescription : identifica la prueba |
failure | FailureDescription : FailureDescription que describe el error y su contexto. |
pruebaTerminó
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
donde podemos especificar la hora de finalización directamente. Combínelo con testStarted(com.android.tradefed.result.TestDescription, long)
para obtener una medida precisa.
Parámetros | |
---|---|
test | TestDescription : identifica la prueba |
endTime | long : la hora en que finalizó la prueba, medida a través de ERROR(/System#currentTimeMillis()) |
testMetrics | ERROR(/Map) de las métricas emitidas |
pruebaTerminó
public final void testEnded (TestDescription test,testMetrics)
Informa el final de la ejecución de un caso de prueba individual.
Si no se invocó testFailed(TestDescription, FailureDescription)
, esta prueba pasó. También devuelve cualquier métrica clave/valor que se haya emitido durante la ejecución del caso de prueba.
Parámetros | |
---|---|
test | TestDescription : identifica la prueba |
testMetrics | ERROR(/Map) de las métricas emitidas |
prueba fallida
public final void testFailed (TestDescription test, FailureDescription failure)
Informa de la falla de un caso de prueba individual.
Se llamará entre testStarted y testEnded.
Parámetros | |
---|---|
test | TestDescription : identifica la prueba |
failure | FailureDescription : FailureDescription que describe el error y su contexto. |
prueba fallida
public final void testFailed (TestDescription test, String trace)
Informa de la falla de un caso de prueba individual.
Se llamará entre testStarted y testEnded.
Parámetros | |
---|---|
test | TestDescription : identifica la prueba |
trace | String : rastro de pila de falla |
prueba ignorada
public final void testIgnored (TestDescription test)
Se llama cuando no se ejecutará una prueba, generalmente porque un método de prueba está anotado con org.junit.Ignore.
Parámetros | |
---|---|
test | TestDescription : identifica la prueba |
registro de prueba
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Utilice este método para registrar un archivo desde la implementación de PostProcessor.
Parámetros | |
---|---|
dataName | String : un ERROR(/String) nombre descriptivo de los datos. por ejemplo, "device_logcat". Tenga en cuenta que dataName puede no ser único por invocación. es decir, los implementadores deben poder manejar múltiples llamadas con el mismo nombre de datos |
dataType | LogDataType : el LogDataType de los datos |
dataStream | InputStreamSource : el InputStreamSource de los datos. Los implementadores deben llamar a createInputStream para comenzar a leer los datos y asegurarse de cerrar el InputStream resultante cuando se complete. Las personas que llaman deben asegurarse de que la fuente de los datos permanezca presente y accesible hasta que se complete el método testLog. |
testLogSaved
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Se llama cuando se guarda el registro de prueba.
Debe usarse en lugar de ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)
.
Parámetros | |
---|---|
dataName | String : un ERROR(/String) nombre descriptivo de los datos. por ejemplo, "device_logcat". Tenga en cuenta que dataName puede no ser único por invocación. es decir, los implementadores deben poder manejar múltiples llamadas con el mismo nombre de datos |
dataType | LogDataType : el LogDataType de los datos |
dataStream | InputStreamSource : el InputStreamSource de los datos. Los implementadores deben llamar a createInputStream para comenzar a leer los datos y asegurarse de cerrar el InputStream resultante cuando se complete. |
logFile | LogFile : el LogFile que contiene los metadatos del archivo guardado. |
testModuleEnded
public final void testModuleEnded ()
Informa del final de la ejecución de un módulo.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Informa el comienzo de un módulo en ejecución. Esta devolución de llamada está asociada con testModuleEnded()
y es opcional en la secuencia. Solo se usa durante una carrera que usa módulos: corredores basados en suite.
Parámetros | |
---|---|
moduleContext | IInvocationContext : el IInvocationContext del módulo. |
testRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
Informa el final de la ejecución de la prueba. FIXME: no podemos tener dos interfaces Map<> con un tipo diferente, por lo que tenemos que usar HashMap aquí.
Parámetros | |
---|---|
elapsedTime | long : tiempo transcurrido informado por el dispositivo, en milisegundos |
runMetrics | Metric . |
pruebaRunFailed
public final void testRunFailed (FailureDescription failure)
La ejecución de la prueba de informes no se pudo completar debido a una falla descrita por FailureDescription
.
Parámetros | |
---|---|
failure | FailureDescription : FailureDescription que describe el error y su contexto. |
pruebaRunFailed
public final void testRunFailed (String errorMessage)
La ejecución de la prueba de informes no se pudo completar debido a un error fatal.
Parámetros | |
---|---|
errorMessage | String : ERROR(/String) que describe el motivo del error de ejecución. |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber)
Informa del inicio de una ejecución de prueba.
Parámetros | |
---|---|
runName | String : el nombre de la ejecución de prueba |
testCount | int : número total de pruebas en ejecución de prueba |
attemptNumber | int : número de orden, identificando los diferentes intentos del mismo runName que se ejecutan varias veces. El número de intento está indexado en 0 y debe incrementarse cada vez que ocurre una nueva ejecución. Por ejemplo, una prueba se reintenta granularmente 3 veces, debe tener 4 ejecuciones totales con el mismo nombre de ejecución y el número de intento es de 0 a 3. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
Prueba de ejecución de devoluciones de llamada
Parámetros | |
---|---|
runName | String : el nombre de la ejecución de prueba |
testCount | int : número total de pruebas en ejecución de prueba |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
Informa del inicio de una ejecución de prueba.
Parámetros | |
---|---|
runName | String : el nombre de la ejecución de prueba |
testCount | int : número total de pruebas en ejecución de prueba |
attemptNumber | int : número de orden, identificando los diferentes intentos del mismo runName que se ejecutan varias veces. El número de intento está indexado en 0 y debe incrementarse cada vez que ocurre una nueva ejecución. Por ejemplo, una prueba se reintenta granularmente 3 veces, debe tener 4 ejecuciones totales con el mismo nombre de ejecución y el número de intento es de 0 a 3. |
startTime | long : la hora en que comenzó la ejecución, medida a través de ERROR(/System#currentTimeMillis()) |
testRunStopped
public final void testRunStopped (long elapsedTime)
La ejecución de la prueba de informes se detuvo antes de completarse debido a una solicitud del usuario.
TODO: actualmente sin usar, considere eliminar
Parámetros | |
---|---|
elapsedTime | long : tiempo transcurrido informado por el dispositivo, en milisegundos |
pruebaEmpezó
public final void testStarted (TestDescription test, long startTime)
Alternativa a testStarted(com.android.tradefed.result.TestDescription)
donde también especificamos cuándo se inició la prueba, combinada con ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
para una medición precisa .
Parámetros | |
---|---|
test | TestDescription : identifica la prueba |
startTime | long : la hora en que comenzó la prueba, medida a través de ERROR(/System#currentTimeMillis()) |
pruebaEmpezó
public final void testStarted (TestDescription test)
Devoluciones de llamadas de casos de prueba
Parámetros | |
---|---|
test | TestDescription : identifica la prueba |
Métodos protegidos
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Anule este método para cambiar el tipo de métrica si es necesario. Por defecto, la métrica se establece en tipo procesado.
Devoluciones | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Devoluciones | |
---|---|
String |