BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Object
   ↳ com.android.tradefed.postprocessor.BasePostProcessor


O IPostProcessor básico que toda implementação precisa estender. Verifique se os métodos de processamento pós-processamento são chamados antes dos acionadores 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 invocação foi encerrada, seja com sucesso ou devido a alguma condição de erro.

final void invocationFailed(FailureDescription failure)

Informa uma invocação incompleta devido a uma condição de erro.

final void invocationFailed(Throwable cause)

Informa uma invocação incompleta devido a uma condição de erro.

void invocationSkipped(SkipReason reason)

Informa que uma invocação foi pulada

final void invocationStarted(IInvocationContext context)

Listeners de invocação para encaminhamento

final boolean isDisabled()

Retorna "True" se o objeto inteiro estiver desativado (pule a configuração e a desmontagem).

final void logAssociation(String dataName, LogFile logFile)

Em alguns casos, o registro precisa estar fortemente associado a casos de teste, mas não é possível fazer isso no callback testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) direto.

Atualiza a associação de registro a ser testada.

processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)

Implemente esse método para agregar métricas e registros em todos os testes.

abstract processRunMetricsAndLogs( rawMetrics, runLogs)

Implemente esse método para gerar um conjunto de novas métricas com base nas métricas e nos registros atuais.

processTestMetricsAndLogs(TestDescription testDescription, testMetrics, testLogs)

Implemente esse método para processar as métricas e os registros de cada teste.

final void setLogSaver(ILogSaver logSaver)

Defina o ILogSaver para permitir que o implementador salve arquivos.

void setUp()

Substitua esse método nos post-processadores filhos para inicializar antes da execução do teste.

final void testAssumptionFailure(TestDescription test, String trace)

Chamada quando um teste atômico sinaliza que assume uma condição falsa

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

Chamada quando um teste atômico sinaliza que assume uma condição falsa

final void testEnded(TestDescription test, long endTime, testMetrics)

Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), em que podemos especificar o horário de término diretamente.

final void testEnded(TestDescription test, testMetrics)

Informa o término da execução de um caso de teste individual.

final void testFailed(TestDescription test, FailureDescription failure)

Informa a falha de um caso de teste individual.

final void testFailed(TestDescription test, String trace)

Informa a falha de um caso de teste individual.

final void testIgnored(TestDescription test)

É chamado quando um teste não é executado, geralmente porque um método de teste é anotado com org.junit.Ignore.

final void testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)

Use esse método para registrar um arquivo da implementação do postprocessor.

final void testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

Chamado quando o registro 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)

Informa o fim da execução do teste.

final void testRunFailed(FailureDescription failure)

A execução do teste não foi concluída devido a uma falha descrita por FailureDescription.

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)

Testar callbacks de execução

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)

Informa que a execução do teste foi interrompida antes da conclusão devido a uma solicitação do usuário.

final void testSkipped(TestDescription test, SkipReason reason)

É chamado quando um teste é pulado e não é executado por um motivo que não é esperado.

final void testStarted(TestDescription test, long startTime)

Alternativa a testStarted(com.android.tradefed.result.TestDescription), em que também especificamos quando o teste foi iniciado, combinado com ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) para uma medida precisa.

final void testStarted(TestDescription test)

Callbacks de casos de teste

Métodos protegidos

void cleanUp()
MetricMeasurement.DataType getMetricType()

Substitua esse método para mudar o tipo de métrica, se necessário.

String getRunName()

Construtores públicos

BasePostProcessor

public BasePostProcessor ()

Métodos públicos

init

public final ITestInvocationListener init (ITestInvocationListener listener)

Etapa de inicialização do pós-processador. É chamado antes de qualquer um dos retornos de chamada de teste.

Parâmetros
listener ITestInvocationListener

Retorna
ITestInvocationListener

invocationEnded

public final void invocationEnded (long elapsedTime)

Informa que a invocação foi encerrada, seja com sucesso 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

invocationFailed

public final void invocationFailed (FailureDescription failure)

