IMetricCollector
public
interface
IMetricCollector
implements
IDisableable,
ILogSaverListener
| com.android.tradefed.device.metric.IMetricCollector |
Essa interface será adicionada como um decorador ao informar os resultados dos testes para coletar métricas correspondentes.
Essa interface não pode ser usada como um ITestInvocationListener. A verificação de configuração vai rejeitá-lo. Ele precisa ser usado como um "metrics_collector".
Não é esperado que os coletores mantenham um estado interno, já que podem ser reutilizados em vários lugares. Se um estado interno realmente precisar ser usado, ele deverá ser limpo em init(IInvocationContext,ITestInvocationListener).
Resumo
Métodos públicos | |
|---|---|
default
boolean
|
captureModuleLevel()
Indica se o coletor é aplicável à captura no nível do módulo e precisa ser inicializado. |
default
boolean
|
doesModuleContainFailure()
Retorna "true" se o módulo atual tiver falhas em casos de teste ou execuções de teste. |
default
void
|
enableDefaultMetricCollection()
Permite que os coletores ativem a coleta de métricas padrão. |
default
IMetricCollector.MetricCollectionLevel
|
getAlwaysOnCollectionLevel()
|
abstract
List<IBuildInfo>
|
getBuildInfos()
Retorna a lista de informações de build disponíveis na invocação. |
abstract
List<ITestDevice>
|
getDevices()
Retorna a lista de dispositivos disponíveis na invocação. |
abstract
ITestInvocationListener
|
getInvocationListener()
Retorna o |
default
IMetricCollector.MetricCollectionLevel
|
getOnFailureCollectionLevel()
|
abstract
ITestInvocationListener
|
init(IInvocationContext context, ITestInvocationListener listener)
Inicialização do coletor com o contexto atual e onde encaminhar os resultados. |
default
boolean
|
isDefaultMetricCollectionEnabled()
Indica se o coletor está coletando métricas como parte da coleta de métricas padrão. |
abstract
void
|
onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)
Callback quando um caso de teste falha devido a uma falha de proposição. |
abstract
void
|
onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)
Callback quando um caso de teste é encerrado. |
abstract
void
|
onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)
Callback quando um caso de teste é encerrado. |
abstract
void
|
onTestFail(DeviceMetricData testData, TestDescription test)
Callback quando um caso de teste falha. |
default
void
|
onTestModuleEnded()
Permite capturar o evento de término do módulo. |
default
void
|
onTestModuleStarted()
Permite capturar o evento de início do módulo. |
abstract
void
|
onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)
Callback quando a execução de um teste é encerrada. |
abstract
void
|
onTestRunStart(DeviceMetricData runData)
Callback quando a execução de um teste é iniciada. |
default
void
|
onTestRunStart(DeviceMetricData runData, int testCount)
Callback quando a execução de um teste é iniciada. |
default
void
|
onTestRunStartBlocking()
Callback explícito para iniciar um coletor manualmente, se ele for compatível. |
abstract
void
|
onTestStart(DeviceMetricData testData)
Callback quando um caso de teste é iniciado. |
default
void
|
setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level)
Define o nível em que o coletor deve coletar registros, independentemente de falhas. |
default
void
|
setModuleContainsFailure()
Define se o módulo teve falhas (caso de teste, execução de teste). |
default
void
|
setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level)
Define o nível em que o coletor deve coletar registros durante falhas. |
Métodos públicos
captureModuleLevel
public boolean captureModuleLevel ()
Indica se o coletor é aplicável à captura no nível do módulo e precisa ser inicializado.
| Retorna | |
|---|---|
boolean |
|
doesModuleContainFailure
public boolean doesModuleContainFailure ()
Retorna "true" se o módulo atual tiver falhas em casos de teste ou execuções de teste.
| Retorna | |
|---|---|
boolean |
|
enableDefaultMetricCollection
public void enableDefaultMetricCollection ()
Permite que os coletores ativem a coleta de métricas padrão. Quando a coleta de métricas padrão está ativada, o coletor só coleta no nível especificado.
getAlwaysOnCollectionLevel
public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()
| Retorna | |
|---|---|
IMetricCollector.MetricCollectionLevel |
|
getBuildInfos
public abstract List<IBuildInfo> getBuildInfos ()
Retorna a lista de informações de build disponíveis na invocação.
| Retorna | |
|---|---|
List<IBuildInfo> |
|
getDevices
public abstract List<ITestDevice> getDevices ()
Retorna a lista de dispositivos disponíveis na invocação.
| Retorna | |
|---|---|
List<ITestDevice> |
|
getInvocationListener
public abstract ITestInvocationListener getInvocationListener ()
Retorna o ITestInvocationListener original para onde estamos encaminhando os resultados.
| Retorna | |
|---|---|
ITestInvocationListener |
|
getOnFailureCollectionLevel
public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()
| Retorna | |
|---|---|
IMetricCollector.MetricCollectionLevel |
|
init
public abstract ITestInvocationListener init (IInvocationContext context, ITestInvocationListener listener)
Inicialização do coletor com o contexto atual e onde encaminhar os resultados. Será chamado apenas uma vez por instância, e o coletor deverá atualizar o contexto e o listener internos. Init nunca será chamado durante um teste, sempre 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 onde colocar os resultados. |
| Retorna | |
|---|---|
ITestInvocationListener |
o novo listener envolvendo o original. |
| Gera | |
|---|---|
DeviceNotAvailableException |
|
isDefaultMetricCollectionEnabled
public boolean isDefaultMetricCollectionEnabled ()
Indica se o coletor está coletando métricas como parte da coleta de métricas padrão.
| Retorna | |
|---|---|
boolean |
|
onTestAssumptionFailure
public abstract void onTestAssumptionFailure (DeviceMetricData testData, TestDescription test)
Callback quando um caso de teste falha devido a uma falha de proposiçã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. |
| Gera | |
|---|---|
DeviceNotAvailableException |
|
onTestEnd
public abstract void onTestEnd (DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)
Callback quando um caso de teste é encerrado. Esse é o momento de fazer a limpeza.
| Parâmetros | |
|---|---|
testData |
DeviceMetricData: o DeviceMetricData que contém os dados do caso de teste. Será o mesmo objeto em onTestStart(DeviceMetricData). |
currentTestCaseMetrics |
Map: o mapa atual de métricas transmitidas para testEnded(TestDescription,Map). |
test |
TestDescription: o TestDescription do caso de teste em andamento. |
| Gera | |
|---|---|
DeviceNotAvailableException |
|
onTestEnd
public abstract void onTestEnd (DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)
Callback quando um caso de teste é encerrado. Esse é o momento de fazer a limpeza.
| Parâmetros | |
|---|---|
testData |
DeviceMetricData: o DeviceMetricData que contém os dados do caso de teste. Será o mesmo objeto em onTestStart(DeviceMetricData). |
currentTestCaseMetrics |
Map: o mapa atual de métricas transmitidas para testEnded(TestDescription,Map). |
| Gera | |
|---|---|
DeviceNotAvailableException |
|
onTestFail
public abstract void onTestFail (DeviceMetricData testData, TestDescription test)
Callback 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. |
| Gera | |
|---|---|
DeviceNotAvailableException |
|
onTestModuleEnded
public void onTestModuleEnded ()
Permite capturar o evento de término do módulo.
| Gera | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestModuleStarted
public void onTestModuleStarted ()
Permite capturar o evento de início do módulo.
| Gera | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestRunEnd
public abstract void onTestRunEnd (DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)
Callback quando a execução de um teste é encerrada. Esse é o momento de fazer a limpeza.
| Parâmetros | |
|---|---|
runData |
DeviceMetricData: o DeviceMetricData que contém os dados da execução. Será o mesmo objeto em onTestRunStart(DeviceMetricData). |
currentRunMetrics |
Map: o mapa atual de métricas transmitidas para testRunEnded(long,Map). |
| Gera | |
|---|---|
DeviceNotAvailableException |
|
onTestRunStart
public abstract void onTestRunStart (DeviceMetricData runData)
Callback quando a execução de um teste é iniciada.
| Parâmetros | |
|---|---|
runData |
DeviceMetricData: o DeviceMetricData que contém os dados da execução. |
| Gera | |
|---|---|
DeviceNotAvailableException |
|
onTestRunStart
public void onTestRunStart (DeviceMetricData runData, int testCount)
Callback quando a execução de um teste é iniciada.
| Parâmetros | |
|---|---|
runData |
DeviceMetricData: o DeviceMetricData que contém os dados da execução. |
testCount |
int: o número de casos de teste nesta execução de teste. |
| Gera | |
|---|---|
DeviceNotAvailableException |
|
onTestRunStartBlocking
public void onTestRunStartBlocking ()
Callback explícito para iniciar um coletor manualmente, se ele for compatível. Isso garante que estamos fora de algum ciclo de vida de teste assíncrono.
| Gera | |
|---|---|
|
com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
|
onTestStart
public abstract void onTestStart (DeviceMetricData testData)
Callback quando um caso de teste é iniciado.
| Parâmetros | |
|---|---|
testData |
DeviceMetricData: o DeviceMetricData que contém os dados do caso de teste. |
| Gera | |
|---|---|
DeviceNotAvailableException |
|
setAlwaysOnCollectionLevel
public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)
Define o nível em que o coletor deve coletar registros, independentemente de falhas.
O nível NULL não resulta em coleta.
| Parâmetros | |
|---|---|
level |
IMetricCollector.MetricCollectionLevel: MetricCollectionLevel em que os registros serão coletados. |
setModuleContainsFailure
public void setModuleContainsFailure ()
Define se o módulo teve falhas (caso de teste, execução de teste).
setOnFailureCollectionLevel
public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)
Define o nível em que o coletor deve coletar registros durante falhas.
O nível NULL não resulta em coleta.
| Parâmetros | |
|---|---|
level |
IMetricCollector.MetricCollectionLevel: MetricCollectionLevel em que os registros serão coletados. |