BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Object
   ↳ com.android.tradefed.postprocessor.BasePostProcessor


Die Basis-IPostProcessor, die jede Implementierung erweitern sollte. Achten Sie darauf, dass die Methoden zur Nachbearbeitung vor den Reportern für das Endergebnis aufgerufen werden.

Zusammenfassung

Öffentliche Konstruktoren

BasePostProcessor()

Öffentliche Methoden

final ITestInvocationListener init(ITestInvocationListener listener)

Initialisierungsschritt des Postprozessors.

final void invocationEnded(long elapsedTime)

Meldet, dass der Aufruf beendet wurde, unabhängig davon, ob dies erfolgreich oder aufgrund eines Fehlerzustands geschehen ist.

final void invocationFailed(FailureDescription failure)

Meldet einen unvollständigen Aufruf aufgrund eines Fehlerzustands.

final void invocationFailed(Throwable cause)

Meldet einen unvollständigen Aufruf aufgrund eines Fehlerzustands.

void invocationSkipped(SkipReason reason)

Meldet einen Aufruf als übersprungen

final void invocationStarted(IInvocationContext context)

Invocation-Listener für die Weiterleitung

final boolean isDisabled()

Gibt „True“ zurück, wenn das gesamte Objekt deaktiviert ist (sowohl Einrichtung als auch Abbau werden übersprungen).

final void logAssociation(String dataName, LogFile logFile)

In einigen Fällen muss ein Logeintrag stark mit einem Testlauf verknüpft sein, aber die Möglichkeit dazu besteht beim direkten testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)-Callback nicht.

Aktualisiert die Zuordnung von Log zu Test.

processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)

Implementieren Sie diese Methode, um Messwerte und Logs für alle Tests zusammenzufassen.

abstract processRunMetricsAndLogs( rawMetrics, runLogs)

Implementieren Sie diese Methode, um eine Reihe neuer Messwerte aus den vorhandenen Messwerten und Logs zu generieren.

processTestMetricsAndLogs(TestDescription testDescription, testMetrics, testLogs)

Implementieren Sie diese Methode, um Messwerte und Logs aus den einzelnen Tests nachzubearbeiten.

final void setLogSaver(ILogSaver logSaver)

Legen Sie ILogSaver fest, damit der Implementierer Dateien speichern kann.

void setUp()

Überschreiben Sie diese Methode in den untergeordneten Postprozessoren, um sie vor dem Ausführen des Tests zu initialisieren.

final void testAssumptionFailure(TestDescription test, String trace)

Wird aufgerufen, wenn bei einem atomaren Test eine Bedingung als falsch angenommen wird

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

Wird aufgerufen, wenn bei einem atomaren Test eine Bedingung als falsch angenommen wird

final void testEnded(TestDescription test, long endTime, testMetrics)

Alternative zu ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), mit der wir die Endzeit direkt angeben können.

final void testEnded(TestDescription test, testMetrics)

Meldet das Ende der Ausführung eines einzelnen Testlaufs.

final void testFailed(TestDescription test, FailureDescription failure)

Meldet das Fehlschlagen eines einzelnen Testlaufs.

final void testFailed(TestDescription test, String trace)

Meldet das Fehlschlagen eines einzelnen Testlaufs.

final void testIgnored(TestDescription test)

Wird aufgerufen, wenn ein Test nicht ausgeführt wird, in der Regel, weil eine Testmethode mit „org.junit.Ignore“ annotiert ist.

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

Mit dieser Methode können Sie eine Datei aus der PostProcessor-Implementierung protokollieren.

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

Wird aufgerufen, wenn das Testprotokoll gespeichert wird.

final void testModuleEnded()

Meldet das Ende einer Modulausführung.

final void testModuleStarted(IInvocationContext moduleContext)

Meldet den Beginn der Ausführung eines Moduls.

final void testRunEnded(long elapsedTime, runMetrics)

Meldet das Ende des Testlaufs.

final void testRunFailed(FailureDescription failure)

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

final void testRunFailed(String errorMessage)

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

final void testRunStarted(String runName, int testCount, int attemptNumber)

Meldet den Beginn eines Testlaufs.

final void testRunStarted(String runName, int testCount)

Testlauf-Callbacks

final void testRunStarted(String runName, int testCount, int attemptNumber, long startTime)

Meldet den Beginn eines Testlaufs.

final void testRunStopped(long elapsedTime)

Der Testlauf für Berichte wurde aufgrund einer Nutzeranfrage vor Abschluss beendet.

final void testSkipped(TestDescription test, SkipReason reason)

Wird aufgerufen, wenn ein Test übersprungen wird und aus einem Grund, der normalerweise nicht erwartet wird, nicht ausgeführt wurde.

final void testStarted(TestDescription test, long startTime)

Alternative zu testStarted(com.android.tradefed.result.TestDescription), bei der wir auch angeben, wann der Test gestartet wurde, in Kombination mit ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) für eine genaue Messung.

