BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

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


A IPostProcessor base que todas as implementações precisam estender. Certifique-se de que a postagem os métodos de processamento são chamados antes dos informantes do resultado final.

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 algum erro condição.

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 uma invocação como "ignorada"

final void invocationStarted(IInvocationContext context)

Listeners de invocação para encaminhamento

final boolean isDisabled()

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

final void logAssociation(String dataName, LogFile logFile)

Em alguns casos, o registro deve ser fortemente associado a casos de teste, mas a oportunidade de fazer assim no testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) direto de retorno de chamada não é possível.

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 a partir das métricas existentes e ou de sistemas operacionais de contêineres.

processTestMetricsAndLogs(TestDescription testDescription, testMetrics, testLogs)

Implemente esse método para publicar métricas e registros do processo de cada teste.

final void setLogSaver(ILogSaver logSaver)

Defina o ILogSaver para permitir que o implementador salve arquivos.

void setUp()

Modifique 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 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)

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 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 é 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 final de uma execução de módulo.

final void testModuleStarted(IInvocationContext moduleContext)

Informa o início de um módulo em execução.

final void 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 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)

A execução do teste de relatórios 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 normalmente 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()

Modifique 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. Precisa ser chamado antes de qualquer teste .

Parâmetros
listener ITestInvocationListener

Retorna
ITestInvocationListener

invocaçãoFinalizada

public final void invocationEnded (long elapsedTime)

Informa que a invocação foi encerrada, seja com sucesso ou devido a algum erro condição.

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 uma 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 uma 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 uma invocação como "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.

Desativado

public final boolean isDisabled ()

Retorna "True" se o objeto inteiro estiver desativado (ignorar a configuração e a eliminação). Falso, do contrário.

Retorna
boolean

associação de registro

public final void logAssociation (String dataName, 
                LogFile logFile)

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

Atualiza a associação de registro para teste. Se esse método for chamado durante um teste, o log pertence 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 vindas de esse método será o gerador de relatórios como métricas de execução. Somente as métricas geradas recentemente devem ser retornado e com um nome de chave exclusivo (não é permitido o conflito com chaves existentes).

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

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

Retorna
O conjunto de métricas geradas recentemente 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 a partir das métricas existentes e ou de sistemas operacionais de contêineres. Somente as métricas recém-geradas devem ser retornadas, e com nome de chave exclusivo (sem colisão com chaves existentes são permitidas).

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

runLogs : o conjunto de arquivos de registros para a execução do teste.

Retorna
O conjunto de métricas recém-geradas com base nas métricas de execução.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

Implemente esse método para publicar métricas e registros do processo de cada teste. Apenas os novos métricas geradas devem ser retornadas e com um nome de chave exclusivo (sem colisão com as são permitidas).

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 geradas recentemente 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

Configuração

public void setUp ()

Modifique 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 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)

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

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 de término do teste, medido por System.currentTimeMillis().

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

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

Informa o final da execução de um caso de teste individual.

Se testFailed(TestDescription, FailureDescription) não foi invocado, o teste foi aprovado. Também retorna qualquer chave/valor métricas que podem ter sido emitidas durante a execução do caso de teste.

Parâmetros
test TestDescription: identifica o teste.

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

testFailed

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

testFailed

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: stack trace de falha

testIgnorado

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 de String dos dados. Por exemplo: "device_logcat". Observação dataName pode não ser exclusivo por invocação. os implementadores devem ser capazes de lidar 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 começar a ler os dados e fechar o InputStream quando concluído. Os autores da chamada precisam garantir que a fonte dos dados não seja alterada. 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.

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

Parâmetros
dataName String: um nome descritivo de String dos dados. Por exemplo: "device_logcat". Observação dataName pode não ser exclusivo por invocação. os implementadores devem ser capazes de lidar 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 começar a ler os dados e fechar o InputStream quando concluído.

logFile LogFile: o LogFile que contém os metadados do arquivo salvo.

testModuleEnded

public final void testModuleEnded ()

Informa o final de uma execução de módulo.

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

Informa o início de um módulo em execução. Esse callback está associado a testModuleEnded() e é opcional na sequência. Ela só é usada durante uma execução que usa módulos: executores baseados em pacote.

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 dois Map<> interfaces com tipos diferentes, então precisamos usar o HashMap aqui.

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

runMetrics : pares de chave-valor informados no final de um teste com 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 descrevendo a falha e o 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 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 de 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 executados várias vezes. O "tryNumber" tem índice 0 e deve ser incrementado todas as vezes ocorre uma nova execução. Por exemplo: Um teste é repetido de forma granular três vezes, deve ter quatro no total é executado com o mesmo runName, e o tryNumber 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 de 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 de 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 executados várias vezes. O "tryNumber" tem índice 0 e deve ser incrementado sempre que um uma nova execução. Por exemplo: Um teste é repetido de forma granular três vezes, deve ter quatro execuções no total com o mesmo runName, e o tryNumber vai de 0 a 3.

startTime long: o horário de início da corrida, medida usando System.currentTimeMillis().

testRunSinterrupto

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: não usado no momento, 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 é ignorado e não executado por um motivo que normalmente não é esperado. Tentaremos realizar esses testes novamente para tentar obter 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 de início do teste, 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

limpeza

protected void cleanUp ()

getMetricType

protected MetricMeasurement.DataType getMetricType ()

Modifique 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