ProtoResultReporter
public abstract class ProtoResultReporter
extends Object
implements ITestInvocationListener , ILogSaverListener , ISupportGranularResults
java.lang.Object | |
↳ | com.android.tradefed.result.proto.ProtoResultReporter |
O repórter de resultados cria um protobuf TestRecord
com todos os resultados dentro. Deve ser estendido para lidar com o que fazer com o proto final em processFinalProto(com.android.tradefed.result.proto.TestRecordProto.TestRecord)
.
Resumo
Construtores públicos | |
---|---|
ProtoResultReporter () |
Métodos públicos | |
---|---|
final void | invocationEnded (long elapsedTime) Relata que a invocação foi encerrada, seja com êxito ou devido a alguma condição de erro. |
void | invocationFailed ( FailureDescription failure) Relata uma invocação incompleta devido a alguma condição de erro. |
void | invocationFailed (Throwable cause) Relata uma invocação incompleta devido a alguma condição de erro. |
void | invocationSkipped ( SkipReason reason) Relata uma invocação como ignorada |
final void | invocationStarted ( IInvocationContext context) Informa o início da chamada de teste. |
final void | logAssociation (String dataName, LogFile logFile) Em alguns casos, o log deve estar fortemente associado a casos de teste, mas a oportunidade de fazê-lo diretamente |
void | processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs) Use o registro de invocação para enviar um por um todos os logs finais da invocação. |
void | processFinalProto (TestRecordProto.TestRecord finalRecord) Tratamento do proto final com todos os resultados. |
void | processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext) Tratamento do protocolo de registro de teste de invocação parcial após a ocorrência |
void | processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord) Tratamento do protocolo de registro de caso de teste finalizado após |
void | processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord) O tratamento do protocolo de registro de caso de teste parcial após |
void | processTestModuleEnd (TestRecordProto.TestRecord moduleRecord) Tratamento do protocolo de registro do módulo finalizado após a ocorrência de |
void | processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord) Tratamento do proto de registro do módulo parcial após |
void | processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress) Tratamento do protocolo de registro de execução finalizado após a ocorrência |
void | processTestRunStarted (TestRecordProto.TestRecord runStartedRecord) Tratamento do protocolo de registro de execução de teste parcial após a ocorrência |
void | setGranularResults (boolean granularResults) |
void | setInlineRecordOfChildren (boolean inline) |
boolean | supportGranularResults () Retorna True se o relator oferecer suporte a resultados granulares; caso contrário, retorna false. |
final void | testAssumptionFailure ( TestDescription test, String trace) Chamado quando um teste atômico sinaliza que assume uma condição falsa |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) Chamado quando um teste atômico sinaliza que assume uma condição falsa |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) Alternativa para |
void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) Relata o final da execução de um caso de teste individual. |
final void | testFailed ( TestDescription test, FailureDescription failure) Relata a falha de um caso de teste individual. |
final void | testFailed ( TestDescription test, String trace) Relata a falha de um caso de teste individual. |
final void | testIgnored ( TestDescription test) Chamado quando um teste não será executado, geralmente porque um método de teste é anotado com org.junit.Ignore. |
final void | testModuleEnded () Informa o fim da execução de um módulo. |
final void | testModuleStarted ( IInvocationContext moduleContext) Relata o início de um módulo em execução. |
final void | testRunEnded (long elapsedTimeMillis, runMetrics) testRunEnded (long elapsedTimeMillis, runMetrics) Informa o final da execução do teste. |
final void | testRunFailed ( FailureDescription failure) A execução do teste de relatórios não foi concluída devido a uma falha descrita por |
final void | testRunFailed (String errorMessage) A execução do teste de relatórios não foi concluída devido a um erro fatal. |
void | testRunStarted (String runName, int testCount, int attemptNumber) Informa o início de uma execução de teste. |
final void | testRunStarted (String runName, int testCount) Informa o início de uma execução de teste. |
void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Informa o início de uma execução de teste. |
final void | testSkipped ( TestDescription test, SkipReason reason) Chamado quando um teste é ignorado e não foi executado por um motivo que normalmente não é esperado. |
final void | testStarted ( TestDescription test, long startTime) Alternativa para |
final void | testStarted ( TestDescription test) Relata o início de um caso de teste individual. |
Métodos protegidos | |
---|---|
TestRecordProto.ChildReference | createModuleChildReference (TestRecordProto.TestRecord record) Cria uma referência filho para um módulo. |
Construtores públicos
ProtoResultReporter
public ProtoResultReporter ()
Métodos públicos
invocaçãoEnded
public final void invocationEnded (long elapsedTime)
Relata que a invocação foi encerrada, seja com êxito ou devido a alguma condição de erro.
Será chamado automaticamente pelo framework TradeFederation.Parâmetros | |
---|---|
elapsedTime | long : o tempo decorrido da invocação em ms |
invocaçãoFailed
public void invocationFailed (FailureDescription failure)
Relata uma invocação incompleta devido a alguma condição de erro.
Será chamado automaticamente pelo framework TradeFederation.
Parâmetros | |
---|---|
failure | FailureDescription : a FailureDescription que descreve a causa da falha |
invocaçãoFailed
public void invocationFailed (Throwable cause)
Relata uma invocação incompleta devido a alguma condição de erro.
Será chamado automaticamente pelo framework TradeFederation.Parâmetros | |
---|---|
cause | Throwable : a causa Throwable da falha |
invocaçãoSkipped
public void invocationSkipped (SkipReason reason)
Relata uma invocação como ignorada
Parâmetros | |
---|---|
reason | SkipReason |
invocaçãoiniciada
public final void invocationStarted (IInvocationContext context)
Informa o início da chamada de teste.
Será chamado automaticamente pelo framework TradeFederation. Os repórteres precisam substituir esse método para oferecer suporte a relatórios de vários dispositivos.
Parâmetros | |
---|---|
context | IInvocationContext : informações sobre a invocação |
logAssociação
public final void logAssociation (String dataName, LogFile logFile)
Em alguns casos, o log deve estar fortemente associado a casos de teste, mas a oportunidade de fazê-lo diretamente testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
não é possível. Assim, este retorno de chamada permite fornecer explicitamente uma associação forte.
Parâmetros | |
---|---|
dataName | String : O nome dos dados |
logFile | LogFile : o LogFile que foi logado anteriormente e deve ser associado ao caso de teste. |
processFinalInvocationLogs
public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)
Use o registro de invocação para enviar um por um todos os logs finais da invocação.
Parâmetros | |
---|---|
invocationLogs | TestRecordProto.TestRecord : o proto finalizado que representa a invocação. |
processFinalProto
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
Tratamento do proto final com todos os resultados.
Parâmetros | |
---|---|
finalRecord | TestRecordProto.TestRecord : O proto finalizado com todos os resultados da invocação. |
processStartInvocation
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
Tratamento do protocolo de registro de teste de invocação parcial após a ocorrência invocationStarted(com.android.tradefed.invoker.IInvocationContext)
.
Parâmetros | |
---|---|
invocationStartRecord | TestRecordProto.TestRecord : o proto parcial preenchido após o invocationStart. |
invocationContext | IInvocationContext : a invocação IInvocationContext . |
processTestCaseEnded
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
Tratamento do protocolo de registro de caso de teste finalizado após ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))
ocorrer.
Parâmetros | |
---|---|
testCaseRecord | TestRecordProto.TestRecord : o proto finalizado que representa um caso de teste. |
processTestCaseStarted
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
O tratamento do protocolo de registro de caso de teste parcial após testStarted(com.android.tradefed.result.TestDescription, long)
ocorreu.
Parâmetros | |
---|---|
testCaseStartedRecord | TestRecordProto.TestRecord : o proto parcial que representa o caso de teste. |
processTestModuleEnd
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
Tratamento do protocolo de registro do módulo finalizado após a ocorrência de testModuleEnded()
.
Parâmetros | |
---|---|
moduleRecord | TestRecordProto.TestRecord : O proto finalizado que representa o módulo. |
processTestModuleStarted
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
Tratamento do proto de registro do módulo parcial após testModuleStarted(com.android.tradefed.invoker.IInvocationContext)
ter ocorrido.
Parâmetros | |
---|---|
moduleStartRecord | TestRecordProto.TestRecord : o proto parcial que representa o módulo. |
processTestRunEnded
public void processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
Tratamento do protocolo de registro de execução finalizado após a ocorrência ERROR(/#testRunEnded(long,HashMap))
.
Parâmetros | |
---|---|
runRecord | TestRecordProto.TestRecord : o proto finalizado que representa a execução. |
moduleInProgress | boolean : se um módulo está ou não em andamento. |
processTestRunStarted
public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)
Tratamento do protocolo de registro de execução de teste parcial após a ocorrência testRunStarted(String, int)
.
Parâmetros | |
---|---|
runStartedRecord | TestRecordProto.TestRecord : o proto parcial que representa a execução. |
definirGranularResults
public void setGranularResults (boolean granularResults)
Parâmetros | |
---|---|
granularResults | boolean |
setInlineRecordOfChildren
public void setInlineRecordOfChildren (boolean inline)
Parâmetros | |
---|---|
inline | boolean |
suporteGranularResults
public boolean supportGranularResults ()
Retorna True se o relator oferecer suporte a resultados granulares; caso contrário, retorna false.
Devoluções | |
---|---|
boolean |
testeAssunçãoFalha
public final void testAssumptionFailure (TestDescription test, String trace)
Chamado quando um teste atômico sinaliza que assume uma condição falsa
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
trace | String : rastreamento de pilha de falha |
testeAssunçãoFalha
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Chamado quando um teste atômico sinaliza que assume uma condição falsa
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
failure | FailureDescription : FailureDescription que descreve a falha e seu contexto. |
teste finalizado
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternativa para ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
onde podemos especificar o horário de término diretamente. Combine com testStarted(com.android.tradefed.result.TestDescription, long)
para uma medida precisa.
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
endTime | long : o horário em que o teste terminou, medido via System.currentTimeMillis() |
testMetrics | ERROR(/Map) das métricas emitidas |
teste finalizado
public void testEnded (TestDescription test,testMetrics)
Relata o final da execução de um caso de teste individual.
Se testFailed(TestDescription, FailureDescription)
não foi invocado, este teste foi aprovado. Também retorna quaisquer métricas de chave/valor que possam ter sido emitidas durante a execução do caso de teste.
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
testMetrics | ERROR(/Map) das métricas emitidas |
teste falhou
public final void testFailed (TestDescription test, FailureDescription failure)
Relata a falha de um caso de teste individual.
Será chamado entre testStarted e testEnded.
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
failure | FailureDescription : FailureDescription que descreve a falha e seu contexto. |
teste falhou
public final void testFailed (TestDescription test, String trace)
Relata a falha de um caso de teste individual.
Será chamado entre testStarted e testEnded.
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
trace | String : rastreamento de pilha de falha |
testeIgnorado
public final void testIgnored (TestDescription test)
Chamado quando um teste não será executado, geralmente porque um método de teste é anotado com org.junit.Ignore.
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
testModuleEnded
public final void testModuleEnded ()
Informa o fim da execução de um módulo.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Relata o início de um módulo em execução. Este retorno de chamada está associado a testModuleEnded()
e é opcional na sequência. Ele é usado apenas durante uma execução que usa módulos: executores baseados em suíte.
Parâmetros | |
---|---|
moduleContext | IInvocationContext : o IInvocationContext do módulo. |
testRunEnded
public final void testRunEnded (long elapsedTimeMillis,runMetrics)
Informa o final da execução do teste. FIXME: Não podemos ter duas interfaces Map<> com tipos diferentes, então temos que usar HashMap aqui.
Parâmetros | |
---|---|
elapsedTimeMillis | long : tempo decorrido relatado pelo dispositivo, em milissegundos |
runMetrics | Metric . |
testRunFailed
public final void testRunFailed (FailureDescription failure)
A execução do teste de relatórios não foi concluída devido a uma falha descrita por FailureDescription
.
Parâmetros | |
---|---|
failure | FailureDescription : FailureDescription que descreve a falha e seu contexto. |
testRunFailed
public final void testRunFailed (String errorMessage)
A execução do teste de relatórios não foi concluída devido a um erro fatal.
Parâmetros | |
---|---|
errorMessage | String : String que descreve o motivo da falha na execução. |
testRunStarted
public void testRunStarted (String runName, int testCount, int attemptNumber)
Informa o início de uma execução de teste.
Parâmetros | |
---|---|
runName | String : o nome da execução de teste |
testCount | int : número total de testes em execução de teste |
attemptNumber | int : número do pedido, identificando as diferentes tentativas do mesmo runName que são executadas diversas vezes. O tryNumber é indexado em 0 e deve aumentar sempre que uma nova execução acontece. por exemplo, um teste é repetido de forma granular 3 vezes, deve ter 4 execuções totais sob o mesmo runName e o tryNumber é de 0 a 3. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
Informa o início de uma execução de teste.
Parâmetros | |
---|---|
runName | String : o nome da execução de teste |
testCount | int : número total de testes em execução de teste |
testRunStarted
public void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
Informa o início de uma execução de teste.
Parâmetros | |
---|---|
runName | String : o nome da execução de teste |
testCount | int : número total de testes em execução de teste |
attemptNumber | int : número do pedido, identificando as diferentes tentativas do mesmo runName que são executadas diversas vezes. O tryNumber é indexado em 0 e deve aumentar sempre que uma nova execução acontece. por exemplo, um teste é repetido de forma granular 3 vezes, deve ter 4 execuções totais sob o mesmo runName e o tryNumber é de 0 a 3. |
startTime | long : a hora em que a execução começou, medida via System.currentTimeMillis() |
teste ignorado
public final void testSkipped (TestDescription test, SkipReason reason)
Chamado quando um teste é ignorado e não foi executado por um motivo que normalmente não é esperado. Esses testes serão tentados novamente para tentar obter uma execução adequada.
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
reason | SkipReason : SkipReason |
teste iniciado
public final void testStarted (TestDescription test, long startTime)
Alternativa para testStarted(com.android.tradefed.result.TestDescription)
onde também especificamos quando o teste foi iniciado, combinado com ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
para uma medida precisa .
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
startTime | long : a hora em que o teste começou, medido via System.currentTimeMillis() |
teste iniciado
public final void testStarted (TestDescription test)
Relata o início de um caso de teste individual. Interface mais antiga, deve usar testStarted(com.android.tradefed.result.TestDescription)
sempre que possível.
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
Métodos protegidos
createModuleChildReference
protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)
Cria uma referência filho para um módulo.
Parâmetros | |
---|---|
record | TestRecordProto.TestRecord |
Devoluções | |
---|---|
TestRecordProto.ChildReference |