IInvocationContext
public interface IInvocationContext
implements Serializable
| com.android.tradefed.invoker.IInvocationContext |
Содержит информацию о вызове, необходимую для доступа тестов. Тесты не должны изменять содержащийся здесь контекст, поэтому будут доступны только геттеры, за исключением атрибутов контекста для целей отчетности.
Краткое содержание
Константы | |
|---|---|
String | INVOCATION_IDКлюч используется для хранения связанного идентификатора вызова. |
Общедоступные методы | |
|---|---|
abstract void | addAllocatedDevice (Map<String, ITestDevice > deviceWithName) Отслеживание карты имен конфигурационных устройств, связанных с |
abstract void | addAllocatedDevice (String deviceName, ITestDevice testDevice)Добавьте объект ITestDevice, который будет отслеживаться с помощью метаданных при выделении устройства. |
abstract void | addDeviceBuildInfo (String deviceName, IBuildInfo buildinfo) Добавьте объект |
abstract void | addInvocationAttribute (String attributeName, String attributeValue)Добавьте атрибут «Вызов». |
abstract void | addInvocationAttributes ( MultiMap <String, String> attributesMap) Добавьте сразу несколько атрибутов вызова с помощью |
default void | addInvocationTimingMetric ( IInvocationContext.TimingEvent timingEvent, Long durationMillis)Добавить метрику времени выполнения вызова. |
abstract void | addSerialsFromShard (Integer index, List<String> serials)Добавьте отслеживаемый серийный номер, назначенный одному из сегментов, на которых выполняются тесты. |
default String | getAttribute (String key)Удобный способ получения атрибута контекста вызова в виде единой пары ключ-значение. |
abstract MultiMap <String, String> | getAttributes ()Возвращает копию карты, содержащую все атрибуты вызова. |
abstract IBuildInfo | getBuildInfo (String deviceName) Возвращает объект |
abstract IBuildInfo | getBuildInfo ( ITestDevice testDevice) Возвращает объект |
abstract String | getBuildInfoName ( IBuildInfo info) Возвращает имя устройства, заданное в XML-конфигурации из объекта |
abstract List< IBuildInfo > | getBuildInfos () Возвращает все объекты |
abstract ConfigurationDescriptor | getConfigurationDescriptor ()Возвращает дескриптор, связанный с конфигурацией теста, которая запустила выполнение запроса. |
abstract ITestDevice | getDevice (String deviceName) Возвращает объект |
abstract Map< ITestDevice , IBuildInfo > | getDeviceBuildMap ()Возвращает карту ассоциаций информации об устройстве/сборке. |
abstract ITestDevice | getDeviceBySerial (String serial) Возвращает объект |
abstract List<String> | getDeviceConfigNames ()Возвращает список имен конфигурационных файлов устройства, отслеживаемого в этом вызове. |
abstract String | getDeviceName ( ITestDevice device) Возвращает имя устройства, заданное в XML-конфигурации объекта |
abstract List< ITestDevice > | getDevices ()Возвращает все выделенные устройства, отслеживаемые для этого вызова. |
abstract String | getInvocationId () |
default Map< IInvocationContext.TimingEvent , Long> | getInvocationTimingMetrics ()Возвращает карту, содержащую метрики времени выполнения. |
abstract IInvocationContext | getModuleInvocationContext ()Возвращает контекст вызова модуля во время его выполнения в рамках тестового набора. |
abstract int | getNumDevicesAllocated ()Возвращает количество устройств, выделенных для вызова. |
abstract List<String> | getSerials ()Возвращает список серийных номеров устройства, отслеживаемого в этом вызове. |
abstract Map<Integer, List<String>> | getShardsSerials ()Возвращает карту всех отслеживаемых серийных номеров и их сегментов, участвующих в сегментировании. |
abstract String | getTestTag ()Возвращает тег теста вызова. |
abstract void | markReleasedEarly ()Обратите внимание, что устройства поступают в продажу раньше запланированного срока. |
abstract void | setConfigurationDescriptor ( ConfigurationDescriptor configurationDescriptor)Задает дескриптор, связанный с конфигурацией теста, которая запустила выполнение. |
abstract void | setModuleInvocationContext ( IInvocationContext invocationContext)Устанавливает контекст вызова модуля при его выполнении в рамках тестового набора. |
abstract void | setRecoveryModeForAllDevices ( ITestDevice.RecoveryMode mode) Устанавливает режим |
abstract void | setTestTag (String testTag)Устанавливает тег теста при вызове. |
abstract InvocationContext.Context | toProto ()Сериализуйте экземпляр контекста в protobuf. |
abstract boolean | wasReleasedEarly ()Возвращает значение, указывающее, были ли устройства выпущены досрочно и больше не будут использоваться. |
Константы
Идентификатор_вызова
public static final String INVOCATION_ID
Ключ используется для хранения связанного идентификатора вызова.
Постоянное значение: "идентификатор вызова"
Общедоступные методы
addAllocatedDevice
public abstract void addAllocatedDevice (Map<String, ITestDevice> deviceWithName)
Отслеживает карту имен конфигурационных устройств, связанных с ITestDevice . Предыдущее отслеживание не удаляется перед добавлением.
| Параметры | |
|---|---|
deviceWithName | Map : Map дополнительного устройства для отслеживания. |
addAllocatedDevice
public abstract void addAllocatedDevice (String deviceName,
ITestDevice testDevice)Добавьте объект ITestDevice для отслеживания с помощью метаданных при выделении устройства. Это установит информацию о сборке в значение null в карте.
| Параметры | |
|---|---|
deviceName | String : имя конфигурации устройства, которое будет связано с ITestDevice |
testDevice | ITestDevice : будет добавлен к выделенным устройствам. |
addDeviceBuildInfo
public abstract void addDeviceBuildInfo (String deviceName,
IBuildInfo buildinfo) Добавьте объект IBuildInfo для отслеживания, указав в нем имя конфигурации устройства.
| Параметры | |
|---|---|
deviceName | String : имя конфигурации устройства |
buildinfo | IBuildInfo : объект IBuildInfo связанный с именем конфигурации устройства. |
addInvocationAttribute
public abstract void addInvocationAttribute (String attributeName,
String attributeValue)Добавьте атрибут «Вызов».
| Параметры | |
|---|---|
attributeName | String |
attributeValue | String |
addInvocationAttributes
public abstract void addInvocationAttributes (MultiMap<String, String> attributesMap)
Добавьте сразу несколько атрибутов вызова с помощью UniqueMultiMap .
| Параметры | |
|---|---|
attributesMap | MultiMap |
addInvocationTimingMetric
public void addInvocationTimingMetric (IInvocationContext.TimingEvent timingEvent, Long durationMillis)
Добавить метрику времени выполнения вызова.
| Параметры | |
|---|---|
timingEvent | IInvocationContext.TimingEvent |
durationMillis | Long |
addSerialsFromShard
public abstract void addSerialsFromShard (Integer index,
List<String> serials)Добавьте отслеживаемый серийный номер, назначенный одному из сегментов, на которых выполняются тесты.
| Параметры | |
|---|---|
index | Integer : индекс сегмента с использованием серийных номеров. |
serials | List : перечень серийных номеров, подлежащих отслеживанию. |
получить атрибут
public String getAttribute (String key)
Удобный метод для получения атрибута контекста вызова в виде единой пары ключ-значение. Никогда не возвращает null.
| Параметры | |
|---|---|
key | String |
| Возвраты | |
|---|---|
String | Если ключ не существует, то пустая строка, в противном случае — значение. |
получить атрибуты
public abstract MultiMap<String, String> getAttributes ()
Возвращает копию карты, содержащую все атрибуты вызова.
| Возвраты | |
|---|---|
MultiMap <String, String> | |
получить информацию о сборке
public abstract IBuildInfo getBuildInfo (String deviceName)
Возвращает объект IBuildInfo связанный с указанным именем конфигурации устройства. Возвращает null, если имя устройства не удается сопоставить.
| Параметры | |
|---|---|
deviceName | String |
| Возвраты | |
|---|---|
IBuildInfo | |
получить информацию о сборке
public abstract IBuildInfo getBuildInfo (ITestDevice testDevice)
Возвращает объект IBuildInfo связанный с ITestDevice
| Параметры | |
|---|---|
testDevice | ITestDevice |
| Возвраты | |
|---|---|
IBuildInfo | |
getBuildInfoName
public abstract String getBuildInfoName (IBuildInfo info)
Возвращает имя устройства, заданное в XML-конфигурации из объекта IBuildInfo . Возвращает null, если объект IBuildInfo не может быть сопоставлен.
| Параметры | |
|---|---|
info | IBuildInfo |
| Возвраты | |
|---|---|
String | |
получить информацию о сборке
public abstract List<IBuildInfo> getBuildInfos ()
Возвращает все объекты IBuildInfo , отслеживаемые для этого вызова.
| Возвраты | |
|---|---|
List< IBuildInfo > | |
getConfigurationDescriptor
public abstract ConfigurationDescriptor getConfigurationDescriptor ()
Возвращает дескриптор, связанный с конфигурацией теста, которая запустила выполнение запроса.
| Возвраты | |
|---|---|
ConfigurationDescriptor | |
getDevice
public abstract ITestDevice getDevice (String deviceName)
Возвращает объект ITestDevice , связанный с указанным именем конфигурации устройства.
| Параметры | |
|---|---|
deviceName | String |
| Возвраты | |
|---|---|
ITestDevice | |
getDeviceBuildMap
public abstract Map<ITestDevice, IBuildInfo> getDeviceBuildMap ()
Возвращает карту ассоциаций информации об устройстве/сборке.
| Возвраты | |
|---|---|
Map< ITestDevice , IBuildInfo > | |
getDeviceBySerial
public abstract ITestDevice getDeviceBySerial (String serial)
Возвращает ITestDevice связанный с предоставленным серийным номером. Не следует использовать слишком много таких объектов, поскольку это не самый быстрый способ поиска.
| Параметры | |
|---|---|
serial | String |
| Возвраты | |
|---|---|
ITestDevice | |
getDeviceConfigNames
public abstract List<String> getDeviceConfigNames ()
Возвращает список имен конфигурационных файлов устройства, отслеживаемого в этом вызове.
| Возвраты | |
|---|---|
List<String> | |
getDeviceName
public abstract String getDeviceName (ITestDevice device)
Возвращает имя устройства, заданное в XML-конфигурации объекта ITestDevice . Возвращает null, если объект ITestDevice не найден.
| Параметры | |
|---|---|
device | ITestDevice |
| Возвраты | |
|---|---|
String | |
getDevices
public abstract List<ITestDevice> getDevices ()
Возвращает все выделенные устройства, отслеживаемые для этого вызова.
| Возвраты | |
|---|---|
List< ITestDevice > | |
getInvocationId
public abstract String getInvocationId ()
| Возвраты | |
|---|---|
String | связанный идентификатор вызова или null , если не связан с вызовом |
getInvocationTimingMetrics
public Map<IInvocationContext.TimingEvent, Long> getInvocationTimingMetrics ()
Возвращает карту, содержащую метрики времени выполнения.
| Возвраты | |
|---|---|
Map< IInvocationContext.TimingEvent , Long> | |
getModuleInvocationContext
public abstract IInvocationContext getModuleInvocationContext ()
Возвращает контекст вызова модуля во время его выполнения в рамках тестового набора.
| Возвраты | |
|---|---|
IInvocationContext | |
getNumDevicesAllocated
public abstract int getNumDevicesAllocated ()
Возвращает количество устройств, выделенных для вызова.
| Возвраты | |
|---|---|
int | |
getSerials
public abstract List<String> getSerials ()
Возвращает список серийных номеров устройства, отслеживаемого в этом вызове.
| Возвраты | |
|---|---|
List<String> | |
getShardsSerials
public abstract Map<Integer, List<String>> getShardsSerials ()
Возвращает карту всех отслеживаемых серийных номеров и их сегментов, участвующих в сегментировании. Пусто, если вызов не сегментирован.
| Возвраты | |
|---|---|
Map<Integer, List<String>> | |
getTestTag
public abstract String getTestTag ()
Возвращает тег теста вызова.
| Возвраты | |
|---|---|
String | |
markReleasedEarly
public abstract void markReleasedEarly ()
Обратите внимание, что устройства поступают в продажу раньше запланированного срока.
setConfigurationDescriptor
public abstract void setConfigurationDescriptor (ConfigurationDescriptor configurationDescriptor)
Задает дескриптор, связанный с конфигурацией теста, которая запустила выполнение.
| Параметры | |
|---|---|
configurationDescriptor | ConfigurationDescriptor |
setModuleInvocationContext
public abstract void setModuleInvocationContext (IInvocationContext invocationContext)
Устанавливает контекст вызова модуля при его выполнении в рамках тестового набора.
| Параметры | |
|---|---|
invocationContext | IInvocationContext |
setRecoveryModeForAllDevices
public abstract void setRecoveryModeForAllDevices (ITestDevice.RecoveryMode mode)
Устанавливает режим RecoveryMode для всех устройств, входящих в контекст.
| Параметры | |
|---|---|
mode | ITestDevice.RecoveryMode |
setTestTag
public abstract void setTestTag (String testTag)
Устанавливает тег теста при вызове.
| Параметры | |
|---|---|
testTag | String |
toProto
public abstract InvocationContext.Context toProto ()
Сериализуйте экземпляр контекста в protobuf.
| Возвраты | |
|---|---|
InvocationContext.Context | |
был выпущен раньше
public abstract boolean wasReleasedEarly ()
Возвращает значение, указывающее, были ли устройства выпущены досрочно и больше не будут использоваться.
| Возвраты | |
|---|---|
boolean | |