final void testStarted(TestDescription test)

Testlauf-Callbacks

Geschützte Methoden

void cleanUp()
MetricMeasurement.DataType getMetricType()

Überschreiben Sie diese Methode, um den Messwerttyp bei Bedarf zu ändern.

String getRunName()

Öffentliche Konstruktoren

BasePostProcessor

public BasePostProcessor ()

Öffentliche Methoden

init

public final ITestInvocationListener init (ITestInvocationListener listener)

Initialisierungsschritt des Postprozessors. Wird garantiert vor allen Test-Callbacks aufgerufen.

Parameter
listener ITestInvocationListener

Returns
ITestInvocationListener

invocationEnded

public final void invocationEnded (long elapsedTime)

Meldet, dass der Aufruf beendet wurde, unabhängig davon, ob dies erfolgreich oder aufgrund eines Fehlerzustands geschehen ist.

Wird automatisch vom TradeFederation-Framework aufgerufen.

Parameter
elapsedTime long: die verstrichene Zeit des Aufrufs in Millisekunden

invocationFailed

public final void invocationFailed (FailureDescription failure)

Meldet einen unvollständigen Aufruf aufgrund eines Fehlerzustands.

Wird automatisch vom TradeFederation-Framework aufgerufen.

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

invocationFailed

public final 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 final void invocationStarted (IInvocationContext context)

Invocation-Listener für die Weiterleitung

Parameter
context IInvocationContext: Informationen zum Aufruf

isDisabled

public final boolean isDisabled ()

Gibt „True“ zurück, wenn das gesamte Objekt deaktiviert ist (sowohl Einrichtung als auch Abbau werden übersprungen). ansonsten „falsch“.

Returns
boolean

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

In einigen Fällen muss ein Logeintrag stark mit einem Testlauf verknüpft sein, aber die Möglichkeit dazu besteht beim direkten testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)-Callback nicht. Mit diesem Callback kann also explizit eine starke Assoziierung angegeben werden.

Aktualisiert die Zuordnung von Log zu Test. Wenn diese Methode während eines Tests aufgerufen wird, gehört das Log zum Test. Andernfalls ist es ein Laufzeitlog.

Parameter
dataName String: Der Name der Daten

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

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

Implementieren Sie diese Methode, um Messwerte und Logs für alle Tests zusammenzufassen. Messwerte, die aus dieser Methode stammen, werden als Laufmesswerte gemeldet. Es sollten nur die neu generierten Messwerte zurückgegeben werden, und zwar mit einem eindeutigen Schlüsselnamen (keine Überschneidung mit vorhandenen Schlüsseln).

Parameter
allTestMetrics ListMultimap: Eine HashMultimap, in der die Messwerte aus jedem Test nach Messwertnamen gruppiert gespeichert werden.

allTestLogs : Eine Zuordnung, in der die Zuordnung der Logdateien der einzelnen Tests nach ihren Datennamen gespeichert ist. Die TestDescription der einzelnen Tests werden als Schlüssel verwendet.

Returns
Die Menge der neu generierten Messwerte aus allen Testmesswerten.

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

Implementieren Sie diese Methode, um eine Reihe neuer Messwerte aus den vorhandenen Messwerten und Logs zu generieren. Es sollten nur die neu generierten Messwerte zurückgegeben werden, und zwar mit einem eindeutigen Schlüsselnamen (keine Überschneidung mit vorhandenen Schlüsseln).

Parameter
rawMetrics : Die Gruppe der Rohmesswerte, die für den Lauf verfügbar sind.

runLogs : Die Gruppe der Logdateien für den Testlauf.

Returns
Die Menge der neu generierten Messwerte aus den Laufmesswerten.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

Implementieren Sie diese Methode, um Messwerte und Logs aus den einzelnen Tests nachzubearbeiten. Es sollten nur die neu generierten Messwerte zurückgegeben werden, und zwar mit einem eindeutigen Schlüsselnamen (keine Überschneidung mit vorhandenen Schlüsseln).

Parameter
testDescription TestDescription: Das TestDescription-Objekt, das den Test beschreibt.

testMetrics : Die Gruppe der Messwerte aus dem Test.

testLogs : Die Menge der Dateien, die während des Tests protokolliert wurden.

Returns
Die Menge der neu generierten Messwerte aus den Testmesswerten.

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

Legen Sie ILogSaver fest, damit der Implementierer Dateien speichern kann.

Parameter
logSaver ILogSaver: die ILogSaver

setUp

public void setUp ()

Überschreiben Sie diese Methode in den untergeordneten Postprozessoren, um sie vor dem Ausführen des Tests zu initialisieren.

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

Wird aufgerufen, wenn bei einem atomaren Test eine Bedingung als falsch angenommen wird

Parameter
test TestDescription: Gibt den Test an.

trace String: Stacktrace des Fehlers

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

