BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IMetricCollector , IDeviceActionReceiver

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


Implementação básica de IMetricCollector que permite iniciar e parar 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)

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

final ITestInvocationListener getInvocationListener ()

Retorna o ITestInvocationListener original para onde 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)

Relata que a invocação foi encerrada, seja com êxito ou devido a alguma condição de erro.

final void invocationFailed ( FailureDescription failure)

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

final void invocationFailed (Throwable cause)

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

void invocationSkipped ( SkipReason reason)

Relata uma invocação como ignorada

final void invocationStarted ( IInvocationContext context)

Ouvintes de invocação para encaminhamento

final boolean isDisabled ()

Retorna True se todo o objeto estiver desativado (ignore a configuração e a desmontagem).

boolean isDisabledReceiver ()

Se o IDeviceActionReceiver está desabilitado ou não.

final void logAssociation (String dataName, LogFile logFile)

Não use a implementação interna do coletor de métricas.

void onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test)

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

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

Retorno de chamada quando um caso de teste é finalizado.

void onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics)

Retorno de chamada quando um caso de teste é finalizado.

void onTestFail ( DeviceMetricData testData, TestDescription test)

Retorno de chamada quando um caso de teste falha.

void onTestModuleEnded ()

Permite capturar o evento de término do módulo.

void onTestModuleStarted ()

Permite capturar o evento de módulo iniciado.

void onTestRunEnd ( DeviceMetricData runData, currentRunMetrics) onTestRunEnd ( DeviceMetricData runData, currentRunMetrics)

Retorno de chamada quando uma execução de teste é encerrada.

void onTestRunFailed ( DeviceMetricData testData, FailureDescription failure)

Retorno de chamada para eventos testRunFailed

void onTestRunStart ( DeviceMetricData runData)

Retorno de chamada quando uma execução de teste é iniciada.

void onTestStart ( DeviceMetricData testData)

Retorno de chamada quando um caso de teste é iniciado.

void rebootEnded ( ITestDevice device)

Recebe notificação quando a reinicialização termina no dispositivo.

void rebootStarted ( ITestDevice device)

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

final void setDisable (boolean isDisabled)

Define se o objeto deve ser desabilitado.

void setDisableReceiver (boolean isDisabled)

Define se o IDeviceActionReceiver deve ser desabilitado.

final void setLogSaver ( ILogSaver logSaver)

Não use a implementação interna 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) testEnded ( TestDescription test, long endTime, testMetrics)

Alternativa para ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) onde podemos especificar o horário de término diretamente.

final void testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics)

Relata 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 será executado, geralmente porque um método de teste é anotado com org.junit.Ignore.

final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)

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

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

Não use a implementação interna do coletor de métricas.

final void testModuleEnded ()

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

final void testModuleStarted ( IInvocationContext moduleContext)

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

final void testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics)

Informa o final 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)

Retornos de chamada 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)

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 foi executado por um motivo que normalmente não é esperado.

final void testStarted ( TestDescription test, long startTime)

Alternativa para testStarted(com.android.tradefed.result.TestDescription) onde também especificamos quando o teste foi iniciado, combinado com ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) para uma medida precisa .

final void testStarted ( TestDescription test)

Retornos de chamada de casos de teste

Campos

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

Lança
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildInfos

public final  getBuildInfos ()

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

Devoluções

getDispositivos

public final  getDevices ()

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

Devoluções

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

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

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

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

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

Retorna o ITestInvocationListener original para onde estamos encaminhando os resultados.

Devoluções
ITestInvocationListener

getModuleName

public String getModuleName ()

Devoluções
String

getRealDevices

public final  getRealDevices ()

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

Devoluções

getRunName

public String getRunName ()

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

Devoluções
String mRunName, o nome da execução de teste atual.

iniciar

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

Inicialização do coletor com o contexto atual e para onde encaminhar os resultados. Será chamado apenas uma vez por instância e espera-se que o coletor atualize seu contexto interno e ouvinte. Init nunca será chamado durante uma execução de teste antes.

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

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

