BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IDeviceActionReceiver, IMetricCollector

java.lang.Object
   ↳ com.android.tradefed.device.metric.BaseDeviceMetricCollector


Implementação básica de IMetricCollector que permite iniciar e interromper a coleta em onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) e ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map)).

Resumo

Campos

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

Construtores públicos

BaseDeviceMetricCollector()

Métodos públicos

void extraInit(IInvocationContext context, ITestInvocationListener listener)
final getBuildInfos()

Retorna a lista de informações de build disponíveis na invocação.

final getDevices()

Retorna a lista de dispositivos disponíveis na invocação.

File getFileFromTestArtifacts(String fileName)

Recuperar o arquivo dos artefatos de teste ou dos artefatos do módulo e do cache em um mapa para as chamadas subsequentes.

final ITestInvocationListener getInvocationListener()

Retorna o ITestInvocationListener original para o qual estamos encaminhando os resultados.

String getModuleName()
final getRealDevices()

Retorna todos os dispositivos não stub da lista getDevices().

String getRunName()

Retorna o nome da execução de teste mRunName que aciona o coletor.

final ITestInvocationListener init(IInvocationContext context, ITestInvocationListener listener)

Inicialização do coletor com o contexto atual e para onde encaminhar os resultados.

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

boolean isDisabledReceiver()

Se o IDeviceActionReceiver está desativado ou não.

final void logAssociation(String dataName, LogFile logFile)

Não use dentro da implementação do coletor de métricas.

void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

Callback quando um caso de teste falha com falha de suposição.

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)

Callback quando um caso de teste é encerrado.

void onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)

Callback quando um caso de teste é encerrado.

void onTestFail(DeviceMetricData testData, TestDescription test)

Chamada de retorno quando um caso de teste falha.

void onTestModuleEnded()

Permite a captura do evento encerrado de módulo.

void onTestModuleStarted()

Permite a captura do evento iniciado pelo módulo.

void onTestRunEnd(DeviceMetricData runData, currentRunMetrics)

Callback quando a execução de um teste é finalizada.

void onTestRunFailed(DeviceMetricData testData, FailureDescription failure)

Callback para eventos testRunFailed

void onTestRunStart(DeviceMetricData runData)

Callback quando uma execução de teste é iniciada.

void onTestStart(DeviceMetricData testData)

Callback quando um caso de teste é iniciado.

void rebootEnded(ITestDevice device)

Recebe uma notificação quando a reinicialização foi encerrada no dispositivo.

void rebootStarted(ITestDevice device)

Recebe uma notificação quando a reinicialização é iniciada no dispositivo.

final void setDisable(boolean isDisabled)

Define se o objeto deve ser desativado.

void setDisableReceiver(boolean isDisabled)

Define se o IDeviceActionReceiver precisa ser desativado.

final void setLogSaver(ILogSaver logSaver)

Não use dentro da implementação do coletor de métricas.

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)

Fornece o registro associado ou os dados de depuração da invocação de teste.

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

Não use dentro da implementação do coletor de métricas.

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

Campos

TEST_CASE_EXCLUI_GROUP_OPTION

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

Construtores públicos

BaseDeviceMetricCollector

public BaseDeviceMetricCollector ()

Métodos públicos

ExtraInit

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

Gera
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildInfos

public final  getBuildInfos ()

Retorna a lista de informações de build disponíveis na invocação.

Retorna

getDevices

public final  getDevices ()

Retorna a lista de dispositivos disponíveis na invocação.

Retorna

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

Recuperar o arquivo dos artefatos de teste ou dos artefatos do módulo e do cache em um mapa para as chamadas subsequentes.

Parâmetros
fileName String: nome do arquivo a ser pesquisado nos artefatos.

Retorna
File Arquivo do artefato de teste ou do artefato do módulo. Retorna nulo se o arquivo não for encontrado.

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

Retorna o ITestInvocationListener original para o qual estamos encaminhando os resultados.

Retorna
ITestInvocationListener

getModuleName

public String getModuleName ()

Retorna
String

getRealDevices (em inglês)

public final  getRealDevices ()

Retorna todos os dispositivos não stub da lista getDevices().

Retorna

getRunName

public String getRunName ()

Retorna o nome da execução de teste mRunName que aciona o coletor.

Retorna
String mRunName, o nome atual da execução do teste.

init

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

Inicialização do coletor com o contexto atual e para onde encaminhar os resultados. Will (Ação) será chamado uma vez por instância e o coletor deverá atualizar seu respectivo contexto e ouvinte. Ele nunca será chamado durante um teste executado antes.

Não substitua a menos que você saiba o que está fazendo.

Parâmetros
context IInvocationContext: o IInvocationContext da invocação em andamento.

listener ITestInvocationListener: o ITestInvocationListener em que os resultados são colocados.