Informa uma invocação incompleta devido a uma condição de erro.

Será chamado automaticamente pelo framework TradeFederation.

Parâmetros
failure FailureDescription: o FailureDescription que descreve a causa da falha

invocationFailed

public final void invocationFailed (Throwable cause)

Informa uma invocação incompleta devido a uma condição de erro.

Será chamado automaticamente pelo framework TradeFederation.

Parâmetros
cause Throwable: a causa Throwable da falha

invocationSkipped

public void invocationSkipped (SkipReason reason)

Informa que uma invocação foi pulada

Parâmetros
reason SkipReason

invocationStarted

public final void invocationStarted (IInvocationContext context)

Listeners de invocação para encaminhamento

Parâmetros
context IInvocationContext: informações sobre a invocação

isDisabled

public final boolean isDisabled ()

Retorna "True" se o objeto inteiro estiver desativado (pule a configuração e a desmontagem). Falso em outros casos.

Retorna
boolean

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

Em alguns casos, o registro precisa estar fortemente associado a casos de teste, mas não é possível fazer isso no callback testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) direto. Assim, esse callback permite fornecer uma associação forte explicitamente.

Atualiza a associação de registro a ser testada. Se esse método for chamado durante um teste, o registro pertencerá ao teste. Caso contrário, será um registro de execução.

Parâmetros
dataName String: o nome dos dados

logFile LogFile: o LogFile que foi registrado antes e precisa ser associado ao caso de teste.

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

Implemente esse método para agregar métricas e registros em todos os testes. As métricas geradas por esse método serão informadas como métricas de execução. Somente as métricas recém-geradas serão retornadas e com nome de chave exclusivo (não é permitido conflito com chaves existentes).

Parâmetros
allTestMetrics ListMultimap: um HashMultimap que armazena as métricas de cada teste agrupadas por nomes de métrica.

allTestLogs : um mapa que armazena o mapa de arquivos de registro de cada teste com chaves pelos nomes de dados, usando o TestDescription de cada teste como chaves.

Retorna
Conjunto de métricas recém-geradas de todas as métricas de teste.

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

Implemente esse método para gerar um conjunto de novas métricas com base nas métricas e nos registros atuais. Somente as métricas recém-geradas podem ser retornadas e com nome de chave exclusivo (não é permitido colisão com chaves existentes).

Parâmetros
rawMetrics : o conjunto de métricas brutas disponível para a execução.

runLogs : o conjunto de arquivos de registro da execução do teste.

Retorna
Conjunto de métricas recém-geradas a partir das métricas de execução.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

Implemente esse método para processar as métricas e os registros de cada teste. Somente as métricas recém- geradas podem ser retornadas e com nome de chave exclusivo (não é permitido conflito com chaves existentes).

Parâmetros
testDescription TestDescription: o objeto TestDescription que descreve o teste.

testMetrics : o conjunto de métricas do teste.

testLogs : o conjunto de arquivos registrados durante o teste.

Retorna
Conjunto de métricas recém-geradas com base nas 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

setUp

public void setUp ()

Substitua esse método nos post-processadores filhos para inicializar antes da execução do teste.

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

Chamada quando um teste atômico sinaliza que assume uma condição falsa

Parâmetros
test TestDescription: identifica o teste

trace String: stack trace de falha

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

Chamada 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 o contexto dela.

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), em que 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 tempo em que o teste foi concluído, medido por System.currentTimeMillis()

testMetrics : uma ERROR(/Map) das métricas emitidas

testEnded

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 invocado, o teste foi aprovado. Também retorna as métricas de chave/valor que podem ter sido emitidas durante a execução do caso de teste.

Parâmetros
test TestDescription: identifica o teste

testMetrics : uma ERROR(/Map) das métricas emitidas

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

Informa 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 o contexto dela.

testFailed

public final void testFailed (TestDescription test, 
                String trace)

Informa a falha de um caso de teste individual.

Será chamado entre testStarted e testEnded.

