BasePostProcesor
public abstract class BasePostProcessor
extends Object
implements IPostProcessor
java.lang.Object | |
com.android.tradefed.postprocessor.BasePostProcessor |
Podstawowy IPostProcessor
, który powinna rozszerzać każda implementacja. Upewnij się, że metody przetwarzania końcowego są wywoływane przed raportami końcowymi.
Streszczenie
Konstruktorzy publiczni | |
---|---|
BasePostProcessor () |
Metody publiczne | |
---|---|
final ITestInvocationListener | init ( ITestInvocationListener listener) Etap inicjalizacji postprocesora. |
final void | invocationEnded (long elapsedTime) Informuje, że wywołanie zostało zakończone pomyślnie lub z powodu błędu. |
final void | invocationFailed ( FailureDescription failure) Zgłasza niekompletne wywołanie z powodu jakiegoś błędu. |
final void | invocationFailed (Throwable cause) Zgłasza niekompletne wywołanie z powodu jakiegoś błędu. |
final void | invocationStarted ( IInvocationContext context) Odbiorniki wywołania do przekazywania |
final boolean | isDisabled () Zwraca True, jeśli cały obiekt jest wyłączony (pomiń zarówno konfigurację, jak i usuwanie). |
final void | logAssociation (String dataName, LogFile logFile) W niektórych przypadkach dziennik musi być silnie powiązany z przypadkami testowymi, ale możliwość zrobienia tego w bezpośrednim Aktualizuje powiązanie dziennika z testem. |
processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) Zaimplementuj tę metodę, aby agregować metryki i dzienniki we wszystkich testach. | |
abstract | processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) Zaimplementuj tę metodę, aby wygenerować zestaw nowych metryk z istniejących metryk i dzienników. |
processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) Zaimplementuj tę metodę, aby publikować metryki procesu i dzienniki z każdego testu. | |
final void | setLogSaver ( ILogSaver logSaver) Ustaw |
void | setUp () Zastąp tę metodę w postprocesorach podrzędnych, aby zainicjować przed uruchomieniem testu. |
final void | testAssumptionFailure ( TestDescription test, String trace) Wywoływane, gdy atomowy test oznaczy, że przyjmuje warunek, który jest fałszywy |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) Wywoływane, gdy atomowy test oznaczy, że przyjmuje warunek, który jest fałszywy |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) Alternatywa dla |
final void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) Raportuje zakończenie wykonywania pojedynczego przypadku testowego. |
final void | testFailed ( TestDescription test, FailureDescription failure) Zgłasza niepowodzenie pojedynczego przypadku testowego. |
final void | testFailed ( TestDescription test, String trace) Zgłasza niepowodzenie pojedynczego przypadku testowego. |
final void | testIgnored ( TestDescription test) Wywoływana, gdy test nie zostanie uruchomiony, zwykle dlatego, że metoda testowa ma adnotację org.junit.Ignore. |
final void | testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) Użyj tej metody, aby zarejestrować plik z implementacji PostProcessor. |
final void | testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile) Wywoływane po zapisaniu dziennika testów. |
final void | testModuleEnded () Zgłasza koniec uruchomienia modułu. |
final void | testModuleStarted ( IInvocationContext moduleContext) Zgłasza początek działania modułu. |
final void | testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) Raportuje koniec uruchomienia testowego. |
final void | testRunFailed ( FailureDescription failure) Testowanie raportów nie powiodło się z powodu błędu opisanego przez |
final void | testRunFailed (String errorMessage) Testowanie raportów nie powiodło się z powodu błędu krytycznego. |
final void | testRunStarted (String runName, int testCount, int attemptNumber) Raportuje początek uruchomienia testowego. |
final void | testRunStarted (String runName, int testCount) Testowe wywołania zwrotne |
final void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Raportuje początek uruchomienia testowego. |
final void | testRunStopped (long elapsedTime) Raporty, że uruchomienie testowe zostało zatrzymane przed zakończeniem z powodu żądania użytkownika. |
final void | testStarted ( TestDescription test, long startTime) Alternatywa dla |
final void | testStarted ( TestDescription test) Przypadki testowe wywołania zwrotne |
Metody chronione | |
---|---|
MetricMeasurement.DataType | getMetricType () Zastąp tę metodę, aby w razie potrzeby zmienić typ metryki. |
String | getRunName () |
Konstruktorzy publiczni
BasePostProcesor
public BasePostProcessor ()
Metody publiczne
w tym
public final ITestInvocationListener init (ITestInvocationListener listener)
Etap inicjalizacji postprocesora. Upewniono się, że zostanie wywołane przed wywołaniami zwrotnymi testów.
Parametry | |
---|---|
listener | ITestInvocationListener |
Zwroty | |
---|---|
ITestInvocationListener |
inwokacjaZakończona
public final void invocationEnded (long elapsedTime)
Informuje, że wywołanie zostało zakończone pomyślnie lub z powodu błędu.
Zostanie automatycznie wywołany przez platformę TradeFederation.Parametry | |
---|---|
elapsedTime | long : czas trwania wywołania w ms |
wywołanie nie powiodło się
public final void invocationFailed (FailureDescription failure)
Zgłasza niekompletne wywołanie z powodu jakiegoś błędu.
Zostanie automatycznie wywołany przez platformę TradeFederation.
Parametry | |
---|---|
failure | FailureDescription : FailureDescription opisujący przyczynę niepowodzenia |
wywołanie nie powiodło się
public final void invocationFailed (Throwable cause)
Zgłasza niekompletne wywołanie z powodu jakiegoś błędu.
Zostanie automatycznie wywołany przez platformę TradeFederation.Parametry | |
---|---|
cause | Throwable : Throwable przyczyna niepowodzenia |
wywołanieRozpoczęto
public final void invocationStarted (IInvocationContext context)
Odbiorniki wywołania do przekazywania
Parametry | |
---|---|
context | IInvocationContext : informacje o wywołaniu |
jest niepełnosprawny
public final boolean isDisabled ()
Zwraca True, jeśli cały obiekt jest wyłączony (pomiń zarówno konfigurację, jak i usuwanie). W przeciwnym razie fałsz.
Zwroty | |
---|---|
boolean |
logAssociation
public final void logAssociation (String dataName, LogFile logFile)
W niektórych przypadkach dziennik musi być silnie powiązany z przypadkami testowymi, ale możliwość zrobienia tego w bezpośrednim testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
nie jest możliwe. Tak więc to wywołanie zwrotne umożliwia jawne zapewnienie silnego skojarzenia.
Aktualizuje powiązanie dziennika z testem. Jeśli ta metoda zostanie wywołana podczas testu, dziennik należy do testu; w przeciwnym razie będzie to dziennik uruchomienia.
Parametry | |
---|---|
dataName | String : nazwa danych |
logFile | LogFile : LogFile , który został wcześniej zarejestrowany i powinien być powiązany z przypadkiem testowym. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Zaimplementuj tę metodę, aby agregować metryki i dzienniki we wszystkich testach. Metryki wychodzące z tej metody będą raportowane jako dane uruchomieniowe. Powinny zostać zwrócone tylko nowo wygenerowane metryki z unikalną nazwą klucza (nie dopuszcza się kolizji z istniejącymi kluczami).
Parametry | |
---|---|
allTestMetrics | ListMultimap : HashMultimap przechowujący metryki z każdego testu pogrupowane według nazw metryk. |
allTestLogs | TestDescription każdego testu jako kluczy. |
Zwroty | |
---|---|
Zestaw nowo wygenerowanych metryk ze wszystkich metryk testowych. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Zaimplementuj tę metodę, aby wygenerować zestaw nowych metryk z istniejących metryk i dzienników. Powinny zostać zwrócone tylko nowo wygenerowane metryki z unikalną nazwą klucza (nie dopuszcza się kolizji z istniejącymi kluczami).
Parametry | |
---|---|
rawMetrics | |
runLogs |
Zwroty | |
---|---|
Zestaw nowo wygenerowanych metryk z metryk uruchomienia. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Zaimplementuj tę metodę, aby publikować metryki procesu i dzienniki z każdego testu. Powinny zostać zwrócone tylko nowo wygenerowane metryki z unikalną nazwą klucza (nie dopuszcza się kolizji z istniejącymi kluczami).
Parametry | |
---|---|
testDescription | TestDescription : obiekt TestDescription opisujący test. |
testMetrics | |
testLogs |
Zwroty | |
---|---|
Zestaw nowo wygenerowanych metryk z metryk testowych. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Ustaw ILogSaver
, aby umożliwić implementatorowi zapisywanie plików.
Parametry | |
---|---|
logSaver | ILogSaver : ILogSaver |
organizować coś
public void setUp ()
Zastąp tę metodę w postprocesorach podrzędnych, aby zainicjować przed uruchomieniem testu.
testZałożenieNiepowodzenie
public final void testAssumptionFailure (TestDescription test, String trace)
Wywoływane, gdy atomowy test oznaczy, że przyjmuje warunek, który jest fałszywy
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
trace | String : ślad stosu awarii |
testZałożenieNiepowodzenie
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Wywoływane, gdy atomowy test oznaczy, że przyjmuje warunek, który jest fałszywy
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
failure | FailureDescription : FailureDescription opisująca niepowodzenie i jego kontekst. |
testZakończony
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternatywa dla ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
gdzie możemy bezpośrednio określić czas zakończenia. Połącz z testStarted(com.android.tradefed.result.TestDescription, long)
aby uzyskać dokładny pomiar.
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
endTime | long : czas zakończenia testu, mierzony za pomocą System.currentTimeMillis() |
testMetrics | ERROR(/Map) emitowanych metryk |
testZakończony
public final void testEnded (TestDescription test,testMetrics)
Raportuje zakończenie wykonywania pojedynczego przypadku testowego.
Jeśli testFailed(TestDescription, FailureDescription)
nie został wywołany, ten test zakończył się pomyślnie. Zwraca również wszelkie metryki klucz/wartość, które mogły zostać wyemitowane podczas wykonywania przypadku testowego.
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
testMetrics | ERROR(/Map) emitowanych metryk |
Test nieudany
public final void testFailed (TestDescription test, FailureDescription failure)
Zgłasza niepowodzenie pojedynczego przypadku testowego.
Zostanie wywołana między testStarted i testEnded.
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
failure | FailureDescription : FailureDescription opisująca niepowodzenie i jego kontekst. |
Test nieudany
public final void testFailed (TestDescription test, String trace)
Zgłasza niepowodzenie pojedynczego przypadku testowego.
Zostanie wywołana między testStarted i testEnded.
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
trace | String : ślad stosu awarii |
testIgnorowane
public final void testIgnored (TestDescription test)
Wywoływana, gdy test nie zostanie uruchomiony, zwykle dlatego, że metoda testowa ma adnotację org.junit.Ignore.
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
testLog
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Użyj tej metody, aby zarejestrować plik z implementacji PostProcessor.
Parametry | |
---|---|
dataName | String : opisowa nazwa danych typu String . np. „device_logcat”. Uwaga dataName może nie być unikatowa na wywołanie. tj. realizatorzy muszą być w stanie obsłużyć wiele wywołań z tą samą nazwą data |
dataType | LogDataType : LogDataType danych |
dataStream | InputStreamSource : InputStreamSource danych. Realizatorzy powinni wywołać metodę createInputStream, aby rozpocząć odczytywanie danych i zapewnić zamknięcie wynikowego InputStream po zakończeniu. Wywołujący powinien upewnić się, że źródło danych pozostaje obecne i dostępne do momentu zakończenia metody testLog. |
testLogZapisano
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Wywoływane po zapisaniu dziennika testów.
Należy używać zamiast ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)
.
Parametry | |
---|---|
dataName | String : opisowa nazwa danych typu String . np. „device_logcat”. Uwaga dataName może nie być unikatowa na wywołanie. tj. realizatorzy muszą być w stanie obsłużyć wiele wywołań z tą samą nazwą data |
dataType | LogDataType : LogDataType danych |
dataStream | InputStreamSource : InputStreamSource danych. Realizatorzy powinni wywołać metodę createInputStream, aby rozpocząć odczytywanie danych i zapewnić zamknięcie wynikowego InputStream po zakończeniu. |
logFile | LogFile : LogFile zawierający metadane zapisanego pliku. |
testModułZakończony
public final void testModuleEnded ()
Zgłasza koniec uruchomienia modułu.
testModułUruchomiony
public final void testModuleStarted (IInvocationContext moduleContext)
Zgłasza początek działania modułu. To wywołanie zwrotne jest powiązane z testModuleEnded()
i jest opcjonalne w sekwencji. Jest używany tylko podczas biegu, który używa modułów: biegaczy opartych na pakiecie.
Parametry | |
---|---|
moduleContext | IInvocationContext : IInvocationContext modułu. |
TestUruchomionyZakończony
public final void testRunEnded (long elapsedTime,runMetrics)
Raportuje koniec uruchomienia testowego. FIXME: Nie możemy mieć dwóch interfejsów Map<> o różnych typach, więc musimy tutaj użyć HashMap.
Parametry | |
---|---|
elapsedTime | long : urządzenie zgłosiło czas, który upłynął, w milisekundach |
runMetrics | Metric . |
TestUruchomie się nie powiódł
public final void testRunFailed (FailureDescription failure)
Testowanie raportów nie powiodło się z powodu błędu opisanego przez FailureDescription
.
Parametry | |
---|---|
failure | FailureDescription : FailureDescription opisująca niepowodzenie i jego kontekst. |
TestUruchomie się nie powiódł
public final void testRunFailed (String errorMessage)
Testowanie raportów nie powiodło się z powodu błędu krytycznego.
Parametry | |
---|---|
errorMessage | String : String opisujący przyczynę niepowodzenia uruchomienia. |
testUruchomiony
public final void testRunStarted (String runName, int testCount, int attemptNumber)
Raportuje początek uruchomienia testowego.
Parametry | |
---|---|
runName | String : nazwa uruchomienia testowego |
testCount | int : całkowita liczba testów w przebiegu testowym |
attemptNumber | int : numer porządkowy, identyfikujący różne próby tego samego runName, które są uruchamiane wiele razy. PróbaNumber jest indeksowana 0 i powinna zwiększać się za każdym razem, gdy nastąpi nowe uruchomienie. Np. Test jest powtarzany 3 razy na poziomie granularnym, powinien mieć łącznie 4 przebiegi pod tą samą nazwą runName, a numer próby wynosi od 0 do 3. |
testUruchomiony
public final void testRunStarted (String runName, int testCount)
Testowe wywołania zwrotne
Parametry | |
---|---|
runName | String : nazwa uruchomienia testowego |
testCount | int : całkowita liczba testów w przebiegu testowym |
testUruchomiony
public final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
Raportuje początek uruchomienia testowego.
Parametry | |
---|---|
runName | String : nazwa uruchomienia testowego |
testCount | int : całkowita liczba testów w przebiegu testowym |
attemptNumber | int : numer porządkowy, identyfikujący różne próby tego samego runName, które są uruchamiane wiele razy. PróbaNumber jest indeksowana 0 i powinna zwiększać się za każdym razem, gdy nastąpi nowe uruchomienie. Np. Test jest powtarzany 3 razy na poziomie granularnym, powinien mieć łącznie 4 przebiegi pod tą samą nazwą runName, a numer próby wynosi od 0 do 3. |
startTime | long : czas rozpoczęcia biegu, mierzony za pomocą System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
Raporty, że uruchomienie testowe zostało zatrzymane przed zakończeniem z powodu żądania użytkownika.
TODO: obecnie nieużywane, rozważ usunięcie
Parametry | |
---|---|
elapsedTime | long : urządzenie zgłosiło czas, który upłynął, w milisekundach |
testRozpoczęto
public final void testStarted (TestDescription test, long startTime)
Alternatywa dla testStarted(com.android.tradefed.result.TestDescription)
, gdzie określamy również, kiedy test został uruchomiony, w połączeniu z ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
dla dokładnego pomiaru .
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
startTime | long : czas rozpoczęcia testu, mierzony za pomocą System.currentTimeMillis() |
testRozpoczęto
public final void testStarted (TestDescription test)
Przypadki testowe wywołania zwrotne
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
Metody chronione
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Zastąp tę metodę, aby w razie potrzeby zmienić typ metryki. Domyślnie metryka jest ustawiona na typ przetworzony.
Zwroty | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Zwroty | |
---|---|
String |