BasePostProcessor
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
java.lang.Object | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
El IPostProcessor
base que debe extender cada implementación. Asegúrate de que se llame 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)
Paso de inicialización del procesador posterior. |
final
void
|
invocationEnded(long elapsedTime)
Informa que la invocación finalizó, ya sea de forma correcta 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()
Muestra verdadero si todo el objeto está inhabilitado (se omite la configuración y el desmontaje). |
final
void
|
logAssociation(String dataName, LogFile logFile)
En algunos casos, el registro debe estar fuertemente asociado con un caso de prueba, pero no es posible hacerlo en la devolución de llamada directa de Actualiza la asociación de registro a 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 procesar las métricas y los registros de cada prueba. |
final
void
|
setLogSaver(ILogSaver logSaver)
Establece el |
void
|
setUp()
Anula este método en los procesadores posteriores secundarios para inicializarlo 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 falsa. |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Se llama cuando una prueba atómica marca que supone una condición 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 el error de un caso de prueba individual. |
final
void
|
testFailed(TestDescription test, String trace)
Informa el error de un caso de prueba individual. |
final
void
|
testIgnored(TestDescription test)
Se llama cuando no se ejecutará una prueba, por lo general, 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 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 prueba. |
final
void
|
testRunFailed(FailureDescription failure)
No se pudo completar la ejecución de prueba de informes debido a un error que describe |
final
void
|
testRunFailed(String errorMessage)
No se pudo completar la ejecución de prueba de informes debido a un error irrecuperable. |
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 la 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)
La ejecución de prueba de los informes se detuvo antes de completarse 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 normalmente no se espera. |
final
void
|
testStarted(TestDescription test, long startTime)
Es una 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)
Paso de inicialización del postprocesador. Se debe llamar antes de cualquiera de las devoluciones de llamada de prueba.
Parámetros | |
---|---|
listener |
ITestInvocationListener |
Muestra | |
---|---|
ITestInvocationListener |
invocationEnded
public final void invocationEnded (long elapsedTime)
Informa que la invocación finalizó, ya sea de forma correcta 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 del error. |
invocationSkipped
public void invocationSkipped (SkipReason reason)
Informa que se omitió una invocación
Parámetros | |
---|---|
reason |
SkipReason |
iniciación de invocación
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 |
Inhabilitado
public final boolean isDisabled ()
Muestra el valor True si se inhabilita el objeto completo (omite la configuración y la eliminación). 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 un caso 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 manera explícita.
Actualiza la asociación de registro a 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 : Es el nombre de los datos. |
logFile |
LogFile : Es el LogFile que se registró antes y debe estar asociado 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 informarán como métricas de ejecución. Solo se deben mostrar las métricas generadas recientemente y con un nombre de clave único (no se permite la colisión con claves existentes).
Parámetros | |
---|---|
allTestMetrics |
ListMultimap : 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 cada prueba de archivos de registro codificados por sus nombres de datos, con 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 mostrar las métricas generadas recientemente y con un nombre de clave único (no se permite la colisión 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 | |
---|---|
|
El conjunto de métricas recién generadas a partir de las métricas de ejecución. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Implementa este método para procesar las métricas y los registros de cada prueba. Solo se deben mostrar las métricas recién generadas y con un nombre de clave único (no se permite ningún conflicto con las 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 que se registró durante la prueba. |
Muestra | |
---|---|
|
Es el conjunto de métricas generadas recientemente a partir de las métricas de prueba. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Establece el ILogSaver
para permitir que el implementador guarde archivos.
Parámetros | |
---|---|
logSaver |
ILogSaver : el ILogSaver |
Configuración
public void setUp ()
Anula este método en los procesadores posteriores secundarios para inicializarlo 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 asume una condición falsa.
Parámetros | |
---|---|
test |
TestDescription : Identifica la prueba. |
trace |
String : Seguimiento de pila de las fallas |
ErrordeAsuncióndeprueba
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Se llama cuando una prueba atómica marca que asume una condición 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 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 muestra cualquier métrica de par clave-valor que se pueda haber 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 |
Prueba con errores
public final void testFailed (TestDescription test, FailureDescription failure)
Informa el error 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 el error de un caso de prueba individual.
Se llamará entre testStarted y testEnded.
Parámetros | |
---|---|
test |
TestDescription : Identifica la prueba. |
trace |
String : seguimiento de pila de la falla |
pruebaIgnorada
public final void testIgnored (TestDescription test)
Se llama cuando no se ejecuta una prueba, por lo general, porque un método de prueba se anota 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 : Un nombre descriptivo String de los datos, p. ej., "device_logcat". Nota:
Es posible que dataName no sea ú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 : 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 terminen. Los llamadores deben asegurarse de que la fuente de los datos permanezca presente y se pueda acceder a ella 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 : Es un nombre descriptivo String de los datos, p. ej., "device_logcat". Nota:
Es posible que dataName no sea ú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 terminen. |
logFile |
LogFile : Es el 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 con testModuleEnded()
y es opcional en la secuencia. Solo se usa durante una ejecución que usa módulos: ejecutores basados en paquetes.
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 prueba.
Parámetros | |
---|---|
elapsedTime |
long : Tiempo transcurrido informado por el dispositivo, en milisegundos |
runMetrics |
: Son los pares clave-valor que se informan al final de una ejecución de prueba. |
Error de ejecución de prueba
public final void testRunFailed (FailureDescription failure)
No se pudo completar la ejecución de prueba de los informes debido a un error que describe 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 informes debido a un error irrecuperable.
Parámetros | |
---|---|
errorMessage |
String : String que describe el motivo de la falla de 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 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 ejecutaron varias veces. El attemptNumber tiene un índice de 0 y debe aumentar cada vez que se realiza una ejecución nueva. p.ej., una prueba se vuelve a intentar de forma granular 3 veces, debe tener 4 ejecuciones en total con el mismo runName y el attemptNumber va de 0 a 3. |
pruebaRunStarted
public final void testRunStarted (String runName, int testCount)
Devoluciones de llamada de la ejecución de prueba
Parámetros | |
---|---|
runName |
String : Es el nombre de la ejecución de 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 prueba. |
testCount |
int : Es la cantidad total de pruebas en la ejecución de prueba. |
attemptNumber |
int : Es el número de orden que identifica los diferentes intentos del mismo runName que se ejecuta varias veces. El attemptNumber tiene un índice de 0 y debe aumentar cada vez que se realiza una ejecución nueva. p.ej., una prueba se vuelve a intentar de forma granular 3 veces, debe tener 4 ejecuciones en total con el mismo runName y el attemptNumber va de 0 a 3. |
startTime |
long : La hora en que comenzó la ejecución, medida a través de System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
La ejecución de prueba de informes se detuvo antes de completarse debido a una solicitud del usuario.
TODO: currently unused, consider removing
Parámetros | |
---|---|
elapsedTime |
long : Tiempo transcurrido informado por el dispositivo, en milisegundos |
pruebaOmitir
public final void testSkipped (TestDescription test, SkipReason reason)
Se llama cuando se omite una prueba y no se ejecuta por un motivo que no suele esperarse. Estas pruebas se intentarán volver a intentar para lograr una ejecución adecuada.
Parámetros | |
---|---|
test |
TestDescription : Identifica la prueba. |
reason |
SkipReason : SkipReason |
testStarted
public final void testStarted (TestDescription test, long startTime)
Es una 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 obtener una medición precisa.
Parámetros | |
---|---|
test |
TestDescription : Identifica la prueba. |
startTime |
long : Es la 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 está configurada en el tipo procesado.
Muestra | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Muestra | |
---|---|
String |