listener ITestInvocationListener : o ITestInvocationListener onde colocar os resultados.

Devoluções
ITestInvocationListener o novo ouvinte envolvendo o original.

Lança
DeviceNotAvailableException

invocaçãoEnded

public final void invocationEnded (long elapsedTime)

Informa que a invocação foi encerrada, seja com êxito ou devido a alguma condição de erro.

Será chamado automaticamente pelo framework TradeFederation.

Parâmetros
elapsedTime long : o tempo decorrido da invocação em ms

invocaçãoFailed

public final void invocationFailed (FailureDescription failure)

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

Será chamado automaticamente pelo framework TradeFederation.

Parâmetros
failure FailureDescription : a FailureDescription que descreve a causa da falha

invocaçãoFailed

public final void invocationFailed (Throwable cause)

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

Será chamado automaticamente pelo framework TradeFederation.

Parâmetros
cause Throwable : a causa Throwable da falha

invocaçãoSkipped

public void invocationSkipped (SkipReason reason)

Relata uma invocação como ignorada

Parâmetros
reason SkipReason

invocaçãoiniciada

public final void invocationStarted (IInvocationContext context)

Ouvintes de invocação para encaminhamento

Parâmetros
context IInvocationContext : informações sobre a invocação

está desabilitado

public final boolean isDisabled ()

Retorna True se todo o objeto estiver desativado (ignore a configuração e a desmontagem). Caso contrário, falso.

Devoluções
boolean

isDisabledReceiver

public boolean isDisabledReceiver ()

Se o IDeviceActionReceiver está desabilitado ou não.

Devoluções
boolean retorne verdadeiro se desabilitado, falso caso contrário.

logAssociação

public final void logAssociation (String dataName, 
                LogFile logFile)

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

Parâmetros
dataName String : O nome dos dados

logFile LogFile : o LogFile que foi logado anteriormente e deve ser associado ao caso de teste.

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

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

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

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

Lança
DeviceNotAvailableException

onTestEnd

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

Retorno de chamada quando um caso de teste é finalizado. Este deve ser o momento da limpeza.

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

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

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

Lança
DeviceNotAvailableException

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

Retorno de chamada quando um caso de teste é finalizado. Este deve ser o momento da limpeza.

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

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

Lança
DeviceNotAvailableException

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

Retorno de chamada quando um caso de teste falha.

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

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

Lança
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

Permite capturar o evento de término do módulo.

Lança
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

Permite capturar o evento de módulo iniciado.

Lança
DeviceNotAvailableException

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

Retorno de chamada quando uma execução de teste é encerrada. Este deve ser o momento da limpeza.

Parâmetros
runData DeviceMetricData : o DeviceMetricData que contém os dados da execução. Será o mesmo objeto de onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) .

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

Lança
DeviceNotAvailableException

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

Retorno de chamada para eventos testRunFailed

Lança
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

Retorno de chamada quando uma execução de teste é iniciada.

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

Lança
DeviceNotAvailableException

onTestStart

public void onTestStart (DeviceMetricData testData)

Retorno de chamada quando um caso de teste é iniciado.

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

Lança
DeviceNotAvailableException

reinicializaçãoFinalizada

public void rebootEnded (ITestDevice device)

Recebe notificação quando a reinicialização termina no dispositivo.

NOTA: Os receptores devem evitar a reinicialização durante esse retorno de chamada. Qualquer tentativa de reinicialização será ignorada.

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

Lança
DeviceNotAvailableException

reiniciarIniciado

public void rebootStarted (ITestDevice device)

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

NOTA: Os receptores devem evitar a reinicialização durante esse retorno de chamada. Qualquer tentativa de reinicialização será ignorada.

Parâmetros
device ITestDevice : ITestDevice onde a reinicialização foi iniciada.

Lança
DeviceNotAvailableException

definirDesativar

public final void setDisable (boolean isDisabled)

Define se o objeto deve ser desabilitado. Desativado significa que as etapas de configuração e desmontagem devem ser ignoradas. Pode ser usado para desabilitar um objeto por padrão no construtor padrão.

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

