CollectingTestListener

public class CollectingTestListener
extends Object implements IDisableable, ILogSaverListener, ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.CollectingTestListener

Subclasses diretas conhecidas JsonHttpTestResultReporter, LUCIResultReporter, MetricsXMLResultReporter, ModuleListener, ReportPassedTests, ResultAggregator, ShardListener, SuiteResultReporter, XmlResultReporter JsonHttpTestResultReporter Um criador de relatórios de resultados que codifica os resultados das métricas de teste e as informações de ramificação e dispositivo em JSON e POST em um endpoint de serviço HTTP. LUCIResultReporter Um gerador de relatórios de resultados que salva os resultados de testes necessários para o ResultDB e o LUCI no formato JSON (go/result-sink) e registra o local do arquivo no console.  MetricsXMLResultReporter O MetricsXMLResultReporter grava métricas de teste e de execução em um arquivo XML em uma pasta especificada pelo parâmetro "metrics-folder" na fase "invocationEnded" do teste.  ModuleListener Listener anexado a cada IRemoteTest de cada módulo para coletar a lista de resultados.  ReportPassedTests Informar em um arquivo os possíveis filtros para excluir o teste aprovado.  ResultAggregator Encaminhador especial que agrega os resultados quando necessário, com base na estratégia de nova tentativa adotada.  ShardListener Um ITestInvocationListener que coleta resultados de um fragmento de invocação (ou seja, uma divisão de invocação para ser executada em vários recursos em paralelo) e os encaminha para outro listener.  SuiteResultReporter Coletar resultados de testes para uma invocação de pacote inteiro e gerar os resultados finais.  XmlResultReporter Grava resultados do JUnit em arquivos XML em um formato consistente com XMLJUnitResultFormatter do Ant.

Subclasses indiretas conhecidas FormattedGeneratorReporter, XmlFormattedGeneratorReporter FormattedGeneratorReporter Reporter que permite gerar relatórios em um formato específico.  XmlFormattedGeneratorReporter Implementação do FormattedGeneratorReporter que formata os resultados do conjunto em um formato XML.

---

Um ITestInvocationListener que vai coletar todos os resultados do teste.

Embora as estruturas de dados usadas nesse objeto sejam thread-safe, os callbacks ITestInvocationListener precisam ser chamados na ordem correta.

Resumo

Construtores públicos
CollectingTestListener()

Métodos públicos
IBuildInfo	getBuildInfo() Esse método foi descontinuado. confie na IBuildInfo de getInvocationContext().
TestRunResult	getCurrentRunResults() Recebe os resultados da execução do teste atual.
int	getExpectedTests() Retorna o número de testes esperados.
IInvocationContext	getInvocationContext() Retorna o contexto de invocação informado via invocationStarted(com.android.tradefed.invoker.IInvocationContext)
	getMergedTestRunResults() Retorna a coleção mesclada de resultados de todas as execuções em diferentes tentativas.
IInvocationContext	getModuleContextForRunResult(String testRunName) Retorna o IInvocationContext do módulo associado aos resultados.
MultiMap<String, LogFile>	getModuleLogFiles() Retorna uma cópia do mapa que contém todos os arquivos registrados associados ao módulo.
MultiMap<String, LogFile>	getNonAssociatedLogFiles() Retorna uma cópia do mapa que contém todos os arquivos registrados não associados a uma execução de teste ou a um módulo.
int	getNumAllFailedTestRuns() Retorna o número total de execuções de teste em um estado de falha.
int	getNumAllFailedTests() Retorna o número total de testes em estado de falha (somente falhas, falhas de pressuposto não contam para isso).
int	getNumTestsInState(TestStatus status) Retorna o número de testes no estado especificado para esta execução.
int	getNumTestsInState(TestResult.TestStatus ddmlibStatus) Para compatibilidade com tipos de status mais antigos
int	getNumTotalTests() Retorna o número total de testes concluídos em todas as execuções.
IBuildInfo	getPrimaryBuildInfo() Retorna as informações principais da build que foram informadas via invocationStarted(com.android.tradefed.invoker.IInvocationContext).
	getRunResults() Esse método foi descontinuado. Use getMergedTestRunResults()
