IInvocationContext
public interface IInvocationContext
com.android.tradefed.invoker.IInvocationContext |
Enthält Informationen über den Aufruf, auf die die Tests bei Bedarf zugreifen können. Tests sollten den hier enthaltenen Kontext nicht ändern, sodass nur Getter verfügbar sind, mit Ausnahme der Kontextattribute für Berichtszwecke.
Zusammenfassung
Konstanten | |
---|---|
String | INVOCATION_ID Schlüssel zum Speichern der zugeordneten Aufruf-ID. |
Öffentliche Methoden | |
---|---|
abstract void | addAllocatedDevice ( deviceWithName) addAllocatedDevice ( deviceWithName) Verfolgen Sie eine Zuordnung des Konfigurationsgerätenamens, der einem |
abstract void | addAllocatedDevice (String deviceName, ITestDevice testDevice) Fügen Sie ein ITestDevice hinzu, das von den Metadaten nachverfolgt werden soll, wenn das Gerät zugewiesen wird. |
abstract void | addDeviceBuildInfo (String deviceName, IBuildInfo buildinfo) Fügen Sie eine |
abstract void | addInvocationAttribute (String attributeName, String attributeValue) Fügen Sie ein Aufrufattribut hinzu. |
abstract void | addInvocationAttributes ( MultiMap <String, String> attributesMap) Fügen Sie mehrere Aufrufattribute gleichzeitig über eine |
default void | addInvocationTimingMetric ( IInvocationContext.TimingEvent timingEvent, Long durationMillis) Fügen Sie eine Aufruf-Timing-Metrik hinzu. |
abstract void | addSerialsFromShard (Integer index, serials) addSerialsFromShard (Integer index, serials) Fügen Sie eine zu verfolgende Seriennummer hinzu, die einem der Shards zugewiesen ist, auf denen einige Tests ausgeführt werden. |
default String | getAttribute (String key) Eine bequeme Methode zum Abrufen des Aufrufkontextattributs als einzelnes Schlüssel-Wert-Paar. |
abstract MultiMap <String, String> | getAttributes () Gibt eine Kopie der Zuordnung zurück, die alle Aufrufattribute enthält. |
abstract IBuildInfo | getBuildInfo (String deviceName) Gibt die |
abstract IBuildInfo | getBuildInfo ( ITestDevice testDevice) Gibt die dem |
abstract String | getBuildInfoName ( IBuildInfo info) Gibt den Namen des Geräts zurück, das in der XML-Konfiguration aus der |
abstract | getBuildInfos () Gibt alle für diesen Aufruf verfolgten |
abstract ConfigurationDescriptor | getConfigurationDescriptor () Gibt den Deskriptor zurück, der der Testkonfiguration zugeordnet ist, die den Aufruf gestartet hat |
abstract ITestDevice | getDevice (String deviceName) Gibt das |
abstract | getDeviceBuildMap () Gibt die Karte der Geräte-/Build-Info-Zuordnung zurück |
abstract ITestDevice | getDeviceBySerial (String serial) Gibt das |
abstract | getDeviceConfigNames () Gibt die Liste der Gerätekonfigurationsnamen des in diesem Aufruf verfolgten Geräts zurück |
abstract String | getDeviceName ( ITestDevice device) Gibt den Namen des Geräts zurück, das in der XML-Konfiguration von |
abstract | getDevices () Geben Sie alle zugewiesenen Geräte zurück, die für diesen Aufruf verfolgt wurden. |
abstract String | getInvocationId () |
default | getInvocationTimingMetrics () Gibt die Zuordnung zurück, die die Metriken für das Aufruftiming enthält. |
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 | getSerials () Gibt die Liste der Seriennummern des in diesem Aufruf verfolgten Geräts zurück |
abstract | getShardsSerials () Gibt die Karte aller nachverfolgten Serien und ihrer am Sharding beteiligten Shards zurück. |
abstract String | getTestTag () Gibt das Test-Tag des Aufrufs zurück. |
abstract void | markReleasedEarly () Markieren Sie, dass die Geräte vorzeitig veröffentlicht werden. |
abstract void | setConfigurationDescriptor ( ConfigurationDescriptor configurationDescriptor) Legt den Deskriptor fest, der der Testkonfiguration zugeordnet ist, die den Aufruf gestartet hat |
abstract void | setModuleInvocationContext ( IInvocationContext invocationContext) Legt den Aufrufkontext des Moduls fest, während es als Teil einer Suite ausgeführt wird. |
abstract void | setRecoveryModeForAllDevices ( ITestDevice.RecoveryMode mode) Legt den |
abstract void | setTestTag (String testTag) Legt das Test-Tag für den Aufruf fest. |
abstract InvocationContext.Context | toProto () Serialisiert eine Kontextinstanz in einen Protobuf. |
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 zugeordneten Aufruf-ID.
Konstanter Wert: "Aufruf-ID"
Öffentliche Methoden
addAllocatedDevice
public abstract void addAllocatedDevice (deviceWithName)
Verfolgen Sie eine Zuordnung des Konfigurationsgerätenamens, der einem ITestDevice
zugeordnet ist. Löscht nicht das vorherige Tracking vor dem Hinzufügen.
Parameter | |
---|---|
deviceWithName | ERROR(/Map) des zusätzlichen zu verfolgenden Geräts |
addAllocatedDevice
public abstract void addAllocatedDevice (String deviceName, ITestDevice testDevice)
Fügen Sie ein ITestDevice hinzu, das von den Metadaten nachverfolgt werden soll, wenn das Gerät zugewiesen wird. setzt die Build-Info in der Karte auf null.
Parameter | |
---|---|
deviceName | String : der Gerätekonfigurationsname, der dem ITestDevice zugeordnet werden soll |
testDevice | ITestDevice : zum Hinzufügen zu den zugewiesenen Geräten. |
addDeviceBuildInfo
public abstract void addDeviceBuildInfo (String deviceName, IBuildInfo buildinfo)
Fügen Sie eine IBuildInfo
hinzu, die mit dem Gerätekonfigurationsnamen nachverfolgt werden soll.
Parameter | |
---|---|
deviceName | String : der Name der Gerätekonfiguration |
buildinfo | IBuildInfo : eine IBuildInfo die dem Gerätekonfigurationsnamen 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)
Fügen Sie mehrere Aufrufattribute gleichzeitig über eine UniqueMultiMap
hinzu.
Parameter | |
---|---|
attributesMap | MultiMap |
addInvocationTimingMetric
public void addInvocationTimingMetric (IInvocationContext.TimingEvent timingEvent, Long durationMillis)
Fügen Sie eine Aufruf-Timing-Metrik hinzu.
Parameter | |
---|---|
timingEvent | IInvocationContext.TimingEvent |
durationMillis | Long |
addSerialsFromShard
public abstract void addSerialsFromShard (Integer index,serials)
Fügen Sie eine zu verfolgende Seriennummer hinzu, die einem der Shards zugewiesen ist, auf denen einige Tests ausgeführt werden.
Parameter | |
---|---|
index | Integer : Der Index des Shards, der die Seriennummern verwendet |
serials |
getAttribut
public String getAttribute (String key)
Eine bequeme Methode zum Abrufen des Aufrufkontextattributs als einzelnes Schlüssel-Wert-Paar. Geben Sie niemals null zurück.
Parameter | |
---|---|
key | String |
Kehrt zurück | |
---|---|
String | leerer String, wenn der Schlüssel nicht existiert, ansonsten der Wert. |
getAttribute
public abstract MultiMap<String, String> getAttributes ()
Gibt eine Kopie der Zuordnung zurück, die alle Aufrufattribute enthält.
Kehrt zurück | |
---|---|
MultiMap <String, String> |
getBuildInfo
public abstract IBuildInfo getBuildInfo (String deviceName)
Gibt die IBuildInfo
zurück, die dem bereitgestellten Gerätekonfigurationsnamen zugeordnet ist. Gibt null zurück, wenn der Gerätename nicht zugeordnet werden kann.
Parameter | |
---|---|
deviceName | String |
Kehrt zurück | |
---|---|
IBuildInfo |
getBuildInfo
public abstract IBuildInfo getBuildInfo (ITestDevice testDevice)
Gibt die dem ITestDevice
zugeordnete IBuildInfo
zurück
Parameter | |
---|---|
testDevice | ITestDevice |
Kehrt zurück | |
---|---|
IBuildInfo |
getBuildInfoName
public abstract String getBuildInfoName (IBuildInfo info)
Gibt den Namen des Geräts zurück, das in der XML-Konfiguration aus der IBuildInfo
festgelegt wurde. Gibt null zurück, wenn die IBuildInfo nicht abgeglichen werden kann
Parameter | |
---|---|
info | IBuildInfo |
Kehrt zurück | |
---|---|
String |
getBuildInfos
public abstractgetBuildInfos ()
Gibt alle für diesen Aufruf verfolgten IBuildInfo
zurück.
Kehrt zurück | |
---|---|
getConfigurationDescriptor
public abstract ConfigurationDescriptor getConfigurationDescriptor ()
Gibt den Deskriptor zurück, der der Testkonfiguration zugeordnet ist, die den Aufruf gestartet hat
Kehrt zurück | |
---|---|
ConfigurationDescriptor |
getDevice
public abstract ITestDevice getDevice (String deviceName)
Gibt das ITestDevice
zurück, das dem bereitgestellten Gerätekonfigurationsnamen zugeordnet ist.
Parameter | |
---|---|
deviceName | String |
Kehrt zurück | |
---|---|
ITestDevice |
getDeviceBuildMap
public abstractgetDeviceBuildMap ()
Gibt die Karte der Geräte-/Build-Info-Zuordnung zurück
Kehrt zurück | |
---|---|
getDeviceBySerial
public abstract ITestDevice getDeviceBySerial (String serial)
Gibt das ITestDevice
zurück, das der bereitgestellten Seriennummer zugeordnet ist. Verwenden Sie nicht zu viel, da dies nicht die schnellste Suche ist.
Parameter | |
---|---|
serial | String |
Kehrt zurück | |
---|---|
ITestDevice |
getDeviceConfigNames
public abstractgetDeviceConfigNames ()
Gibt die Liste der Gerätekonfigurationsnamen des in diesem Aufruf verfolgten Geräts zurück
Kehrt zurück | |
---|---|
getDeviceName
public abstract String getDeviceName (ITestDevice device)
Gibt den Namen des Geräts zurück, das in der XML-Konfiguration von ITestDevice
festgelegt wurde. Gibt null zurück, wenn ITestDevice nicht abgeglichen werden kann.
Parameter | |
---|---|
device | ITestDevice |
Kehrt zurück | |
---|---|
String |
getDevices
public abstractgetDevices ()
Geben Sie alle zugewiesenen Geräte zurück, die für diesen Aufruf verfolgt wurden.
Kehrt zurück | |
---|---|
getInvocationId
public abstract String getInvocationId ()
Kehrt zurück | |
---|---|
String | zugeordnete Aufruf-ID oder null , wenn sie nicht mit einem Aufruf verknüpft ist |
getInvocationTimingMetrics
publicgetInvocationTimingMetrics ()
Gibt die Zuordnung zurück, die die Metriken für das Aufruftiming enthält.
Kehrt zurück | |
---|---|
getModuleInvocationContext
public abstract IInvocationContext getModuleInvocationContext ()
Gibt den Aufrufkontext des Moduls zurück, während es als Teil einer Suite ausgeführt wird.
Kehrt zurück | |
---|---|
IInvocationContext |
getNumDevicesAllocated
public abstract int getNumDevicesAllocated ()
Gibt die Anzahl der für den Aufruf zugewiesenen Geräte zurück.
Kehrt zurück | |
---|---|
int |
getSerials
public abstractgetSerials ()
Gibt die Liste der Seriennummern des in diesem Aufruf verfolgten Geräts zurück
Kehrt zurück | |
---|---|
getShardsSerials
public abstractgetShardsSerials ()
Gibt die Karte aller nachverfolgten Serien und ihrer am Sharding beteiligten Shards zurück. Leer, wenn kein fragmentierter Aufruf.
Kehrt zurück | |
---|---|
getTestTag
public abstract String getTestTag ()
Gibt das Test-Tag des Aufrufs zurück.
Kehrt zurück | |
---|---|
String |
markReleasedEarly
public abstract void markReleasedEarly ()
Markieren Sie, dass die Geräte vorzeitig veröffentlicht werden.
setConfigurationDescriptor
public abstract void setConfigurationDescriptor (ConfigurationDescriptor configurationDescriptor)
Legt den Deskriptor fest, der der Testkonfiguration zugeordnet ist, die den Aufruf gestartet hat
Parameter | |
---|---|
configurationDescriptor | ConfigurationDescriptor |
setModuleInvocationContext
public abstract void setModuleInvocationContext (IInvocationContext invocationContext)
Legt den Aufrufkontext des Moduls fest, während es als Teil einer Suite ausgeführt wird.
Parameter | |
---|---|
invocationContext | IInvocationContext |
setRecoveryModeForAllDevices
public abstract void setRecoveryModeForAllDevices (ITestDevice.RecoveryMode mode)
Legt den RecoveryMode
aller Geräte fest, die Teil des Kontexts sind
Parameter | |
---|---|
mode | ITestDevice.RecoveryMode |
setTestTag
public abstract void setTestTag (String testTag)
Legt das Test-Tag für den Aufruf fest.
Parameter | |
---|---|
testTag | String |
zuProto
public abstract InvocationContext.Context toProto ()
Serialisiert eine Kontextinstanz in einen Protobuf.
Kehrt zurück | |
---|---|
InvocationContext.Context |
warReleasedEarly
public abstract boolean wasReleasedEarly ()
Gibt zurück, ob die Geräte vorzeitig freigegeben wurden und nicht mehr verwendet werden.
Kehrt zurück | |
---|---|
boolean |