BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IDeviceActionReceiver , IMetricCollector

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

Известные прямые подклассы AtraceCollector , BugreportzOnFailureCollector , BugreportzOnTestCaseFailureCollector , ClangCodeCoverageCollector , CodeCoverageCollector , CountTestCasesCollector , DebugHostLogOnFailureCollector , DeviceTraceCollector , FilePullerDeviceMetricCollector , GcovCodeCoverageCollector , GcovKernelCodeCoverageCollector , HostStatsdMetricCollector , JavaCodeCoverageCollector , LogcatOnFailureCollector , LogcatTimingMetricCollector , ModulePerfettoCollector , RebootReasonCollector , RuntimeRestartCollector , ScreenRecordOnFailureCollector , ScreenshotOnFailureCollector AtraceCollector Объект IMetricCollector , который запускает трассировку во время теста, собирает результаты и записывает их в лог при выполнении теста. BugreportzOnFailureCollector Собирайте отчеты об ошибках (ugreportz), если какой-либо тестовый случай не пройден. BugreportzOnTestCaseFailureCollector Собирайте отчеты об ошибках (ugreportz), если какой-либо тестовый случай в ходе выполнения не удается. ClangCodeCoverageCollector Объект BaseDeviceMetricCollector , который будет получать данные о покрытии кода Clang с устройства и записывать их в качестве тестовых артефактов. CodeCoverageCollector Объект BaseDeviceMetricCollector , который будет собирать данные об уровне покрытия Java и нативных тестов с устройства и записывать их в качестве тестовых артефактов. CountTestCasesCollector Подсчитайте и сообщите количество тестовых случаев для заданного IRemoteTest . DebugHostLogOnFailureCollector Сборщик, который будет собирать и записывать логи на стороне хоста при возникновении ошибки в тестовом случае. DeviceTraceCollector Сборщик данных, который запустит трассировку Perfetto при начале выполнения теста и запишет файл трассировки в конце. FilePullerDeviceMetricCollector BaseDeviceMetricCollector , который отслеживает ключи метрик, поступающие от устройства, и извлекает их в файл с устройства. GcovCodeCoverageCollector Объект BaseDeviceMetricCollector , который будет получать данные измерений покрытия gcov с устройства и регистрировать их в качестве тестовых артефактов. GcovKernelCodeCoverageCollector Объект BaseDeviceMetricCollector , который будет извлекать результаты измерений покрытия ядра gcov из debugfs и с устройства, а затем регистрировать их в виде тестовых артефактов. HostStatsdMetricCollector IMetricCollector , который собирает метрики statsd со стороны хоста, используя команды утилиты statsd. JavaCodeCoverageCollector Объект BaseDeviceMetricCollector , который будет собирать данные об уровне покрытия Java-кода с устройства и записывать их в качестве тестовых артефактов. LogcatOnFailureCollector Сборщик логов, который будет собирать и записывать данные в logcat при сбое тестового случая или выполнения теста. LogcatTimingMetricCollector Сборщик метрик, который собирает информацию о времени (например, время переключения пользователя) из logcat во время одного или нескольких повторяющихся тестов, используя заданные шаблоны регулярных выражений для анализа сигналов начала и конца события из строк logcat. ModulePerfettoCollector Сборщик данных, который будет запускать трассировку Perfetto при запуске и завершении тестового модуля, а также при перезагрузке устройства. RebootReasonCollector Сборщик данных, который отслеживает перезагрузки устройств во время тестового запуска и сообщает о них с указанием причины и количества. RuntimeRestartCollector Сборщик, который собирает метки времени перезапусков во время выполнения (сбоев системного сервера) в ходе тестового запуска, если таковые имели место. ScreenRecordOnFailureCollector Сборщик данных, который будет записывать и регистрировать видео с экрана в случае сбоя тестового случая. ScreenshotOnFailureCollector Сборщик данных, который будет делать снимок экрана и записывать его в журнал при сбое тестового случая.