TestRunResult	getTestRunAtAttempt(String testRunName, int attempt) Retorna o TestRunResult para uma única tentativa.
int	getTestRunAttemptCount(String testRunName) Retorna o número de tentativas para um determinado nome de execução de teste.
	getTestRunAttempts(String testRunName) Recebe todas as tentativas de um TestRunResult de uma determinada execução de teste.
	getTestRunForAttempts(int attempt) Recebe todos os resultados de uma determinada tentativa.
	getTestRunNames() Retorne todos os nomes de todas as execuções de teste.
boolean	hasFailedTests() Retorna se a invocação teve testes com falha ou falha de pressuposição.
boolean	hasTestRunResultsForName(String testRunName) Retorna se um determinado nome de execução de teste tem resultados.
void	invocationEnded(long elapsedTime) Informa que a invocação foi encerrada, seja com sucesso ou devido a alguma condição de erro.
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
void	invocationStarted(IInvocationContext context) Informa o início da invocação do teste.
boolean	isDisabled() Retorna "True" se o objeto inteiro estiver desativado (ignora a configuração e a desmontagem).
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).
void	setBuildInfo(IBuildInfo buildInfo) Esse método foi descontinuado. Não é mais necessário para testes.
void	setDisable(boolean isDisabled) Define se o objeto deve ser desativado.
void	setMergeStrategy(MergeStrategy strategy) Define o MergeStrategy a ser usado ao mesclar resultados.
void	testAssumptionFailure(TestDescription test, String trace) Chamado quando um teste atômico sinaliza que pressupõe uma condição falsa.
void	testAssumptionFailure(TestDescription test, FailureDescription failure) Chamado quando um teste atômico sinaliza que pressupõe uma condição falsa.
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.
void	testEnded(TestDescription test, testMetrics) Informa o fim da execução de um caso de teste individual.
void	testFailed(TestDescription test, FailureDescription failure) Informa a falha de um caso de teste individual.
void	testFailed(TestDescription test, String trace) Informa a falha de um caso de teste individual.
void	testIgnored(TestDescription test) Chamado quando um teste não será executado, geralmente porque um método de teste é anotado com org.junit.Ignore.
void	testModuleEnded() Informa o fim da execução de um módulo.
void	testModuleStarted(IInvocationContext moduleContext) Informa o início da execução de um módulo.
void	testRunEnded(long elapsedTime, runMetrics) Informa o fim da execução do teste.
void	testRunFailed(FailureDescription failure) O teste de relatórios não foi concluído devido a uma falha descrita por FailureDescription.
void	testRunFailed(String errorMessage) O teste de execução de relatórios não foi concluído devido a um erro fatal.
void	testRunStarted(String name, int numTests, int attemptNumber) Informa o início de uma execução de teste.
void	testRunStarted(String name, int numTests) Informa o início de uma execução de teste.
void	testRunStarted(String name, int numTests, int attemptNumber, long startTime) Informa o início de uma execução de teste.
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.
void	testSkipped(TestDescription test, SkipReason reason) Chamado quando um teste é ignorado e não é executado por um motivo que geralmente não é esperado.
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.
void	testStarted(TestDescription test) Informa o início de um caso de teste individual.

Métodos protegidos
final void	clearModuleLogFiles() Permite limpar o arquivo do módulo para evitar que eles sejam mantidos por muito tempo.
final void	clearResultsForName(String testRunName) Permite limpar os resultados de um determinado nome de execução.
final void	clearTestRunResults() Permite limpar todos os resultados de execução de teste para evitar que eles sejam mantidos por muito tempo.
void	setIsAggregrateMetrics(boolean aggregate) Ative a opção "Agregar métricas"

Construtores públicos

CollectingTestListener

public CollectingTestListener ()

Métodos públicos

getBuildInfo

public IBuildInfo getBuildInfo ()

Esse método foi descontinuado.
dependem do IBuildInfo de getInvocationContext().

Retorna as informações da versão.

Retorna
IBuildInfo

getCurrentRunResults

public TestRunResult getCurrentRunResults ()

