IInvocationContext

public interface IInvocationContext
implements Serializable

com.android.tradefed.invoker.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)

新增 Invocation 屬性。

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

傳回裝置/建構資訊關聯的地圖

abstract ITestDevice getDeviceBySerial(String serial)

傳回與所提供序號相關聯的 ITestDevice

abstract List<String> getDeviceConfigNames()

傳回在此叫用中追蹤的裝置設定名稱清單

abstract String getDeviceName(ITestDevice device)

ITestDevice 的 xml 設定中傳回裝置群組名稱。

abstract List<ITestDevice> getDevices()

傳回此呼叫所追蹤的所有已分配裝置。

abstract String getInvocationId()
default Map<IInvocationContext.TimingEvent, Long> getInvocationTimingMetrics()

傳回包含叫用時間指標的地圖。

abstract IInvocationContext getModuleInvocationContext()

Returns the invocation context of module while being executed as part of a suite.

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)

Sets the invocation context of module while being executed as part of a suite.

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,以便在分配裝置時追蹤中繼資料。 會將地圖中的建構資訊設為空值。

參數
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, 
                List<String> serials)

新增要追蹤的序號,並指派給執行部分測試的其中一個分片。

參數
index Integer:使用序號的分片索引

serials List:要追蹤的序號清單。

getAttribute

public String getAttribute (String key)

這個便利的方法可做為單一鍵/值組合,擷取叫用內容屬性。 請勿傳回空值。

參數
key String

傳回
String 如果鍵不存在,則為空字串,否則為值。

getAttributes

public abstract MultiMap<String, String> getAttributes ()

傳回包含所有叫用屬性的對應副本。

傳回
MultiMap<String, String>

getBuildInfo

public abstract IBuildInfo getBuildInfo (String deviceName)

傳回與所提供裝置設定名稱相關聯的 IBuildInfo。如果無法比對 deviceName,則傳回空值。

參數
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 無法比對,則傳回空值

參數
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<ITestDeviceIBuildInfo> getDeviceBuildMap ()

傳回裝置/建構資訊關聯的地圖

傳回
Map<ITestDeviceIBuildInfo>

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,則傳回空值。

參數
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<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)

Sets the invocation context of module while being executed as part of a suite.

參數
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