setDisableReceiver

public void setDisableReceiver (boolean isDisabled)

Define se o IDeviceActionReceiver deve ser desabilitado. Desativar significa que ele não será 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 a implementação interna do coletor de métricas. Isso é puro encaminhamento.

Parâmetros
logSaver ILogSaver : o ILogSaver

testeAssunçãoFalha

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 : rastreamento de pilha de falha

testeAssunçãoFalha

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 que descreve a falha e seu contexto.

teste finalizado

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

Alternativa para ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) onde podemos especificar o horário de término diretamente. Combine com testStarted(com.android.tradefed.result.TestDescription, long) para uma medida precisa.

Parâmetros
test TestDescription : identifica o teste

endTime long : o horário em que o teste terminou, medido via System.currentTimeMillis()

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

teste finalizado

public final void testEnded (TestDescription test, 
                 testMetrics)

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

Se testFailed(TestDescription, FailureDescription) não foi invocado, este teste foi aprovado. Também retorna quaisquer métricas de chave/valor que possam 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

teste falhou

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 que descreve a falha e seu contexto.

teste falhou

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 : rastreamento de pilha de falha

testeIgnorado

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

testeLog

public final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

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

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

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

Parâmetros
dataName String : um nome descritivo da String dos dados. por exemplo, "dispositivo_logcat". Nota dataName pode não ser exclusivo por chamada. ou seja, os implementadores devem ser capazes de lidar com 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 iniciar a leitura dos dados e garantir o fechamento do InputStream resultante quando concluído. Os chamadores devem garantir que a fonte 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)

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

Parâmetros
dataName String : um nome descritivo da String dos dados. por exemplo, "dispositivo_logcat". Nota dataName pode não ser exclusivo por chamada. ou seja, os implementadores devem ser capazes de lidar com 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 iniciar a leitura dos dados e garantir o fechamento do 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)

Relata o início de um módulo em execução. Este retorno de chamada está associado a testModuleEnded() e é opcional na sequência. Ele é usado apenas durante uma execução que usa módulos: executores baseados em suíte.

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

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

runMetrics : pares de valores-chave relatados no final de uma execução de 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 que descreve a falha e seu 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 que descreve 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 em execução de teste

attemptNumber int : número do pedido, identificando as diferentes tentativas do mesmo runName que são executadas diversas vezes. O tryNumber é indexado em 0 e deve aumentar sempre que uma nova execução acontece. por exemplo, um teste é repetido de forma granular 3 vezes, deve ter 4 execuções totais sob o mesmo runName e o tryNumber é de 0 a 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Retornos de chamada de execução de teste

Parâmetros
runName String : o nome da execução de teste

testCount int : número total de testes em execução de 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 em execução de teste

attemptNumber int : número do pedido, identificando as diferentes tentativas do mesmo runName que são executadas diversas vezes. O tryNumber é indexado em 0 e deve aumentar sempre que uma nova execução acontece. por exemplo, um teste é repetido de forma granular 3 vezes, deve ter 4 execuções totais sob o mesmo runName e o tryNumber é de 0 a 3.

startTime long : a hora em que a execução começou, medida via System.currentTimeMillis()

testRunStopped

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: atualmente não utilizado, considere remover

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

teste ignorado

public final void testSkipped (TestDescription test, 
                SkipReason reason)

Chamado quando um teste é ignorado e não foi executado por um motivo que normalmente não é esperado. Esses testes serão tentados novamente para tentar obter uma execução adequada.

Parâmetros
test TestDescription : identifica o teste

reason SkipReason : SkipReason

teste iniciado

public final void testStarted (TestDescription test, 
                long startTime)

Alternativa para testStarted(com.android.tradefed.result.TestDescription) onde também especificamos quando o teste foi iniciado, combinado com ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) para uma medida precisa .

Parâmetros
test TestDescription : identifica o teste

startTime long : a hora em que o teste começou, medido via System.currentTimeMillis()

teste iniciado

public final void testStarted (TestDescription test)

Retornos de chamada de casos de teste

Parâmetros
test TestDescription : identifica o teste