ProtoResultReporter

public abstract class ProtoResultReporter
extends Object implements ILogSaverListener, ISupportGranularResults, ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.proto.ProtoResultReporter

Subclasses diretas conhecidas FileProtoResultReporter, StreamProtoResultReporter FileProtoResultReporter Gerador de relatórios proto que despeja o TestRecord em um arquivo.  StreamProtoResultReporter Uma implementação de ProtoResultReporter

Subclasses indiretas conhecidas InvocationProtoResultReporter, ModuleProtoResultReporter InvocationProtoResultReporter Repórteres para armazenar informações de cache no nível da invocação e a lista de módulos. ModuleProtoResultReporter Um criador de relatórios de resultados destinado a informar apenas os resultados no nível do módulo.

---

O criador de relatórios de resultados cria um protobuf TestRecord com todos os resultados. Precisa ser estendido para processar o que fazer com o proto final em processFinalProto(TestRecord).

Resumo

Construtores públicos
ProtoResultReporter()

Métodos públicos
final void	invocationEnded(long elapsedTime) Informa que a invocação foi encerrada, seja com sucesso ou devido a alguma condição de erro.
void	invocationFailed(FailureDescription failure) Informa uma invocação incompleta 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.
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,LogDataType,InputStreamSource,LogFile).
void	processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs) Use o registro de invocação para enviar um por um todos os registros finais da invocação.
void	processFinalProto(TestRecordProto.TestRecord finalRecord) Processamento do proto final com todos os resultados.
void	processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext) Processamento do proto de registro de teste de invocação parcial após a ocorrência de invocationStarted(IInvocationContext).
void	processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord) Processamento do proto de registro de caso de teste finalizado após a ocorrência de testEnded(TestDescription,long,HashMap).
void	processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord) Processamento do proto de registro de caso de teste parcial após a ocorrência de testStarted(TestDescription,long).
void	processTestModuleEnd(TestRecordProto.TestRecord moduleRecord) Processamento do proto de registro do módulo finalizado após a ocorrência de testModuleEnded().
void	processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord) Processamento do proto de registro parcial do módulo após a ocorrência de testModuleStarted(IInvocationContext).
void	processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress) Processamento do proto de registro de execução finalizado após a ocorrência de testRunEnded(long,HashMap).
void	processTestRunStarted(TestRecordProto.TestRecord runStartedRecord) Processamento do proto de registro de execução parcial do teste após a ocorrência de testRunStarted(String,int).
void	setGranularResults(boolean granularResults)
void	setInlineRecordOfChildren(boolean inline)
boolean	supportGranularResults() Retorna "True" se o jornalista puder usar resultados detalhados. Caso contrário, retorna "False".
final void	testAssumptionFailure(TestDescription test, String trace) Chamado quando um teste atômico sinaliza que ele pressupõe uma condição falsa.
final void	testAssumptionFailure(TestDescription test, FailureDescription failure) Chamado quando um teste atômico sinaliza que ele pressupõe uma condição falsa.
final void	testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics) Alternativa a testEnded(TestDescription,Map) em que podemos especificar o horário de término diretamente.
void	testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> 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 é executado, geralmente porque um método de teste é anotado com org.junit.Ignore.
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 elapsedTimeMillis, HashMap<String, MetricMeasurement.Metric> runMetrics) Informa o fim da execução do teste.
final void	testRunFailed(FailureDescription failure) Não foi possível concluir o teste de execução de relatórios 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.
void	testRunStarted(String runName, int testCount, int attemptNumber) Informa o início de um teste.
final void	testRunStarted(String runName, int testCount) Informa o início de um teste.
void	testRunStarted(String runName, int testCount, int attemptNumber, long startTime) Informa o início de um teste.
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(TestDescription) em que também especificamos quando o teste foi iniciado, combinado com testEnded(TestDescription,long,Map) para uma medição precisa.
final void	testStarted(TestDescription test) Informa o início de um caso de teste individual.

Métodos protegidos
void	afterModuleEnd()
void	beforeModuleStart()
TestRecordProto.ChildReference	createModuleChildReference(TestRecordProto.TestRecord record) Cria uma referência filha para um módulo.

Construtores públicos

ProtoResultReporter

public ProtoResultReporter ()

Métodos públicos

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

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,LogDataType,InputStreamSource,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 registrado anteriormente e que precisa ser associado ao caso de teste.

processFinalInvocationLogs

public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)

Use o registro de invocação para enviar um por um todos os registros finais da invocação.

