IInvocationContext

public interface IInvocationContext
implements Serializable

com.android.tradefed.invoker.IInvocationContext


Enthält Informationen zum Aufruf, auf die die Tests bei Bedarf zugreifen können. Tests sollten den hier enthaltenen Kontext nicht ändern. Daher sind nur Getter verfügbar, mit Ausnahme der Kontextattribute für Berichterstellungszwecke.

Zusammenfassung

Konstanten

String INVOCATION_ID

Schlüssel zum Speichern der zugehörigen Aufruf-ID.

Öffentliche Methoden

abstract void addAllocatedDevice(Map<String, ITestDevice> deviceWithName)

Eine Zuordnung des Namens des Konfigurationsgeräts zu einem ITestDevice verfolgen.

abstract void addAllocatedDevice(String deviceName, ITestDevice testDevice)

Fügen Sie ein ITestDevice hinzu, das von den Metadaten verfolgt werden soll, wenn das Gerät zugewiesen wird.

abstract void addDeviceBuildInfo(String deviceName, IBuildInfo buildinfo)

Fügen Sie ein IBuildInfo hinzu, das mit dem Namen der Gerätekonfiguration erfasst werden soll.

abstract void addInvocationAttribute(String attributeName, String attributeValue)

Fügen Sie ein Aufrufattribut hinzu.

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

Über eine UniqueMultiMap können Sie mehrere Aufrufattribute gleichzeitig hinzufügen.

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

Fügen Sie einen Messwert für den Aufrufzeitpunkt hinzu.

abstract void addSerialsFromShard(Integer index, List<String> serials)

Fügen Sie eine Seriennummer hinzu, die als einem der Shards zugewiesen verfolgt werden soll, auf dem einige Tests ausgeführt werden.

default String getAttribute(String key)

Eine praktische Methode zum Abrufen des Attributs des Aufrufkontexts als einzelnes Schlüssel/Wert-Paar.

abstract MultiMap<String, String> getAttributes()

Gibt eine Kopie der Karte mit allen Aufrufattributen zurück.

abstract IBuildInfo getBuildInfo(String deviceName)

Gibt die IBuildInfo zurück, die mit dem angegebenen Namen der Gerätekonfiguration verknüpft ist.

abstract IBuildInfo getBuildInfo(ITestDevice testDevice)

Gibt den IBuildInfo zurück, der dem ITestDevice zugeordnet ist.

abstract String getBuildInfoName(IBuildInfo info)

Gibt den Namen der Gerätegruppe in der XML-Konfiguration aus IBuildInfo zurück.

abstract List<IBuildInfo> getBuildInfos()

Gibt alle IBuildInfo zurück, die für diesen Aufruf erfasst wurden.

abstract ConfigurationDescriptor getConfigurationDescriptor()

Gibt den Deskriptor zurück, der der Testkonfiguration zugeordnet ist, mit der der Aufruf gestartet wurde.

abstract ITestDevice getDevice(String deviceName)

Gibt die ITestDevice zurück, die mit dem angegebenen Namen der Gerätekonfiguration verknüpft ist.

abstract Map<ITestDeviceIBuildInfo> getDeviceBuildMap()

Gibt die Zuordnung von Geräte-/Build-Informationen zurück.

abstract ITestDevice getDeviceBySerial(String serial)

Gibt die ITestDevice zurück, die mit der angegebenen Seriennummer verknüpft ist.

abstract List<String> getDeviceConfigNames()

Gibt die Liste der Namen der Gerätekonfigurationen des in diesem Aufruf verfolgten Geräts zurück.

abstract String getDeviceName(ITestDevice device)

Gibt den Namen der Gerätegruppe in der XML-Konfiguration aus ITestDevice zurück.

abstract List<ITestDevice> getDevices()

Gibt alle zugewiesenen Geräte zurück, die für diesen Aufruf verfolgt werden.

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

Gibt die Karte mit den Messwerten für das Aufruf-Timing zurück.

abstract IInvocationContext getModuleInvocationContext()

Gibt den Aufrufkontext des Moduls zurück, während es als Teil einer Suite ausgeführt wird.

abstract int getNumDevicesAllocated()

Gibt die Anzahl der für den Aufruf zugewiesenen Geräte zurück.

abstract List<String> getSerials()

Gibt die Liste der Seriennummern des Geräts zurück, das bei diesem Aufruf erfasst wurde.

abstract Map<Integer, List<String>> getShardsSerials()

Gibt die Map aller verfolgten Seriennummern und des zugehörigen Shards zurück, der am Sharding beteiligt ist.

abstract String getTestTag()

Gibt das Test-Tag für den Aufruf zurück.

abstract void markReleasedEarly()

Markieren Sie die Geräte als vorzeitig freigegeben.

abstract void setConfigurationDescriptor(ConfigurationDescriptor configurationDescriptor)

Legt den Deskriptor fest, der der Testkonfiguration zugeordnet ist, mit der der Aufruf gestartet wurde.

abstract void setModuleInvocationContext(IInvocationContext invocationContext)

Legt den Aufrufkontext des Moduls fest, wenn es als Teil einer Suite ausgeführt wird.