Известные косвенные подклассы AtraceRunMetricCollector , BluetoothConnectionLatencyCollector , BluetoothConnectionStateCollector , BluetoothHciSnoopLogCollector , FilePullerLogCollector , ModuleLogcatCollector , PerfettoFilePullerCollector , PerfettoPullerMetricCollector , ShowmapPullerMetricCollector , TraceCmdCollector AtraceRunMetricCollector Собирает трассировки из всех тестовых каталогов в указанной директории с тестового устройства, регистрирует данные в тестовом каталоге, обрабатывает файлы трассировок в тестовом каталоге и агрегирует метрики. BluetoothConnectionLatencyCollector Сборщик данных будет отправлять на устройства предварительно заданную конфигурацию метрики statsd duration и собирать данные о продолжительности Bluetooth-соединения для каждого профиля. BluetoothConnectionStateCollector Этот сборщик будет собирать метрики BluetoothConnectionStateChanged и записывать номер состояния соединения для каждого профиля. BluetoothHciSnoopLogCollector Сборщик данных для включения функции отслеживания активности Bluetooth HCI на тестируемом устройстве и сбора логов для каждого теста. FilePullerLogCollector Запись лога файла, предоставленного устройством. ModuleLogcatCollector Версия сборщика logcat, но для модуля. PerfettoFilePullerCollector Сборщик, который извлекает из устройства файлы трассировки Perfetto, при необходимости сжимает их и добавляет в журналы тестирования. PerfettoPullerMetricCollector Этот класс устарел. Используйте PerfettoFilePullerCollector и ERROR(/PerfettoTracePostProcessor) вместо него. ShowmapPullerMetricCollector Базовая реализация FilePullerDeviceMetricCollector , позволяющая извлекать файлы showmap с устройства и собирать с них метрики. TraceCmdCollector Объект IMetricCollector , который собирает трассировки во время тестирования с помощью trace-cmd и записывает их в лог при запуске программы.

---

Базовая реализация IMetricCollector , позволяющая запускать и останавливать сбор данных в onTestRunStart(DeviceMetricData) и onTestRunEnd(DeviceMetricData,Map) .

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

Константы
String	TEST_CASE_EXCLUDE_GROUP_OPTION
String	TEST_CASE_INCLUDE_GROUP_OPTION

Государственные строители
BaseDeviceMetricCollector ()

