Procesor BasePost

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Obiekt
↳ 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 raporterami wyników końcowych.

Streszczenie

Konstruktory publiczne

BasePostProcessor ()

Metody publiczne

final ITestInvocationListener init ( ITestInvocationListener listener)

Etap inicjalizacji postprocesora.

final void invocationEnded (long elapsedTime)

Zgłasza, że ​​wywołanie zakończyło się pomyślnie lub 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.

final void invocationStarted ( IInvocationContext context)

Słuchacze wywołań do przekazywania

final boolean isDisabled ()

Zwraca True, jeśli cały obiekt jest wyłączony (pomiń zarówno konfigurację, jak i demontaż).

final void logAssociation (String dataName, LogFile logFile)

W niektórych przypadkach log musi być silnie powiązany z przypadkami testowymi, ale możliwość zrobienia tego na bezpośrednim testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) wywołanie zwrotne nie jest możliwe.

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 ze wszystkich testów.

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 i dzienniki procesu z każdego testu.

final void setLogSaver ( ILogSaver logSaver)

Ustaw ILogSaver , aby umożliwić implementatorowi zapisywanie plików.

void setUp ()

Zastąp tę metodę w postprocesorach potomnych, aby zainicjować je przed uruchomieniem testu.

final void testAssumptionFailure ( TestDescription test, String trace)

Wywoływana, gdy test atomowy oznacza, że ​​zakłada warunek, który jest fałszywy

final void testAssumptionFailure ( TestDescription test, FailureDescription failure)

Wywoływana, gdy test atomowy oznacza, że ​​zakłada warunek, który jest fałszywy

final void testEnded ( TestDescription test, long endTime, testMetrics) 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.

final void testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics)

Zgłasza koniec wykonania pojedynczego przypadku testowego.

final void testFailed ( TestDescription test, FailureDescription failure)

Zgłasza awarię pojedynczego przypadku testowego.

final void testFailed ( TestDescription test, String trace)

Zgłasza awarię 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ływana, gdy zapisywany jest dziennik testu.

final void testModuleEnded ()

Zgłasza koniec uruchomienia modułu.

final void testModuleStarted ( IInvocationContext moduleContext)

Zgłasza początek uruchomionego modułu.

final void testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics)

Zgłasza koniec przebiegu testowego.

final void testRunFailed ( FailureDescription failure)

Przebieg testu raportów nie został ukończony z powodu błędu opisanego przez FailureDescription .

final void testRunFailed (String errorMessage)

Testowanie raportów nie zostało ukończone z powodu błędu krytycznego.

final void testRunStarted (String runName, int testCount, int attemptNumber)

Zgłasza początek przebiegu testowego.

final void testRunStarted (String runName, int testCount)

Testowe wywołania zwrotne

final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)

Zgłasza początek przebiegu testowego.

final void testRunStopped (long elapsedTime)

Przebieg testu raportów został zatrzymany przed zakończeniem z powodu żądania użytkownika.

final void testStarted ( TestDescription test, long startTime)

Alternatywa dla testStarted(com.android.tradefed.result.TestDescription) , gdzie również określamy kiedy test został uruchomiony, w połączeniu z ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) dla dokładnego pomiaru .

final void testStarted ( TestDescription test)

Wywołania zwrotne przypadków testowych

Metody chronione

MetricMeasurement.DataType getMetricType ()

Zastąp tę metodę, aby w razie potrzeby zmienić typ metryki.

String getRunName ()

Konstruktory publiczne

Procesor BasePost

public BasePostProcessor ()

Metody publiczne

w tym

public final ITestInvocationListener init (ITestInvocationListener listener)

Etap inicjalizacji postprocesora. Zapewniono wywołanie przed jakimkolwiek wywołaniem zwrotnym testu.

Parametry
listener ITestInvocationListener

Zwroty
ITestInvocationListener

wywołanie zakończone

public final void invocationEnded (long elapsedTime)

Zgłasza, że ​​wywołanie zakończyło się pomyślnie lub z powodu błędu.

Zostanie automatycznie wywołany przez platformę TradeFederation.

Parametry
elapsedTime long : czas, który upłynął od wywołania w ms

wywołanie nie powiodło się