abstract void setRecoveryModeForAllDevices(ITestDevice.RecoveryMode mode)

Legt die RecoveryMode aller Geräte fest, die Teil des Kontexts sind.

abstract void setTestTag(String testTag)

Legt das Aufruf-Test-Tag fest.

abstract InvocationContext.Context toProto()

Serialisiert die Kontextinstanz in einen Protokollpuffer.

abstract boolean wasReleasedEarly()

Gibt zurück, ob die Geräte vorzeitig freigegeben wurden und nicht mehr verwendet werden.

Konstanten

INVOCATION_ID

public static final String INVOCATION_ID

Schlüssel zum Speichern der zugehörigen Aufruf-ID.

Konstanter Wert: "invocation-id"

Öffentliche Methoden

addAllocatedDevice

public abstract void addAllocatedDevice (Map<String, ITestDevice> deviceWithName)

Eine Zuordnung des Namens des Konfigurationsgeräts zu einem ITestDevice verfolgen. Vor dem Hinzufügen wird das vorherige Tracking nicht gelöscht.

Parameter
deviceWithName Map: die Map des zusätzlichen Geräts, das getrackt werden soll

addAllocatedDevice

public abstract void addAllocatedDevice (String deviceName, 
                ITestDevice testDevice)

Fügen Sie ein ITestDevice hinzu, das von den Metadaten verfolgt werden soll, wenn das Gerät zugewiesen wird. Dadurch werden die Build-Informationen in der Karte auf „null“ gesetzt.

Parameter
deviceName String: Der Name der Gerätekonfiguration, die mit dem ITestDevice verknüpft werden soll.

testDevice ITestDevice: muss den zugewiesenen Geräten hinzugefügt werden.

addDeviceBuildInfo

public abstract void addDeviceBuildInfo (String deviceName, 
                IBuildInfo buildinfo)

Fügen Sie ein IBuildInfo hinzu, das mit dem Namen der Gerätekonfiguration erfasst werden soll.

Parameter
deviceName String: der Name der Gerätekonfiguration

buildinfo IBuildInfo: eine IBuildInfo, die dem Namen der Gerätekonfiguration zugeordnet ist.

addInvocationAttribute

public abstract void addInvocationAttribute (String attributeName, 
                String attributeValue)

Fügen Sie ein Aufrufattribut hinzu.

Parameter
attributeName String

attributeValue String

addInvocationAttributes

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

Über eine UniqueMultiMap können Sie mehrere Aufrufattribute gleichzeitig hinzufügen.

Parameter
attributesMap MultiMap

addInvocationTimingMetric

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

Fügen Sie einen Messwert für den Aufrufzeitpunkt hinzu.

Parameter
timingEvent IInvocationContext.TimingEvent

durationMillis Long

addSerialsFromShard

public abstract void addSerialsFromShard (Integer index, 
                List<String> serials)

Fügen Sie eine Seriennummer hinzu, die als einem der Shards zugewiesen verfolgt werden soll, auf dem einige Tests ausgeführt werden.

Parameter
index Integer: Der Index des Shards, der die Seriennummern verwendet.

serials List: Die Liste der zu verfolgenden Seriennummern.

getAttribute

public String getAttribute (String key)

Eine praktische Methode zum Abrufen des Attributs des Aufrufkontexts als einzelnes Schlüssel/Wert-Paar. Gibt niemals „null“ zurück.

Parameter
key String

Gibt Folgendes zurück:
String Ein leerer String, wenn der Schlüssel nicht vorhanden ist, andernfalls der Wert.

getAttributes

public abstract MultiMap<String, String> getAttributes ()

Gibt eine Kopie der Karte mit allen Aufrufattributen zurück.

Gibt Folgendes zurück:
MultiMap<String, String>

getBuildInfo

public abstract IBuildInfo getBuildInfo (String deviceName)

Gibt die IBuildInfo zurück, die mit dem angegebenen Namen der Gerätekonfiguration verknüpft ist. Gibt „null“ zurück, wenn der deviceName nicht gefunden werden kann.

Parameter
deviceName String

Gibt Folgendes zurück:
IBuildInfo

getBuildInfo

public abstract IBuildInfo getBuildInfo (ITestDevice testDevice)

Gibt den IBuildInfo zurück, der dem ITestDevice zugeordnet ist.

Parameter
testDevice ITestDevice

Gibt Folgendes zurück:
IBuildInfo

getBuildInfoName

public abstract String getBuildInfoName (IBuildInfo info)

Gibt den Namen der Gerätegruppe in der XML-Konfiguration aus IBuildInfo zurück. Gibt „null“ zurück, wenn keine Übereinstimmung für „IBuildInfo“ gefunden werden kann.

Parameter
info IBuildInfo

Gibt Folgendes zurück:
String

getBuildInfos

public abstract List<IBuildInfo> getBuildInfos ()

Gibt alle IBuildInfo zurück, die für diesen Aufruf erfasst wurden.

Gibt Folgendes zurück:
List<IBuildInfo>

getConfigurationDescriptor

public abstract ConfigurationDescriptor getConfigurationDescriptor ()

