BasePostProcessor
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
| java.lang.Object | |
| ↳ | com.android.tradefed.postprocessor.BasePostProcessor |
Klasa bazowa IPostProcessor, którą powinna rozszerzać każda implementacja. Sprawdź, czy metody przetwarzania końcowego są wywoływane przed reporterami wyników końcowych.
Podsumowanie
Publiczne konstruktory | |
|---|---|
BasePostProcessor()
|
|
Metody publiczne | |
|---|---|
final
ITestInvocationListener
|
init(ITestInvocationListener listener)
Etap inicjowania postprocesora. |
final
void
|
invocationEnded(long elapsedTime)
Informuje, że wywołanie zostało zakończone, niezależnie od tego, czy zakończyło się ono pomyślnie, czy z powodu błędu. |
final
void
|
invocationFailed(FailureDescription failure)
Zgłasza niekompletne wywołanie z powodu błędu. |
final
void
|
invocationFailed(Throwable cause)
Zgłasza niekompletne wywołanie z powodu błędu. |
void
|
invocationSkipped(SkipReason reason)
Zgłasza wywołanie jako pominięte |
final
void
|
invocationStarted(IInvocationContext context)
Odbiorniki wywołań do przekazywania |
final
boolean
|
isDisabled()
Zwraca wartość Prawda, jeśli cały obiekt jest wyłączony (pomija zarówno konfigurację, jak i czyszczenie). |
final
void
|
logAssociation(String dataName, LogFile logFile)
W niektórych przypadkach dziennik musi być ściśle powiązany z przypadkami testowymi, ale nie można tego zrobić w bezpośrednim wywołaniu zwrotnym Aktualizuje powiązanie logu z testem. |
|
processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,
Zaimplementuj tę metodę, aby agregować dane i logi ze wszystkich testów. |
abstract
|
processRunMetricsAndLogs(
Zaimplementuj tę metodę, aby wygenerować zestaw nowych rodzajów danych na podstawie dotychczasowych rodzajów danych i logów. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Zaimplementuj tę metodę, aby przetwarzać dane i dzienniki z każdego testu. |
final
void
|
setLogSaver(ILogSaver logSaver)
Ustaw |
void
|
setUp()
Zastąp tę metodę w procesorach końcowych podrzędnych, aby zainicjować ją przed uruchomieniem testu. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Wywoływana, gdy test atomowy zgłosi, że zakłada warunek, który jest fałszywy |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Wywoływana, gdy test atomowy zgłosi, że zakłada warunek, który jest fałszywy |
final
void
|
testEnded(TestDescription test, long endTime,
Alternatywa dla |
final
void
|
testEnded(TestDescription test,
Zgłasza zakończenie wykonania 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 jest opatrzona 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ływana po zapisaniu dziennika testu. |
final
void
|
testModuleEnded()
Zgłasza zakończenie działania modułu. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
Zgłasza rozpoczęcie działania modułu. |
final
void
|
testRunEnded(long elapsedTime,
Raport na koniec testu. |
final
void
|
testRunFailed(FailureDescription failure)
Nie udało się dokończyć testu raportów z powodu błędu opisanego w |
final
void
|
testRunFailed(String errorMessage)
Nie udało się ukończyć testu raportów z powodu błędu krytycznego. |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Zgłasza 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)
Zgłasza rozpoczęcie testu. |
final
void
|
testRunStopped(long elapsedTime)
Testowe uruchomienie raportów zostało zatrzymane przed zakończeniem na prośbę użytkownika. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Wywoływana, gdy test jest pomijany i nie jest wykonywany z przyczyny, która zwykle nie jest oczekiwana. |
final
void
|
testStarted(TestDescription test, long startTime)
Alternatywa dla |
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()
|
Publiczne konstruktory
BasePostProcessor
public BasePostProcessor ()
Metody publiczne
init
public final ITestInvocationListener init (ITestInvocationListener listener)
Etap inicjowania postprocesora. Wywoływana przed wszystkimi wywołaniami zwrotnymi testów.
| Parametry | |
|---|---|
listener |
ITestInvocationListener |
| Zwroty | |
|---|---|
ITestInvocationListener |
|
invocationEnded
public final void invocationEnded (long elapsedTime)
Informuje, że wywołanie zostało zakończone, niezależnie od tego, czy zakończyło się ono pomyślnie, czy z powodu błędu.
Zostanie automatycznie wywołana przez platformę TradeFederation.
| Parametry | |
|---|---|
elapsedTime |
long: czas trwania wywołania w milisekundach |
invocationFailed
public final void invocationFailed (FailureDescription failure)
Zgłasza niekompletne wywołanie z powodu błędu.
Zostanie automatycznie wywołana przez platformę TradeFederation.
| Parametry | |
|---|---|
failure |
FailureDescription: FailureDescription opisujący przyczynę niepowodzenia |
invocationFailed
public final void invocationFailed (Throwable cause)
Zgłasza niekompletne wywołanie z powodu błędu.
Zostanie automatycznie wywołana przez platformę TradeFederation.
| Parametry | |
|---|---|
cause |
Throwable: Throwable przyczyna niepowodzenia |
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łań do przekazywania
| Parametry | |
|---|---|
context |
IInvocationContext: informacje o wywołaniu, |
isDisabled
public final boolean isDisabled ()
Zwraca wartość Prawda, jeśli cały obiekt jest wyłączony (pomija zarówno konfigurację, jak i czyszczenie). W przeciwnym razie ma wartość Fałsz.
| Zwroty | |
|---|---|
boolean |
|
logAssociation
public final void logAssociation (String dataName,
LogFile logFile)W niektórych przypadkach dziennik musi być ściśle powiązany z przypadkami testowymi, ale nie można tego zrobić w bezpośrednim wywołaniu zwrotnym 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 określić silne powiązanie.
Aktualizuje powiązanie logu z testem. Jeśli ta metoda jest wywoływana 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ł zarejestrowany wcześniej i powinien być powiązany z przypadkiem testowym. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Zaimplementuj tę metodę, aby agregować dane i logi ze wszystkich testów. Dane pochodzące z tej metody będą raportowane jako dane dotyczące uruchomienia. Zwracane powinny być tylko nowo wygenerowane dane z niepowtarzalną nazwą klucza (nie można używać nazw kluczy, które już istnieją).
| Parametry | |
|---|---|
allTestMetrics |
ListMultimap: HashMultimap przechowujący dane z każdego testu pogrupowane według nazw danych. |
allTestLogs |
: mapa przechowująca mapę plików dziennika każdego testu, której klucze są nazwami danych,
a kluczami są TestDescription każdego testu. |
| Zwroty | |
|---|---|
|
Zbiór nowo wygenerowanych wskaźników ze wszystkich wskaźników testu. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Zaimplementuj tę metodę, aby wygenerować zestaw nowych rodzajów danych na podstawie dotychczasowych rodzajów danych i logów. Zwracane powinny być tylko nowo wygenerowane dane z niepowtarzalną nazwą klucza (nie są dozwolone konflikty z istniejącymi kluczami).
| Parametry | |
|---|---|
rawMetrics |
: zestaw surowych danych dostępnych dla danego uruchomienia. |
runLogs |
: Zestaw plików dziennika dla testu. |
| Zwroty | |
|---|---|
|
Zestaw nowo wygenerowanych danych na podstawie danych z biegu. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Zaimplementuj tę metodę, aby przetwarzać dane i dzienniki z każdego testu. Należy zwracać tylko nowo wygenerowane dane z niepowtarzalną nazwą klucza (nie można używać kluczy, które już istnieją).
| Parametry | |
|---|---|
testDescription |
TestDescription: obiekt TestDescription opisujący test. |
testMetrics |
: zestaw danych z testu. |
testLogs |
: Zestaw plików zarejestrowanych podczas testu. |
| Zwroty | |
|---|---|
|
Zbiór nowo wygenerowanych danych na podstawie danych testowych. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Ustaw ILogSaver, aby umożliwić osobie wdrażającej zapisywanie plików.
| Parametry | |
|---|---|
logSaver |
ILogSaver: ILogSaver |
setUp
public void setUp ()
Zastąp tę metodę w procesorach końcowych podrzędnych, aby zainicjować ją przed uruchomieniem testu.
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Wywoływana, gdy test atomowy zgłosi, że zakłada warunek, który jest fałszywy
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test. |
trace |
String: zrzut stosu błędu |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Wywoływana, gdy test atomowy zgłosi, że zakłada warunek, który 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. Łącz z testStarted(com.android.tradefed.result.TestDescription, long), aby uzyskać dokładne pomiary.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test. |
endTime |
long: czas zakończenia testu mierzony za pomocą System.currentTimeMillis() |
testMetrics |
: ERROR(/Map) wyemitowanych wskaźników |
testEnded
public final void testEnded (TestDescription test,testMetrics)
Zgłasza zakończenie wykonania pojedynczego przypadku testowego.
Jeśli funkcja testFailed(TestDescription, FailureDescription) nie została wywołana, test został zaliczony. Zwraca też wszystkie dane klucz/wartość, które mogły zostać wyemitowane podczas wykonywania przypadku testowego.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test. |
testMetrics |
: ERROR(/Map) wyemitowanych wskaźników |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
Zgłasza niepowodzenie pojedynczego przypadku testowego.
Będzie wywoływana między testStarted a 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)
Zgłasza niepowodzenie pojedynczego przypadku testowego.
Będzie wywoływana między testStarted a testEnded.
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test. |
trace |
String: zrzut stosu błędu |
testIgnored
public final void testIgnored (TestDescription test)
Wywoływana, gdy test nie zostanie uruchomiony, zwykle dlatego, że metoda testowa jest opatrzona 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, np. „device_logcat”.String Uwaga: parametr dataName może nie być unikalny w przypadku każdego wywołania. Oznacza to, że osoby wdrażające muszą być w stanie obsłużyć wiele wywołań z tym samym parametrem dataName. |
dataType |
LogDataType: LogDataType danych |
dataStream |
InputStreamSource: InputStreamSource danych. Osoby wdrażające powinny wywołać funkcję createInputStream, aby rozpocząć odczytywanie danych, i po zakończeniu zamknąć wynikowy strumień InputStream. Wywołujący powinni zadbać o to, aby źródło danych było dostępne do momentu zakończenia działania metody testLog. |
testLogSaved
public final void testLogSaved (String dataName,
LogDataType dataType,
InputStreamSource dataStream,
LogFile logFile)Wywoływana po zapisaniu dziennika testu.
Należy go używać zamiast atrybutu ITestInvocationListener.testLog(String, LogDataType,
InputStreamSource).
| Parametry | |
|---|---|
dataName |
String: opisowa nazwa danych, np. „device_logcat”.String Uwaga: parametr dataName może nie być unikalny w przypadku każdego wywołania. Oznacza to, że osoby wdrażające muszą być w stanie obsłużyć wiele wywołań z tym samym parametrem dataName. |
dataType |
LogDataType: LogDataType danych |
dataStream |
InputStreamSource: InputStreamSource danych. Osoby wdrażające powinny wywołać funkcję createInputStream, aby rozpocząć odczytywanie danych, i po zakończeniu zamknąć wynikowy InputStream. |
logFile |
LogFile: LogFile zawierający metadane zapisanego pliku. |
testModuleEnded
public final void testModuleEnded ()
Zgłasza zakończenie działania 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 uruchamiania modułów: narzędzi do uruchamiania opartych na pakietach.
| Parametry | |
|---|---|
moduleContext |
IInvocationContext: IInvocationContext modułu. |
testRunEnded
public final void testRunEnded (long elapsedTime,
runMetrics) Raport na koniec testu.
| Parametry | |
|---|---|
elapsedTime |
long: czas, który upłynął od ostatniego zgłoszenia przez urządzenie (w milisekundach) |
runMetrics |
: pary klucz-wartość zgłaszane na końcu testu |
testRunFailed
public final void testRunFailed (FailureDescription failure)
Nie udało się dokończyć 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ę ukończyć testu raportów z powodu błędu krytycznego.
| Parametry | |
|---|---|
errorMessage |
String: String opisujący przyczynę niepowodzenia uruchomienia. |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber)Zgłasza rozpoczęcie testu.
| Parametry | |
|---|---|
runName |
String: nazwa testu, |
testCount |
int: łączna liczba testów w teście |
attemptNumber |
int: numer zamówienia, który identyfikuje różne próby tego samego parametru runName
wykonywanego wielokrotnie. Wartość attemptNumber jest indeksowana od 0 i powinna zwiększać się za każdym razem, gdy następuje nowe uruchomienie. Przykład: test jest ponownie uruchamiany 3 razy, więc w sumie ma 4 uruchomienia pod tą samą nazwą runName, a wartość attemptNumber wynosi 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 teście |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber,
long startTime)Zgłasza rozpoczęcie testu.
| Parametry | |
|---|---|
runName |
String: nazwa testu, |
testCount |
int: łączna liczba testów w teście |
attemptNumber |
int: numer zamówienia, który identyfikuje różne próby tego samego parametru runName
wykonywanego wielokrotnie. Numer próby jest indeksowany od 0 i powinien zwiększać się za każdym razem, gdy następuje nowe uruchomienie. Na przykład jeśli test jest ponownie uruchamiany 3 razy, powinien mieć łącznie 4 uruchomienia pod tą samą nazwą uruchomienia, a numer próby powinien wynosić od 0 do 3. |
startTime |
long: czas rozpoczęcia biegu mierzony za pomocą System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
Testowe uruchomienie raportów zostało zatrzymane przed zakończeniem na prośbę użytkownika.
TODO: obecnie nieużywane, rozważ usunięcie
| Parametry | |
|---|---|
elapsedTime |
long: czas, który upłynął od ostatniego zgłoszenia przez urządzenie (w milisekundach) |
testSkipped
public final void testSkipped (TestDescription test, SkipReason reason)
Wywoływana, gdy test jest pomijany i nie jest wykonywany z przyczyny, która zwykle nie jest oczekiwana. Te testy będą ponawiane, aby uzyskać prawidłowe wykonanie.
| 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 podajemy też datę rozpoczęcia testu, w połączeniu z 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 mierzony za pomocą System.currentTimeMillis(). |
testStarted
public final void testStarted (TestDescription test)
Wywołania zwrotne przypadków testowych
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test. |
Metody chronione
cleanUp
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 typ przetworzony.
| Zwroty | |
|---|---|
MetricMeasurement.DataType |
|
getRunName
protected String getRunName ()
| Zwroty | |
|---|---|
String |
|