Общедоступные методы
boolean	doesModuleContainFailure () Возвращает true, если текущий модуль содержал какие-либо тестовые случаи или ошибки выполнения тестов.
void	enableDefaultMetricCollection () Позволяет сборщикам метрик включить сбор метрик по умолчанию.
void	extraInit ( IInvocationContext context, ITestInvocationListener listener)
IMetricCollector.MetricCollectionLevel	getAlwaysOnCollectionLevel ()
final List< IBuildInfo >	getBuildInfos () Возвращает список доступной информации о сборке, полученной в результате вызова.
final List< ITestDevice >	getDevices () Возвращает список устройств, доступных в данном вызове.
File	getFileFromTestArtifacts (String fileName) Получите файл из тестовых или модульных артефактов и кэшируйте его в карте для последующих вызовов.
final ITestInvocationListener	getInvocationListener () Возвращает исходный объект ITestInvocationListener , куда мы пересылаем результаты.
String	getModuleName ()
IMetricCollector.MetricCollectionLevel	getOnFailureCollectionLevel ()
final List< ITestDevice >	getRealDevices () Возвращает все устройства, не являющиеся заглушками, из списка getDevices() .
String	getRunName () Возвращает имя тестового запуска mRunName , который запускает сборщик данных.
String	getTestName () Возвращает имя теста mTestName , который запускает сборщик данных.
final ITestInvocationListener	init ( IInvocationContext context, ITestInvocationListener listener) Инициализация сборщика данных с указанием текущего контекста и места пересылки результатов.
final void	invocationEnded (long elapsedTime) Сообщает о завершении вызова, будь то успешное завершение или возникновение ошибки.
final void	invocationFailed ( FailureDescription failure) Сообщает о неполном вызове из-за какой-либо ошибки.
final void	invocationFailed (Throwable cause) Сообщает о неполном вызове из-за какой-либо ошибки.
void	invocationSkipped ( SkipReason reason) Сообщает о пропуске вызова.
final void	invocationStarted ( IInvocationContext context) Слушатели вызовов для переадресации
boolean	isDefaultMetricCollectionEnabled () Определяет, собирает ли сборщик метрики в рамках стандартного сбора метрик.
final boolean	isDisabled () Возвращает True, если весь объект отключен (пропускаем как настройку, так и очистку).
boolean	isDisabledReceiver () Отключен ли IDeviceActionReceiver или нет.
final void	logAssociation (String dataName, LogFile logFile) Не используйте это внутри реализации сборщика метрик.
void	onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test) Функция обратного вызова, которая срабатывает, когда тестовый случай завершается с ошибкой предположения.
void	onTestEnd ( DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics) Функция обратного вызова, которая срабатывает по завершении тестового случая.
void	onTestEnd ( DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test) Функция обратного вызова, которая срабатывает по завершении тестового случая.
void	onTestFail ( DeviceMetricData testData, TestDescription test) Функция обратного вызова, которая срабатывает при неудачном выполнении тестового случая.
void	onTestModuleEnded () Позволяет перехватывать событие завершения работы модуля.
void	onTestModuleStarted () Позволяет перехватывать событие запуска модуля.
void	onTestRunEnd ( DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics) Функция обратного вызова, которая срабатывает по завершении тестового запуска.
void	onTestRunFailed ( DeviceMetricData testData, FailureDescription failure) Функция обратного вызова для событий testRunFailed
void	onTestRunStart ( DeviceMetricData runData) Функция обратного вызова, которая срабатывает при запуске тестового запуска.
void	onTestStart ( DeviceMetricData testData) Функция обратного вызова, которая срабатывает при запуске тестового случая.
void	rebootEnded ( ITestDevice device) Получает уведомление о завершении перезагрузки устройства.
void	rebootStarted ( ITestDevice device) Получает уведомление о начале перезагрузки устройства.
void	setAlwaysOnCollectionLevel ( IMetricCollector.MetricCollectionLevel level) Задает уровень, при котором сборщик должен собирать журналы независимо от сбоев.
final void	setDisable (boolean isDisabled) Определяет, следует ли отключать объект.
void	setDisableReceiver (boolean isDisabled) Определяет, следует ли отключать IDeviceActionReceiver .
final void	setLogSaver ( ILogSaver logSaver) Не используйте это внутри реализации сборщика метрик.
void	setModuleContainsFailure () Указывает, были ли в модуле какие-либо ошибки (тестовый случай, запуск теста).
void	setOnFailureCollectionLevel ( IMetricCollector.MetricCollectionLevel level) Задает уровень, на котором сборщик должен собирать журналы во время сбоев.
final void	testAssumptionFailure ( TestDescription test, String trace) Вызывается, когда атомарный тест указывает на то, что он предполагает ложное условие.
final void	testAssumptionFailure ( TestDescription test, FailureDescription failure) Вызывается, когда атомарный тест указывает на то, что он предполагает ложное условие.
final void	testEnded ( TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics) Альтернатива функции testEnded(TestDescription,Map) позволяющая напрямую указать время окончания.
final void	testEnded ( TestDescription test, HashMap<String, MetricMeasurement.Metric> testMetrics) Сообщает о завершении выполнения отдельного тестового случая.
final void	testFailed ( TestDescription test, FailureDescription failure) Сообщает о сбое отдельного тестового случая.
final void	testFailed ( TestDescription test, String trace) Сообщает о сбое отдельного тестового случая.
final void	testIgnored ( TestDescription test) Вызывается, когда тест выполняться не будет, как правило, потому что тестовый метод аннотирован с помощью org.junit.Ignore.
final void	testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) Предоставляет соответствующие данные журнала или отладочные данные из вызова теста.
final void	testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile) Не используйте это внутри реализации сборщика метрик.
final void	testModuleEnded () Сообщает об окончании выполнения модуля.
final void	testModuleStarted ( IInvocationContext moduleContext) Сообщает о начале работы модуля.
final void	testRunEnded (long elapsedTime, HashMap<String, MetricMeasurement.Metric> runMetrics) Сообщает об окончании тестового запуска.
final void	testRunFailed ( FailureDescription failure) Сообщается, что запуск тестового запуска не завершился из-за ошибки, описанной в FailureDescription .
final void	testRunFailed (String errorMessage) Сообщается, что тестовый запуск не завершился из-за критической ошибки.
final void	testRunStarted (String runName, int testCount, int attemptNumber) Сообщает о начале тестового запуска.
final void	testRunStarted (String runName, int testCount) Обратные вызовы при запуске тестов
final void	testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Сообщает о начале тестового запуска.
final void	testRunStopped (long elapsedTime) Тестирование отчетов было прервано до завершения по запросу пользователя.
final void	testSkipped ( TestDescription test, SkipReason reason) Вызывается, когда тест пропущен и не выполнен по причине, которая обычно не ожидается.
final void	testStarted ( TestDescription test, long startTime) Альтернатива функции testStarted(TestDescription) , где мы также указываем время начала теста, в сочетании с testEnded(TestDescription,long,Map) для более точного измерения.
final void	testStarted ( TestDescription test) Обратные вызовы тестовых случаев