Parâmetros
test TestDescription: identifica o teste

trace String: stack trace de falha

testIgnored

public final void testIgnored (TestDescription test)

É chamado quando um teste não é 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 esse método para registrar um arquivo da implementação do postprocessor.

Parâmetros
dataName String: um nome descritivo String dos dados, por exemplo, "device_logcat". Observação dataName pode não ser exclusivo por invocação. Ou seja, os implementadores precisam ser capazes de processar várias chamadas com o mesmo dataName.

dataType LogDataType: o LogDataType dos dados

dataStream InputStreamSource: o InputStreamSource dos dados. Os implementadores precisam chamar createInputStream para começar a ler os dados e garantir que o InputStream resultante seja fechado quando concluído. Os autores de chamada precisam garantir que a origem 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 registro de teste é salvo.

Deve ser usado no lugar de ITestInvocationListener.testLog(String, LogDataType, InputStreamSource).

Parâmetros
dataName String: um nome descritivo String dos dados, por exemplo, "device_logcat". Observação O dataName pode não ser exclusivo por invocação. Ou seja, os implementadores precisam ser capazes de processar várias chamadas com o mesmo dataName.

dataType LogDataType: o LogDataType dos dados

dataStream InputStreamSource: o InputStreamSource dos dados. Os implementadores precisam chamar createInputStream para começar a ler os dados e garantir que o InputStream resultante seja fechado quando concluído.

logFile LogFile: o LogFile que contém 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 callback está associado a testModuleEnded() e é opcional na sequência. Ele é usado apenas durante uma execução que usa módulos: executores baseados em pacotes.

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.

Parâmetros
elapsedTime long: tempo decorrido informado pelo dispositivo, em milissegundos

runMetrics : pares de chave-valor informados no final de uma execução de teste

testRunFailed

public final void testRunFailed (FailureDescription failure)

A execução do teste não foi concluída devido a uma falha descrita por FailureDescription.

Parâmetros
failure FailureDescription: FailureDescription que descreve a falha e o contexto dela.

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 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 de pedido, que identifica as diferentes tentativas do mesmo runName que são executadas várias vezes. O attemptNumber é indexado em 0 e precisa ser incrementado sempre que uma nova execução acontece. Por exemplo, um teste é tentado granularmente três vezes, precisa ter quatro execuções no total com o mesmo runName e o attemptNumber varia de 0 a 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Testar callbacks de execução

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 de pedido, que identifica as diferentes tentativas do mesmo runName que são executadas várias vezes. O attemptNumber é indexado em 0 e precisa ser incrementado sempre que uma nova execução acontece. Por exemplo, se um teste é tentado três vezes, ele precisa ter quatro execuções no total com o mesmo runName e o attemptNumber varia de 0 a 3.

startTime long: o horário em que a execução começou, medido por System.currentTimeMillis()

testRunStopped

public final void testRunStopped (long elapsedTime)

Informa que a execução do teste foi interrompida antes da conclusão devido a uma solicitação do usuário.

TODO: atualmente não usado, considere remover

Parâmetros
elapsedTime long: tempo decorrido informado pelo dispositivo, em milissegundos

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

É chamado quando um teste é pulado e não é executado por um motivo que não é esperado. Esses testes serão tentados novamente para tentar uma execução adequada.

Parâmetros
test TestDescription: identifica o teste

reason SkipReason: SkipReason

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

Alternativa a testStarted(com.android.tradefed.result.TestDescription), em que 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: o momento em que o teste começou, medido por System.currentTimeMillis()

testStarted

public final void testStarted (TestDescription test)

Callbacks de casos de teste

Parâmetros
test TestDescription: identifica o teste

Métodos protegidos

cleanUp

protected void cleanUp ()

getMetricType

protected MetricMeasurement.DataType getMetricType ()

Substitua esse método para mudar o tipo de métrica, se necessário. Por padrão, a métrica é definida como tipo processado.

Retorna
MetricMeasurement.DataType

getRunName

protected String getRunName ()

Retorna
String