IMetricCollector

public interface IMetricCollector
implements IDisableable , ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector

Этот интерфейс будет добавлен в качестве декоратора при формировании отчетов о результатах тестов для сбора соответствующих метрик.

Этот интерфейс нельзя использовать в качестве Даже если он наследует ITestInvocationListener , проверка конфигурации его отклонит. Его необходимо использовать как "metrics_collector".

Сборщикам не требуется хранить внутреннее состояние, поскольку они могут быть повторно использованы в нескольких местах. Если внутреннее состояние действительно необходимо использовать, то его следует очищать при init(IInvocationContext,ITestInvocationListener) .

Краткое содержание

Общедоступные методы

default boolean captureModuleLevel ()

Применим ли сборщик данных для захвата данных на уровне модуля и должен ли он быть инициализирован.

default boolean doesModuleContainFailure ()

Возвращает true, если текущий модуль содержал какие-либо тестовые случаи или ошибки выполнения тестов.

default void enableDefaultMetricCollection ()

Позволяет сборщикам метрик включить сбор метрик по умолчанию.

default IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()
abstract List< IBuildInfo > getBuildInfos ()

Возвращает список доступной информации о сборке, полученной в результате вызова.

abstract List< ITestDevice > getDevices ()

Возвращает список устройств, доступных в данном вызове.

abstract ITestInvocationListener getInvocationListener ()

Возвращает исходный объект ITestInvocationListener , куда мы пересылаем результаты.

default IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()
abstract ITestInvocationListener init ( IInvocationContext context, ITestInvocationListener listener)

Инициализация сборщика данных с указанием текущего контекста и места пересылки результатов.

default boolean isDefaultMetricCollectionEnabled ()

Определяет, собирает ли сборщик метрики в рамках стандартного сбора метрик.

abstract void onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test)

Функция обратного вызова, которая срабатывает, когда тестовый случай завершается с ошибкой предположения.

abstract void onTestEnd ( DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)

Функция обратного вызова, которая срабатывает по завершении тестового случая.

abstract void onTestEnd ( DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

Функция обратного вызова, которая срабатывает по завершении тестового случая.

abstract void onTestFail ( DeviceMetricData testData, TestDescription test)

Функция обратного вызова, которая срабатывает при неудачном выполнении тестового случая.

default void onTestModuleEnded ()

Позволяет перехватывать событие завершения работы модуля.

default void onTestModuleStarted ()

Позволяет перехватывать событие запуска модуля.

abstract void onTestRunEnd ( DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)

Функция обратного вызова, которая срабатывает по завершении тестового запуска.

abstract void onTestRunStart ( DeviceMetricData runData)

Функция обратного вызова, которая срабатывает при запуске тестового запуска.

default void onTestRunStart ( DeviceMetricData runData, int testCount)

Функция обратного вызова, которая срабатывает при запуске тестового запуска.

default void onTestRunStartBlocking ()

Явный обработчик события для ручного запуска сборщика мусора, если такая возможность поддерживается.

abstract void onTestStart ( DeviceMetricData testData)

Функция обратного вызова, которая срабатывает при запуске тестового случая.

default void setAlwaysOnCollectionLevel ( IMetricCollector.MetricCollectionLevel level)

Задает уровень, при котором сборщик должен собирать журналы независимо от сбоев.

default void setModuleContainsFailure ()

Указывает, были ли в модуле какие-либо ошибки (тестовый случай, запуск теста).

default void setOnFailureCollectionLevel ( IMetricCollector.MetricCollectionLevel level)

Задает уровень, на котором сборщик должен собирать журналы во время сбоев.

Общедоступные методы

captureModuleLevel 

public boolean captureModuleLevel ()

Применим ли сборщик данных для захвата данных на уровне модуля и должен ли он быть инициализирован.

Возвраты
boolean

doesModuleContainFailure 

public boolean doesModuleContainFailure ()

Возвращает true, если текущий модуль содержал какие-либо тестовые случаи или ошибки выполнения тестов.

Возвраты
boolean

enableDefaultMetricCollection 

public void enableDefaultMetricCollection ()

Позволяет сборщикам метрик включать сбор метрик по умолчанию. При включении сбора метрик по умолчанию сборщик должен собирать метрики только на указанном уровне сбора.

getAlwaysOnCollectionLevel 

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

Возвраты
IMetricCollector.MetricCollectionLevel

получить информацию о сборке 

public abstract List<IBuildInfo> getBuildInfos ()

Возвращает список доступной информации о сборке, полученной в результате вызова.

Возвраты
List< IBuildInfo >

getDevices 

public abstract List<ITestDevice> getDevices ()

Возвращает список устройств, доступных в данном вызове.

Возвраты
List< ITestDevice >

getInvocationListener 

public abstract ITestInvocationListener getInvocationListener ()

Возвращает исходный объект ITestInvocationListener , куда мы пересылаем результаты.

Возвраты
ITestInvocationListener

getOnFailureCollectionLevel 

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

Возвраты
IMetricCollector.MetricCollectionLevel

инициализация 

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

Инициализация сборщика с текущим контекстом и указанием, куда пересылать результаты. Вызывается только один раз для каждого экземпляра, и ожидается, что сборщик обновит свой внутренний контекст и слушатель. Инициализация никогда не будет вызываться во время выполнения теста, всегда перед ним.

Не вносите изменения, если не знаете, что делаете.

Параметры
context IInvocationContext : IInvocationContext для выполняемого вызова.

listener ITestInvocationListener : объект ITestInvocationListener , куда помещаются результаты.

Возвраты
ITestInvocationListener Новый слушатель переворачивает исходного.

Броски
DeviceNotAvailableException

isDefaultMetricCollectionEnabled 

public boolean isDefaultMetricCollectionEnabled ()

Определяет, собирает ли сборщик метрики в рамках стандартного сбора метрик.

Возвраты
boolean

onTestAssumptionFailure 

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

Функция обратного вызова, которая срабатывает, когда тестовый случай завершается с ошибкой предположения.

Параметры
testData DeviceMetricData : объект DeviceMetricData , содержащий данные для тестового случая.

test TestDescription : TestDescription текущего тестового случая.

Броски
DeviceNotAvailableException

onTestEnd 

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, 
                TestDescription test)

