BasePostProcessor
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
java.lang.Object | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
Podstawowa IPostProcessor
, którą powinna rozszerzać każda implementacja. Upewnij się, że post
metody przetwarzania są wywoływane przed raportami o ostatecznych wynikach.
Podsumowanie
Konstruktory publiczne | |
---|---|
BasePostProcessor()
|
Metody publiczne | |
---|---|
final
ITestInvocationListener
|
init(ITestInvocationListener listener)
Krok inicjowania procesora post. |
final
void
|
invocationEnded(long elapsedTime)
Raportuje, że wywołanie zostało zakończone (prawidłowo lub z powodu błędu) . |
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)
Detektory wywołań na potrzeby przekazywania |
final
boolean
|
isDisabled()
Zwraca wartość Prawda, jeśli cały obiekt jest wyłączony (pomiń zarówno konfigurację, jak i dezaktywację). |
final
void
|
logAssociation(String dataName, LogFile logFile)
W niektórych przypadkach zapis musi być silnie powiązany z przypadkami testowymi, ale mieć możliwość
więc w przypadku sprzedaży bezpośredniej Aktualizuje powiązanie logu z testem. |
|
processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,
Zaimplementuj tę metodę, aby agregować wskaźniki i logi ze wszystkich testów. |
abstract
|
processRunMetricsAndLogs(
Zaimplementuj tę metodę, aby wygenerować zestaw nowych danych na podstawie dotychczasowych danych oraz dzienników. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Zaimplementuj tę metodę, aby publikować wskaźniki i logi procesów z każdego testu. |
final
void
|
setLogSaver(ILogSaver logSaver)
Ustaw |
void
|
setUp()
Zastąp tę metodę w podrzędnych procesorach postowych, aby zainicjować ją przed uruchomieniem testu. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Wywoływane, gdy flagi testów atomowych wskazują, że przyjmuje się warunek o wartości fałszywego |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Wywoływane, gdy flagi testów atomowych wskazują, że przyjmuje się warunek o wartości fałszywego |
final
void
|
testEnded(TestDescription test, long endTime,
Alternatywa dla parametru |
final
void
|
testEnded(TestDescription test,
Raportuje koniec wykonania danego 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, zazwyczaj dlatego, że metoda testowa jest oznaczona adnotacją org.junit.Ignoruj. |
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 testowego. |
final
void
|
testModuleEnded()
Raportuje zakończenie działania modułu. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
Raportuje początek uruchomionego modułu. |
final
void
|
testRunEnded(long elapsedTime,
Koniec przebiegu testowego raportów. |
final
void
|
testRunFailed(FailureDescription failure)
Nie udało się wykonać testu raportów z powodu błędu opisanego w |
final
void
|
testRunFailed(String errorMessage)
Nie udało się wykonać testu raportów z powodu błędu krytycznego. |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Raportuje rozpoczęcie testu. |
final
void
|
testRunStarted(String runName, int testCount)
Testuj wywołania zwrotne |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Raportuje rozpoczęcie testu. |
final
void
|
testRunStopped(long elapsedTime)
Test raportów został zatrzymany przed ukończeniem na prośbę użytkownika. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Wywoływane, gdy test został pominięty i nie został wykonany z przyczyn, które zwykle nie są oczekiwane. |
final
void
|
testStarted(TestDescription test, long startTime)
Alternatywa dla parametru |
final
void
|
testStarted(TestDescription test)
Wywołania zwrotne przypadków testowych |
Metody chronione | |
---|---|
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 procesora post. Upewnij się, że ma zostać wywołana przed jakimkolwiek testem .
Parametry | |
---|---|
listener |
ITestInvocationListener |
Zwroty | |
---|---|
ITestInvocationListener |
Zakończenie wywołania
public final void invocationEnded (long elapsedTime)
Raportuje, że wywołanie zostało zakończone (prawidłowo lub z powodu błędu) .
będzie automatycznie wywoływana przez platformę federacji handlowej.
Parametry | |
---|---|
elapsedTime |
long : czas, jaki upłynął wywołania w milisekundach, |
Błąd wywołania
public final void invocationFailed (FailureDescription failure)
Zgłasza niepełne wywołanie z powodu błędu.
będzie automatycznie wywoływana przez platformę federacji handlowej.
Parametry | |
---|---|
failure |
FailureDescription : FailureDescription opisujący przyczynę błędu; |
Błąd wywołania
public final void invocationFailed (Throwable cause)
Zgłasza niepełne wywołanie z powodu błędu.
będzie automatycznie wywoływana przez platformę federacji handlowej.
Parametry | |
---|---|
cause |
Throwable : przyczyna błędu (Throwable ). |
Wywołanie pominięte
public void invocationSkipped (SkipReason reason)
Zgłasza wywołanie jako pominięte
Parametry | |
---|---|
reason |
SkipReason |
Rozpoczęcie wywoływania
public final void invocationStarted (IInvocationContext context)
Detektory wywołań na potrzeby przekazywania
Parametry | |
---|---|
context |
IInvocationContext : informacje o wywołaniu. |
Wyłączono
public final boolean isDisabled ()
Zwraca wartość Prawda, jeśli cały obiekt jest wyłączony (pomiń zarówno konfigurację, jak i dezaktywację). W przeciwnym razie ma wartość Fałsz.
Zwroty | |
---|---|
boolean |
powiązanie_logowania
public final void logAssociation (String dataName, LogFile logFile)
W niektórych przypadkach zapis musi być silnie powiązany z przypadkami testowymi, ale mieć możliwość
więc w przypadku sprzedaży bezpośredniej testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
oddzwanianie jest niemożliwe. Dzięki temu to wywołanie zwrotne umożliwia utworzenie silnego powiązania
bezpośrednio.
Aktualizuje powiązanie logu z testem. Jeśli ta metoda zostanie wywołana podczas testu, należy do testu; W przeciwnym razie będzie to dziennik uruchomienia.
Parametry | |
---|---|
dataName |
String : nazwa danych |
logFile |
LogFile : LogFile , który został zarejestrowany wcześniej i powinny być powiązany z parametrem
dla danego przypadku testowego. |
przetwarzaj wszystkieWskaźnikiTestówAndLogi
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Zaimplementuj tę metodę, aby agregować wskaźniki i logi ze wszystkich testów. Dane z: ta metoda będzie raporterem jako wskaźnikiem uruchomienia. Należy tylko nowo wygenerowane dane z unikalną nazwą klucza (kolizja z istniejącymi kluczami nie jest dozwolona).
Parametry | |
---|---|
allTestMetrics |
ListMultimap : mapa HashMultimapy przechowująca wskaźniki z każdego testu pogrupowane według danych
nazw. |
allTestLogs |
: mapa przechowująca mapę plików dziennika z każdego testu z zapisanymi kluczami nazw danych,
używając TestDescription każdego testu jako kluczy. |
Zwroty | |
---|---|
|
Zbiór nowo wygenerowanych wskaźników ze wszystkich testowych wskaźników. |
Wskaźniki i logi procesów
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Zaimplementuj tę metodę, aby wygenerować zestaw nowych danych na podstawie dotychczasowych danych oraz dzienników. Zwracane powinny być tylko nowo wygenerowane dane z unikalną nazwą klucza (nie kolizja z istniejącymi kluczami jest dozwolona).
Parametry | |
---|---|
rawMetrics |
: zestaw nieprzetworzonych danych dostępnych na potrzeby uruchomienia. |
runLogs |
: zbiór plików dziennika na potrzeby uruchomienia testowego. |
Zwroty | |
---|---|
|
Zbiór nowo wygenerowanych wskaźników na podstawie wskaźników biegowych. |
procesTestWskaźnikiandLogi
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Zaimplementuj tę metodę, aby publikować wskaźniki i logi procesów z każdego testu. Tylko nowe powinny zostać zwrócone dane z unikalną nazwą klucza (bez konfliktu z istniejącymi ).
Parametry | |
---|---|
testDescription |
TestDescription : obiekt TestDescription opisujący test. |
testMetrics |
: zbiór danych z testu. |
testLogs |
: zbiór plików zarejestrowanych podczas testu. |
Zwroty | |
---|---|
|
Zbiór nowo wygenerowanych wskaźników na podstawie wskaźników testowych. |
setLogSaver (Zapisywanie zdarzeń setLogSaver)
public final void setLogSaver (ILogSaver logSaver)
Ustaw ILogSaver
, aby umożliwić implementatorowi zapisywanie plików.
Parametry | |
---|---|
logSaver |
ILogSaver : ILogSaver |
Konfiguracja
public void setUp ()
Zastąp tę metodę w podrzędnych procesorach postowych, aby zainicjować ją przed uruchomieniem testu.
Niepowodzenie testuZałożenia Niepowodzeń
public final void testAssumptionFailure (TestDescription test, String trace)
Wywoływane, gdy flagi testów atomowych wskazują, że przyjmuje się warunek o wartości fałszywego
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
trace |
String : zrzut stosu niepowodzenia |
Niepowodzenie testuZałożenia Niepowodzeń
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Wywoływane, gdy flagi testów atomowych wskazują, że przyjmuje się warunek o wartości fałszywego
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
failure |
FailureDescription : FailureDescription opisujący błąd i jego kontekst. |
testZakończony
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternatywa dla parametru ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
, w którym można określić godzinę zakończenia
bezpośrednio. Aby uzyskać dokładny pomiar, połącz go z polem testStarted(com.android.tradefed.result.TestDescription, long)
.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
endTime |
long : czas zakończenia testu (mierzony w polu System.currentTimeMillis() ). |
testMetrics |
: ERROR(/Map) wysłanych wskaźników |
testZakończony
public final void testEnded (TestDescription test,testMetrics)
Raportuje koniec wykonania danego przypadku testowego.
Jeśli funkcja testFailed(TestDescription, FailureDescription)
nie została wywołana, test zaliczony. Zwraca również dowolną parę klucz/wartość
wskaźniki, które mogły zostać wyemitowane podczas wykonywania przypadku testowego.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
testMetrics |
: ERROR(/Map) wysłanych wskaźników |
Niepowodzenie testu
public final void testFailed (TestDescription test, FailureDescription failure)
Zgłasza niepowodzenie pojedynczego przypadku testowego.
Jest wywoływana między testStarted a testEnded.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
failure |
FailureDescription : FailureDescription opisujący błąd i jego kontekst. |
Niepowodzenie testu
public final void testFailed (TestDescription test, String trace)
Zgłasza niepowodzenie pojedynczego przypadku testowego.
Jest wywoływana między testStarted a testEnded.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
trace |
String : zrzut stosu niepowodzenia |
testignorowany
public final void testIgnored (TestDescription test)
Wywoływana, gdy test nie zostanie uruchomiony, zazwyczaj dlatego, że metoda testowa jest oznaczona adnotacją org.junit.Ignoruj.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
dziennik testów
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”. Notatka
Wartość dataName nie może być unikalna na każdym wywołaniu. Oznacza to, że implementujący muszą być w stanie obsłużyć
wiele wywołań z tą samą wartością dataName |
dataType |
LogDataType : element LogDataType danych |
dataStream |
InputStreamSource : element InputStreamSource danych. Implementatorzy powinni wywołać
createInputStream, aby zacząć odczytywać dane i upewnić się, że
Strumień wejściowy po zakończeniu. Rozmówca powinien zadbać o to, aby źródło danych było nadal źródłem danych.
obecny i dostępny do chwili zakończenia działania metody testLog. |
testLogSaved
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Wywoływane po zapisaniu dziennika testowego.
Powinien być używany zamiast ITestInvocationListener#testLog(String, LogDataType,
InputStreamSource)
.
Parametry | |
---|---|
dataName |
String : opisowa nazwa danych typu String . np. „device_logcat”. Notatka
Wartość dataName nie może być unikalna na każdym wywołaniu. Oznacza to, że implementujący muszą być w stanie obsłużyć
wiele wywołań z tą samą wartością dataName |
dataType |
LogDataType : element LogDataType danych |
dataStream |
InputStreamSource : element InputStreamSource danych. Implementatorzy powinni wywołać
createInputStream, aby zacząć odczytywać dane i upewnić się, że
Strumień wejściowy po zakończeniu. |
logFile |
LogFile : pole LogFile zawierające metadane zapisanego pliku. |
Zakończono moduł testowy
public final void testModuleEnded ()
Raportuje zakończenie działania modułu.
Początek modułu testowania
public final void testModuleStarted (IInvocationContext moduleContext)
Raportuje początek uruchomionego modułu. To wywołanie zwrotne jest powiązane z usługą testModuleEnded()
i jest opcjonalne w sekwencji. Używa się go tylko podczas biegu, w którym
moduły: aplikacje biegowe oparte na pakiecie.
Parametry | |
---|---|
moduleContext |
IInvocationContext : element IInvocationContext modułu. |
Zakończono bieg testowy
public final void testRunEnded (long elapsedTime,runMetrics)
Koniec przebiegu testowego raportów. NAPRAWDŹ: nie możemy mieć dwóch map<> z interfejsami różnego typu. musimy użyć Skrótu HashMap.
Parametry | |
---|---|
elapsedTime |
long : czas, który upłynął od urządzenia, w milisekundach |
runMetrics |
: pary klucz-wartość raportowane po zakończeniu testu z użyciem Metric . |
Niepowodzenie testu uruchomienia
public final void testRunFailed (FailureDescription failure)
Nie udało się wykonać testu raportów z powodu błędu opisanego w FailureDescription
.
Parametry | |
---|---|
failure |
FailureDescription : FailureDescription opisujący błąd i jego kontekst. |
Niepowodzenie testu uruchomienia
public final void testRunFailed (String errorMessage)
Nie udało się wykonać testu raportów z powodu błędu krytycznego.
Parametry | |
---|---|
errorMessage |
String : String z opisem przyczyny niepowodzenia uruchomienia. |
Uruchomiono test
public final void testRunStarted (String runName, int testCount, int attemptNumber)
Raportuje rozpoczęcie testu.
Parametry | |
---|---|
runName |
String : nazwa uruchomienia testu |
testCount |
int : łączna liczba testów w teście |
attemptNumber |
int : numer zamówienia identyfikujący różne próby wykonania tej samej wartości runName
uruchamianych wiele razy. Liczba próbek jest indeksowana 0 i powinna być większa za każdym razem.
nowy bieg. np. Test został ponowiony po 3 próbach. Łącznie powinien przypadać 4 razy
działa w ramach tej samej nazwy runName, a parametr orderNumber mieści się w zakresie od 0 do 3. |
Uruchomiono test
public final void testRunStarted (String runName, int testCount)
Testuj wywołania zwrotne
Parametry | |
---|---|
runName |
String : nazwa uruchomienia testu |
testCount |
int : łączna liczba testów w teście |
Uruchomiono test
public final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
Raportuje rozpoczęcie testu.
Parametry | |
---|---|
runName |
String : nazwa uruchomienia testu |
testCount |
int : łączna liczba testów w teście |
attemptNumber |
int : numer zamówienia identyfikujący różne próby wykonania tej samej wartości runName
uruchamianych wiele razy. Wartość orderNumber jest indeksowana o wartości 0 i powinna rosnąć za każdym razem, gdy
nowego uruchomienia. np. Test został ponowiony po 3 próbach. Powinien on mieć łącznie 4 uruchomienia.
w tej samej wartości runName, a parametr phishingNumber mieści się w zakresie od 0 do 3. |
startTime |
long : czas rozpoczęcia uruchomienia (mierzony w polu System.currentTimeMillis() ). |
Zatrzymano uruchomienie testu
public final void testRunStopped (long elapsedTime)
Test raportów został zatrzymany przed ukończeniem na prośbę użytkownika.
DO ZROBIENIA: obecnie nieużywane, rozważ usunięcie
Parametry | |
---|---|
elapsedTime |
long : czas, który upłynął od urządzenia, w milisekundach |
testPominięto
public final void testSkipped (TestDescription test, SkipReason reason)
Wywoływane, gdy test został pominięty i nie został wykonany z przyczyn, które zwykle nie są oczekiwane. W tych testach zostaną ponowione próby przeprowadzenia prawidłowego wykonania.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
reason |
SkipReason : SkipReason |
testStarted (rozpoczęto test)
public final void testStarted (TestDescription test, long startTime)
Alternatywa dla parametru testStarted(com.android.tradefed.result.TestDescription)
, gdzie również określamy, kiedy test został przeprowadzony
w połączeniu z parametrem ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
, aby uzyskać dokładny pomiar.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
startTime |
long : czas rozpoczęcia testu (określony za pomocą parametru System.currentTimeMillis() ). |
testStarted (rozpoczęto test)
public final void testStarted (TestDescription test)
Wywołania zwrotne przypadków testowych
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
Metody chronione
czyszczenie
protected void cleanUp ()
getMetricType
protected MetricMeasurement.DataType getMetricType ()
W razie potrzeby zastąp tę metodę, aby zmienić typ danych. Domyślnie dane są ustawione na .
Zwroty | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Zwroty | |
---|---|
String |