BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

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


A IPostProcessor básica que toda implementação precisa estender. Verifique se os métodos de pós- processamento são chamados antes dos informantes 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 alguma condição de erro.

final void invocationFailed(Throwable cause)

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

void invocationSkipped(SkipReason reason)

Informa que uma invocação foi ignorada

final void invocationStarted(IInvocationContext context)

Listeners de invocação para encaminhamento

final boolean isDisabled()

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

final void logAssociation(String dataName, LogFile logFile)

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

Atualiza a associação de registro para teste.

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 pós-processar métricas e registros de cada teste.

final void setLogSaver(ILogSaver logSaver)

Defina ILogSaver para permitir que o implementador salve arquivos.

void setUp()

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

final void testAssumptionFailure(TestDescription test, String trace)

Chamado quando um teste atômico sinaliza que pressupõe uma condição falsa.

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

Chamado quando um teste atômico sinaliza que pressupõe 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 fim 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 será 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)

O teste de relatórios não foi concluído devido a uma falha descrita por FailureDescription.

final void testRunFailed(String errorMessage)

O teste de execução de relatórios não foi concluído 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)

O relatório 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 é ignorado e não é executado por um motivo que geralmente 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 medição 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. Garantido que será chamado antes de qualquer um dos callbacks 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 pela estrutura 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 alguma condição de erro.

Será chamado automaticamente pela estrutura 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 alguma condição de erro.

Será chamado automaticamente pela estrutura TradeFederation.

Parâmetros
cause Throwable: a causa Throwable da falha

invocationSkipped

public void invocationSkipped (SkipReason reason)

Informa que uma invocação foi ignorada

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 (ignora a configuração e a desmontagem). Caso contrário, retorna "falso".

Retorna
boolean

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

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

Atualiza a associação de registro para teste. Se esse método for chamado durante um teste, o registro vai 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 desse método serão informadas como métricas de execução. Somente as métricas recém-geradas devem ser retornadas, com um nome de chave exclusivo (não é permitida colisão com chaves existentes).

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

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

Retorna
O 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 devem ser retornadas, com um nome de chave exclusivo (não é permitida colisão com chaves atuais).

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

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

Retorna
O conjunto de métricas recém-geradas das métricas de execução.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

Implemente esse método para pós-processar métricas e registros de cada teste. Somente as métricas geradas recentemente devem ser retornadas, com um nome de chave exclusivo (não é permitida colisão com chaves atuais).

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
O conjunto de métricas recém-geradas das métricas de teste.

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

Defina ILogSaver para permitir que o implementador salve arquivos.

Parâmetros
logSaver ILogSaver: o ILogSaver

setUp

public void setUp ()

Substitua esse método nos pós-processadores filhos 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 pressupõe uma condição falsa.

Parâmetros
test TestDescription: identifica o teste.

trace String: stack trace da falha

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

Chamado quando um teste atômico sinaliza que pressupõe 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 medição precisa.

Parâmetros
test TestDescription: identifica o teste.

endTime long: o horário em que o teste terminou, 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 todas 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 da falha

testIgnored

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 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 fechar o InputStream resultante quando concluído. Os autores da 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: 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 fechar o InputStream resultante 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 só é usado 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)

O teste de relatórios não foi concluído 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)

O teste de execução de relatórios não foi concluído 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 do pedido, identificando 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 é repetido granularmente três vezes, ele precisa ter quatro execuções no mesmo runName, e o attemptNumber é 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 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 é repetido granularmente três vezes e precisa ter quatro execuções no mesmo runName, e o attemptNumber é 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)

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

TODO: currently unused, consider removing

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

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

Chamado quando um teste é ignorado e não é executado por um motivo que geralmente não é esperado. Esses testes serão repetidos 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 medição precisa.

Parâmetros
test TestDescription: identifica o teste.

startTime long: o horário 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