IInvocationContext

public interface IInvocationContext

com.android.tradefed.invoker.IInvocationContext

包含有关调用的相关信息，以便测试在需要时进行访问。测试不应修改此处包含的上下文，因此除了用于生成报告的上下文属性之外，只有 getter 可用。

摘要

常量

String INVOCATION_ID

用于存储关联的调用 ID 的键。

公共方法

abstract void addAllocatedDevice( deviceWithName)

跟踪与 ITestDevice 关联的配置设备名称的映射。

abstract void addAllocatedDevice(String deviceName, ITestDevice testDevice)

添加一个 ITestDevice，以便在分配设备时由元数据跟踪。

abstract void addDeviceBuildInfo(String deviceName, IBuildInfo buildinfo)

添加要使用设备配置名称跟踪的 IBuildInfo。

abstract void addInvocationAttribute(String attributeName, String attributeValue)

添加 Invocation 属性。

abstract void addInvocationAttributes(MultiMap<String, String> attributesMap)

通过 UniqueMultiMap 一次添加多个调用属性。

default void addInvocationTimingMetric(IInvocationContext.TimingEvent timingEvent, Long durationMillis)

添加了调用时间指标。

abstract void addSerialsFromShard(Integer index, serials)

添加一个序列，以便跟踪分配给运行某些测试的分片之一。

default String getAttribute(String key)

一种便捷的方法，用于将调用上下文属性作为单个键值对检索出来。

abstract MultiMap<String, String> getAttributes()

返回包含所有调用属性的映射的副本。

abstract IBuildInfo getBuildInfo(String deviceName)

返回与所提供的设备配置名称关联的 IBuildInfo。

abstract IBuildInfo getBuildInfo(ITestDevice testDevice)

返回与 ITestDevice 关联的 IBuildInfo

abstract String getBuildInfoName(IBuildInfo info)

从 IBuildInfo 返回在 xml 配置中设置的设备名称。

abstract getBuildInfos()

返回为此调用跟踪的所有 IBuildInfo。

abstract ConfigurationDescriptor getConfigurationDescriptor()

返回与启动调用的测试配置相关联的描述符

abstract ITestDevice getDevice(String deviceName)

返回与所提供的设备配置名称关联的 ITestDevice。

abstract getDeviceBuildMap()

返回设备/build 信息关联的映射

abstract ITestDevice getDeviceBySerial(String serial)

返回与所提供的序列号关联的 ITestDevice。

abstract getDeviceConfigNames()

返回在此调用中跟踪的设备的设备配置名称列表

abstract String getDeviceName(ITestDevice device)

从 ITestDevice 返回在 xml 配置中设置的设备的名称。

abstract getDevices()

返回为此调用跟踪的所有已分配设备。

abstract String getInvocationId()
default getInvocationTimingMetrics()

返回包含调用时间指标的映射。

abstract IInvocationContext getModuleInvocationContext()

返回模块在作为套件一部分执行时的调用上下文。

abstract int getNumDevicesAllocated()

返回为调用分配的设备数量。

abstract getSerials()

返回在此调用中跟踪的设备的序列号列表

abstract getShardsSerials()

返回所有已跟踪的序列及其参与分片的分片的映射。

abstract String getTestTag()

返回调用测试标记。

abstract void markReleasedEarly()

标记即将发布的设备。

abstract void setConfigurationDescriptor(ConfigurationDescriptor configurationDescriptor)

设置与启动调用的测试配置关联的描述符

abstract void setModuleInvocationContext(IInvocationContext invocationContext)

在作为套件的一部分执行时，设置模块的调用上下文。

abstract void setRecoveryModeForAllDevices(ITestDevice.RecoveryMode mode)

设置上下文中所有设备的 RecoveryMode

abstract void setTestTag(String testTag)

设置调用测试标记。

abstract InvocationContext.Context toProto()

将上下文实例序列化为 protobuf。

abstract boolean wasReleasedEarly()

返回设备是否为提前发布且不会再使用。

常量

INVOCATION_ID

public static final String INVOCATION_ID

用于存储关联的调用 ID 的键。

常量值： "invocation-id"

公共方法

