BasePostProcessor
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
java.lang.Object | |
😎 | com.android.tradefed.postprocessor.BasePostProcessor |
Die Basis-IPostProcessor
, die jede Implementierung erweitern soll. Achten Sie darauf, dass der Beitrag
vor den Reportern des Endergebnisses aufgerufen.
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, ob erfolgreich oder aufgrund eines Fehlers . |
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. |
void
|
invocationSkipped(SkipReason reason)
Meldet einen Aufruf als übersprungen |
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 Teardown überspringen). |
final
void
|
logAssociation(String dataName, LogFile logFile)
In einigen Fällen muss das Protokoll eng mit Testfällen verknüpft sein, aber es besteht die Möglichkeit,
also zum direkten Aktualisiert die Zuordnung von Log zu Test. |
|
processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,
Implementieren Sie diese Methode, um Messwerte und Logs für alle Tests zu aggregieren. |
abstract
|
processRunMetricsAndLogs(
Implementieren Sie diese Methode, um eine Reihe neuer Messwerte aus den vorhandenen Messwerten zu generieren. Logs. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Implementieren Sie diese Methode, um Prozessmesswerte und Logs von jedem Test zu posten. |
final
void
|
setLogSaver(ILogSaver logSaver)
Legen Sie |
void
|
setUp()
Überschreiben Sie diese Methode in den untergeordneten Postprozessoren, um sie vor dem Test zu initialisieren. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Wird aufgerufen, wenn ein Atomtest meldet, dass eine Bedingung falsch ist |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Wird aufgerufen, wenn ein Atomtest meldet, dass eine Bedingung falsch ist |
final
void
|
testEnded(TestDescription test, long endTime,
Alternative zu |
final
void
|
testEnded(TestDescription test,
Meldet das Ausführungsende eines einzelnen Testlaufs. |
final
void
|
testFailed(TestDescription test, FailureDescription failure)
Meldet das Scheitern eines einzelnen Testlaufs. |
final
void
|
testFailed(TestDescription test, String trace)
Meldet das Scheitern eines einzelnen Testlaufs. |
final
void
|
testIgnored(TestDescription test)
Wird aufgerufen, wenn ein Test nicht ausgeführt wird. Dies ist im Allgemeinen der Fall, weil eine Testmethode mit org.junit.Ignorieren. |
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 beim Speichern des Testprotokolls aufgerufen. |
final
void
|
testModuleEnded()
Meldet das Ende einer Modulausführung. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
Meldet den Beginn eines laufenden Moduls. |
final
void
|
testRunEnded(long elapsedTime,
Ende des Testlaufs für Berichte. |
final
void
|
testRunFailed(FailureDescription failure)
Der Testlauf für Berichte konnte aufgrund eines von |
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 Start eines Testlaufs. |
final
void
|
testRunStarted(String runName, int testCount)
Testlauf-Callbacks |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Meldet den Start eines Testlaufs. |
final
void
|
testRunStopped(long elapsedTime)
Der Testlauf für Berichte wurde aufgrund einer Nutzeranfrage vor dem Abschluss gestoppt. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Wird aufgerufen, wenn ein Test übersprungen und aus einem normalerweise nicht erwarteten Grund nicht ausgeführt wurde. |
final
void
|
testStarted(TestDescription test, long startTime)
Alternative zu |
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. Muss vor den Tests aufgerufen werden Callbacks angegeben werden.
Parameter | |
---|---|
listener |
ITestInvocationListener |
Returns | |
---|---|
ITestInvocationListener |
Aufrufende beendet
public final void invocationEnded (long elapsedTime)
Meldet, dass der Aufruf beendet wurde, ob erfolgreich oder aufgrund eines Fehlers .
Wird automatisch vom TradeFederation-Framework aufgerufen.
Parameter | |
---|---|
elapsedTime |
long : die verstrichene Zeit des Aufrufs in ms |
CallFailed (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 |
CallFailed (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 |
callSkipped
public void invocationSkipped (SkipReason reason)
Meldet einen Aufruf als übersprungen
Parameter | |
---|---|
reason |
SkipReason |
callStarted
public final void invocationStarted (IInvocationContext context)
Aufruf-Listener für die Weiterleitung
Parameter | |
---|---|
context |
IInvocationContext : Informationen zum Aufruf |
ist deaktiviert
public final boolean isDisabled ()
Gibt "True" zurück, wenn das gesamte Objekt deaktiviert ist (Einrichtung und Teardown überspringen). Andernfalls „false“.
Returns | |
---|---|
boolean |
LogAssociation
public final void logAssociation (String dataName, LogFile logFile)
In einigen Fällen muss das Protokoll eng mit Testfällen verknüpft sein, aber es besteht die Möglichkeit,
also zum direkten testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
Callback ist nicht möglich. Dieser Callback ermöglicht also eine starke Assoziation
explizit auf.
Aktualisiert die Zuordnung von Log zu Test. Wenn diese Methode während eines Tests aufgerufen wird, gehört zum Test; Andernfalls ist es ein Ausführungsprotokoll.
Parameter | |
---|---|
dataName |
String : der Name der Daten |
logFile |
LogFile : LogFile , die zuvor protokolliert wurde und mit dem
Testfall. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Implementieren Sie diese Methode, um Messwerte und Logs für alle Tests zu aggregieren. Messwerte, die aus Diese Methode ist Reporter als Ausführungsmesswerte. Nur die neu generierten Messwerte sollten zurückgegeben und mit einem eindeutigen Schlüsselnamen (keine Kollision mit vorhandenen Schlüsseln ist zulässig).
Parameter | |
---|---|
allTestMetrics |
ListMultimap : HashMultimap, in dem die Messwerte aus jedem Test nach Messwerten gruppiert werden
Namen. |
allTestLogs |
: Eine Zuordnung, die die Zuordnung der Protokolldateien für jeden Test, die nach Datennamen geordnet sind, speichert.
Dabei werden die TestDescription der einzelnen Tests als Schlüssel verwendet. |
Returns | |
---|---|
|
Die neu generierten Messwerte aus allen Testmesswerten. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Implementieren Sie diese Methode, um eine Reihe neuer Messwerte aus den vorhandenen Messwerten zu generieren. Logs. Nur die neu generierten Messwerte sollten mit einem eindeutigen Schlüsselnamen (keine Konflikte mit vorhandenen Schlüsseln sind zulässig.
Parameter | |
---|---|
rawMetrics |
: Die für die Ausführung verfügbaren Rohmesswerte. |
runLogs |
: Die Protokolldateien für den Testlauf. |
Returns | |
---|---|
|
Die neu generierten Messwerte aus den Ausführungsmesswerten. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Implementieren Sie diese Methode, um Prozessmesswerte und Logs von jedem Test zu posten. Nur die neuen Die generierten Messwerte sollten mit einem eindeutigen Schlüsselnamen zurückgegeben werden (keine Kollision mit vorhandenen Schlüssel sind zulässig).
Parameter | |
---|---|
testDescription |
TestDescription : Das TestDescription-Objekt, das den Test beschreibt. |
testMetrics |
: Die Messwerte aus dem Test. |
testLogs |
: Die während des Tests protokollierten Dateien. |
Returns | |
---|---|
|
Die 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 |
einrichten
public void setUp ()
Überschreiben Sie diese Methode in den untergeordneten Postprozessoren, um sie vor dem Test zu initialisieren.
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Wird aufgerufen, wenn ein Atomtest meldet, dass eine Bedingung falsch ist
Parameter | |
---|---|
test |
TestDescription : Identifiziert den Test |
trace |
String : Stacktrace des Fehlers |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Wird aufgerufen, wenn ein Atomtest meldet, dass eine Bedingung falsch ist
Parameter | |
---|---|
test |
TestDescription : Identifiziert den Test |
failure |
FailureDescription : FailureDescription , der den Fehler und seinen Kontext beschreibt. |
TestBeendet
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternative zu ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
, wobei das Ende angegeben werden kann
. In Kombination mit testStarted(com.android.tradefed.result.TestDescription, long)
erhalten Sie eine genaue Messung.
Parameter | |
---|---|
test |
TestDescription : Identifiziert den Test |
endTime |
long : die Zeit, zu der der Test beendet wurde, gemessen über System.currentTimeMillis() |
testMetrics |
: ein ERROR(/Map) der ausgegebenen Messwerte |
TestBeendet
public final void testEnded (TestDescription test,testMetrics)
Meldet das Ausführungsende eines einzelnen Testlaufs.
Wenn testFailed(TestDescription, FailureDescription)
nicht aufgerufen wurde, ist dieser Test erfolgreich. Gibt auch beliebige Schlüssel/Wert-Paare zurück
Messwerte, die möglicherweise während der Ausführung des Testlaufs ausgegeben wurden.
Parameter | |
---|---|
test |
TestDescription : Identifiziert den Test |
testMetrics |
: ein ERROR(/Map) der ausgegebenen Messwerte |
TestFehlgeschlagen
public final void testFailed (TestDescription test, FailureDescription failure)
Meldet das Scheitern eines einzelnen Testlaufs.
Wird zwischen testStarted und testEnded aufgerufen.
Parameter | |
---|---|
test |
TestDescription : Identifiziert den Test |
failure |
FailureDescription : FailureDescription , der den Fehler und seinen Kontext beschreibt. |
TestFehlgeschlagen
public final void testFailed (TestDescription test, String trace)
Meldet das Scheitern eines einzelnen Testlaufs.
Wird zwischen testStarted und testEnded aufgerufen.
Parameter | |
---|---|
test |
TestDescription : Identifiziert den Test |
trace |
String : Stacktrace des Fehlers |
testIgnoriert
public final void testIgnored (TestDescription test)
Wird aufgerufen, wenn ein Test nicht ausgeführt wird. Dies ist im Allgemeinen der Fall, weil eine Testmethode mit org.junit.Ignorieren.
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 beschreibender String -Name der Daten. z.B. „device_logcat“. Hinweis
dataName darf pro Aufruf nicht eindeutig sein. d. h. Implementierungsteams müssen
Mehrere Aufrufe mit demselben dataName |
dataType |
LogDataType : die LogDataType der Daten |
dataStream |
InputStreamSource : die InputStreamSource der Daten. Implementierungslösungen sollten
createInputStream, um mit dem Lesen der Daten zu beginnen und sicherzustellen, dass das resultierende
InputStream, wenn abgeschlossen ist. Anrufer sollten dafür sorgen, dass die Datenquelle nicht verloren geht.
vorhanden und zugänglich sind, bis die testLog-Methode abgeschlossen ist. |
testLogSaved
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Wird beim Speichern des Testprotokolls aufgerufen.
Sollte anstelle von ITestInvocationListener#testLog(String, LogDataType,
InputStreamSource)
verwendet werden.
Parameter | |
---|---|
dataName |
String : Ein beschreibender String -Name der Daten. z.B. „device_logcat“. Hinweis
dataName darf pro Aufruf nicht eindeutig sein. d. h. Implementierungsteams müssen
Mehrere Aufrufe mit demselben dataName |
dataType |
LogDataType : die LogDataType der Daten |
dataStream |
InputStreamSource : die InputStreamSource der Daten. Implementierungslösungen sollten
createInputStream, um mit dem Lesen der Daten zu beginnen und sicherzustellen, dass das resultierende
InputStream, wenn abgeschlossen ist. |
logFile |
LogFile : LogFile mit den Metadaten der gespeicherten Datei |
TestModulBeendet
public final void testModuleEnded ()
Meldet das Ende einer Modulausführung.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Meldet den Beginn eines laufenden Moduls. Dieser Callback ist testModuleEnded()
zugeordnet und in der Sequenz optional. Es wird nur während einer Ausführung verwendet, bei der
Module: Suite-basierte Runner.
Parameter | |
---|---|
moduleContext |
IInvocationContext : IInvocationContext des Moduls. |
testRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
Ende des Testlaufs für Berichte. PROBLEM: Es können nicht zwei Karten verwendet werden.<> mit unterschiedlichen Typen. Wir müssen hier HashMap verwenden.
Parameter | |
---|---|
elapsedTime |
long : Gerät hat die verstrichene Zeit in Millisekunden gemeldet |
runMetrics |
: Schlüssel/Wert-Paare, die am Ende eines Testlaufs mit Metric gemeldet werden. |
testRunFailed (Testlauf fehlgeschlagen)
public final void testRunFailed (FailureDescription failure)
Der Testlauf für Berichte konnte aufgrund eines von FailureDescription
beschriebenen Fehlers nicht abgeschlossen werden.
Parameter | |
---|---|
failure |
FailureDescription : FailureDescription , der den Fehler und seinen Kontext beschreibt. |
testRunFailed (Testlauf fehlgeschlagen)
public final void testRunFailed (String errorMessage)
Der Testlauf für Berichte konnte aufgrund eines schwerwiegenden Fehlers nicht abgeschlossen werden.
Parameter | |
---|---|
errorMessage |
String : String , die 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 der Testausführung |
testCount |
int : Gesamtzahl der Tests im Testlauf |
attemptNumber |
int : Bestellnummer, die die verschiedenen Versuche desselben runName-Elements identifiziert
die mehrmals ausgeführt werden. Die "tryNumber" ist 0-indexiert und muss jedes Mal erhöht werden.
eine neue Ausführung stattfindet. z.B. Ein Test ist detailliert 3-mal wiederholt und sollte insgesamt 4 Mal wiederholt werden.
unter demselben runName-Wert ausgeführt,
und der Wert liegt zwischen 0 und 3. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
Testlauf-Callbacks
Parameter | |
---|---|
runName |
String : der Name der Testausführung |
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 der Testausführung |
testCount |
int : Gesamtzahl der Tests im Testlauf |
attemptNumber |
int : Bestellnummer, die die verschiedenen Versuche desselben runName-Elements identifiziert
die mehrmals ausgeführt werden. Die "tryNumber" ist 0-indexiert und sollte jedes Mal erhöht werden, wenn ein
neue Ausführung stattfindet. z.B. Ein Test ist detailliert 3-mal wiederholt und sollte insgesamt 4 Durchläufe umfassen.
„runName“ und die „tryNumber“ liegt zwischen 0 und 3. |
startTime |
long : der Zeitpunkt, zu dem die Ausführung gestartet wurde, gemessen über System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
Der Testlauf für Berichte wurde aufgrund einer Nutzeranfrage vor dem Abschluss gestoppt.
AUFGABE: Derzeit nicht verwendet, entfernen Sie eventuell
Parameter | |
---|---|
elapsedTime |
long : Gerät hat die verstrichene Zeit in Millisekunden gemeldet |
TestSkipped
public final void testSkipped (TestDescription test, SkipReason reason)
Wird aufgerufen, wenn ein Test übersprungen und aus einem normalerweise nicht erwarteten Grund nicht ausgeführt wurde. Es wird versucht, diese Tests zu wiederholen, um eine ordnungsgemäße Ausführung zu erzielen.
Parameter | |
---|---|
test |
TestDescription : Identifiziert den Test |
reason |
SkipReason : SkipReason |
testgestartet
public final void testStarted (TestDescription test, long startTime)
Alternative zu testStarted(com.android.tradefed.result.TestDescription)
, wobei auch der Zeitpunkt des Tests angegeben wird
gestartet, in Kombination mit ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
für eine genaue Messung.
Parameter | |
---|---|
test |
TestDescription : Identifiziert den Test |
startTime |
long : der Zeitpunkt, zu dem der Test gestartet wurde, gemessen über System.currentTimeMillis() |
testgestartet
public final void testStarted (TestDescription test)
Testlauf-Callbacks
Parameter | |
---|---|
test |
TestDescription : Identifiziert den Test |
Geschützte Methoden
CleanUp
protected void cleanUp ()
GetMetric-Typ
protected MetricMeasurement.DataType getMetricType ()
Überschreiben Sie diese Methode, um den Messwerttyp bei Bedarf zu ändern. Standardmäßig ist der Messwert auf verarbeiteten Typ.
Returns | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Returns | |
---|---|
String |