Функция обратного вызова, которая срабатывает по завершении тестового случая. В этот момент следует выполнить очистку ресурсов.

Параметры
testData DeviceMetricData : объект DeviceMetricData , содержащий данные для тестового случая. Будет тем же объектом, что и во время onTestStart(DeviceMetricData) .

currentTestCaseMetrics Map : текущая карта метрик, переданных в testEnded(TestDescription,Map) .

test TestDescription : TestDescription текущего тестового случая.

Броски
DeviceNotAvailableException

onTestEnd 

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

Функция обратного вызова, которая срабатывает по завершении тестового случая. В этот момент следует выполнить очистку ресурсов.

Параметры
testData DeviceMetricData : объект DeviceMetricData , содержащий данные для тестового случая. Будет тем же объектом, что и во время onTestStart(DeviceMetricData) .

currentTestCaseMetrics Map : текущая карта метрик, переданных в testEnded(TestDescription,Map) .

Броски
DeviceNotAvailableException

onTestFail 

public abstract void onTestFail (DeviceMetricData testData, 
                TestDescription test)

Функция обратного вызова, которая срабатывает при неудачном выполнении тестового случая.

Параметры
testData DeviceMetricData : объект DeviceMetricData , содержащий данные для тестового случая.

test TestDescription : TestDescription текущего тестового случая.

Броски
DeviceNotAvailableException

onTestModuleEnded 

public void onTestModuleEnded ()

Позволяет перехватывать событие завершения работы модуля.

Броски
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestModuleStarted 

public void onTestModuleStarted ()

Позволяет перехватывать событие запуска модуля.

Броски
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunEnd 

public abstract void onTestRunEnd (DeviceMetricData runData, 
                Map<String, MetricMeasurement.Metric> currentRunMetrics)

Функция обратного вызова, которая срабатывает по завершении тестового запуска. В этот момент следует выполнить очистку ресурсов.

Параметры
runData DeviceMetricData : объект DeviceMetricData , содержащий данные для выполнения теста. Будет тем же объектом, что и во время onTestRunStart(DeviceMetricData) .

currentRunMetrics Map : текущая карта метрик, переданных в testRunEnded(long,Map) .

Броски
DeviceNotAvailableException

onTestRunStart 

public abstract void onTestRunStart (DeviceMetricData runData)

Функция обратного вызова, которая срабатывает при запуске тестового запуска.

Параметры
runData DeviceMetricData : объект DeviceMetricData , содержащий данные о ходе выполнения.

Броски
DeviceNotAvailableException

onTestRunStart 

public void onTestRunStart (DeviceMetricData runData, 
                int testCount)

Функция обратного вызова, которая срабатывает при запуске тестового запуска.

Параметры
runData DeviceMetricData : объект DeviceMetricData , содержащий данные о ходе выполнения.

testCount int : количество тестовых случаев в этом тестовом запуске.

Броски
DeviceNotAvailableException

onTestRunStartBlocking 

public void onTestRunStartBlocking ()

Явный коллбэк для ручного запуска сборщика мусора, если он это поддерживает. Это позволяет гарантировать, что мы выходим из некоторых асинхронных циклов тестирования.

Броски
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestStart 

public abstract void onTestStart (DeviceMetricData testData)

Функция обратного вызова, которая срабатывает при запуске тестового случая.

Параметры
testData DeviceMetricData : объект DeviceMetricData , содержащий данные для тестового случая.

Броски
DeviceNotAvailableException

setAlwaysOnCollectionLevel 

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

Задает уровень, при котором сборщик должен собирать журналы независимо от сбоев.

Значение NULL приведет к тому, что сборка мусора не будет произведена.

Параметры
level IMetricCollector.MetricCollectionLevel : MetricCollectionLevel на котором будут собираться журналы.

setModuleContainsFailure 

public void setModuleContainsFailure ()

Указывает, были ли в модуле какие-либо ошибки (тестовый случай, запуск теста).

setOnFailureCollectionLevel 

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

Задает уровень, на котором сборщик должен собирать журналы во время сбоев.

Значение NULL приведет к тому, что сборка мусора не будет произведена.

Параметры
level IMetricCollector.MetricCollectionLevel : MetricCollectionLevel на котором будут собираться журналы.