Константы

TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

Постоянное значение: "test-case-exclude-group"

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

Постоянное значение: "test-case-include-group"

Государственные строители

BaseDeviceMetricCollector

public BaseDeviceMetricCollector ()

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

doesModuleContainFailure

public boolean doesModuleContainFailure ()

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

Возвраты
boolean

enableDefaultMetricCollection

public void enableDefaultMetricCollection ()

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

extraInit

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

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

getAlwaysOnCollectionLevel

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

Возвраты
IMetricCollector.MetricCollectionLevel

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

public final List<IBuildInfo> getBuildInfos ()

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

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

getDevices

public final List<ITestDevice> getDevices ()

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

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

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

Получите файл из тестовых или модульных артефактов и кэшируйте его в карте для последующих вызовов.

Параметры
fileName	String : имя файла, который нужно найти в артефактах.

Возвраты
File	Файл из тестового или модульного артефакта. Возвращает null, если файл не найден.

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

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

Возвраты
ITestInvocationListener

getModuleName

public String getModuleName ()

Возвраты
String

getOnFailureCollectionLevel

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

Возвраты
IMetricCollector.MetricCollectionLevel

getRealDevices

public final List<ITestDevice> getRealDevices ()

Возвращает все устройства, не являющиеся заглушками, из списка getDevices() .

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

getRunName

public String getRunName ()

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

Возвраты
String	mRunName — имя текущего запуска теста.

getTestName

public String getTestName ()

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

Возвраты
String	mTestName — текущее имя теста.

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

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

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

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

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

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

Броски
DeviceNotAvailableException

вызов завершен

public final void invocationEnded (long elapsedTime)

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

Будет автоматически вызвана фреймворком TradeFederation.

Параметры
elapsedTime	long : время выполнения вызова в миллисекундах

вызов не удался

public final void invocationFailed (FailureDescription failure)

Сообщает о неполном вызове из-за какой-либо ошибки.

Будет автоматически вызвана фреймворком TradeFederation.

Параметры
failure	FailureDescription : описание причины сбоя FailureDescription

вызов не удался

public final void invocationFailed (Throwable cause)

Сообщает о неполном вызове из-за какой-либо ошибки.

Будет автоматически вызвана фреймворком TradeFederation.

Параметры
cause	Throwable : Throwable причина отказа.

вызовПропущен

public void invocationSkipped (SkipReason reason)

Сообщает о пропуске вызова.

Параметры
reason	SkipReason

вызовНачался

public final void invocationStarted (IInvocationContext context)

Слушатели вызовов для переадресации

Параметры
context	IInvocationContext : информация о вызове

isDefaultMetricCollectionEnabled

public boolean isDefaultMetricCollectionEnabled ()

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

Возвраты
boolean

isDisabled

public final boolean isDisabled ()

Возвращает True, если весь объект отключен (пропускает как настройку, так и очистку). В противном случае — False.

Возвраты
boolean

isDisabledReceiver

public boolean isDisabledReceiver ()

Отключен ли IDeviceActionReceiver или нет.

Возвраты
boolean	Возвращает true, если отключено, false в противном случае.

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

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

Параметры
dataName	String : Название данных
logFile	LogFile : LogFile , в который были записаны данные ранее и который должен быть связан с тестовым случаем.

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

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

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

Броски
DeviceNotAvailableException

onTestEnd

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

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

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

Броски
DeviceNotAvailableException

onTestEnd

public 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

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

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

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

Броски
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

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

Броски
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

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

Броски
DeviceNotAvailableException

onTestRunEnd

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

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

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

Броски
DeviceNotAvailableException

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

Функция обратного вызова для событий testRunFailed

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

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

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

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

Броски
DeviceNotAvailableException

onTestStart

public void onTestStart (DeviceMetricData testData)

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

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

Броски
DeviceNotAvailableException

перезагрузка завершена

public void rebootEnded (ITestDevice device)

Получает уведомление о завершении перезагрузки устройства.