Recebe os resultados da execução do teste atual.

Os resultados podem não estar completos. Recomendamos testar o valor de TestRunResult.isRunComplete() e/ou (@link TestRunResult#isRunFailure()} conforme apropriado antes de processar os resultados.

Retorna
TestRunResult	o TestRunResult que representa os dados coletados durante a última execução do teste

getExpectedTests

public int getExpectedTests ()

Retorna o número de testes esperados. Pode ser diferente de getNumTotalTests() se alguns testes não forem executados.

Retorna
int

getInvocationContext

public IInvocationContext getInvocationContext ()

Retorna o contexto de invocação informado via invocationStarted(com.android.tradefed.invoker.IInvocationContext)

Retorna
IInvocationContext

getMergedTestRunResults

public  getMergedTestRunResults ()

Retorna a coleção mesclada de resultados de todas as execuções em diferentes tentativas.

Se houver vários resultados, cada execução de teste será mesclada, e o resultado mais recente vai substituir os resultados de execuções anteriores. As execuções de teste são ordenadas por número de tentativa.

As métricas da mesma tentativa serão mescladas com base na preferência definida por aggregate-metrics. As métricas finais serão as da última tentativa.

Retorna

getModuleContextForRunResult

public IInvocationContext getModuleContextForRunResult (String testRunName)

Retorna o IInvocationContext do módulo associado aos resultados.

Parâmetros
testRunName	String: o nome dado por {testRunStarted(String, int).

Retorna
IInvocationContext	O IInvocationContext do módulo para um determinado nome de execução de teste null se não houver resultados para esse nome.

getModuleLogFiles

public MultiMap<String, LogFile> getModuleLogFiles ()

Retorna uma cópia do mapa que contém todos os arquivos registrados associados ao módulo.

Retorna
MultiMap<String, LogFile>

getNonAssociatedLogFiles

public MultiMap<String, LogFile> getNonAssociatedLogFiles ()

Retorna uma cópia do mapa que contém todos os arquivos registrados não associados a uma execução de teste ou a um módulo.

Retorna
MultiMap<String, LogFile>

getNumAllFailedTestRuns

public int getNumAllFailedTestRuns ()

Retorna o número total de execuções de teste em um estado de falha.

Retorna
int

getNumAllFailedTests

public int getNumAllFailedTests ()

Retorna o número total de testes em estado de falha (somente falhas, falhas de pressuposição não contam para isso).

Retorna
int

getNumTestsInState

public int getNumTestsInState (TestStatus status)

Retorna o número de testes no estado especificado para esta execução.

Parâmetros
status	TestStatus

Retorna
int

getNumTestsInState

public int getNumTestsInState (TestResult.TestStatus ddmlibStatus)

Para compatibilidade com tipos de status mais antigos

Parâmetros
ddmlibStatus	TestResult.TestStatus

Retorna
int

getNumTotalTests

public int getNumTotalTests ()

Retorna o número total de testes concluídos em todas as execuções.

Retorna
int

getPrimaryBuildInfo

public IBuildInfo getPrimaryBuildInfo ()

Retorna as informações principais da build que foram informadas via invocationStarted(com.android.tradefed.invoker.IInvocationContext). A build principal é a build retornada pelo primeiro provedor de build da configuração em execução. Retorna nulo se não houver contexto (nenhuma build para caso de teste).

Retorna
IBuildInfo

getRunResults

public  getRunResults ()

Esse método foi descontinuado.
Use getMergedTestRunResults()

Retorna os resultados de todas as execuções de teste.

Retorna

getTestRunAtAttempt

public TestRunResult getTestRunAtAttempt (String testRunName, 
                int attempt)

Retorna o TestRunResult para uma única tentativa.

Parâmetros
testRunName	String: o nome dado por {testRunStarted(String, int).
attempt	int: o ID da tentativa.

Retorna
TestRunResult	O TestRunResult para o nome e a tentativa de ID especificados ou null se ele não existir.

getTestRunAttemptCount

public int getTestRunAttemptCount (String testRunName)

Retorna o número de tentativas para um determinado nome de execução de teste.

Parâmetros
testRunName	String: o nome dado por {testRunStarted(String, int).

Retorna
int

getTestRunAttempts

public  getTestRunAttempts (String testRunName)

Recebe todas as tentativas de um TestRunResult de uma determinada execução de teste.

Parâmetros
testRunName	String: o nome dado por {testRunStarted(String, int).

Retorna
	Todos os TestRunResult de uma determinada execução de teste, ordenados por tentativas.

getTestRunForAttempts

public  getTestRunForAttempts (int attempt)

Recebe todos os resultados de uma determinada tentativa.

Parâmetros
attempt	int: a tentativa para a qual queremos resultados.

Retorna
	Todos os TestRunResult de uma determinada tentativa.

getTestRunNames

public  getTestRunNames ()

Retorne todos os nomes de todas as execuções de teste.

Essas execuções de teste podem ter sido executadas várias vezes com tentativas diferentes.

Retorna

hasFailedTests

public boolean hasFailedTests ()

Retorna se a invocação teve testes com falha ou falha de pressuposição.

Retorna
boolean

hasTestRunResultsForName

public boolean hasTestRunResultsForName (String testRunName)

Retorna se um determinado nome de execução de teste tem resultados.

Parâmetros
testRunName	String: o nome dado por {testRunStarted(String, int).

Retorna
boolean

invocationEnded

public 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 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 void invocationStarted (IInvocationContext context)

Informa o início da invocação do teste.

Será chamado automaticamente pela estrutura 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

isDisabled

public 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 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.

Parâmetros
dataName	String: o nome dos dados
logFile	LogFile: o LogFile que foi registrado antes e precisa ser associado ao caso de teste.

setBuildInfo

public void setBuildInfo (IBuildInfo buildInfo)

Esse método foi descontinuado.
Não é mais necessário para testes.

Define as informações de build. Só deve ser usado para testes.

Parâmetros
buildInfo	IBuildInfo

setDisable

public void setDisable (boolean isDisabled)

Define se o objeto deve ser desativado. "Desativado" significa que as etapas de configuração e desmontagem precisam ser ignoradas. Pode ser usado para desativar um objeto por padrão no construtor padrão.

Parâmetros
isDisabled	boolean: o estado em que o objeto deve ser colocado.

setMergeStrategy

public void setMergeStrategy (MergeStrategy strategy)

Define o MergeStrategy a ser usado ao mesclar resultados.

Parâmetros
strategy	MergeStrategy

testAssumptionFailure

public 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 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 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 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 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 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 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 void testModuleEnded ()

Informa o fim da execução de um módulo.

testModuleStarted

public 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 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 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 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 void testRunStarted (String name, 
                int numTests, 
                int attemptNumber)

Informa o início de uma execução de teste.

Parâmetros
name	String: o nome da execução do teste
numTests	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 void testRunStarted (String name, 
                int numTests)

Informa o início de uma execução de teste.

Parâmetros
name	String: o nome da execução do teste
numTests	int: número total de testes na execução do teste

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber, 
                long startTime)

Informa o início de uma execução de teste.

Parâmetros
name	String: o nome da execução do teste
numTests	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 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 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 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 void testStarted (TestDescription test)

Informa o início de um caso de teste individual. Interface mais antiga. Use testStarted(com.android.tradefed.result.TestDescription) sempre que possível.

Parâmetros
test	TestDescription: identifica o teste.

Métodos protegidos

clearModuleLogFiles

protected final void clearModuleLogFiles ()

Permite limpar o arquivo do módulo para evitar que eles sejam carregados por muito tempo.

clearResultsForName

protected final void clearResultsForName (String testRunName)

Permite limpar os resultados de um determinado nome de execução. Use apenas em alguns casos, como o agregador de resultados.

Parâmetros
testRunName	String

clearTestRunResults

protected final void clearTestRunResults ()

Permite limpar todos os resultados da execução do teste para evitar que eles sejam mantidos por muito tempo.

setIsAggregrateMetrics

protected void setIsAggregrateMetrics (boolean aggregate)

Ative a opção "Agregar métricas"

Parâmetros
aggregate	boolean