BasePostProcessor
public abstract class BasePostProcessor
extends Object
implements IPostProcessor
java.lang.Object | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
Der Basis IPostProcessor
, den jede Implementierung erweitern sollte. Stellen Sie sicher, dass die Nachbearbeitungsmethoden vor den Endergebnis-Reportern aufgerufen werden.
Zusammenfassung
Öffentliche Bauträger | |
---|---|
BasePostProcessor () |
Öffentliche Methoden | |
---|---|
final ITestInvocationListener | init ( ITestInvocationListener listener) Initialisierungsschritt des Postprozessors. |
final void | invocationEnded (long elapsedTime) Meldet, dass der Aufruf erfolgreich oder aufgrund einer Fehlerbedingung beendet wurde. |
final void | invocationFailed ( FailureDescription failure) Meldet einen unvollständigen Aufruf aufgrund einer Fehlerbedingung. |
final void | invocationFailed (Throwable cause) Meldet einen unvollständigen Aufruf aufgrund einer Fehlerbedingung. |
final void | invocationStarted ( IInvocationContext context) Aufruf-Listener für die Weiterleitung |
final boolean | isDisabled () Gibt „True“ zurück, wenn das gesamte Objekt deaktiviert ist (Einrichtung und Abbau überspringen). |
final void | logAssociation (String dataName, LogFile logFile) In einigen Fällen muss das Protokoll eng mit einem Testfall verknüpft sein, es besteht jedoch die Möglichkeit, dies direkt über Aktualisiert die Protokoll-zu-Test-Zuordnung. |
processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) Implementieren Sie diese Methode, um Metriken und Protokolle über alle Tests hinweg zu aggregieren. | |
abstract | processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) Implementieren Sie diese Methode, um aus den vorhandenen Metriken und Protokollen eine Reihe neuer Metriken zu generieren. |
processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) Implementieren Sie diese Methode, um Prozessmetriken und Protokolle von jedem Test zu veröffentlichen. | |
final void | setLogSaver ( ILogSaver logSaver) Legen Sie |
void | setUp () Überschreiben Sie diese Methode in den untergeordneten Postprozessoren, um sie vor den Testläufen zu initialisieren. |
final void | testAssumptionFailure ( TestDescription test, String trace) Wird aufgerufen, wenn ein Atomtest meldet, dass er eine falsche Bedingung annimmt |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) Wird aufgerufen, wenn ein Atomtest meldet, dass er eine falsche Bedingung annimmt |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) Alternative zu |
final void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) Meldet das Ausführungsende eines einzelnen Testfalls. |
final void | testFailed ( TestDescription test, FailureDescription failure) Meldet den Fehler eines einzelnen Testfalls. |
final void | testFailed ( TestDescription test, String trace) Meldet den Fehler eines einzelnen Testfalls. |
final void | testIgnored ( TestDescription test) Wird aufgerufen, wenn ein Test nicht ausgeführt wird, im Allgemeinen, weil eine Testmethode mit org.junit.Ignore annotiert ist. |
final void | testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) Verwenden Sie diese Methode, um eine Datei aus der PostProcessor-Implementierung zu 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 eines Modullaufs. |
final void | testModuleStarted ( IInvocationContext moduleContext) Meldet den Beginn der Ausführung eines Moduls. |
final void | testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) Meldet das Ende des Testlaufs. |
final void | testRunFailed ( FailureDescription failure) Der Testlauf des Berichts konnte aufgrund eines in |
final void | testRunFailed (String errorMessage) Der Testlauf des Berichts konnte aufgrund eines schwerwiegenden Fehlers nicht abgeschlossen werden. |
final void | testRunStarted (String runName, int testCount, int attemptNumber) Meldet den Start eines Testlaufs. |
final void | testRunStarted (String runName, int testCount) Testlauf-Rückrufe |
final void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Meldet den Start eines Testlaufs. |
final void | testRunStopped (long elapsedTime) Der Testlauf des Berichts wurde aufgrund einer Benutzeranfrage vor Abschluss abgebrochen. |
final void | testStarted ( TestDescription test, long startTime) Alternative zu |
final void | testStarted ( TestDescription test) Rückrufe von Testfällen |
Geschützte Methoden | |
---|---|
MetricMeasurement.DataType | getMetricType () Überschreiben Sie diese Methode, um den Metriktyp bei Bedarf zu ändern. |
String | getRunName () |
Öffentliche Bauträger
BasePostProcessor
public BasePostProcessor ()
Öffentliche Methoden
drin
public final ITestInvocationListener init (ITestInvocationListener listener)
Initialisierungsschritt des Postprozessors. Es wird sichergestellt, dass der Aufruf vor einem der Testrückrufe erfolgt.
Parameter | |
---|---|
listener | ITestInvocationListener |
Kehrt zurück | |
---|---|
ITestInvocationListener |
invocationEnded
public final void invocationEnded (long elapsedTime)
Meldet, dass der Aufruf erfolgreich oder aufgrund einer Fehlerbedingung beendet wurde.
Wird automatisch vom TradeFederation-Framework aufgerufen.Parameter | |
---|---|
elapsedTime | long : die verstrichene Zeit des Aufrufs in ms |
Aufruf fehlgeschlagen
public final void invocationFailed (FailureDescription failure)
Meldet einen unvollständigen Aufruf aufgrund einer Fehlerbedingung.
Wird automatisch vom TradeFederation-Framework aufgerufen.
Parameter | |
---|---|
failure | FailureDescription : Die FailureDescription , die die Ursache des Fehlers beschreibt |
Aufruf fehlgeschlagen
public final void invocationFailed (Throwable cause)
Meldet einen unvollständigen Aufruf aufgrund einer Fehlerbedingung.
Wird automatisch vom TradeFederation-Framework aufgerufen.Parameter | |
---|---|
cause | Throwable : Die Throwable -Ursache des Fehlers |
invocationStarted
public final void invocationStarted (IInvocationContext context)
Aufruf-Listener für die Weiterleitung
Parameter | |
---|---|
context | IInvocationContext : Informationen zum Aufruf |
ist behindert
public final boolean isDisabled ()
Gibt „True“ zurück, wenn das gesamte Objekt deaktiviert ist (Einrichtung und Abbau überspringen). Sonst falsch.
Kehrt zurück | |
---|---|
boolean |
logAssociation
public final void logAssociation (String dataName, LogFile logFile)
In einigen Fällen muss das Protokoll eng mit einem Testfall verknüpft sein, es besteht jedoch die Möglichkeit, dies direkt über testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
Rückruf ist nicht möglich. Somit ermöglicht dieser Rückruf die explizite Bereitstellung einer starken Assoziation.
Aktualisiert die Protokoll-zu-Test-Zuordnung. Wird diese Methode während eines Tests aufgerufen, dann gehört das Protokoll zum Test; andernfalls handelt es sich um ein Laufprotokoll.
Parameter | |
---|---|
dataName | String : Der Name der Daten |
logFile | LogFile : die LogFile , die zuvor protokolliert wurde und dem Testfall zugeordnet werden sollte. |
ProcessAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Implementieren Sie diese Methode, um Metriken und Protokolle über alle Tests hinweg zu aggregieren. Die aus dieser Methode resultierenden Metriken werden als Laufmetriken an den Reporter weitergegeben. Es sollten nur die neu generierten Metriken zurückgegeben werden, und zwar mit einem eindeutigen Schlüsselnamen (Kollision mit vorhandenen Schlüsseln ist nicht zulässig).
Parameter | |
---|---|
allTestMetrics | ListMultimap : Eine HashMultimap, die die Metriken aus jedem Test, gruppiert nach Metriknamen, speichert. |
allTestLogs | TestDescription jedes Tests als Schlüssel verwendet wird. |
Kehrt zurück | |
---|---|
Der Satz neu generierter Metriken aus allen Testmetriken. |
ProcessRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Implementieren Sie diese Methode, um aus den vorhandenen Metriken und Protokollen eine Reihe neuer Metriken zu generieren. Es sollten nur die neu generierten Metriken zurückgegeben werden, und zwar mit einem eindeutigen Schlüsselnamen (Kollision mit vorhandenen Schlüsseln ist nicht zulässig).
Parameter | |
---|---|
rawMetrics | |
runLogs |
Kehrt zurück | |
---|---|
Der Satz neu generierter Metriken aus den Laufmetriken. |
ProcessTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Implementieren Sie diese Methode, um Prozessmetriken und Protokolle von jedem Test zu veröffentlichen. Es sollten nur die neu generierten Metriken zurückgegeben werden, und zwar mit einem eindeutigen Schlüsselnamen (Kollision mit vorhandenen Schlüsseln ist nicht zulässig).
Parameter | |
---|---|
testDescription | TestDescription : Das TestDescription-Objekt, das den Test beschreibt. |
testMetrics | |
testLogs |
Kehrt zurück | |
---|---|
Der Satz neu generierter Metriken aus den Testmetriken. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Legen Sie ILogSaver
so fest, dass der Implementierer Dateien speichern kann.
Parameter | |
---|---|
logSaver | ILogSaver : der ILogSaver |
aufstellen
public void setUp ()
Überschreiben Sie diese Methode in den untergeordneten Postprozessoren, um sie vor den Testläufen zu initialisieren.
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Wird aufgerufen, wenn ein Atomtest meldet, dass er eine falsche Bedingung annimmt
Parameter | |
---|---|
test | TestDescription : Identifiziert den Test |
trace | String : Stack-Trace des Fehlers |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Wird aufgerufen, wenn ein Atomtest meldet, dass er eine falsche Bedingung annimmt
Parameter | |
---|---|
test | TestDescription : Identifiziert den Test |
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))
wo wir die Endzeit direkt angeben können. Für eine genaue Messung mit testStarted(com.android.tradefed.result.TestDescription, long)
kombinieren.
Parameter | |
---|---|
test | TestDescription : Identifiziert den Test |
endTime | long : Die Zeit, zu der der Test endete, gemessen über System.currentTimeMillis() |
testMetrics | ERROR(/Map) der ausgegebenen Metriken |
testEnded
public final void testEnded (TestDescription test,testMetrics)
Meldet das Ausführungsende eines einzelnen Testfalls.
Wenn testFailed(TestDescription, FailureDescription)
nicht aufgerufen wurde, wurde dieser Test bestanden. Gibt außerdem alle Schlüssel-/Wertmetriken zurück, die möglicherweise während der Ausführung des Testfalls ausgegeben wurden.
Parameter | |
---|---|
test | TestDescription : Identifiziert den Test |
testMetrics | ERROR(/Map) der ausgegebenen Metriken |
im Test durchgefallen
public final void testFailed (TestDescription test, FailureDescription failure)
Meldet den Fehler eines einzelnen Testfalls.
Wird zwischen testStarted und testEnded aufgerufen.
Parameter | |
---|---|
test | TestDescription : Identifiziert den Test |
failure | FailureDescription : FailureDescription , die den Fehler und seinen Kontext beschreibt. |
im Test durchgefallen
public final void testFailed (TestDescription test, String trace)
Meldet den Fehler eines einzelnen Testfalls.
Wird zwischen testStarted und testEnded aufgerufen.
Parameter | |
---|---|
test | TestDescription : Identifiziert den Test |
trace | String : Stack-Trace des Fehlers |
testIgnored
public final void testIgnored (TestDescription test)
Wird aufgerufen, wenn ein Test nicht ausgeführt wird, im Allgemeinen, weil eine Testmethode mit org.junit.Ignore annotiert ist.
Parameter | |
---|---|
test | TestDescription : Identifiziert den Test |
testLog
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Verwenden Sie diese Methode, um eine Datei aus der PostProcessor-Implementierung zu protokollieren.
Parameter | |
---|---|
dataName | String : ein String der den Namen der Daten beschreibt. zB „device_logcat“. Beachten Sie, dass dataName pro Aufruf möglicherweise nicht eindeutig ist. Das heißt, Implementierer müssen in der Lage sein, mehrere Aufrufe mit demselben Datennamen zu verarbeiten |
dataType | LogDataType : der LogDataType der Daten |
dataStream | InputStreamSource : die InputStreamSource der Daten. Implementierer sollten createInputStream aufrufen, um mit dem Lesen der Daten zu beginnen, und sicherstellen, dass der resultierende InputStream nach Abschluss geschlossen wird. Aufrufer sollten sicherstellen, dass die Datenquelle vorhanden und zugänglich bleibt, bis die testLog-Methode abgeschlossen ist. |
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 der den Namen der Daten beschreibt. zB „device_logcat“. Beachten Sie, dass dataName pro Aufruf möglicherweise nicht eindeutig ist. Das heißt, Implementierer müssen in der Lage sein, mehrere Aufrufe mit demselben Datennamen zu verarbeiten |
dataType | LogDataType : der LogDataType der Daten |
dataStream | InputStreamSource : die InputStreamSource der Daten. Implementierer sollten createInputStream aufrufen, um mit dem Lesen der Daten zu beginnen, und sicherstellen, dass der resultierende InputStream nach Abschluss geschlossen wird. |
logFile | LogFile : Das LogFile , das die Metadaten der gespeicherten Datei enthält. |
testModuleEnded
public final void testModuleEnded ()
Meldet das Ende eines Modullaufs.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Meldet den Beginn der Ausführung eines Moduls. Dieser Rückruf ist mit testModuleEnded()
verknüpft und in der Sequenz optional. Es wird nur während eines Laufs verwendet, der Module verwendet: Suite-basierte Läufer.
Parameter | |
---|---|
moduleContext | IInvocationContext : der IInvocationContext des Moduls. |
testRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
Meldet das Ende des Testlaufs. FIXME: Wir können nicht zwei Map<>-Schnittstellen mit unterschiedlichem Typ haben, daher müssen wir hier HashMap verwenden.
Parameter | |
---|---|
elapsedTime | long : Vom Gerät gemeldete verstrichene Zeit in Millisekunden |
runMetrics | Metric gemeldet werden. |
testRunFailed
public final void testRunFailed (FailureDescription failure)
Der Testlauf des Berichts konnte aufgrund eines in FailureDescription
beschriebenen Fehlers nicht abgeschlossen werden.
Parameter | |
---|---|
failure | FailureDescription : FailureDescription , die den Fehler und seinen Kontext beschreibt. |
testRunFailed
public final void testRunFailed (String errorMessage)
Der Testlauf des Berichts konnte aufgrund eines schwerwiegenden Fehlers nicht abgeschlossen werden.
Parameter | |
---|---|
errorMessage | String : String , der den Grund für den Ausführungsfehler beschreibt. |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber)
Meldet den Start eines Testlaufs.
Parameter | |
---|---|
runName | String : der Name des Testlaufs |
testCount | int : Gesamtzahl der Tests im Testlauf |
attemptNumber | int : Auftragsnummer, die die verschiedenen Versuche desselben runName identifiziert, die mehrmals ausgeführt werden. Die tryNumber ist 0-indiziert und sollte bei jedem neuen Lauf erhöht werden. Beispielsweise wird ein Test granular dreimal wiederholt, es sollten insgesamt 4 Ausführungen unter demselben runName erfolgen und die Versuchsnummer liegt zwischen 0 und 3. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
Testlauf-Rückrufe
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 Start eines Testlaufs.
Parameter | |
---|---|
runName | String : der Name des Testlaufs |
testCount | int : Gesamtzahl der Tests im Testlauf |
attemptNumber | int : Auftragsnummer, die die verschiedenen Versuche desselben runName identifiziert, die mehrmals ausgeführt werden. Die tryNumber ist 0-indiziert und sollte bei jedem neuen Lauf erhöht werden. Beispielsweise wird ein Test granular dreimal wiederholt, es sollten insgesamt 4 Ausführungen unter demselben runName erfolgen und die Versuchsnummer liegt zwischen 0 und 3. |
startTime | long : Die Zeit, zu der der Lauf gestartet wurde, gemessen über System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
Der Testlauf des Berichts wurde aufgrund einer Benutzeranfrage vor Abschluss abgebrochen.
TODO: derzeit nicht verwendet, erwägen Sie die Entfernung
Parameter | |
---|---|
elapsedTime | long : Vom Gerät gemeldete verstrichene Zeit in Millisekunden |
testgestartet
public final void testStarted (TestDescription test, long startTime)
Alternative zu testStarted(com.android.tradefed.result.TestDescription)
, wo wir auch angeben, wann der Test gestartet wurde, kombiniert mit ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
für eine genaue Messung .
Parameter | |
---|---|
test | TestDescription : Identifiziert den Test |
startTime | long : Die Zeit, zu der der Test gestartet wurde, gemessen über System.currentTimeMillis() |
testgestartet
public final void testStarted (TestDescription test)
Rückrufe von Testfällen
Parameter | |
---|---|
test | TestDescription : Identifiziert den Test |
Geschützte Methoden
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Überschreiben Sie diese Methode, um den Metriktyp bei Bedarf zu ändern. Standardmäßig ist die Metrik auf den verarbeiteten Typ eingestellt.
Kehrt zurück | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Kehrt zurück | |
---|---|
String |