调用上下文

public interface IInvocationContext

com.android.tradefed.invoker.IInspirationContext


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

概括

常数

String INVOCATION_ID

用于存储关联调用 ID 的密钥。

公共方法

abstract void addAllocatedDevice ( deviceWithName) 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)

添加调用属性。

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

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

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

添加调用计时指标。

abstract void addSerialsFromShard (Integer index, serials) 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 ()

返回设备/构建信息关联的地图

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 的密钥。

常量值:“调用 ID”

公共方法

添加分配的设备

public abstract void addAllocatedDevice ( deviceWithName)

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

参数
deviceWithName :要跟踪的附加设备的ERROR(/Map)

添加分配的设备

public abstract void addAllocatedDevice (String deviceName, 
                ITestDevice testDevice)

添加一个 ITestDevice,以便在分配设备时通过元数据进行跟踪。将在地图中将构建信息设置为 null。

参数
deviceName String :与ITestDevice关联的设备配置名称

testDevice ITestDevice :添加到分配的设备中。

添加设备构建信息

public abstract void addDeviceBuildInfo (String deviceName, 
                IBuildInfo buildinfo)

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

参数
deviceName String : 设备配置名称

buildinfo IBuildInfo :与设备配置名称关联的IBuildInfo

添加调用属性

public abstract void addInvocationAttribute (String attributeName, 
                String attributeValue)

添加调用属性。

参数
attributeName String

attributeValue String

添加调用属性

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

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

参数
attributesMap MultiMap

添加调用计时指标

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

添加调用计时指标。

参数
timingEvent IInvocationContext.TimingEvent

durationMillis Long

从分片添加序列号

public abstract void addSerialsFromShard (Integer index, 
                 serials)

添加要跟踪的序列号,分配给运行某些测试的分片之一。

参数
index Integer :使用序列号的分片索引

serials :要跟踪的连续剧列表。

获取属性

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 。如果 deviceName 无法匹配,则返回 null。

参数
deviceName String

退货
IBuildInfo

获取构建信息

public abstract IBuildInfo getBuildInfo (ITestDevice testDevice)

返回与ITestDevice关联的IBuildInfo

参数
testDevice ITestDevice

退货
IBuildInfo

获取构建信息名称

public abstract String getBuildInfoName (IBuildInfo info)

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

参数
info IBuildInfo

退货
String

获取构建信息

public abstract  getBuildInfos ()

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

退货

获取配置描述符

public abstract ConfigurationDescriptor getConfigurationDescriptor ()

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

退货
ConfigurationDescriptor

获取设备

public abstract ITestDevice getDevice (String deviceName)

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

参数
deviceName String

退货
ITestDevice

获取设备构建映射

public abstract  getDeviceBuildMap ()

返回设备/构建信息关联的地图

退货

通过序列号获取设备

public abstract ITestDevice getDeviceBySerial (String serial)

返回与所提供的序列号关联的ITestDevice 。不要使用太多,因为这不是最快的查找。

参数
serial String

退货
ITestDevice

获取设备配置名称

public abstract  getDeviceConfigNames ()

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

退货

获取设备名称

public abstract String getDeviceName (ITestDevice device)

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

参数
device ITestDevice

退货
String

获取设备

public abstract  getDevices ()

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

退货

获取调用ID

public abstract String getInvocationId ()

退货
String关联的调用 ID,如果未链接到调用则为null

获取调用计时指标

public  getInvocationTimingMetrics ()

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

退货

获取模块调用上下文

public abstract IInvocationContext getModuleInvocationContext ()

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

退货
IInvocationContext

获取分配的设备数量

public abstract int getNumDevicesAllocated ()

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

退货
int

获取连续出版物

public abstract  getSerials ()

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

退货

获取ShardsSerials

public abstract  getShardsSerials ()

返回所有跟踪的连续剧及其参与分片的分片的地图。如果不是分片调用则为空。

退货

获取测试标签

public abstract String getTestTag ()

返回调用测试标签。

退货
String

标记提前发布

public abstract void markReleasedEarly ()

标记这些设备正在提前发布。

设置配置描述符

public abstract void setConfigurationDescriptor (ConfigurationDescriptor configurationDescriptor)

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

参数
configurationDescriptor ConfigurationDescriptor

设置模块调用上下文

public abstract void setModuleInvocationContext (IInvocationContext invocationContext)

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

参数
invocationContext IInvocationContext

设置所有设备的恢复模式

public abstract void setRecoveryModeForAllDevices (ITestDevice.RecoveryMode mode)

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

参数
mode ITestDevice.RecoveryMode

设置测试标签

public abstract void setTestTag (String testTag)

设置调用测试标签。

参数
testTag String

原型

public abstract InvocationContext.Context toProto ()

将上下文实例序列化到 protobuf 中。

退货
InvocationContext.Context

提前发布

public abstract boolean wasReleasedEarly ()

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

退货
boolean