BasePostProcessor
public abstract class BasePostProcessor
extends Object
implements IPostProcessor
java.lang.Object | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
O IPostProcessor
base que toda implementação deve estender. Certifique-se de que os métodos de pós-processamento sejam chamados antes dos relatórios de resultados finais.
Resumo
Construtores públicos | |
---|---|
BasePostProcessor () |
Métodos públicos | |
---|---|
final ITestInvocationListener | init ( ITestInvocationListener listener) Etapa de inicialização do pós-processador. |
final void | invocationEnded (long elapsedTime) Informa que a chamada foi finalizada, seja com sucesso ou devido a alguma condição de erro. |
final void | invocationFailed ( FailureDescription failure) Relata uma invocação incompleta devido a alguma condição de erro. |
final void | invocationFailed (Throwable cause) Relata uma invocação incompleta devido a alguma condição de erro. |
final void | invocationStarted ( IInvocationContext context) Ouvintes de invocação para encaminhamento |
final boolean | isDisabled () Retorna True se o objeto inteiro estiver desabilitado (ignore a configuração e desmontagem). |
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 no Atualiza a associação log-to-test. |
processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) Implemente este método para agregar métricas e logs em todos os testes. | |
abstract | processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) Implemente esse método para gerar um conjunto de novas métricas a partir das métricas e logs existentes. |
processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) Implemente este método para postar métricas de processo e logs de cada teste. | |
final void | setLogSaver ( ILogSaver logSaver) Defina o |
void | setUp () Substitua esse método nos pós-processadores filho para inicializar antes da execução do teste. |
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 |
final void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) Informa o fim 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 | testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) Use este método para registrar um arquivo da implementação PostProcessor. |
final void | testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile) Chamado quando o log de teste é salvo. |
final void | testModuleEnded () Informa o fim da execução de um módulo. |
final void | testModuleStarted ( IInvocationContext moduleContext) Informa o início da execução de um módulo. |
final void | testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) Informa o fim da execução do teste. |
final void | testRunFailed ( FailureDescription failure) A execução do teste de relatórios falhou 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. |
final 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) Callbacks de execução de teste |
final void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Informa o início de uma execução de teste. |
final void | testRunStopped (long elapsedTime) A execução do teste de relatórios foi interrompida antes da conclusão devido a uma solicitação do usuário. |
final void | testStarted ( TestDescription test, long startTime) Alternativa para |
final void | testStarted ( TestDescription test) Retornos de chamada de casos de teste |
Métodos protegidos | |
---|---|
MetricMeasurement.DataType | getMetricType () Substitua esse método para alterar o tipo de métrica, se necessário. |
String | getRunName () |
Construtores públicos
BasePostProcessor
public BasePostProcessor ()
Métodos públicos
iniciar
public final ITestInvocationListener init (ITestInvocationListener listener)
Etapa de inicialização do pós-processador. Certifique-se de ser chamado antes de qualquer um dos retornos de chamada de teste.
Parâmetros | |
---|---|
listener | ITestInvocationListener |
devoluções | |
---|---|
ITestInvocationListener |
invocaçãoEncerrada
public final void invocationEnded (long elapsedTime)
Informa que a chamada foi finalizada, seja com sucesso ou devido a alguma condição de erro.
Será chamado automaticamente pela estrutura TradeFederation.Parâmetros | |
---|---|
elapsedTime | long : o tempo decorrido da invocação em ms |
invocação falhou
public final void invocationFailed (FailureDescription failure)
Relata uma invocação incompleta devido a alguma condição de erro.
Será chamado automaticamente pela estrutura TradeFederation.
Parâmetros | |
---|---|
failure | FailureDescription : o FailureDescription que descreve a causa da falha |
invocação falhou
public final void invocationFailed (Throwable cause)
Relata uma invocação incompleta devido a alguma condição de erro.
Será chamado automaticamente pela estrutura TradeFederation.Parâmetros | |
---|---|
cause | Throwable : a causa ERROR(/Throwable) da falha |
invocaçãoIniciado
public final void invocationStarted (IInvocationContext context)
Ouvintes de invocação para encaminhamento
Parâmetros | |
---|---|
context | IInvocationContext : informações sobre a invocação |
está desabilitado
public final boolean isDisabled ()
Retorna True se o objeto inteiro estiver desabilitado (ignore a configuração e desmontagem). Falso caso contrário.
devoluções | |
---|---|
boolean |
logAssociation
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 no testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
não é possível. Assim, esse retorno de chamada permite fornecer explicitamente uma forte associação.
Atualiza a associação log-to-test. Se esse método for chamado durante um teste, o log pertencerá ao teste; caso contrário, será um log de execução.
Parâmetros | |
---|---|
dataName | String : O nome dos dados |
logFile | LogFile : o LogFile que foi registrado antes e deve ser associado ao caso de teste. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Implemente este método para agregar métricas e logs em todos os testes. As métricas provenientes desse método serão relatadas como métricas de execução. Somente as métricas recém-geradas devem ser retornadas e com nome de chave exclusivo (nenhuma colisão com chaves existentes é permitida).
Parâmetros | |
---|---|
allTestMetrics | ListMultimap : Um HashMultimap armazenando as métricas de cada teste agrupadas por nomes de métricas. |
allTestLogs | TestDescription de cada teste como chaves. |
devoluções | |
---|---|
O conjunto de métricas recém-geradas de todas as métricas de teste. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Implemente esse método para gerar um conjunto de novas métricas a partir das métricas e logs existentes. Somente as métricas recém-geradas devem ser retornadas e com nome de chave exclusivo (nenhuma colisão com chaves existentes é permitida).
Parâmetros | |
---|---|
rawMetrics | |
runLogs |
devoluções | |
---|---|
O conjunto de métricas recém-geradas das métricas de execução. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Implemente este método para postar métricas de processo e logs de cada teste. Somente as métricas recém-geradas devem ser retornadas e com nome de chave exclusivo (nenhuma colisão com chaves existentes é permitida).
Parâmetros | |
---|---|
testDescription | TestDescription : O objeto TestDescription que descreve o teste. |
testMetrics | |
testLogs |
devoluções | |
---|---|
O conjunto de métricas recém-geradas das métricas de teste. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Defina o ILogSaver
para permitir que o implementador salve arquivos.
Parâmetros | |
---|---|
logSaver | ILogSaver : o ILogSaver |
configurar
public void setUp ()
Substitua esse método nos pós-processadores filho para inicializar antes da execução do teste.
testAssumptionFailure
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 |
testAssumptionFailure
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 descrevendo a falha e seu contexto. |
testeFinalizado
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 : a hora em que o teste terminou, medido via ERROR(/System#currentTimeMillis()) |
testMetrics | ERROR(/Map) das métricas emitidas |
testeFinalizado
public final void testEnded (TestDescription test,testMetrics)
Informa o fim da execução de um caso de teste individual.
Se testFailed(TestDescription, FailureDescription)
não foi chamado, esse 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 descrevendo 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 |
testLog
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Use este método para registrar um arquivo da implementação PostProcessor.
Parâmetros | |
---|---|
dataName | String : um nome descritivo ERROR(/String) dos dados. por exemplo, "dispositivo_logcat". Observação dataName pode não ser exclusivo por chamada. ou seja, os implementadores devem ser capazes de lidar com várias chamadas com o mesmo dataName |
dataType | LogDataType : o LogDataType dos dados |
dataStream | InputStreamSource : o InputStreamSource dos dados. Os implementadores devem chamar createInputStream para iniciar a leitura dos dados e garantir o fechamento do InputStream resultante quando concluído. Os chamadores devem garantir que a fonte dos dados permaneça presente e acessível até que o método testLog seja concluído. |
testLogSaved
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Chamado quando o log de teste é salvo.
Deve ser usado no lugar de ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)
.
Parâmetros | |
---|---|
dataName | String : um nome descritivo ERROR(/String) dos dados. por exemplo, "dispositivo_logcat". Observação dataName pode não ser exclusivo por chamada. ou seja, os implementadores devem ser capazes de lidar com várias chamadas com o mesmo dataName |
dataType | LogDataType : o LogDataType dos dados |
dataStream | InputStreamSource : o InputStreamSource dos dados. Os implementadores devem chamar createInputStream para iniciar a leitura dos dados e garantir o fechamento do InputStream resultante quando concluído. |
logFile | LogFile : o LogFile contendo os metadados do arquivo salvo. |
testModuleEnded
public final void testModuleEnded ()
Informa o fim da execução de um módulo.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Informa o início da execução de um módulo. Esse 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 suite.
Parâmetros | |
---|---|
moduleContext | IInvocationContext : o IInvocationContext do módulo. |
testRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
Informa o fim 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 | |
---|---|
elapsedTime | 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 falhou devido a uma falha descrita por FailureDescription
.
Parâmetros | |
---|---|
failure | FailureDescription : FailureDescription descrevendo 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 : ERROR(/String) descrevendo o motivo da falha na execução. |
testRunStarted
public final 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 do teste |
testCount | int : número total de testes na execução do teste |
attemptNumber | int : número do pedido, identificando as diferentes tentativas do mesmo runName que executam várias vezes. O tryNumber é indexado em 0 e deve ser incrementado toda vez que uma nova execução ocorrer. Por exemplo, um teste é repetido granularmente 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)
Callbacks de execução de teste
Parâmetros | |
---|---|
runName | String : o nome da execução do teste |
testCount | int : número total de testes na execução do teste |
testRunStarted
public final 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 do teste |
testCount | int : número total de testes na execução do teste |
attemptNumber | int : número do pedido, identificando as diferentes tentativas do mesmo runName que executam várias vezes. O tryNumber é indexado em 0 e deve ser incrementado toda vez que uma nova execução ocorrer. Por exemplo, um teste é repetido granularmente 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 ERROR(/System#currentTimeMillis()) |
testRunStopped
public final void testRunStopped (long elapsedTime)
A execução do teste de relatórios foi interrompida antes da conclusão devido a uma solicitação do usuário.
TODO: atualmente não utilizado, considere remover
Parâmetros | |
---|---|
elapsedTime | long : tempo decorrido relatado pelo dispositivo, em milissegundos |
testStarted
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 medição precisa .
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
startTime | long : a hora em que o teste começou, medido via ERROR(/System#currentTimeMillis()) |
testStarted
public final void testStarted (TestDescription test)
Retornos de chamada de casos de teste
Parâmetros | |
---|---|
test | TestDescription : identifica o teste |
Métodos protegidos
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Substitua esse método para alterar o tipo de métrica, se necessário. Por padrão, a métrica é definida como tipo processado.
devoluções | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
devoluções | |
---|---|
String |