Retorna
ITestInvocationListener ao novo listener que envolve o original.

Gera
DeviceNotAvailableException

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

isDisabledReceiver

public boolean isDisabledReceiver ()

Se o IDeviceActionReceiver está desativado ou não.

Retorna
boolean Vai retornar "true" se estiver desativado. Caso contrário, vai retornar "false".

associação de registro

public final void logAssociation (String dataName, 
                LogFile logFile)

Não use dentro da implementação do coletor de métricas. Isso é puro encaminhamento.

Parâmetros
dataName String: o nome dos dados

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

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

Callback quando um caso de teste falha com falha de suposição.

Parâmetros
testData DeviceMetricData: o DeviceMetricData que contém os dados para o caso de teste.

test TestDescription: o TestDescription do caso de teste em andamento.

Gera
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics, 
                TestDescription test)

Callback quando um caso de teste é encerrado. Esse deve ser o momento da limpeza.

Parâmetros
testData DeviceMetricData: o DeviceMetricData que contém os dados para o caso de teste. Será o mesmo objeto de onTestStart(com.android.tradefed.device.metric.DeviceMetricData).

currentTestCaseMetrics : o mapa atual de métricas transmitidas para ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)).

test TestDescription: o TestDescription do caso de teste em andamento.

Gera
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

Callback quando um caso de teste é encerrado. Esse deve ser o momento da limpeza.

Parâmetros
testData DeviceMetricData: o DeviceMetricData que contém os dados para o caso de teste. Será o mesmo objeto de onTestStart(com.android.tradefed.device.metric.DeviceMetricData).

currentTestCaseMetrics : o mapa atual de métricas transmitidas para ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)).

Gera
DeviceNotAvailableException

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

Chamada de retorno quando um caso de teste falha.

Parâmetros
testData DeviceMetricData: o DeviceMetricData que contém os dados para o caso de teste.

test TestDescription: o TestDescription do caso de teste em andamento.

Gera
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

Permite a captura do evento encerrado de módulo.

Gera
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

Permite a captura do evento iniciado pelo módulo.

Gera
DeviceNotAvailableException

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

Callback quando a execução de um teste é finalizada. Esse deve ser o momento da limpeza.

Parâmetros
runData DeviceMetricData: o DeviceMetricData que contém os dados para a execução. Será igual objeto como durante onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData).

currentRunMetrics : o mapa atual de métricas transmitidas para ERROR(/#testRunEnded(long,Map)).

Gera
DeviceNotAvailableException

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

Callback para eventos testRunFailed

Gera
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

Callback quando uma execução de teste é iniciada.

Parâmetros
runData DeviceMetricData: o DeviceMetricData que contém os dados para a execução.

Gera
DeviceNotAvailableException

onTestStart

public void onTestStart (DeviceMetricData testData)

Callback quando um caso de teste é iniciado.

Parâmetros
testData DeviceMetricData: o DeviceMetricData que contém os dados para o caso de teste.

Gera
DeviceNotAvailableException

Reinicializado

public void rebootEnded (ITestDevice device)

Recebe uma notificação quando a reinicialização foi encerrada no dispositivo.

OBSERVAÇÃO: os receptores devem evitar a reinicialização durante esse callback. Qualquer tentativa de reinicialização será ignorada.

Parâmetros
device ITestDevice: ITestDevice em que a reinicialização terminou.

Gera
DeviceNotAvailableException

reinicializado iniciado.

public void rebootStarted (ITestDevice device)

Recebe uma notificação quando a reinicialização é iniciada no dispositivo.

OBSERVAÇÃO: os receptores devem evitar a reinicialização durante esse callback. Qualquer tentativa de reinicialização será ignorada.

Parâmetros
device ITestDevice: ITestDevice em que a reinicialização começou.

Gera
DeviceNotAvailableException

setDesativar

public final void setDisable (boolean isDisabled)

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

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

setDisableReceiver

public void setDisableReceiver (boolean isDisabled)

Define se o IDeviceActionReceiver precisa ser desativado. A desativação significa que ele não estar registrado no dispositivo para receber eventos de ação do dispositivo.

Parâmetros
isDisabled boolean

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

Não use dentro da implementação do coletor de métricas. Isso é puro encaminhamento.

Parâmetros
logSaver ILogSaver: o ILogSaver

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)

Fornece o registro associado ou os dados de depuração da invocação de teste.

Precisa ser chamado antes de ERROR(/ITestInvocationListener#invocationFailed(Throwable)) ou ERROR(/ITestInvocationListener#invocationEnded(long))

A estrutura da TradeFederation chamará automaticamente esse método, fornecendo o registro do host e, se aplicável, o logcat do dispositivo.

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)

Não use dentro da implementação do coletor de métricas. Isso é puro encaminhamento.

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.