BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IDeviceActionReceiver , IMetricCollector

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

Базовая реализация IMetricCollector , которая позволяет запускать и останавливать сбор данных при onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) и ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map)) .

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

Константы

String TEST_CASE_EXCLUDE_GROUP_OPTION

String TEST_CASE_INCLUDE_GROUP_OPTION

Публичные конструкторы

BaseDeviceMetricCollector ()

Публичные методы

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

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

final getDevices ()

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

File getFileFromTestArtifacts (String fileName)

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

final ITestInvocationListener getInvocationListener ()

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

String getModuleName ()
final 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)

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

final boolean isDisabled ()

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

boolean isDisabledReceiver ()

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

final void logAssociation (String dataName, LogFile logFile)

Не используйте внутреннюю реализацию сборщика метрик.

void onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test)

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

void onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)

Обратный вызов по завершении тестового случая.

void onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics)

Обратный вызов по завершении тестового случая.

void onTestFail ( DeviceMetricData testData, TestDescription test)

Обратный вызов в случае сбоя тестового случая.

void onTestModuleEnded ()

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

void onTestModuleStarted ()

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

void onTestRunEnd ( DeviceMetricData runData, currentRunMetrics)

Обратный вызов по завершении тестового прогона.

void onTestRunFailed ( DeviceMetricData testData, FailureDescription failure)

Обратный вызов для событий testRunFailed

void onTestRunStart ( DeviceMetricData runData)

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

void onTestStart ( DeviceMetricData testData)

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

void rebootEnded ( ITestDevice device)

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

void rebootStarted ( ITestDevice device)

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

final void setDisable (boolean isDisabled)

Устанавливает, следует ли отключать объект.

void setDisableReceiver (boolean isDisabled)

Устанавливает, следует ли отключать IDeviceActionReceiver .

final void setLogSaver ( ILogSaver logSaver)

Не используйте внутреннюю реализацию сборщика метрик.

final void testAssumptionFailure ( TestDescription test, String trace)

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

final void testAssumptionFailure ( TestDescription test, FailureDescription failure)

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

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

Альтернатива ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) где мы можем напрямую указать время окончания.

final void testEnded ( TestDescription test, 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, 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(com.android.tradefed.result.TestDescription) , где мы также указываем, когда был запущен тест, в сочетании с ERROR(/#testEnded(com.android.tradefed.result.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 ()

Публичные методы

extraInit 

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

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

получитьBuildInfos 

public final  getBuildInfos ()

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

Возврат

получитьДевайсы 

public final  getDevices ()

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

Возврат

получитьФайлИзТестАртефакты 

public File getFileFromTestArtifacts (String fileName)

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

Параметры
fileName String : имя файла для поиска в артефактах.

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

getInvocationListener 

public final ITestInvocationListener getInvocationListener ()

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

Возврат
ITestInvocationListener

getModuleName 

public String getModuleName ()

Возврат
String

получитьRealDevices 

public final  getRealDevices ()

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

Возврат

getRunName 

public String getRunName ()

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

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

getTestName 

public String getTestName ()

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

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

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

public final ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

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

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

Параметры
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 : информация о вызове

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, 
                 currentTestCaseMetrics, 
                TestDescription test)

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

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

currentTestCaseMetrics : текущая карта метрик, переданная в ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) .

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

Броски
DeviceNotAvailableException

onTestEnd 

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

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

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

currentTestCaseMetrics : текущая карта метрик, переданная в ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) .

Броски
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, 
                 currentRunMetrics)

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

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

currentRunMetrics : текущая карта метрик, переданная в ERROR(/#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

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

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, 
                 testMetrics)

Альтернатива ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) , где можно напрямую указать время окончания. Для точного измерения используйте testStarted(com.android.tradefed.result.TestDescription, long) .

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

endTime long : время окончания теста, измеренное с помощью System.currentTimeMillis()

testMetrics : ERROR(/Map) выданных метрик

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

public final void testEnded (TestDescription test, 
                 testMetrics)

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

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

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

testMetrics : ERROR(/Map) выданных метрик

testFailed 

public final void testFailed (TestDescription test, 
                FailureDescription failure)

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

Будет вызван между testStarted и testEnded.

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

failure FailureDescription : FailureDescription , описывающее сбой и его контекст.

testFailed 

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)) или 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, 
                 runMetrics)

Сообщается об окончании тестового прогона.

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

runMetrics : пары «ключ-значение», сообщаемые в конце тестового прогона

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, выполняемые несколько раз. Попытка (temptNumber) имеет индекс 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, выполняемые несколько раз. Попытка (temptNumber) имеет индекс 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(com.android.tradefed.result.TestDescription) , где мы также указываем, когда был запущен тест, в сочетании с ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) для точного измерения.

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

startTime long : время начала теста, измеренное с помощью System.currentTimeMillis()

тест начат 

public final void testStarted (TestDescription test)

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

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