Базедевицеметрикколлектор

public class BaseDeviceMetricCollector
extends Object implements IDeviceActionReceiver , IMetricCollector

java.lang.Объект
↳ com.android.tradefed.device.metric.BaseDeviceMetricCollector

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

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

Поля

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

public static final 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 , который запускает сборщик.

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_INCLUDE_GROUP_OPTION 

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

Общественные конструкторы

Базедевицеметрикколлектор 

public BaseDeviceMetricCollector ()

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

extraInit 

public void extraInit (IInvocationContext context, 
                ITestInvocationListener listener)

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

getBuildInfos 

public final  getBuildInfos ()

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

Возврат

ПолучитьУстройства 

public final  getDevices ()

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

Возврат

getFileFromTestArtifacts 

public File getFileFromTestArtifacts (String fileName)

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

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

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

getInvoctionListener 

public final ITestInvocationListener getInvocationListener ()

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

Возврат
ITestInvocationListener

getModuleName 

public String getModuleName ()

Возврат
String

GetRealDevices 

public final  getRealDevices ()

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

Возврат

getRunName 

public String getRunName ()

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

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

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

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, если весь объект отключен (пропускает как установку, так и демонтаж). В противном случае неверно.

Возврат
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

УстановитьОтключить 

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

тестПредположениеОтказ 

public final void testAssumptionFailure (TestDescription test, 
                String trace)

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

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

trace String : трассировка стека сбоя.

тестПредположениеОтказ 

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

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

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

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

testEnded 

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) выданных метрик

testEnded 

public final void testEnded (TestDescription test, 
                 testMetrics)

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

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

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

testMetrics : ERROR(/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 : идентифицирует тест.

журнал испытаний 

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

Предоставляет связанные данные журнала или отладки из тестового вызова.

Должен быть вызван перед ERROR(/ITestInvocationListener#invocationFailed(Throwable)) или ERROR(/ITestInvocationListener#invocationEnded(long))

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

Параметры
dataName String : String описательное имя данных. например, «device_logcat». Примечание. 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 не может быть уникальным для каждого вызова. т.е. разработчики должны иметь возможность обрабатывать несколько вызовов с одним и тем же именем данных.

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 : номер заказа, идентифицирующий различные попытки одного и того же имени запуска, которые выполняются несколько раз. Номер попытки имеет индекс 0 и должен увеличиваться каждый раз при новом запуске. например, тест гранулярно повторяется 3 раза, всего должно быть 4 запуска под одним и тем же именем запуска, а номер попытки — от 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 : номер заказа, идентифицирующий различные попытки одного и того же имени запуска, которые выполняются несколько раз. Номер попытки имеет индекс 0 и должен увеличиваться каждый раз при новом запуске. например, тест повторяется 3 раза, всего должно быть 4 запуска под одним и тем же именем запуска, а номер попытки — от 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 : идентифицирует тест.