BaseDeviceMetricCollector
public class BaseDeviceMetricCollector
extends Object
implements IMetricCollector , IDeviceActionReceiver
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 () Возвращает исходный |
String | getModuleName () |
final | getRealDevices () Возвращает все незаглушенные устройства из списка |
String | getRunName () Возвращает имя запуска теста |
final ITestInvocationListener | init ( IInvocationContext context, ITestInvocationListener listener) Инициализация сборщика с текущим контекстом и указанием, куда пересылать результаты. |
final void | invocationEnded (long elapsedTime) Сообщает, что вызов завершился успешно или из-за какой-либо ошибки. |
final void | invocationFailed ( FailureDescription failure) Сообщает о незавершенном вызове из-за некоторого состояния ошибки. |
final void | invocationFailed (Throwable cause) Сообщает о незавершенном вызове из-за некоторого состояния ошибки. |
final void | invocationStarted ( IInvocationContext context) Слушатели вызовов для пересылки |
final boolean | isDisabled () Возвращает True, если весь объект отключен (пропустить как настройку, так и демонтаж). |
boolean | isDisabledReceiver () Отключен ли |
final void | logAssociation (String dataName, LogFile logFile) Не используйте внутреннюю реализацию сборщика метрик. |
void | onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test) Обратный вызов при сбое тестового примера с ошибкой предположения. |
void | onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test) Обратный вызов, когда тестовый пример завершен. |
void | onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) Обратный вызов, когда тестовый пример завершен. |
void | onTestFail ( DeviceMetricData testData, TestDescription test) Обратный вызов при сбое тестового примера. |
void | onTestModuleEnded () Позволяет захватывать событие завершения работы модуля. |
void | onTestModuleStarted () Позволяет захватывать событие запуска модуля. |
void | onTestRunEnd ( DeviceMetricData runData, currentRunMetrics) 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) Устанавливает, следует ли отключить |
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) testEnded ( TestDescription test, long endTime, testMetrics) Альтернатива |
final void | testEnded ( TestDescription test, testMetrics) 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) testRunEnded (long elapsedTime, runMetrics) Сообщает об окончании тестового прогона. |
final void | testRunFailed ( FailureDescription failure) Не удалось выполнить тестовый запуск отчетов из-за сбоя, описанного в |
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 | testStarted ( TestDescription test, long startTime) Альтернатива |
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
Публичные конструкторы
BaseDeviceMetricCollector
public BaseDeviceMetricCollector ()
Публичные методы
экстраинит
public void extraInit (IInvocationContext context, ITestInvocationListener listener)
Броски | |
---|---|
| com.android.tradefed.device.DeviceNotAvailableException |
DeviceNotAvailableException |
getBuildInfos
public finalgetBuildInfos ()
Возвращает список сведений о сборке, доступных при вызове.
Возвращает | |
---|---|
getDevices
public finalgetDevices ()
Возвращает список устройств, доступных в вызове.
Возвращает | |
---|---|
getFileFromTestArtifacts
public File getFileFromTestArtifacts (String fileName)
Извлеките файл из тестовых артефактов или артефактов модуля и кэшируйте его на карте для последующих вызовов.
Параметры | |
---|---|
fileName | String : имя файла для поиска в артефактах. |
Возвращает | |
---|---|
File | Файл из артефакта теста или артефакта модуля. Возвращает ноль, если файл не найден. |
getInvocationListener
public final ITestInvocationListener getInvocationListener ()
Возвращает исходный ITestInvocationListener
, куда мы пересылаем результаты.
Возвращает | |
---|---|
ITestInvocationListener |
getModuleName
public String getModuleName ()
Возвращает | |
---|---|
String |
получитьRealDevices
public finalgetRealDevices ()
Возвращает все незаглушенные устройства из списка 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 : прошедшее время вызова в мс |
invocationFailed
public final void invocationFailed (FailureDescription failure)
Сообщает о незавершенном вызове из-за некоторого состояния ошибки.
Будет автоматически вызываться фреймворком TradeFederation.
Параметры | |
---|---|
failure | FailureDescription : FailureDescription , описывающий причину сбоя. |
invocationFailed
public final void invocationFailed (Throwable cause)
Сообщает о незавершенном вызове из-за некоторого состояния ошибки.
Будет автоматически вызываться фреймворком TradeFederation.Параметры | |
---|---|
cause | Throwable : Throwable причина сбоя |
вызов запущен
public final void invocationStarted (IInvocationContext context)
Слушатели вызовов для пересылки
Параметры | |
---|---|
context | IInvocationContext : информация о вызове |
выключен
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 , который был зарегистрирован ранее и должен быть связан с тестовым примером. |
onTestAssummentFailure
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 |
онтестмодулестартед
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 |
rebootEnded
public void rebootEnded (ITestDevice device)
Получает уведомление о завершении перезагрузки устройства.
ПРИМЕЧАНИЕ. Получателям следует избегать перезагрузки во время этого обратного вызова. Любая попытка перезагрузки будет проигнорирована.
Параметры | |
---|---|
device | ITestDevice : ITestDevice , на котором завершилась перезагрузка. |
Броски | |
---|---|
DeviceNotAvailableException |
rebootStarted
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 |
сетлогсавер
public final void setLogSaver (ILogSaver logSaver)
Не используйте внутреннюю реализацию сборщика метрик. Это чистая переадресация.
Параметры | |
---|---|
logSaver | ILogSaver : ILogSaver |
testAssummentFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Вызывается, когда атомарный тест отмечает, что он принимает условие, которое является ложным.
Параметры | |
---|---|
test | TestDescription : идентифицирует тест |
trace | String : трассировка стека сбоя |
testAssummentFailure
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) выдаваемых метрик |
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 : идентифицирует тест |
журнал испытаний
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 ()
Сообщает об окончании выполнения модуля.
тестмодулестартед
public final void testModuleStarted (IInvocationContext moduleContext)
Сообщает о начале работы модуля. Этот обратный вызов связан с testModuleEnded()
и является необязательным в последовательности. Он используется только во время запуска, в котором используются модули: бегуны на основе набора.
Параметры | |
---|---|
moduleContext | IInvocationContext : IInvocationContext модуля. |
testRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
Сообщает об окончании тестового прогона. ИСПРАВЛЕНИЕ: У нас не может быть двух интерфейсов Map<> с разными типами, поэтому здесь мы должны использовать HashMap.
Параметры | |
---|---|
elapsedTime | long : устройство сообщило о прошедшем времени в миллисекундах |
runMetrics | 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, которые выполняются несколько раз. ПопыткаNumber имеет индекс 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 : номер заказа, идентифицирующий различные попытки одного и того же runName, которые выполняются несколько раз. ПопыткаNumber имеет индекс 0 и должна увеличиваться каждый раз, когда происходит новый запуск. Например, тест гранулированно повторяется 3 раза, он должен иметь 4 полных запуска под одним и тем же именем запуска, а число попыток — от 0 до 3. |
startTime | long : время запуска, измеренное с помощью System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
Тестовый запуск отчетов остановлен до завершения по запросу пользователя.
TODO: в настоящее время не используется, рассмотрите возможность удаления
Параметры | |
---|---|
elapsedTime | long : устройство сообщило о прошедшем времени в миллисекундах |
testStarted
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() |
testStarted
public final void testStarted (TestDescription test)
Обратные вызовы тестовых случаев
Параметры | |
---|---|
test | TestDescription : идентифицирует тест |