Parâmetros
invocationLogs	TestRecordProto.TestRecord: o proto finalizado que representa a invocação.

processFinalProto

public void processFinalProto (TestRecordProto.TestRecord finalRecord)

Processamento do proto final com todos os resultados.

Parâmetros
finalRecord	TestRecordProto.TestRecord: o proto finalizado com todos os resultados da invocação.

processStartInvocation

public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, 
                IInvocationContext invocationContext)

Processamento do proto de registro de teste de invocação parcial após a ocorrência de invocationStarted(IInvocationContext).

Parâmetros
invocationStartRecord	TestRecordProto.TestRecord: o proto parcial preenchido após o invocationStart.
invocationContext	IInvocationContext: a invocação IInvocationContext.

processTestCaseEnded

public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)

Processamento do proto de registro de caso de teste finalizado após a ocorrência de testEnded(TestDescription,long,HashMap).

Parâmetros
testCaseRecord	TestRecordProto.TestRecord: o proto finalizado que representa um caso de teste.

processTestCaseStarted

public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)

Processamento do proto de registro de caso de teste parcial após a ocorrência de testStarted(TestDescription,long).

Parâmetros
testCaseStartedRecord	TestRecordProto.TestRecord: o proto parcial que representa o caso de teste.

processTestModuleEnd

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

Processamento do proto de registro do módulo finalizado após a ocorrência de testModuleEnded().

Parâmetros
moduleRecord	TestRecordProto.TestRecord: o proto finalizado que representa o módulo.

processTestModuleStarted

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

Processamento do proto de registro parcial do módulo após a ocorrência de testModuleStarted(IInvocationContext).

Parâmetros
moduleStartRecord	TestRecordProto.TestRecord: o proto parcial que representa o módulo.

processTestRunEnded

public void processTestRunEnded (TestRecordProto.TestRecord runRecord, 
                boolean moduleInProgress)

Processamento do proto de registro de execução finalizado após a ocorrência de testRunEnded(long,HashMap).

Parâmetros
runRecord	TestRecordProto.TestRecord: o proto finalizado que representa a execução.
moduleInProgress	boolean: se um módulo está em andamento ou não.

processTestRunStarted

public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)

Processamento do proto de registro de execução parcial do teste após a ocorrência de testRunStarted(String,int).

Parâmetros
runStartedRecord	TestRecordProto.TestRecord: o proto parcial que representa a execução.

setGranularResults

public void setGranularResults (boolean granularResults)

Parâmetros
granularResults	boolean

setInlineRecordOfChildren

public void setInlineRecordOfChildren (boolean inline)

Parâmetros
inline	boolean

supportGranularResults

public boolean supportGranularResults ()

Retorna "True" se o jornalista puder usar resultados detalhados. Caso contrário, retorna "False".

Retorna
boolean

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

Chamado quando um teste atômico sinaliza que ele 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 ele 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, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

Alternativa a testEnded(TestDescription,Map) em que podemos especificar o horário de término diretamente. Combine com testStarted(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	HashMap: uma Map das métricas emitidas

testEnded

public void testEnded (TestDescription test, 
                HashMap<String, MetricMeasurement.Metric> 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	HashMap: uma 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 é executado, geralmente porque um método de teste é anotado com org.junit.Ignore.

Parâmetros
test	TestDescription: identifica o teste.

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 suítes.

Parâmetros
moduleContext	IInvocationContext: o IInvocationContext do módulo.

testRunEnded

public final void testRunEnded (long elapsedTimeMillis, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

Informa o fim da execução do teste. FIXME: Não podemos ter duas interfaces Map<> com tipos diferentes, então precisamos usar HashMap aqui.

Parâmetros
elapsedTimeMillis	long: tempo decorrido informado pelo dispositivo, em milissegundos
runMetrics	HashMap: pares de chave-valor informados no final de uma execução de teste com Metric.

testRunFailed

public final void testRunFailed (FailureDescription failure)

Não foi possível concluir o teste de execução de relatórios 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 que descreve o motivo da falha na execução.

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

Informa o início de um 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)

Informa o início de um 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 void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

Informa o início de um 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()

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(TestDescription) em que também especificamos quando o teste foi iniciado, combinado com testEnded(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)

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

Parâmetros
test	TestDescription: identifica o teste.

Métodos protegidos

afterModuleEnd

protected void afterModuleEnd ()

beforeModuleStart

protected void beforeModuleStart ()

createModuleChildReference

protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)

Cria uma referência filha para um módulo.

Parâmetros
record	TestRecordProto.TestRecord

Retorna
TestRecordProto.ChildReference