Wird aufgerufen, wenn bei einem atomaren Test eine Bedingung als falsch angenommen wird

Parameter
test TestDescription: Gibt den Test an.

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

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

Alternative zu ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), mit der wir die Endzeit direkt angeben können. Kombinieren Sie sie mit testStarted(com.android.tradefed.result.TestDescription, long), um genaue Ergebnisse zu erhalten.

Parameter
test TestDescription: Gibt den Test an.

endTime long: Die Uhrzeit, zu der der Test beendet wurde, gemessen über System.currentTimeMillis()

testMetrics : eine ERROR(/Map) der ausgegebenen Messwerte

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

Meldet das Ende der Ausführung eines einzelnen Testlaufs.

Wenn testFailed(TestDescription, FailureDescription) nicht aufgerufen wurde, wurde dieser Test bestanden. Gibt auch alle Schlüssel/Wert-Messwerte zurück, die während der Ausführung des Testlaufs ausgegeben wurden.

Parameter
test TestDescription: Gibt den Test an.

testMetrics : eine ERROR(/Map) der ausgegebenen Messwerte

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

Meldet das Fehlschlagen eines einzelnen Testlaufs.

Wird zwischen „testStarted“ und „testEnded“ aufgerufen.

Parameter
test TestDescription: Gibt den Test an.

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

testFailed

public final void testFailed (TestDescription test, 
                String trace)

Meldet das Fehlschlagen eines einzelnen Testlaufs.

Wird zwischen „testStarted“ und „testEnded“ aufgerufen.

Parameter
test TestDescription: Gibt den Test an.

trace String: Stacktrace des Fehlers

testIgnored

public final void testIgnored (TestDescription test)

Wird aufgerufen, wenn ein Test nicht ausgeführt wird, in der Regel, weil eine Testmethode mit „org.junit.Ignore“ annotiert ist.

Parameter
test TestDescription: Gibt den Test an.

testLog

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

Mit dieser Methode können Sie eine Datei aus der PostProcessor-Implementierung protokollieren.

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 testLog-Methode vorhanden und zugänglich bleibt.

testLogSaved

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

Wird aufgerufen, wenn das Testprotokoll gespeichert wird.

Sollte anstelle von ITestInvocationListener.testLog(String, LogDataType, InputStreamSource) verwendet werden.

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.

logFile LogFile: das LogFile mit den Metadaten der gespeicherten Datei.

testModuleEnded

public final void testModuleEnded ()

Meldet das Ende einer Modulausführung.

testModuleStarted

public final 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 final void testRunEnded (long elapsedTime, 
                 runMetrics)

Meldet das Ende des Testlaufs.

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

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

testRunFailed

public final 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, die den Fehler und seinen Kontext beschreibt.

testRunFailed

public final void testRunFailed (String errorMessage)

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

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

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

Meldet den Beginn eines Testlaufs.

Parameter
runName String: der Name des Testlaufs

testCount 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. Wenn ein Test beispielsweise dreimal wiederholt wird, sollte er insgesamt vier Läufe mit demselben runName haben und die attemptNumber sollte von 0 bis 3 reichen.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Testlauf-Callbacks

Parameter
runName String: der Name des Testlaufs

testCount int: Gesamtzahl der Tests im Testlauf

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

Meldet den Beginn eines Testlaufs.

Parameter
runName String: der Name des Testlaufs

testCount 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: Die Startzeit des Laufs, gemessen mit System.currentTimeMillis()

testRunStopped

public final void testRunStopped (long elapsedTime)

Der Testlauf für Berichte wurde aufgrund einer Nutzeranfrage vor Abschluss beendet.

TODO: currently unused, consider removing

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

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

Wird aufgerufen, wenn ein Test übersprungen wird und aus einem Grund, der normalerweise nicht erwartet wird, nicht ausgeführt wurde. Diese Tests werden wiederholt, um eine ordnungsgemäße Ausführung zu erreichen.

Parameter
test TestDescription: Gibt den Test an.

reason SkipReason: SkipReason

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

Alternative zu testStarted(com.android.tradefed.result.TestDescription), bei der wir auch angeben, wann der Test gestartet wurde, in Kombination mit ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) für eine genaue Messung.

Parameter
test TestDescription: Gibt den Test an.

startTime long: Die Uhrzeit, zu der der Test begonnen hat, gemessen über System.currentTimeMillis()

testStarted

public final void testStarted (TestDescription test)

Testlauf-Callbacks

Parameter
test TestDescription: Gibt den Test an.

Geschützte Methoden

cleanUp

protected void cleanUp ()

getMetricType

protected MetricMeasurement.DataType getMetricType ()

Überschreiben Sie diese Methode, um den Messwerttyp bei Bedarf zu ändern. Standardmäßig ist der Messwert auf den verarbeiteten Typ festgelegt.

Returns
MetricMeasurement.DataType

getRunName

protected String getRunName ()

Returns
String