ПРИМЕЧАНИЕ: Во время выполнения этого обратного вызова получателям следует избегать перезагрузки. Любая попытка перезагрузки будет проигнорирована.

Параметры
device	ITestDevice : ITestDevice на котором завершилась перезагрузка.

Броски
DeviceNotAvailableException

перезагрузка начата

public void rebootStarted (ITestDevice device)

Получает уведомление о начале перезагрузки устройства.

ПРИМЕЧАНИЕ: Во время выполнения этого обратного вызова получателям следует избегать перезагрузки. Любая попытка перезагрузки будет проигнорирована.

Параметры
device	ITestDevice : ITestDevice с которого началась перезагрузка.

Броски
DeviceNotAvailableException

setAlwaysOnCollectionLevel

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

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

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

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

setDisable

public final void setDisable (boolean isDisabled)

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

Параметры
isDisabled	boolean : состояние, в которое должен быть помещен объект.

setDisableReceiver

public void setDisableReceiver (boolean isDisabled)

Определяет, следует ли отключить IDeviceActionReceiver . Отключение означает, что он не будет зарегистрирован на устройстве для получения событий действий устройства.

Параметры
isDisabled	boolean

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

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

Параметры
logSaver	ILogSaver : ILogSaver

setModuleContainsFailure

public void setModuleContainsFailure ()

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

setOnFailureCollectionLevel

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

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

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

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

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

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

Параметры
test	TestDescription : идентифицирует тест
trace	String : трассировка стека ошибки

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

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

Параметры
test	TestDescription : идентифицирует тест
failure	FailureDescription : Описание ошибки и контекст её FailureDescription .

тест завершен