public final void invocationFailed (FailureDescription failure)

Zgłasza niekompletne wywołanie z powodu 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 błędu.

Zostanie automatycznie wywołany przez platformę TradeFederation.

Parametry
cause Throwable : przyczyna niepowodzenia ERROR(/Throwable)

wywołanie rozpoczęte

public final void invocationStarted (IInvocationContext context)

Słuchacze wywołań 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 demontaż). Fałsz inaczej.

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 możliwość zrobienia tego na bezpośrednim testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) wywołanie zwrotne nie jest możliwe. Zatem to wywołanie zwrotne pozwala jawnie zapewnić silne powiązanie.

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 był wcześniej rejestrowany i powinien być powiązany z przypadkiem testowym.

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

Zaimplementuj tę metodę, aby agregować metryki i dzienniki ze wszystkich testów. Metryki wychodzące z tej metody będą zgłaszane jako metryki przebiegu. Zwracane powinny być tylko nowo wygenerowane metryki z unikalną nazwą klucza (kolizja z istniejącymi kluczami nie jest dozwolona).

Parametry
allTestMetrics ListMultimap : HashMultimap przechowująca metryki z każdego testu pogrupowane według nazw metryk.

allTestLogs : mapa przechowująca mapę plików dziennika każdego testu z kluczami według ich nazw danych, przy użyciu TestDescription każdego testu jako kluczy.

Zwroty
Zestaw nowo wygenerowanych metryk ze wszystkich metryk testowych.

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

Zaimplementuj tę metodę, aby wygenerować zestaw nowych metryk z istniejących metryk i dzienników. Zwracane powinny być tylko nowo wygenerowane metryki z unikalną nazwą klucza (kolizja z istniejącymi kluczami nie jest dozwolona).

Parametry
rawMetrics : zestaw nieprzetworzonych metryk dostępnych dla przebiegu.

runLogs : Zestaw plików dziennika dla przebiegu testowego.

Zwroty
Zestaw nowo wygenerowanych metryk z metryk uruchomienia.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

Zaimplementuj tę metodę, aby publikować metryki i dzienniki procesu z każdego testu. Zwracane powinny być tylko nowo wygenerowane metryki z unikalną nazwą klucza (kolizja z istniejącymi kluczami nie jest dozwolona).

Parametry
testDescription TestDescription : Obiekt TestDescription opisujący test.

testMetrics : zestaw metryk z testu.

testLogs : Zestaw plików zarejestrowanych podczas testu.

Zwroty
Zestaw nowo wygenerowanych metryk z metryk testowych.

ustawLogSaver

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 potomnych, aby zainicjować je przed uruchomieniem testu.

testZałożenieNiepowodzenie

public final void testAssumptionFailure (TestDescription test, 
                String trace)

Wywoływana, gdy test atomowy oznacza, że ​​zakłada 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ływana, gdy test atomowy oznacza, że ​​zakłada warunek, który jest fałszywy

Parametry
test TestDescription : identyfikuje test

failure FailureDescription : FailureDescription opisujący błąd i jego kontekst.

