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. einem Aufruf, der parallel auf mehreren Ressourcen ausgeführt wird) erfasst und an einen anderen Listener weiterleitet.

Zusammenfassung

Öffentliche Konstruktoren

ShardListener(ITestInvocationListener main)

Erstellen Sie einen ShardListener.

Öffentliche Methoden

List<ITestInvocationListener> getUnderlyingResultReporter()
void invocationEnded(long elapsedTime)

Gibt an, dass der Aufruf beendet wurde, entweder erfolgreich oder aufgrund eines Fehlerzustands.

void invocationFailed(FailureDescription failure)

Meldet einen unvollständigen Aufruf aufgrund eines Fehlerzustands.

void invocationFailed(Throwable cause)

Meldet einen unvollständigen Aufruf aufgrund eines Fehlerzustands.

void invocationSkipped(SkipReason reason)

Meldet einen Aufruf als übersprungen

void invocationStarted(IInvocationContext context)

Meldet den Beginn des Testaufrufs.

void logAssociation(String dataName, LogFile logFile)

In einigen Fällen muss das Log eng mit einem Testlauf verknüpft sein, aber die Möglichkeit dazu besteht beim direkten testLogSaved(String,LogDataType,InputStreamSource,LogFile)-Callback nicht.

void setSupportGranularResults(boolean enableGranularResults)
boolean supportGranularResults()

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

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

Stellt die zugehörigen Protokoll- oder Debugging-Daten aus dem Testaufruf bereit.

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

void testModuleEnded()

Meldet das Ende einer Modulausführung.

void testModuleStarted(IInvocationContext moduleContext)

Meldet den Beginn der Ausführung eines Moduls.

void testRunEnded(long elapsedTime, HashMap<String, MetricMeasurement.Metric> runMetrics)

Meldet das Ende des Testlaufs.

void testRunFailed(FailureDescription failure)

Der Testlauf für Berichte konnte aufgrund eines Fehlers, der durch FailureDescription beschrieben wird, 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)

Meldet den Beginn eines Testlaufs.

Öffentliche Konstruktoren

ShardListener

public ShardListener (ITestInvocationListener main)

Erstellen Sie einen ShardListener.

Parameter
main ITestInvocationListener: die ITestInvocationListener, an die die Ergebnisse weitergeleitet 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 List<ITestInvocationListener> getUnderlyingResultReporter ()

Gibt Folgendes zurück:
List<ITestInvocationListener>

invocationEnded

public void invocationEnded (long elapsedTime)

Gibt an, dass der Aufruf beendet wurde, entweder erfolgreich oder aufgrund eines Fehlerzustands.

Wird automatisch vom TradeFederation-Framework aufgerufen.

Parameter
elapsedTime long: die verstrichene Zeit des Aufrufs in Millisekunden

invocationFailed

public void invocationFailed (FailureDescription failure)

Meldet einen unvollständigen Aufruf aufgrund eines Fehlerzustands.

Wird automatisch vom TradeFederation-Framework aufgerufen.

Parameter
failure FailureDescription: die FailureDescription, in der die Ursache des Fehlers beschrieben wird

invocationFailed

public void invocationFailed (Throwable cause)

Meldet einen unvollständigen Aufruf aufgrund eines Fehlerzustands.

Wird automatisch vom TradeFederation-Framework aufgerufen.

Parameter
cause Throwable: die Throwable-Ursache des Fehlers

invocationSkipped

public void invocationSkipped (SkipReason reason)

Meldet einen Aufruf als übersprungen

Parameter
reason SkipReason

invocationStarted

public void invocationStarted (IInvocationContext context)

Meldet den Beginn des Testaufrufs.

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

Parameter
context IInvocationContext: Informationen zum Aufruf

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

In einigen Fällen muss das Log eng mit einem Testlauf verknüpft sein, aber die Möglichkeit dazu besteht beim direkten testLogSaved(String,LogDataType,InputStreamSource,LogFile)-Callback nicht. Mit diesem Callback kann also explizit eine starke Zuordnung angegeben werden.

Parameter
dataName String: Der Name der Daten

logFile LogFile: Die LogFile, die zuvor protokolliert wurde und dem Testlauf zugeordnet werden soll.

setSupportGranularResults

public void setSupportGranularResults (boolean enableGranularResults)

Parameter
enableGranularResults boolean

supportGranularResults

public boolean supportGranularResults ()

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

Gibt Folgendes zurück:
boolean

testLog

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

Stellt die zugehörigen Protokoll- oder Debugging-Daten aus dem Testaufruf bereit.

Muss vor ERROR(ITestInvocationListener.invocationFailed(Throwable)/ITestInvocationListener#invocationFailed(java.lang.Throwable) ITestInvocationListener.invocationFailed(Throwable)) oder ERROR(/ITestInvocationListener#invocationEnded(long)) aufgerufen werden

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

Parameter
dataName String: Ein String aussagekräftiger Name der Daten, z. B. „device_logcat“. Hinweis: dataName ist möglicherweise nicht pro Aufruf eindeutig. Implementierer müssen also mehrere Aufrufe mit demselben dataName verarbeiten können.

dataType LogDataType: die LogDataType der Daten

dataStream InputStreamSource: die InputStreamSource der Daten. Implementierer sollten createInputStream aufrufen, um mit dem Lesen der Daten zu beginnen, und den resultierenden InputStream schließen, wenn sie fertig sind. Anrufer sollten dafür sorgen, dass die Datenquelle bis zum Abschluss der Methode „testLog“ vorhanden und zugänglich bleibt.

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

Meldet das Ende einer Modulausführung.

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

Meldet den Beginn der Ausführung eines Moduls. Dieser Callback ist mit testModuleEnded() verknüpft und in der Sequenz optional. Es wird nur bei einem Lauf verwendet, bei dem Module verwendet werden: Suite-basierte Runner.

Parameter
moduleContext IInvocationContext: Die IInvocationContext des Moduls.

testRunEnded

public void testRunEnded (long elapsedTime, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

Meldet das Ende des Testlaufs. FIXME: Wir können nicht zwei Map<>-Schnittstellen mit unterschiedlichen Typen haben, daher müssen wir hier HashMap verwenden.

Parameter
elapsedTime long: Die vom Gerät gemeldete verstrichene Zeit in Millisekunden.

runMetrics HashMap: Schlüssel/Wert-Paare, die am Ende eines Testlaufs mit Metric gemeldet werden.

testRunFailed

public void testRunFailed (FailureDescription failure)

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

Parameter
failure FailureDescription: FailureDescription, in dem der Fehler und sein Kontext beschrieben werden.

testRunFailed

public void testRunFailed (String failureMessage)

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

Parameter
failureMessage String: String, in dem der Grund für den Fehler bei der Ausführung beschrieben wird.

testRunStarted

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

Meldet den Beginn eines Testlaufs.

Parameter
name String: der Name des Testlaufs

numTests int: Gesamtzahl der Tests im Testlauf

attemptNumber int: Auftragsnummer zur Identifizierung der verschiedenen Versuche desselben runName, die mehrmals ausgeführt werden. Die attemptNumber ist 0-basiert und sollte bei jedem neuen Lauf inkrementiert werden. Beispiel: Ein Test wird dreimal wiederholt. Er sollte insgesamt vier Läufe mit demselben runName haben und die attemptNumber sollte von 0 bis 3 reichen.

startTime long: Der Zeitpunkt, zu dem der Lauf begonnen hat, gemessen mit System.currentTimeMillis()