ProtoResultReporter
public
abstract
class
ProtoResultReporter
extends Object
implements
ILogSaverListener,
ISupportGranularResults,
ITestInvocationListener
java.lang.Object | |
↳ | com.android.tradefed.result.proto.ProtoResultReporter |
El generador de informes de resultados compila un protobuf TestRecord
con todos los resultados dentro. Se debe ampliar para controlar qué hacer con el proto final en processFinalProto(com.android.tradefed.result.proto.TestRecordProto.TestRecord)
.
Resumen
Constructores públicos | |
---|---|
ProtoResultReporter()
|
Métodos públicos | |
---|---|
final
void
|
invocationEnded(long elapsedTime)
Informa que la invocación finalizó, ya sea de forma correcta o debido a alguna condición de error. |
void
|
invocationFailed(FailureDescription failure)
Informa una invocación incompleta debido a alguna condición de error. |
void
|
invocationFailed(Throwable cause)
Informa una invocación incompleta debido a alguna condición de error. |
void
|
invocationSkipped(SkipReason reason)
Informa una invocación como omitida |
final
void
|
invocationStarted(IInvocationContext context)
Informa el inicio de la invocación de prueba. |
final
void
|
logAssociation(String dataName, LogFile logFile)
En algunos casos, el registro debe estar estrechamente asociado con casos de prueba, pero no es posible hacerlo en la devolución de llamada directa a |
void
|
processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs)
Usa el registro de invocación para enviar, uno por uno, todos los registros finales de la invocación. |
void
|
processFinalProto(TestRecordProto.TestRecord finalRecord)
Manejo del proto final con todos los resultados. |
void
|
processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
Control del proto de registro de prueba de invocación parcial después de que se produjo |
void
|
processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord)
Control del proto de registro de caso de prueba finalizado después de que se produjo |
void
|
processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord)
Control del proto de registro de casos de prueba parciales después de que se produjo |
void
|
processTestModuleEnd(TestRecordProto.TestRecord moduleRecord)
Control del proto de registro de módulo finalizado después de que se produjo |
void
|
processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord)
Control del proto de registro de módulo parcial después de que se produjo |
void
|
processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
Control del proto de registro de ejecución finalizado después de que se produjo |
void
|
processTestRunStarted(TestRecordProto.TestRecord runStartedRecord)
Control del proto de registro de ejecución de prueba parcial después de que se produjo |
void
|
setGranularResults(boolean granularResults)
|
void
|
setInlineRecordOfChildren(boolean inline)
|
boolean
|
supportGranularResults()
Muestra True si el generador de informes admite resultados detallados y False en caso contrario. |
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 |
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
|
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 elapsedTimeMillis,
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 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. |
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Informa el inicio de una ejecución de prueba. |
final
void
|
testRunStarted(String runName, int testCount)
Informa el inicio de una ejecución de prueba. |
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Informa el inicio de una ejecución de prueba. |
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. |
final
void
|
testStarted(TestDescription test, long startTime)
Es una alternativa a |
final
void
|
testStarted(TestDescription test)
Informa el inicio de un caso de prueba individual. |
Métodos protegidos | |
---|---|
void
|
afterModuleEnd()
|
void
|
beforeModuleStart()
|
TestRecordProto.ChildReference
|
createModuleChildReference(TestRecordProto.TestRecord record)
Crea una referencia secundaria para un módulo. |
Constructores públicos
ProtoResultReporter
public ProtoResultReporter ()
Métodos públicos
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 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 : El FailureDescription que describe la causa de la falla |
invocationFailed
public void invocationFailed (Throwable cause)
Informa una invocación incompleta debido a alguna condición de error.
Se llamará automáticamente a través del marco TradeFederation.
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 |
invocationStarted
public final void invocationStarted (IInvocationContext context)
Informa el inicio de la invocación de prueba.
El framework de TradeFederation lo llamará automáticamente. Los generadores de informes deben anular este método para admitir informes de varios dispositivos.
Parámetros | |
---|---|
context |
IInvocationContext : Información sobre la invocación |
logAssociation
public final void logAssociation (String dataName, LogFile logFile)
En algunos casos, el registro debe estar estrechamente asociado con casos de prueba, pero no es posible hacerlo en la devolución de llamada directa a 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.
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. |
processFinalInvocationLogs
public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)
Usa el registro de invocación para enviar uno por uno todos los registros finales de la invocación.
Parámetros | |
---|---|
invocationLogs |
TestRecordProto.TestRecord : El proto finalizado que representa la invocación. |
processFinalProto
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
Manejo del proto final con todos los resultados.
Parámetros | |
---|---|
finalRecord |
TestRecordProto.TestRecord : El proto finalizado con todos los resultados de la invocación |
processStartInvocation
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
Control del protocolo de registro de prueba de invocación parcial después de que ocurrió invocationStarted(com.android.tradefed.invoker.IInvocationContext)
.
Parámetros | |
---|---|
invocationStartRecord |
TestRecordProto.TestRecord : El proto parcial propagado después de invocationStart. |
invocationContext |
IInvocationContext : La invocación IInvocationContext . |
processTestCaseEnded
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
Control del proto de registro de caso de prueba finalizado después de que se produjo ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))
.
Parámetros | |
---|---|
testCaseRecord |
TestRecordProto.TestRecord : Es el proto finalizado que representa un caso de prueba. |
processTestCaseStarted
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
Manejo del protocolo de registro de caso de prueba parcial después de que ocurrió testStarted(com.android.tradefed.result.TestDescription, long)
.
Parámetros | |
---|---|
testCaseStartedRecord |
TestRecordProto.TestRecord : El proto parcial que representa el caso de prueba. |
processTestModuleEnd
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
Control del proto de registro de módulo finalizado después de que se produjo testModuleEnded()
.
Parámetros | |
---|---|
moduleRecord |
TestRecordProto.TestRecord : Es el proto finalizado que representa el módulo. |
processTestModuleStarted
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
Control del proto de registro de módulo parcial después de que se produjo testModuleStarted(com.android.tradefed.invoker.IInvocationContext)
.
Parámetros | |
---|---|
moduleStartRecord |
TestRecordProto.TestRecord : Es el proto parcial que representa el módulo. |
processTestRunEnded
public void processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
Control del proto de registro de ejecución finalizado después de que se produjo ERROR(/#testRunEnded(long,HashMap))
.
Parámetros | |
---|---|
runRecord |
TestRecordProto.TestRecord : El proto finalizado que representa la ejecución. |
moduleInProgress |
boolean : Indica si un módulo está en ejecución o no. |
processTestRunStarted
public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)
Manejo del protocolo de registro de ejecución de prueba parcial después de que ocurrió testRunStarted(String, int)
.
Parámetros | |
---|---|
runStartedRecord |
TestRecordProto.TestRecord : El proto parcial que representa la ejecución. |
setGranularResults
public void setGranularResults (boolean granularResults)
Parámetros | |
---|---|
granularResults |
boolean |
setInlineRecordOfChildren
public void setInlineRecordOfChildren (boolean inline)
Parámetros | |
---|---|
inline |
boolean |
supportGranularResults
public boolean supportGranularResults ()
Muestra el valor True si el informante admite resultados detallados. De lo contrario, muestra false.
Muestra | |
---|---|
boolean |
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 la falla |
testAssumptionFailure
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. |
pruebaFinalizada
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 mediciones precisas.
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 |
: Una ERROR(/Map) de las métricas emitidas |
pruebaFinalizada
public 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 haya emitido durante la ejecución del caso de prueba.
Parámetros | |
---|---|
test |
TestDescription : Identifica la prueba. |
testMetrics |
: Una ERROR(/Map) de las métricas emitidas |
testFailed
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 ejecutará una prueba, por lo general, porque un método de prueba está anotado con org.junit.Ignore.
Parámetros | |
---|---|
test |
TestDescription : Identifica la prueba. |
módulodepruebafinalizado
public final void testModuleEnded ()
Informa el final de la ejecución de un módulo.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Informa el comienzo 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 suites.
Parámetros | |
---|---|
moduleContext |
IInvocationContext : Es el IInvocationContext del módulo. |
testRunEnded
public final void testRunEnded (long elapsedTimeMillis,runMetrics)
Informa el final de la ejecución de prueba.
Parámetros | |
---|---|
elapsedTimeMillis |
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. |
testRunFailed
public final void testRunFailed (FailureDescription failure)
No se pudo completar la ejecución de prueba de 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 |
pruebaRunStarted
public 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 : 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 valor de tryNumber tiene un índice 0 y debería aumentar cada vez que
se ejecuta una nueva ejecución, p. ej., se vuelve a intentar una prueba detallada 3 veces, debería tener 4 ejecuciones en total
con el mismo runName y el valor de tryNumber sería del 0 al 3. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
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. |
testRunStarted
public 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 : 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() |
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 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)
Informa el inicio de un caso de prueba individual. Esta interfaz es antigua y debe usar testStarted(com.android.tradefed.result.TestDescription)
siempre que sea posible.
Parámetros | |
---|---|
test |
TestDescription : Identifica la prueba. |
Métodos protegidos
afterModuleEnd
protected void afterModuleEnd ()
beforeModuleStart
protected void beforeModuleStart ()
createModuleChildReference
protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)
Crea una referencia secundaria para un módulo.
Parámetros | |
---|---|
record |
TestRecordProto.TestRecord |
Devuelve | |
---|---|
TestRecordProto.ChildReference |