BasePostProcessor
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
| java.lang.Object | |
| ↳ | com.android.tradefed.postprocessor.BasePostProcessor |
Podstawowa implementacja IPostProcessor, którą powinna rozszerzać każda implementacja. Upewnij się, że metody przetwarzania po przetwarzaniu są wywoływane przed metodami raportowania ostatecznych wyników.
Podsumowanie
Konstruktory publiczne | |
|---|---|
BasePostProcessor()
|
|
Metody publiczne | |
|---|---|
final
ITestInvocationListener
|
init(ITestInvocationListener listener)
Krok inicjowania postprocesora. |
final
void
|
invocationEnded(long elapsedTime)
Informuje, że wywołanie zostało zakończone (z powodu błędu lub pomyślnie). |
final
void
|
invocationFailed(FailureDescription failure)
zgłasza niepełne wywołanie z powodu błędu. |
final
void
|
invocationFailed(Throwable cause)
zgłasza niepełne wywołanie z powodu błędu. |
void
|
invocationSkipped(SkipReason reason)
zgłasza wywołanie jako pominięte; |
final
void
|
invocationStarted(IInvocationContext context)
Odbiorniki wywołania do przekierowywania |
final
boolean
|
isDisabled()
Zwraca wartość True, jeśli cały obiekt jest wyłączony (pomijanie konfiguracji i demontażu). |
final
void
|
logAssociation(String dataName, LogFile logFile)
W niektórych przypadkach log musi być silnie powiązany z przypadkami testowymi, ale nie można tego zrobić bezpośrednio w wywołaniu Aktualizuje powiązanie logów z testem. |
|
processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,
Zastosuj tę metodę, aby agregować dane i logi ze wszystkich testów. |
abstract
|
processRunMetricsAndLogs(
Zastosuj tę metodę, aby wygenerować zestaw nowych danych na podstawie dotychczasowych danych i logów. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Zastosuj tę metodę do post-processingu danych i dzienników z każdego testu. |
final
void
|
setLogSaver(ILogSaver logSaver)
Ustaw |
void
|
setUp()
Zastąp tę metodę w post-procesorach podrzędnych, aby zainicjować ją przed uruchomieniem testu. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Wywoływany, gdy test atomowy sygnalizuje, że przyjmuje założenie, że warunek jest fałszywy. |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Wywoływany, gdy test atomowy sygnalizuje, że przyjmuje założenie, że warunek jest fałszywy. |
final
void
|
testEnded(TestDescription test, long endTime,
Alternatywa dla |
final
void
|
testEnded(TestDescription test,
Raportuje zakończenie wykonywania pojedynczego przypadku testowego. |
final
void
|
testFailed(TestDescription test, FailureDescription failure)
Raportuje niepowodzenie pojedynczego przypadku testowego. |
final
void
|
testFailed(TestDescription test, String trace)
Raportuje niepowodzenie pojedynczego przypadku testowego. |
final
void
|
testIgnored(TestDescription test)
Wywoływany, gdy test nie zostanie uruchomiony, zwykle dlatego, że metoda testu jest oznaczona adnotacją org.junit.Ignore. |
final
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
Użyj tej metody, aby zapisać plik z implementacji PostProcessor. |
final
void
|
testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Wywoływany podczas zapisywania dziennika testu. |
final
void
|
testModuleEnded()
Raportuje koniec wykonania modułu. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
zgłasza rozpoczęcie działania modułu. |
final
void
|
testRunEnded(long elapsedTime,
Raportuje zakończenie testu. |
final
void
|
testRunFailed(FailureDescription failure)
Nie udało się przeprowadzić testu raportów z powodu błędu opisanego w |
final
void
|
testRunFailed(String errorMessage)
Nie udało się przeprowadzić testu raportów z powodu krytycznego błędu. |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Raportuje rozpoczęcie testu. |
final
void
|
testRunStarted(String runName, int testCount)
Wywołania zwrotne testu |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Raportuje rozpoczęcie testu. |
final
void
|
testRunStopped(long elapsedTime)
Raporty o testach, które zostały przerwane przed zakończeniem na prośbę użytkownika. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Wywoływany, gdy test jest pomijany i nie jest wykonywany z nieoczekiwanego powodu. |
final
void
|
testStarted(TestDescription test, long startTime)
Alternatywa dla |
final
void
|
testStarted(TestDescription test)
Wywołania zwrotne elementów testowania |
Chronione metody | |
|---|---|
void
|
cleanUp()
|
MetricMeasurement.DataType
|
getMetricType()
W razie potrzeby zastąp tę metodę, aby zmienić typ danych. |
String
|
getRunName()
|
Konstruktory publiczne
BasePostProcessor
public BasePostProcessor ()
Metody publiczne
init
public final ITestInvocationListener init (ITestInvocationListener listener)
Krok inicjowania postprocesora. Jest wywoływany przed każdym wywołaniem zwrotnym testów.
| Parametry | |
|---|---|
listener |
ITestInvocationListener |
| Zwroty | |
|---|---|
ITestInvocationListener |
|
invocationEnded
public final void invocationEnded (long elapsedTime)
Informuje, że wywołanie zostało zakończone (z powodu błędu lub pomyślnie).
Będzie wywoływany automatycznie przez platformę TradeFederation.
| Parametry | |
|---|---|
elapsedTime |
long: upłynął czas wywołania w ms |
invocationFailed
public final void invocationFailed (FailureDescription failure)
zgłasza niepełne wywołanie z powodu błędu.
Będzie wywoływany automatycznie przez platformę TradeFederation.
| Parametry | |
|---|---|
failure |
FailureDescription: FailureDescription opisujący przyczynę niepowodzenia |
invocationFailed
public final void invocationFailed (Throwable cause)
zgłasza niepełne wywołanie z powodu błędu.
Będzie wywoływany automatycznie przez platformę TradeFederation.
| Parametry | |
|---|---|
cause |
Throwable: przyczyna niepowodzenia Throwable |
invocationSkipped
public void invocationSkipped (SkipReason reason)
zgłasza wywołanie jako pominięte;
| Parametry | |
|---|---|
reason |
SkipReason |
invocationStarted
public final void invocationStarted (IInvocationContext context)
Odbiorniki wywołania do przekierowywania
| Parametry | |
|---|---|
context |
IInvocationContext: informacje o wywołaniu; |
isDisabled
public final boolean isDisabled ()
Zwraca wartość True, jeśli cały obiekt jest wyłączony (pomijanie konfiguracji i demontażu). W przeciwnym razie ma wartość Fałsz.
| Zwroty | |
|---|---|
boolean |
|
logAssociation
public final void logAssociation (String dataName,
LogFile logFile)W niektórych przypadkach log musi być silnie powiązany z przypadkami testowymi, ale nie można tego zrobić bezpośrednio w wywołaniu testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile). Dzięki temu wywołaniu zwrotnemu można wyraźnie powiązać dane.
Aktualizuje powiązanie logów z testem. Jeśli ta metoda jest wywoływana podczas testu, to dziennik należy do testu; w przeciwnym razie będzie to dziennik działania.
| 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)
Zastosuj tę metodę, aby agregować dane i logi ze wszystkich testów. Dane z tej metody będą raportowane jako dane dotyczące wykonania. Powinny być zwracane tylko nowo wygenerowane dane z unikalną nazwą klucza (niedozwolone są kolizje z dotychczasowymi kluczami).
| Parametry | |
|---|---|
allTestMetrics |
ListMultimap: tablica HashMultimap przechowująca dane z każdego testu pogrupowane według nazw danych. |
allTestLogs |
: mapa przechowująca mapę plików dziennika każdego testu z kluczami w postaci nazw danych, przy użyciu TestDescription jako kluczy. |
| Zwroty | |
|---|---|
|
Zestaw nowo wygenerowanych danych na podstawie wszystkich danych testowych. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Zastosuj tę metodę, aby wygenerować zestaw nowych danych na podstawie dotychczasowych danych i logów. Powinny być zwracane tylko nowo wygenerowane dane z unikalną nazwą klucza (niedozwolone są kolizje z dotychczasowymi kluczami).
| Parametry | |
|---|---|
rawMetrics |
: zbiór danych wyjściowych dostępnych dla wykonania. |
runLogs |
: zbiór plików dziennika z testu. |
| Zwroty | |
|---|---|
|
Zestaw nowo wygenerowanych danych na podstawie danych z wykonania. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Zastosuj tę metodę do post-processingu danych i dzienników z każdego testu. Powinny być zwracane tylko nowo wygenerowane dane z unikalnym kluczem (niedozwolone są kolizje z dotychczasowymi kluczami).
| Parametry | |
|---|---|
testDescription |
TestDescription: obiekt TestDescription opisujący test. |
testMetrics |
: zbiór danych z testu. |
testLogs |
: zbiór plików zarejestrowanych podczas testu. |
| Zwroty | |
|---|---|
|
Zestaw nowo wygenerowanych danych na podstawie danych testowych. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Ustaw wartość ILogSaver, aby umożliwić implementatorowi zapisywanie plików.
| Parametry | |
|---|---|
logSaver |
ILogSaver: ILogSaver |
setUp
public void setUp ()
Zastąp tę metodę w post-procesorach podrzędnych, aby zainicjować ją przed uruchomieniem testu.
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Wywoływany, gdy test atomowy sygnalizuje, że przyjmuje założenie, że warunek jest fałszywy.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
trace |
String: zrzut stosu błędu |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Wywoływany, gdy test atomowy sygnalizuje, że przyjmuje założenie, że warunek jest fałszywy.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
failure |
FailureDescription: FailureDescription opisujący błąd i jego kontekst. |
testEnded
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternatywa dla ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), w której możemy bezpośrednio określić czas zakończenia. Aby uzyskać dokładne pomiary, połącz je z elementem testStarted(com.android.tradefed.result.TestDescription, long).
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
endTime |
long: czas zakończenia testu mierzony za pomocą funkcji System.currentTimeMillis() |
testMetrics |
: ERROR(/Map) danych wyemitowanych |
testEnded
public final void testEnded (TestDescription test,testMetrics)
Raportuje zakończenie wykonywania pojedynczego przypadku testowego.
Jeśli funkcja testFailed(TestDescription, FailureDescription) nie została wywołana, test się powiedzie. Zwraca też wszystkie dane klucz-wartość, które mogły zostać wyemitowane podczas wykonywania przypadku testowego.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
testMetrics |
: ERROR(/Map) danych wyemitowanych |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
Raportuje niepowodzenie pojedynczego przypadku testowego.
Jest wywoływany między testStarted i testEnded.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
failure |
FailureDescription: FailureDescription opisujący błąd i jego kontekst. |
testFailed
public final void testFailed (TestDescription test, String trace)
Raportuje niepowodzenie pojedynczego przypadku testowego.
Jest wywoływany między testStarted i testEnded.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
trace |
String: zrzut stosu błędu |
testIgnored
public final void testIgnored (TestDescription test)
Wywoływany, gdy test nie zostanie uruchomiony, zwykle dlatego, że metoda testu jest oznaczona 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 zapisać plik z implementacji PostProcessor.
| Parametry | |
|---|---|
dataName |
String: Stringnazwa opisowa danych, np. „device_logcat”. Uwaga: nazwa danych może nie być unikalna dla każdego wywołania. Oznacza to, że implementatorzy muszą mieć możliwość obsługi wielu wywołań z tą samą nazwą danych. |
dataType |
LogDataType: LogDataType danych |
dataStream |
InputStreamSource: InputStreamSource danych. Implementatorzy powinni wywołać createInputStream, aby rozpocząć odczytywanie danych, i upewnić się, że zamkną powstały strumień wejściowy po zakończeniu. Osoby wywołujące tę metodę powinny zadbać o to, aby źródło danych było dostępne do momentu zakończenia metody testLog. |
testLogSaved
public final void testLogSaved (String dataName,
LogDataType dataType,
InputStreamSource dataStream,
LogFile logFile)Wywoływany podczas zapisywania dziennika testu.
Należy go używać zamiast atrybutu ITestInvocationListener.testLog(String, LogDataType,
InputStreamSource).
| Parametry | |
|---|---|
dataName |
String: Stringnazwa opisowa danych, np. „device_logcat”. Uwaga:Nazwa danych może nie być unikalna dla każdego wywołania. Implementatorzy muszą mieć możliwość obsługi wielu wywołań z tą samą nazwą danych. |
dataType |
LogDataType: LogDataType danych |
dataStream |
InputStreamSource: InputStreamSource danych. Implementatorzy powinni wywołać metodę createInputStream, aby rozpocząć odczytywanie danych, i zadbać o jej zamknięcie po zakończeniu. |
logFile |
LogFile: LogFile zawierający metadane zapisanego pliku. |
testModuleEnded
public final void testModuleEnded ()
Raportuje koniec wykonania modułu.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
zgłasza rozpoczęcie działania modułu. To wywołanie zwrotne jest powiązane z testModuleEnded() i jest opcjonalne w sekwencji. Jest używany tylko podczas wykonywania testu, który korzysta z modułów: modułów opartych na zestawach.
| Parametry | |
|---|---|
moduleContext |
IInvocationContext: IInvocationContext modułu. |
testRunEnded
public final void testRunEnded (long elapsedTime,
runMetrics) Raportuje zakończenie testu.
| Parametry | |
|---|---|
elapsedTime |
long: czas upłynął, milisekundy zgłoszone przez urządzenie |
runMetrics |
: pary klucz-wartość zgłoszone na końcu wykonania testu |
testRunFailed
public final void testRunFailed (FailureDescription failure)
Nie udało się przeprowadzić testu raportów z powodu błędu opisanego w FailureDescription.
| Parametry | |
|---|---|
failure |
FailureDescription: FailureDescription opisujący błąd i jego kontekst. |
testRunFailed
public final void testRunFailed (String errorMessage)
Nie udało się przeprowadzić testu raportów z powodu krytycznego błędu.
| Parametry | |
|---|---|
errorMessage |
String: String opisujący przyczynę niepowodzenia wykonania. |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber)Raportuje rozpoczęcie testu.
| Parametry | |
|---|---|
runName |
String: nazwa testu; |
testCount |
int: łączna liczba testów w sesji testowej |
attemptNumber |
int: numer zamówienia, który identyfikuje różne próby tego samego runName, które są wykonywane wielokrotnie. attemptNumber jest indeksowany od 0 i powinien zwiększać się za każdym razem, gdy następuje nowe wykonanie. Przykład: test jest szczegółowo powtarzany 3 razy, więc powinien mieć łącznie 4 wykonania pod tym samym runName, a attemptNumber będzie miał wartość od 0 do 3. |
testRunStarted
public final void testRunStarted (String runName,
int testCount)Wywołania zwrotne testu
| Parametry | |
|---|---|
runName |
String: nazwa testu; |
testCount |
int: łączna liczba testów w sesji testowej |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber,
long startTime)Raportuje rozpoczęcie testu.
| Parametry | |
|---|---|
runName |
String: nazwa testu; |
testCount |
int: łączna liczba testów w sesji testowej |
attemptNumber |
int: numer zamówienia, który identyfikuje różne próby tego samego runName, które są wykonywane wielokrotnie. attemptNumber ma indeks 0 i powinien zwiększać się za każdym razem, gdy następuje nowe uruchomienie. Przykład: test jest szczegółowo powtarzany 3 razy, więc powinien mieć łącznie 4 uruchomienia pod tym samym nazwą runName, a wartość attemptNumber powinna się zmieniać od 0 do 3. |
startTime |
long: czas rozpoczęcia wykonywania zadania, mierzony za pomocą System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
Raporty o testach, które zostały przerwane przed zakończeniem na prośbę użytkownika.
TODO: currently unused, consider removing
| Parametry | |
|---|---|
elapsedTime |
long: czas upłynął, milisekundy zgłoszone przez urządzenie |
testSkipped
public final void testSkipped (TestDescription test, SkipReason reason)
Wywoływany, gdy test jest pomijany i nie jest wykonywany z nieoczekiwanego powodu. Te testy zostaną powtórzone, aby sprawdzić, czy tym razem wszystko się uda.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
reason |
SkipReason: SkipReason |
testStarted
public final void testStarted (TestDescription test, long startTime)
Alternatywa dla testStarted(com.android.tradefed.result.TestDescription), w której określamy też, kiedy test się rozpoczął, w połączeniu z ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)), aby uzyskać dokładne wyniki.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
startTime |
long: czas rozpoczęcia testu mierzony za pomocą funkcji System.currentTimeMillis() |
testStarted
public final void testStarted (TestDescription test)
Wywołania zwrotne elementów testowania
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
Chronione metody
cleanUp
protected void cleanUp ()
getMetricType
protected MetricMeasurement.DataType getMetricType ()
W razie potrzeby zastąp tę metodę, aby zmienić typ danych. Domyślnie typ danych jest ustawiony na „przetworzony”.
| Zwroty | |
|---|---|
MetricMeasurement.DataType |
|
getRunName
protected String getRunName ()
| Zwroty | |
|---|---|
String |
|