BasePostProcessor
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
| java.lang.Object | |
| ↳ | com.android.tradefed.postprocessor.BasePostProcessor |
Es el IPostProcessor base que debe extender cada implementación. Asegúrate de que se llamen a los métodos de procesamiento posterior antes de los generadores de informes de resultados finales.
Resumen
Constructores públicos | |
|---|---|
BasePostProcessor()
|
|
Métodos públicos | |
|---|---|
final
ITestInvocationListener
|
init(ITestInvocationListener listener)
Es el paso de inicialización del posprocesador. |
final
void
|
invocationEnded(long elapsedTime)
Informa que la invocación finalizó, ya sea correctamente 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. |
void
|
invocationSkipped(SkipReason reason)
Informa que se omitió una invocación |
final
void
|
invocationStarted(IInvocationContext context)
Objetos de escucha de invocación para el reenvío |
final
boolean
|
isDisabled()
Devuelve True si todo el objeto está inhabilitado (omite la configuración y la limpieza). |
final
void
|
logAssociation(String dataName, LogFile logFile)
En algunos casos, el registro debe estar fuertemente asociado con los casos de prueba, pero no es posible hacerlo en la devolución de llamada directa de Actualiza la asociación de registro con la prueba. |
|
processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,
Implementa este método para agregar métricas y registros en todas las pruebas. |
abstract
|
processRunMetricsAndLogs(
Implementa este método para generar un conjunto de métricas nuevas a partir de las métricas y los registros existentes. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Implementa este método para realizar el procesamiento posterior de las métricas y los registros de cada prueba. |
final
void
|
setLogSaver(ILogSaver logSaver)
Establece |
void
|
setUp()
Anula este método en los procesadores posteriores secundarios para inicializar antes de que se ejecute la prueba. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Se llama cuando una prueba atómica marca que supone una condición que es falsa |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Se llama cuando una prueba atómica marca que supone una condición que es falsa |
final
void
|
testEnded(TestDescription test, long endTime,
Es una alternativa a |
final
void
|
testEnded(TestDescription test,
Informa el final de la ejecución de un caso de prueba individual. |
final
void
|
testFailed(TestDescription test, FailureDescription failure)
Informa la falla de un caso de prueba individual. |
final
void
|
testFailed(TestDescription test, String trace)
Informa 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)
Usa 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 la prueba. |
final
void
|
testModuleEnded()
Informa el final de la ejecución de un módulo. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
Informa el inicio de la ejecución de un módulo. |
final
void
|
testRunEnded(long elapsedTime,
Informa el final de la ejecución de la prueba. |
final
void
|
testRunFailed(FailureDescription failure)
No se pudo completar la ejecución de prueba de los informes debido a una falla que se describe en |
final
void
|
testRunFailed(String errorMessage)
No se pudo completar la ejecución de prueba de los informes debido a un error fatal. |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Informa el inicio de una ejecución de prueba. |
final
void
|
testRunStarted(String runName, int testCount)
Devoluciones de llamada de ejecución de prueba |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Informa el inicio de una ejecución de prueba. |
final
void
|
testRunStopped(long elapsedTime)
Se detuvo la ejecución de prueba de los informes antes de que se completara debido a una solicitud del usuario. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Se llama cuando se omite una prueba y no se ejecuta por un motivo que no se espera habitualmente. |
final
void
|
testStarted(TestDescription test, long startTime)
Alternativa a |
final
void
|
testStarted(TestDescription test)
Devoluciones de llamada de casos de prueba |
Métodos protegidos | |
|---|---|
void
|
cleanUp()
|
MetricMeasurement.DataType
|
getMetricType()
Anula este método para cambiar el tipo de métrica si es necesario. |
String
|
getRunName()
|
Constructores públicos
BasePostProcessor
public BasePostProcessor ()
Métodos públicos
init
public final ITestInvocationListener init (ITestInvocationListener listener)
Es el paso de inicialización del posprocesador. Se garantiza que se llamará antes de cualquiera de las devoluciones de llamada de las pruebas.
| Parámetros | |
|---|---|
listener |
ITestInvocationListener |
| Muestra | |
|---|---|
ITestInvocationListener |
|
invocationEnded
public final void invocationEnded (long elapsedTime)
Informa que la invocación finalizó, ya sea correctamente o debido a alguna condición de error.
El framework de TradeFederation lo llamará automáticamente.
| Parámetros | |
|---|---|
elapsedTime |
long: Es el tiempo transcurrido de la invocación en ms. |
invocationFailed
public final void invocationFailed (FailureDescription failure)
Informa una invocación incompleta debido a alguna condición de error.
El framework de TradeFederation lo llamará automáticamente.
| Parámetros | |
|---|---|
failure |
FailureDescription: Es el FailureDescription que describe la causa de la falla. |
invocationFailed
public final void invocationFailed (Throwable cause)
Informa una invocación incompleta debido a alguna condición de error.
El framework de TradeFederation lo llamará automáticamente.
| Parámetros | |
|---|---|
cause |
Throwable: Es la causa Throwable de la falla. |
invocationSkipped
public void invocationSkipped (SkipReason reason)
Informa que se omitió una invocación
| Parámetros | |
|---|---|
reason |
SkipReason |
invocationStarted
public final void invocationStarted (IInvocationContext context)
Objetos de escucha de invocación para el reenvío
| Parámetros | |
|---|---|
context |
IInvocationContext: Información sobre la invocación |
isDisabled
public final boolean isDisabled ()
Devuelve True si todo el objeto está inhabilitado (omite la configuración y la limpieza). De lo contrario, es falso.
| Muestra | |
|---|---|
boolean |
|
logAssociation
public final void logAssociation (String dataName,
LogFile logFile)En algunos casos, el registro debe estar fuertemente asociado con los casos de prueba, pero no es posible hacerlo en la devolución de llamada directa de testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile). Por lo tanto, esta devolución de llamada permite proporcionar una asociación sólida de forma explícita.
Actualiza la asociación de registro con la prueba. Si se llama a este método durante una prueba, 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: Es el LogFile que se registró antes y que debe asociarse con el caso de prueba. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Implementa este método para agregar métricas y registros en todas las pruebas. Las métricas que se obtengan de este método se registrarán como métricas de ejecución. Solo se deben devolver las métricas generadas recientemente, y con un nombre de clave único (no se permiten colisiones con claves existentes).
| Parámetros | |
|---|---|
allTestMetrics |
ListMultimap: Es un HashMultimap que almacena las métricas de cada prueba agrupadas por nombres de métricas. |
allTestLogs |
: Es un mapa que almacena el mapa de archivos de registro de cada prueba, con sus nombres de datos como claves, y que usa el TestDescription de cada prueba como claves. |
| Muestra | |
|---|---|
|
Es el conjunto de métricas generadas recientemente a partir de todas las métricas de prueba. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Implementa este método para generar un conjunto de métricas nuevas a partir de las métricas y los registros existentes. Solo se deben devolver las métricas generadas recientemente y con un nombre de clave único (no se permiten colisiones con claves existentes).
| Parámetros | |
|---|---|
rawMetrics |
: Es el conjunto de métricas sin procesar disponibles para la ejecución. |
runLogs |
: Es el conjunto de archivos de registro de la ejecución de prueba. |
| Muestra | |
|---|---|
|
Es el conjunto de métricas recién generadas a partir de las métricas de la ejecución. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Implementa este método para realizar el procesamiento posterior de las métricas y los registros de cada prueba. Solo se deben devolver las métricas generadas recientemente, y con un nombre de clave único (no se permiten colisiones con claves existentes).
| Parámetros | |
|---|---|
testDescription |
TestDescription: Es el objeto TestDescription que describe la prueba. |
testMetrics |
: Es el conjunto de métricas de la prueba. |
testLogs |
: Es el conjunto de archivos registrados durante la prueba. |
| Muestra | |
|---|---|
|
Es el conjunto de métricas recién generadas a partir de las métricas de prueba. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Establece ILogSaver para permitir que el implementador guarde archivos.
| Parámetros | |
|---|---|
logSaver |
ILogSaver: El ILogSaver |
setUp
public void setUp ()
Anula este método en los procesadores posteriores secundarios para inicializar antes de que se ejecute la prueba.
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Se llama cuando una prueba atómica marca que supone una condición que es falsa
| Parámetros | |
|---|---|
test |
TestDescription: Identifica la prueba. |
trace |
String: Es el seguimiento de pila de la falla. |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Se llama cuando una prueba atómica marca que supone una condición que es falsa
| Parámetros | |
|---|---|
test |
TestDescription: Identifica la prueba. |
failure |
FailureDescription: FailureDescription que describe la falla y su contexto. |
testEnded
public final void testEnded (TestDescription test, long endTime,testMetrics)
Es una alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) en la que podemos especificar la hora de finalización directamente. Combínalo con testStarted(com.android.tradefed.result.TestDescription, long) para obtener una medición precisa.
| Parámetros | |
|---|---|
test |
TestDescription: Identifica la prueba. |
endTime |
long: Es la fecha y hora en que finalizó la prueba, medida a través de System.currentTimeMillis(). |
testMetrics |
: Un ERROR(/Map) de las métricas emitidas |
testEnded
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 se aprobó. También devuelve las métricas de clave/valor que se hayan emitido durante la ejecución del caso de prueba.
| Parámetros | |
|---|---|
test |
TestDescription: Identifica la prueba. |
testMetrics |
: Un ERROR(/Map) de las métricas emitidas |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
Informa 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 la falla y su contexto. |
testFailed
public final void testFailed (TestDescription test, String trace)
Informa la falla de un caso de prueba individual.
Se llamará entre testStarted y testEnded.
| Parámetros | |
|---|---|
test |
TestDescription: Identifica la prueba. |
trace |
String: Es el seguimiento de pila de la falla. |
testIgnored
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. |
testLog
public final void testLog (String dataName,
LogDataType dataType,
InputStreamSource dataStream)Usa este método para registrar un archivo desde la implementación de PostProcessor.
| Parámetros | |
|---|---|
dataName |
String: Es un nombre descriptivo String de los datos, p. ej., "device_logcat". Nota: dataName puede no ser único por invocación, es decir, los implementadores deben poder controlar varias llamadas con el mismo dataName. |
dataType |
LogDataType: El LogDataType de los datos |
dataStream |
InputStreamSource: Es 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 la lectura. Los llamadores deben asegurarse de que la fuente de 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 la prueba.
Se debe usar en lugar de ITestInvocationListener.testLog(String, LogDataType,
InputStreamSource).
| Parámetros | |
|---|---|
dataName |
String: Es un nombre descriptivo String de los datos, p. ej., "device_logcat". Nota: dataName puede no ser único por invocación, es decir, los implementadores deben poder controlar varias llamadas con el mismo dataName. |
dataType |
LogDataType: El LogDataType de los datos |
dataStream |
InputStreamSource: Es 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 la lectura. |
logFile |
LogFile: Es el objeto LogFile que contiene los metadatos del archivo guardado. |
testModuleEnded
public final void testModuleEnded ()
Informa el final de la ejecución de un módulo.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Informa el inicio de la ejecución de un módulo. Esta devolución de llamada está asociada a testModuleEnded() y es opcional en la secuencia. Solo se usa durante una ejecución que utiliza módulos: ejecutores basados en conjuntos de pruebas.
| Parámetros | |
|---|---|
moduleContext |
IInvocationContext: Es el IInvocationContext del módulo. |
testRunEnded
public final void testRunEnded (long elapsedTime,
runMetrics) Informa el final de la ejecución de la prueba.
| Parámetros | |
|---|---|
elapsedTime |
long: Tiempo transcurrido informado por el dispositivo, en milisegundos |
runMetrics |
: Pares clave-valor que se registran al final de una ejecución de prueba |
testRunFailed
public final void testRunFailed (FailureDescription failure)
No se pudo completar la ejecución de prueba de los informes debido a una falla que se describe en FailureDescription.
| Parámetros | |
|---|---|
failure |
FailureDescription: FailureDescription que describe la falla y su contexto. |
testRunFailed
public final void testRunFailed (String errorMessage)
No se pudo completar la ejecución de prueba de los informes debido a un error fatal.
| Parámetros | |
|---|---|
errorMessage |
String: String que describe el motivo de la falla de la ejecución. |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber)Informa el inicio de una ejecución de prueba.
| Parámetros | |
|---|---|
runName |
String: Es el nombre de la ejecución de la prueba. |
testCount |
int: Es la cantidad total de pruebas en la ejecución de prueba. |
attemptNumber |
int: Es el número de pedido que identifica los diferentes intentos del mismo runName que se ejecuta varias veces. El valor de attemptNumber se indexa a partir de 0 y debe incrementarse cada vez que se realice una nueva ejecución. Por ejemplo, si una prueba se reintenta de forma granular 3 veces, debería tener 4 ejecuciones totales con el mismo runName y el valor de attemptNumber debería ser de 0 a 3. |
testRunStarted
public final void testRunStarted (String runName,
int testCount)Devoluciones de llamada de ejecución de prueba
| Parámetros | |
|---|---|
runName |
String: Es el nombre de la ejecución de la prueba. |
testCount |
int: Es la cantidad total de pruebas en la ejecución de prueba. |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber,
long startTime)Informa el inicio de una ejecución de prueba.
| Parámetros | |
|---|---|
runName |
String: Es el nombre de la ejecución de la prueba. |
testCount |
int: Es la cantidad total de pruebas en la ejecución de prueba. |
attemptNumber |
int: Es el número de pedido que identifica los diferentes intentos del mismo runName que se ejecuta varias veces. El valor de attemptNumber se indexa a partir de 0 y debe incrementarse cada vez que se ejecute una prueba nueva. Por ejemplo, si una prueba se reintenta de forma granular 3 veces, debería tener 4 ejecuciones totales con el mismo runName y el valor de attemptNumber debería ser de 0 a 3. |
startTime |
long: Es la hora en que comenzó la ejecución, medida a través de System.currentTimeMillis(). |
testRunStopped
public final void testRunStopped (long elapsedTime)
Se detuvo la ejecución de prueba de los informes antes de que se completara debido a una solicitud del usuario.
TODO: Actualmente no se usa. Considera quitarlo.
| Parámetros | |
|---|---|
elapsedTime |
long: Tiempo transcurrido informado por el dispositivo, en milisegundos |
testSkipped
public final void testSkipped (TestDescription test, SkipReason reason)
Se llama cuando se omite una prueba y no se ejecuta por un motivo que no se espera habitualmente. Se intentará volver a ejecutar estas pruebas para obtener una ejecución adecuada.
| Parámetros | |
|---|---|
test |
TestDescription: Identifica la prueba. |
reason |
SkipReason: SkipReason |
testStarted
public final void testStarted (TestDescription test, long startTime)
Alternativa a testStarted(com.android.tradefed.result.TestDescription) en la que 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: Es la fecha y hora en que comenzó la prueba, medida a través de System.currentTimeMillis(). |
testStarted
public final void testStarted (TestDescription test)
Devoluciones de llamada de casos de prueba
| Parámetros | |
|---|---|
test |
TestDescription: Identifica la prueba. |
Métodos protegidos
cleanUp
protected void cleanUp ()
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Anula este método para cambiar el tipo de métrica si es necesario. De forma predeterminada, la métrica se establece en el tipo procesado.
| Muestra | |
|---|---|
MetricMeasurement.DataType |
|
getRunName
protected String getRunName ()
| Muestra | |
|---|---|
String |
|