test zakoń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ą ERROR(/System#currentTimeMillis())

testMetrics : ERROR(/Map) emitowanych metryk

test zakończony

public final void testEnded (TestDescription test, 
                 testMetrics)

Zgłasza koniec wykonania pojedynczego przypadku testowego.

Jeśli testFailed(TestDescription, FailureDescription) nie został wywołany, ten test zakończył się pomyślnie. Zwraca również wszelkie metryki klucza/wartości, 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 awarię pojedynczego przypadku testowego.

Zostanie wywołany między testStarted a testEnded.

Parametry
test TestDescription : identyfikuje test

failure FailureDescription : FailureDescription opisujący błąd i jego kontekst.

Test nieudany

public final void testFailed (TestDescription test, 
                String trace)

Zgłasza awarię pojedynczego przypadku testowego.

Zostanie wywołany między testStarted a testEnded.

Parametry
test TestDescription : identyfikuje test

trace String : ślad stosu awarii

zignorowano test

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

dziennik testowy

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 ERROR(/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ą danych

dataType LogDataType : LogDataType danych

dataStream InputStreamSource : InputStreamSource danych. Implementatorzy powinni wywoływać metodę createInputStream, aby rozpocząć odczytywanie danych, i upewnić się, że wynikowy InputStream zostanie zamknięty po zakończeniu. Obiekty wywołujące powinny upewnić się, że źródło danych pozostaje obecne i dostępne do czasu zakończenia metody testLog.

testLogZapisano

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

Wywoływana, gdy zapisywany jest dziennik testu.

Powinien być używany zamiast ITestInvocationListener#testLog(String, LogDataType, InputStreamSource) .

Parametry
dataName String : opisowa nazwa danych ERROR(/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ą danych

dataType LogDataType : LogDataType danych

dataStream InputStreamSource : InputStreamSource danych. Implementatorzy powinni wywoływać metodę createInputStream, aby rozpocząć odczytywanie danych, i upewnić się, że wynikowy InputStream zostanie zamknięty po zakończeniu.

logFile LogFile : LogFile zawierający metadane zapisanego pliku.

testModuleEnd

public final void testModuleEnded ()

Zgłasza koniec uruchomienia modułu.

moduł testowyrozpoczęty

public final void testModuleStarted (IInvocationContext moduleContext)

Zgłasza początek uruchomionego modułu. To wywołanie zwrotne jest powiązane z testModuleEnded() i jest opcjonalne w sekwencji. Jest używany tylko podczas biegu, który korzysta z modułów: biegaczy opartych na pakietach.

Parametry
moduleContext IInvocationContext : IInvocationContext modułu.

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

Zgłasza koniec przebiegu testowego. FIXME: Nie możemy mieć dwóch różnych interfejsów Map<>, więc musimy tutaj użyć HashMap.

Parametry
elapsedTime long : czas, który upłynął od urządzenia, w milisekundach

runMetrics : pary klucz-wartość zgłaszane na koniec przebiegu testu z Metric .

testRunNie powiodło się

public final void testRunFailed (FailureDescription failure)

Przebieg testu raportów nie został ukończony z powodu błędu opisanego przez FailureDescription .

Parametry
failure FailureDescription : FailureDescription opisujący błąd i jego kontekst.

testRunNie powiodło się

public final void testRunFailed (String errorMessage)

Testowanie raportów nie zostało ukończone z powodu błędu krytycznego.

Parametry
errorMessage String : ERROR(/String) opisujący przyczynę niepowodzenia uruchomienia.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

Zgłasza początek przebiegu testowego.

Parametry
runName String : nazwa uruchomienia testu

testCount int : całkowita liczba testów w przebiegu testu

attemptNumber int : numer zamówienia, identyfikujący różne próby tej samej nazwy 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 ponawiany 3 razy w trybie granularnym, powinien mieć łącznie 4 przebiegi pod tą samą nazwą uruchomienia, a numer próby wynosi od 0 do 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Testowe wywołania zwrotne

Parametry
runName String : nazwa uruchomienia testu

testCount int : całkowita liczba testów w przebiegu testu

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

Zgłasza początek przebiegu testowego.

Parametry
runName String : nazwa uruchomienia testu

testCount int : całkowita liczba testów w przebiegu testu

attemptNumber int : numer zamówienia, identyfikujący różne próby tej samej nazwy 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 ponawiany 3 razy w trybie granularnym, powinien mieć łącznie 4 przebiegi pod tą samą nazwą uruchomienia, a numer próby wynosi od 0 do 3.

startTime long : czas rozpoczęcia przebiegu, mierzony za pomocą ERROR(/System#currentTimeMillis())

testRunZatrzymany

public final void testRunStopped (long elapsedTime)

Przebieg testu raportów został zatrzymany przed zakończeniem z powodu żądania użytkownika.

DO ZROBIENIA: obecnie nieużywane, rozważ usunięcie

Parametry
elapsedTime long : czas, który upłynął od urządzenia, w milisekundach

testRozpoczęty

public final void testStarted (TestDescription test, 
                long startTime)

Alternatywa dla testStarted(com.android.tradefed.result.TestDescription) , gdzie również określamy 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ą ERROR(/System#currentTimeMillis())

testRozpoczęty

public final void testStarted (TestDescription test)

Wywołania zwrotne przypadków testowych

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

getRunNazwa

protected String getRunName ()

Zwroty
String