IInvocationContext

public interface IInvocationContext
implements Serializable

com.android.tradefed.invoker.IInvocationContext


テストが必要に応じてアクセスする Invocation に関する情報を保持します。テストでは、ここに含まれるコンテキストを変更しないでください。そのため、レポート用のコンテキスト属性を除き、ゲッターのみが使用可能になります。

概要

定数

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)

呼び出しコンテキスト属性を単一の Key-Value ペアとして取得するための便利なメソッド。

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

スイートの一部として実行されているモジュールの呼び出しコンテキストを返します。

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)

コンテキストの一部であるすべてのデバイスの 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 を追加します。は、マップ内のビルド情報を 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, 
                List<String> serials)

テストを実行しているシャードのいずれかに割り当てられたものとして追跡されるシリアルを追加します。

パラメータ
index Integer: シリアルを使用するシャードのインデックス

serials List: トラッキングするシリアルのリスト。

getAttribute

public String getAttribute (String key)

呼び出しコンテキスト属性を単一の Key-Value ペアとして取得するための便利なメソッド。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<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 を照合できない場合は 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<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