IInvocationContext

public interface IInvocationContext
implements Serializable

com.android.tradefed.invoker.IInvocationContext

已知的间接子类 InvocationContext InvocationContext IInvocationContext 的通用实现。

---

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

摘要

常量
String	INVOCATION_ID 用于存储关联的调用 ID 的键。

公共方法
abstract void	addAllocatedDevice(Map<String, ITestDevice> 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) 添加了调用属性。
abstract void	addInvocationAttributes(MultiMap<String, String> attributesMap) 通过 UniqueMultiMap 一次性添加多个调用属性。
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) 返回与所提供的设备配置名称关联的 IBuildInfo。
abstract IBuildInfo	getBuildInfo(ITestDevice testDevice) 返回与 ITestDevice 关联的 IBuildInfo
abstract String	getBuildInfoName(IBuildInfo info) 从 IBuildInfo 中的 XML 配置返回设备集的名称。
abstract List<IBuildInfo>	getBuildInfos() 返回此调用所跟踪的所有 IBuildInfo。
abstract ConfigurationDescriptor	getConfigurationDescriptor() 返回与启动调用的测试配置关联的描述符
abstract ITestDevice	getDevice(String deviceName) 返回与所提供的设备配置名称关联的 ITestDevice。
abstract Map<ITestDevice, IBuildInfo>	getDeviceBuildMap() 返回设备/build 信息关联的映射
abstract ITestDevice	getDeviceBySerial(String serial) 返回与所提供的序列号关联的 ITestDevice。
abstract List<String>	getDeviceConfigNames() 返回相应调用中跟踪的设备的设备配置名称列表
abstract String	getDeviceName(ITestDevice device) 返回 XML 配置中设备集的名称（来自 ITestDevice）。
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() 返回所有跟踪的序列及其在分片中涉及的分片的 Map。
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 (Map<String, ITestDevice> deviceWithName)

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

参数
deviceWithName	Map：要跟踪的其他设备的 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)

添加调用属性。

参数
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：要跟踪的序列号列表。

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 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 ()

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

返回
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)

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

参数
device	ITestDevice

返回
String

getDevices

public abstract List<ITestDevice> getDevices ()

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

返回
List<ITestDevice>

getInvocationId

public abstract String getInvocationId ()

返回
String	关联的调用 ID；如果未与调用相关联，则为 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。如果不是分片调用，则为空。

返回
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

wasReleasedEarly

public abstract boolean wasReleasedEarly ()

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

返回
boolean