ShardListener

public class ShardListener
extends CollectingTestListener implements ISupportGranularResults

java.lang.Object
↳	com.android.tradefed.result.CollectingTestListener
	↳	com.android.tradefed.invoker.ShardListener

---

Ein ITestInvocationListener, das Ergebnisse aus einem Aufruf-Shard (d. h. einer Aufrufaufteilung, die parallel auf mehreren Ressourcen ausgeführt wird) erfasst und an einen anderen Listener weiterleitet.

Zusammenfassung

Öffentliche Konstruktoren
ShardListener(ITestInvocationListener main) Erstellen Sie eine ShardListener.

Öffentliche Methoden
	getUnderlyingResultReporter()
void	invocationEnded(long elapsedTime) Gibt an, ob die Aufrufe erfolgreich oder aufgrund eines Fehlers beendet wurden.
void	invocationFailed(FailureDescription failure) Eine unvollständige Aufrufung wird aufgrund einer Fehlerbedingung gemeldet.
void	invocationFailed(Throwable cause) Eine unvollständige Aufrufung wird aufgrund einer Fehlerbedingung gemeldet.
void	invocationSkipped(SkipReason reason) Eine Aufrufung wird als übersprungen gemeldet.
void	invocationStarted(IInvocationContext context) Gibt den Beginn der Testausführung an.
void	logAssociation(String dataName, LogFile logFile) In einigen Fällen muss das Protokoll eng mit den Testfällen verknüpft sein, was über den direkten testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)-Callback jedoch nicht möglich ist.
void	setSupportGranularResults(boolean enableGranularResults)
boolean	supportGranularResults() Gibt „True“ zurück, wenn der Berichter detaillierte Ergebnisse unterstützt, andernfalls „False“.
void	testLog(String dataName, LogDataType dataType, InputStreamSource dataStream) Enthält die zugehörigen Protokoll- oder Debug-Daten aus der Testausführung.
void	testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
void	testModuleEnded() Gibt das Ende eines Modullaufs an.
void	testModuleStarted(IInvocationContext moduleContext) Gibt den Beginn der Ausführung eines Moduls an.
void	testRunEnded(long elapsedTime, runMetrics) Gibt das Ende des Testlaufs an.
void	testRunFailed(FailureDescription failure) Der Testlauf für Berichte konnte aufgrund eines Fehlers, der von FailureDescription beschrieben wurde, nicht abgeschlossen werden.
void	testRunFailed(String failureMessage) Der Testlauf für Berichte konnte aufgrund eines schwerwiegenden Fehlers nicht abgeschlossen werden.
void	testRunStarted(String name, int numTests, int attemptNumber, long startTime) Gibt den Beginn eines Testlaufs an.

Öffentliche Konstruktoren

ShardListener

public ShardListener (ITestInvocationListener main)

Erstellen Sie eine ShardListener.

Parameter
main	ITestInvocationListener: die ITestInvocationListener, an die die Ergebnisse gesendet werden sollen. Um Kollisionen mit anderen ShardListeners zu vermeiden, wird dieses Objekt beim Weiterleiten von Ergebnissen mit main synchronisiert. Die Ergebnisse werden erst gesendet, wenn der Aufruf-Shard abgeschlossen ist.

Öffentliche Methoden

getUnderlyingResultReporter

public  getUnderlyingResultReporter ()

Returns

invocationEnded

public void invocationEnded (long elapsedTime)

Gibt an, ob die Aufrufe erfolgreich oder aufgrund eines Fehlers beendet wurden.

Wird automatisch vom TradeFederation-Framework aufgerufen.

Parameter
elapsedTime	long: die verstrichene Zeit seit der Aufrufung in ms

invocationFailed

public void invocationFailed (FailureDescription failure)

Eine unvollständige Aufrufung wird aufgrund einer Fehlerbedingung gemeldet.

Wird automatisch vom TradeFederation-Framework aufgerufen.

Parameter
failure	FailureDescription: die FailureDescription, die die Ursache des Fehlers beschreibt

invocationFailed

public void invocationFailed (Throwable cause)

Eine unvollständige Aufrufung wird aufgrund einer Fehlerbedingung gemeldet.

Wird automatisch vom TradeFederation-Framework aufgerufen.

Parameter
cause	Throwable: die Throwable Ursache des Fehlers

invocationSkipped

public void invocationSkipped (SkipReason reason)

Eine Aufrufung wird als übersprungen gemeldet.

Parameter
reason	SkipReason

invocationStarted