addAllocatedDevice

public abstract void addAllocatedDevice ( deviceWithName)

跟踪与 ITestDevice 关联的配置设备名称的映射。在添加之前不会清除之前的跟踪。

参数
deviceWithName ：要跟踪的其他设备的 ERROR(/Map)

addAllocatedDevice

public abstract void addAllocatedDevice (String deviceName, 
                ITestDevice testDevice)

添加一个 ITestDevice，以便在分配设备时由元数据跟踪。 将在映射中将 build 信息设置为 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)

添加 Invocation 属性。

参数
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, 
                 serials)

添加一个序列，以便跟踪分配给运行某些测试的分片之一。

参数
index Integer：使用序列号的分片的索引
serials ：要跟踪的连续剧列表。

getAttribute

public String getAttribute (String key)

一种便捷的方法，用于将调用上下文属性作为单个键值对检索出来。 切勿返回 null。

参数
key String

返回
String 如果键不存在，则为空字符串；否则，为值。

getAttributes

public abstract MultiMap<String, String> getAttributes ()

返回包含所有调用属性的映射的副本。

返回
MultiMap<String, String>

getBuildInfo

public abstract IBuildInfo getBuildInfo (String deviceName)

返回与所提供的设备配置名称关联的 IBuildInfo。如果无法匹配 deviceName，则返回 null。

参数
deviceName String

返回
IBuildInfo

getBuildInfo

public abstract IBuildInfo getBuildInfo (ITestDevice testDevice)

返回与 ITestDevice 关联的 IBuildInfo

参数
testDevice ITestDevice

返回
IBuildInfo

getBuildInfoName

public abstract String getBuildInfoName (IBuildInfo info)

从 IBuildInfo 返回在 xml 配置中设置的设备名称。如果无法匹配 IBuildInfo，则返回 null

参数
info IBuildInfo

返回
String

getBuildInfos

public abstract  getBuildInfos ()

返回为此调用跟踪的所有 IBuildInfo。

返回

getConfigurationDescriptor

public abstract ConfigurationDescriptor getConfigurationDescriptor ()

返回与启动调用的测试配置关联的描述符

返回
ConfigurationDescriptor

getDevice

public abstract ITestDevice getDevice (String deviceName)

返回与所提供的设备配置名称关联的 ITestDevice。

参数
deviceName String

返回
ITestDevice

getDeviceBuildMap

public abstract  getDeviceBuildMap ()

返回设备/build 信息关联的映射

返回

getDeviceBySerial

public abstract ITestDevice getDeviceBySerial (String serial)

返回与所提供的序列号关联的 ITestDevice。请勿过多使用此方法，因为它不是最快的查找方法。

参数
serial String

返回
ITestDevice

getDeviceConfigNames

public abstract  getDeviceConfigNames ()

返回在此调用中跟踪的设备的设备配置名称列表

返回

getDeviceName

public abstract String getDeviceName (ITestDevice device)

从 ITestDevice 返回在 xml 配置中设置的设备的名称。 如果无法匹配 ITestDevice，则返回 null。

参数
device ITestDevice

返回
String

getDevices

public abstract  getDevices ()

返回为此调用跟踪的所有已分配设备。

返回

getInvocationId

public abstract String getInvocationId ()

返回
String 关联的调用 ID；如果未与调用相关联，则返回 null

getInvocationTimingMetrics

public  getInvocationTimingMetrics ()

返回包含调用时间指标的映射。

返回

getModuleInvocationContext

public abstract IInvocationContext getModuleInvocationContext ()

返回模块在作为套件一部分执行时的调用上下文。

返回
IInvocationContext

getNumDevicesAllocated

public abstract int getNumDevicesAllocated ()

返回为调用分配的设备数量。

返回
int

getSerials

public abstract  getSerials ()

返回在此调用中跟踪的设备的序列号列表

返回

getShardsSerials

public abstract  getShardsSerials ()

返回所有跟踪的序列及其参与分片的分片的映射。如果不是分片调用，则为空。

返回

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

wasReleasedEarly

public abstract boolean wasReleasedEarly ()

返回设备是否为提前发布且不会再使用。

返回
boolean