Gibt den Deskriptor zurück, der der Testkonfiguration zugeordnet ist, mit der der Aufruf gestartet wurde.

Gibt Folgendes zurück:
ConfigurationDescriptor

getDevice

public abstract ITestDevice getDevice (String deviceName)

Gibt die ITestDevice zurück, die mit dem angegebenen Namen der Gerätekonfiguration verknüpft ist.

Parameter
deviceName String

Gibt Folgendes zurück:
ITestDevice

getDeviceBuildMap

public abstract Map<ITestDeviceIBuildInfo> getDeviceBuildMap ()

Gibt die Zuordnung von Geräte-/Build-Informationen zurück.

Gibt Folgendes zurück:
Map<ITestDeviceIBuildInfo>

getDeviceBySerial

public abstract ITestDevice getDeviceBySerial (String serial)

Gibt die ITestDevice zurück, die mit der angegebenen Seriennummer verknüpft ist. Verwenden Sie nicht zu viele, da es sich nicht um die schnellste Suche handelt.

Parameter
serial String

Gibt Folgendes zurück:
ITestDevice

getDeviceConfigNames

public abstract List<String> getDeviceConfigNames ()

Gibt die Liste der Namen der Gerätekonfigurationen des in diesem Aufruf verfolgten Geräts zurück.

Gibt Folgendes zurück:
List<String>

getDeviceName

public abstract String getDeviceName (ITestDevice device)

Gibt den Namen der Gerätegruppe in der XML-Konfiguration aus ITestDevice zurück. Gibt „null“ zurück, wenn „ITestDevice“ nicht zugeordnet werden kann.

Parameter
device ITestDevice

Gibt Folgendes zurück:
String

getDevices

public abstract List<ITestDevice> getDevices ()

Gibt alle zugewiesenen Geräte zurück, die für diesen Aufruf verfolgt werden.

Gibt Folgendes zurück:
List<ITestDevice>

getInvocationId

public abstract String getInvocationId ()

Gibt Folgendes zurück:
String Zugehörige Aufruf-ID oder null, falls nicht mit einem Aufruf verknüpft

getInvocationTimingMetrics

public Map<IInvocationContext.TimingEvent, Long> getInvocationTimingMetrics ()

Gibt die Karte mit den Messwerten für das Aufruf-Timing zurück.

Gibt Folgendes zurück:
Map<IInvocationContext.TimingEvent, Long>

getModuleInvocationContext

public abstract IInvocationContext getModuleInvocationContext ()

Gibt den Aufrufkontext des Moduls zurück, während es als Teil einer Suite ausgeführt wird.

Gibt Folgendes zurück:
IInvocationContext

getNumDevicesAllocated

public abstract int getNumDevicesAllocated ()

Gibt die Anzahl der für den Aufruf zugewiesenen Geräte zurück.

Gibt Folgendes zurück:
int

getSerials

public abstract List<String> getSerials ()

Gibt die Liste der Seriennummern des Geräts zurück, das bei diesem Aufruf erfasst wurde.

Gibt Folgendes zurück:
List<String>

getShardsSerials

public abstract Map<Integer, List<String>> getShardsSerials ()

Gibt die Map aller verfolgten Seriennummern und des zugehörigen Shards zurück, der am Sharding beteiligt ist. Leer, wenn es sich nicht um einen Shard-Aufruf handelt.

Gibt Folgendes zurück:
Map<Integer, List<String>>

getTestTag

public abstract String getTestTag ()

Gibt das Test-Tag für den Aufruf zurück.

Gibt Folgendes zurück:
String

markReleasedEarly

public abstract void markReleasedEarly ()

Markieren Sie die Geräte als vorzeitig freigegeben.

setConfigurationDescriptor

public abstract void setConfigurationDescriptor (ConfigurationDescriptor configurationDescriptor)

Legt den Deskriptor fest, der der Testkonfiguration zugeordnet ist, mit der der Aufruf gestartet wurde.

Parameter
configurationDescriptor ConfigurationDescriptor

setModuleInvocationContext

public abstract void setModuleInvocationContext (IInvocationContext invocationContext)

Legt den Aufrufkontext des Moduls fest, wenn es als Teil einer Suite ausgeführt wird.

Parameter
invocationContext IInvocationContext

setRecoveryModeForAllDevices

public abstract void setRecoveryModeForAllDevices (ITestDevice.RecoveryMode mode)

Legt die RecoveryMode aller Geräte fest, die Teil des Kontexts sind.

Parameter
mode ITestDevice.RecoveryMode

setTestTag

public abstract void setTestTag (String testTag)

Legt das Aufruf-Test-Tag fest.

Parameter
testTag String

toProto

public abstract InvocationContext.Context toProto ()

Serialisiert die Kontextinstanz in einen Protokollpuffer.

Gibt Folgendes zurück:
InvocationContext.Context

wasReleasedEarly

public abstract boolean wasReleasedEarly ()

Gibt zurück, ob die Geräte vorzeitig freigegeben wurden und nicht mehr verwendet werden.

Gibt Folgendes zurück:
boolean