public void invocationStarted (IInvocationContext context)

Gibt den Beginn der Testausführung an.

Wird automatisch vom TradeFederation-Framework aufgerufen. Meldende müssen diese Methode überschreiben, um Berichte für mehrere Geräte zu unterstützen.

Parameter
context	IInvocationContext: Informationen zur Aufrufung

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

In einigen Fällen muss das Protokoll eng mit den Testfällen verknüpft sein, was über den direkten testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)-Callback jedoch nicht möglich ist. So kann mit diesem Rückruf eine starke Verknüpfung explizit angegeben werden.

Parameter
dataName	String: Der Name der Daten
logFile	LogFile: die LogFile, die zuvor protokolliert wurde und mit dem Testfall verknüpft werden soll.

setSupportGranularResults

public void setSupportGranularResults (boolean enableGranularResults)

Parameter
enableGranularResults	boolean

supportGranularResults

public boolean supportGranularResults ()

Gibt „True“ zurück, wenn der Berichter detaillierte Ergebnisse unterstützt, andernfalls „False“.

Returns
boolean

testLog

public void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

Enthält die zugehörigen Protokoll- oder Debug-Daten aus der Testausführung.

Muss vor dem ERROR(/ITestInvocationListener#invocationFailed(Throwable)) oder ERROR(/ITestInvocationListener#invocationEnded(long)) aufgerufen werden

Das TradeFederation-Framework ruft diese Methode automatisch auf und stellt das Hostprotokoll und gegebenenfalls das Geräte-Logcat bereit.

Parameter
dataName	String: Ein String aussagekräftiger Name für die Daten, z. B. „device_logcat“. Hinweis: Der Datenname muss nicht für jeden Aufruf eindeutig sein. Entwickler müssen also in der Lage sein, mehrere Aufrufe mit demselben Datennamen zu verarbeiten.
dataType	LogDataType: die LogDataType der Daten
dataStream	InputStreamSource: die InputStreamSource der Daten. Implementer müssen createInputStream aufrufen, um mit dem Lesen der Daten zu beginnen, und den resultierenden InputStream nach Abschluss schließen. Die Aufrufer müssen dafür sorgen, dass die Datenquelle bis zum Abschluss der testLog-Methode vorhanden und zugänglich ist.

testLogSaved

public void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

Parameter
dataName	String
dataType	LogDataType
dataStream	InputStreamSource
logFile	LogFile

testModuleEnded

public void testModuleEnded ()

Gibt das Ende eines Modullaufs an.

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

Gibt den Beginn der Ausführung eines Moduls an. Dieser Rückruf ist mit testModuleEnded() verknüpft und in der Abfolge optional. Es wird nur bei einem Lauf verwendet, bei dem Module verwendet werden: suitebasierte Auslöser.

Parameter
moduleContext	IInvocationContext: die IInvocationContext des Moduls.

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

Gibt das Ende des Testlaufs an.

Parameter
elapsedTime	long: Vom Gerät gemeldete verstrichene Zeit in Millisekunden
runMetrics	: Schlüssel/Wert-Paare, die am Ende eines Testlaufs erfasst werden

testRunFailed

public void testRunFailed (FailureDescription failure)

Der Testlauf für Berichte konnte aufgrund eines Fehlers, der von FailureDescription beschrieben wurde, nicht abgeschlossen werden.

Parameter
failure	FailureDescription: FailureDescription, die den Fehler und seinen Kontext beschreibt.

testRunFailed

public void testRunFailed (String failureMessage)

Der Testlauf für Berichte konnte aufgrund eines schwerwiegenden Fehlers nicht abgeschlossen werden.

Parameter
failureMessage	String: String mit einer Beschreibung des Grunds für den Ausführungsfehler.

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber, 
                long startTime)

Gibt den Beginn eines Testlaufs an.

Parameter
name	String: der Name des Testlaufs
numTests	int: Gesamtzahl der Tests im Testlauf
attemptNumber	int: Die Bestellnummer, die die verschiedenen Versuche desselben runName identifiziert, der mehrmals ausgeführt wird. Die „attemptNumber“ beginnt bei 0 und sollte bei jedem neuen Durchlauf erhöht werden. Wenn ein Test beispielsweise dreimal wiederholt wird, sollte es insgesamt vier Durchläufe mit demselben „runName“ geben und die „attemptNumber“ sollte von 0 auf 3 steigen.
startTime	long: Zeitpunkt des Beginns der Ausführung, gemessen über System.currentTimeMillis()