public final void testEnded (TestDescription test, 
                long endTime, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

Альтернатива функции testEnded(TestDescription,Map) , позволяющая напрямую указать время окончания. Для более точного измерения можно использовать в сочетании с testStarted(TestDescription,long) .

Параметры
test	TestDescription : идентифицирует тест
endTime	long : время окончания теста, измеренное с помощью System.currentTimeMillis()
testMetrics	HashMap : Map сгенерированных метрик

тест завершен

public final void testEnded (TestDescription test, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

Сообщает о завершении выполнения отдельного тестового случая.

Если testFailed(TestDescription, FailureDescription) не был вызван, тест пройден успешно. Также возвращает любые метрики ключ/значение, которые могли быть получены во время выполнения тестового случая.

Параметры
test	TestDescription : идентифицирует тест
testMetrics	HashMap : Map сгенерированных метрик

тест не пройден

public final void testFailed (TestDescription test, 
                FailureDescription failure)

Сообщает о сбое отдельного тестового случая.

Эта функция будет вызвана в промежутке между testStarted и testEnded.

Параметры
test	TestDescription : идентифицирует тест
failure	FailureDescription : Описание ошибки и контекст её FailureDescription .

тест не пройден

public final void testFailed (TestDescription test, 
                String trace)

Сообщает о сбое отдельного тестового случая.

Эта функция будет вызвана в промежутке между testStarted и testEnded.

Параметры
test	TestDescription : идентифицирует тест
trace	String : трассировка стека ошибки

тест проигнорирован

public final void testIgnored (TestDescription test)

Вызывается, когда тест выполняться не будет, как правило, потому что тестовый метод аннотирован с помощью org.junit.Ignore.

Параметры
test	TestDescription : идентифицирует тест

testLog

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

Предоставляет соответствующие данные журнала или отладочные данные из вызова теста.

Необходимо вызвать перед ERROR(ITestInvocationListener.invocationFailed(Throwable)/ITestInvocationListener#invocationFailed(java.lang.Throwable) ITestInvocationListener.invocationFailed(Throwable)) или ERROR(/ITestInvocationListener#invocationEnded(long))

Фреймворк TradeFederation автоматически вызовет этот метод, предоставив лог хоста и, если применимо, лог устройства.

Параметры
dataName	String : String описательное имя данных. Например, "device_logcat". Обратите внимание, что dataName может быть не уникальным для каждого вызова. То есть разработчики должны иметь возможность обрабатывать несколько вызовов с одним и тем же dataName.
dataType	LogDataType : тип данных LogDataType
dataStream	InputStreamSource : InputStreamSource данных. Разработчикам следует вызвать createInputStream для начала чтения данных и убедиться, что результирующий InputStream закрыт по завершении. Вызывающие стороны должны убедиться, что источник данных остается доступным до завершения метода testLog.

testLogSaved

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

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

Параметры
dataName	String : String описательное имя данных. Например, "device_logcat". Обратите внимание, что dataName может быть не уникальным для каждого вызова. То есть разработчики должны иметь возможность обрабатывать несколько вызовов с одним и тем же dataName.
dataType	LogDataType : тип данных LogDataType
dataStream	InputStreamSource : объект InputStreamSource для данных. Разработчикам следует вызвать метод createInputStream, чтобы начать чтение данных, и убедиться, что результирующий InputStream закрыт по завершении.
logFile	LogFile : LogFile содержащий метаданные сохраненного файла.

testModuleEnded

public final void testModuleEnded ()

Сообщает об окончании выполнения модуля.

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

Сообщает о начале выполнения модуля. Этот обратный вызов связан с testModuleEnded() и является необязательным в последовательности. Он используется только во время запуска, использующего модули: в случае запуска тестов на основе тестовых наборов.

Параметры
moduleContext	IInvocationContext : IInvocationContext модуля.

testRunEnded

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

Сообщает об окончании выполнения теста. FIXME: Мы не можем иметь два интерфейса Map<> с разными типами, поэтому здесь необходимо использовать HashMap.

Параметры
elapsedTime	long : устройство сообщило о прошедшем времени в миллисекундах
runMetrics	HashMap : пары ключ-значение, отображаемые в конце выполнения теста с помощью Metric .

testRunFailed

public final void testRunFailed (FailureDescription failure)

Сообщается, что запуск тестового запуска не завершился из-за ошибки, описанной в FailureDescription .

Параметры
failure	FailureDescription : Описание ошибки и контекст её FailureDescription .

testRunFailed

public final void testRunFailed (String errorMessage)

Сообщается, что тестовый запуск не завершился из-за критической ошибки.

Параметры
errorMessage	String : String описывающая причину сбоя выполнения.

testRunStarted

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

Сообщает о начале тестового запуска.

Параметры
runName	String : название тестового запуска
testCount	int : общее количество тестов в тестовом запуске
attemptNumber	int : порядковый номер, идентифицирующий различные попытки выполнения одного и того же runName, которые выполняются несколько раз. attemptNumber имеет индексацию от 0 и должен увеличиваться каждый раз при новом запуске. Например, если тест повторяется 3 раза, то всего должно быть 4 запуска под одним и тем же runName, а attemptNumber принимает значения от 0 до 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Обратные вызовы при запуске тестов

Параметры
runName	String : название тестового запуска
testCount	int : общее количество тестов в тестовом запуске

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

Сообщает о начале тестового запуска.

Параметры
runName	String : название тестового запуска
testCount	int : общее количество тестов в тестовом запуске
attemptNumber	int : порядковый номер, идентифицирующий различные попытки выполнения одного и того же runName, которые выполняются несколько раз. attemptNumber имеет индексацию от 0 и должен увеличиваться каждый раз при новом запуске. Например, если тест повторяется 3 раза, то всего должно быть 4 запуска под одним и тем же runName, а attemptNumber принимает значения от 0 до 3.
startTime	long : время начала выполнения, измеренное с помощью System.currentTimeMillis()

testRunStopped

public final void testRunStopped (long elapsedTime)

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

TODO: в настоящее время не используется, рассмотрите возможность удаления.

Параметры
elapsedTime	long : устройство сообщило о прошедшем времени в миллисекундах

тест пропущен

public final void testSkipped (TestDescription test, 
                SkipReason reason)

Вызывается, когда тест пропущен и не выполнен по нетипичной причине. Будет предпринята попытка повторного выполнения таких тестов для обеспечения их корректного выполнения.

Параметры
test	TestDescription : идентифицирует тест
reason	SkipReason : SkipReason

тест начат

public final void testStarted (TestDescription test, 
                long startTime)

Альтернатива функции testStarted(TestDescription) , где мы также указываем время начала теста, в сочетании с testEnded(TestDescription,long,Map) для более точного измерения.

Параметры
test	TestDescription : идентифицирует тест
startTime	long : время начала теста, измеренное с помощью System.currentTimeMillis()

тест начат

public final void testStarted (TestDescription test)

Обратные вызовы тестовых случаев

Параметры
test	TestDescription : идентифицирует тест