Procesor BasePost

public abstract class BasePostProcessor
extends Object implements IPostProcessor

Obiekt Java.lang.Object
↳ com.android.tradefed.postprocessor.BasePostProcessor

Podstawowy IPostProcessor , który każda implementacja powinna rozszerzać. Upewnij się, że metody przetwarzania końcowego są wywoływane przed raportami końcowymi wyników.

Streszczenie

Konstruktorzy publiczni

BasePostProcessor ()

Metody publiczne

final ITestInvocationListener init ( ITestInvocationListener listener)

Etap inicjalizacji postprocesora.

final void invocationEnded (long elapsedTime)

Raportuje, ż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 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 wartość True, jeśli cały obiekt jest wyłączony (pomiń konfigurację i demontaż).

final void logAssociation (String dataName, LogFile logFile)

W niektórych przypadkach log musi być ściśle powiązany z przypadkami testowymi, ale możliwość zrobienia tego bezpośrednio na 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 na podstawie 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 metryki i dzienniki procesu końcowego 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 podrzędnych postprocesorach, aby zainicjować ją przed uruchomieniem testu.

final void testAssumptionFailure ( TestDescription test, String trace)

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

final void testAssumptionFailure ( TestDescription test, FailureDescription failure)

Wywoływana, gdy test atomowy sygnalizuje, ż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 niepowodzenie pojedynczego przypadku testowego.

final void testFailed ( TestDescription test, String trace)

Zgłasza niepowodzenie pojedynczego przypadku testowego.

final void testIgnored ( TestDescription test)

Wywoływane, gdy test nie zostanie uruchomiony, zazwyczaj dlatego, że metoda testowa jest oznaczona 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 testów.

final void testModuleEnded ()

Zgłasza koniec działania 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)

Zgłasza koniec przebiegu testowego.

final void testRunFailed ( FailureDescription failure)

Raportuje, że przebieg testu nie został ukończony z powodu błędu opisanego w FailureDescription .

final void testRunFailed (String errorMessage)

Raportuje, że przebieg testu nie został ukończony z powodu błędu krytycznego.

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

Zgłasza rozpoczęcie przebiegu testowego.

final void testRunStarted (String runName, int testCount)

Przetestuj wywołania zwrotne

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

Zgłasza rozpoczęcie przebiegu testowego.

final void testRunStopped (long elapsedTime)

Raportuje, że uruchomienie testowe zostało zatrzymane przed zakończeniem z powodu żądania użytkownika.

final void testStarted ( TestDescription test, long startTime)

Alternatywa dla testStarted(com.android.tradefed.result.TestDescription) , gdzie określamy również, kiedy test został rozpoczęty, w połączeniu z ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) w celu 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 ()

Konstruktorzy publiczni

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

Parametry
listener ITestInvocationListener

Zwroty
ITestInvocationListener

wywołanieZakończone

public final void invocationEnded (long elapsedTime)

Raportuje, ż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 wywołania, który upłynął 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 : Throwable , czyli przyczyna niepowodzenia

wywołanieRozpoczęte

public final void invocationStarted (IInvocationContext context)

Słuchacze wywołań do przekazywania

Parametry
context IInvocationContext : informacja o wywołaniu

jest niepełnosprawny

public final boolean isDisabled ()

Zwraca wartość True, jeśli cały obiekt jest wyłączony (pomiń konfigurację i demontaż). Inaczej nieprawda.

Zwroty
boolean

stowarzyszenie log

public final void logAssociation (String dataName, 
                LogFile logFile)

W niektórych przypadkach log musi być ściśle powiązany z przypadkami testowymi, ale możliwość zrobienia tego bezpośrednio na 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 na wyraźne zapewnienie silnego powiązania.

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 przebiegu.

Parametry
dataName String : nazwa danych

logFile LogFile : plik LogFile , który został wcześniej zarejestrowany 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ą raportowane jako metryki uruchomieniowe. Należy zwrócić tylko nowo wygenerowane metryki i z unikalną nazwą klucza (nie są dozwolone żadne kolizje z istniejącymi kluczami).

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 oznaczoną nazwami 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 na podstawie istniejących metryk i dzienników. Należy zwrócić tylko nowo wygenerowane metryki i z unikalną nazwą klucza (nie są dozwolone żadne kolizje z istniejącymi kluczami).

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

runLogs : Zestaw plików dziennika dla uruchomienia testowego.

Zwroty
Zestaw nowo wygenerowanych metryk na podstawie metryk uruchomieniowych.

ProcessTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

Zaimplementuj tę metodę, aby metryki i dzienniki procesu końcowego z każdego testu. Należy zwrócić tylko nowo wygenerowane metryki i z unikalną nazwą klucza (nie są dozwolone żadne kolizje z istniejącymi kluczami).

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 na podstawie 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 podrzędnych postprocesorach, aby zainicjować ją przed uruchomieniem testu.

testZałożenieNiepowodzenie

public final void testAssumptionFailure (TestDescription test, 
                String trace)

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

Parametry
test TestDescription : identyfikuje test

failure FailureDescription : FailureDescription opisujący awarię i jej 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)

Zgłasza koniec wykonania pojedynczego przypadku testowego.

Jeśli testFailed(TestDescription, FailureDescription) nie został wywołany, 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.

Będzie wywoływany pomiędzy testStarted i testEnded.

Parametry
test TestDescription : identyfikuje test

failure FailureDescription : FailureDescription opisujący awarię i jej kontekst.

Test nieudany

public final void testFailed (TestDescription test, 
                String trace)

Zgłasza niepowodzenie pojedynczego przypadku testowego.

Będzie wywoływany pomiędzy testStarted i testEnded.

Parametry
test TestDescription : identyfikuje test

trace String : ślad stosu awarii

testIgnorowany

public final void testIgnored (TestDescription test)

Wywoływane, gdy test nie zostanie uruchomiony, zazwyczaj dlatego, że metoda testowa jest oznaczona 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 : String opisowy nazwy danych. np. „urządzenie_logcat”. Uwaga nazwa_danych może nie być unikalna dla każdego wywołania. tj. osoby wdrażające muszą być w stanie obsłużyć wiele wywołań z tą samą nazwą danych

dataType LogDataType : LogDataType danych

dataStream InputStreamSource : InputStreamSource danych. Osoby wdrażające powinny wywołać funkcję createInputStream, aby rozpocząć odczytywanie danych, i upewnić się, że po ukończeniu wynikowy strumień wejściowy zostanie zamknięty. Osoby wywołujące powinny upewnić się, że źródło danych pozostaje obecne i dostępne do czasu zakończenia metody testLog.

dziennik testowy zapisany

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

Wywoływana po zapisaniu dziennika testów.

Należy go używać zamiast ITestInvocationListener#testLog(String, LogDataType, InputStreamSource) .

Parametry
dataName String : String opisowy nazwy danych. np. „urządzenie_logcat”. Uwaga nazwa_danych może nie być unikalna dla każdego wywołania. tj. osoby wdrażające muszą być w stanie obsłużyć wiele wywołań z tą samą nazwą danych

dataType LogDataType : LogDataType danych

dataStream InputStreamSource : InputStreamSource danych. Osoby wdrażające powinny wywołać funkcję createInputStream, aby rozpocząć odczytywanie danych, i upewnić się, że po ukończeniu wynikowy strumień wejściowy zostanie zamknięty.

logFile LogFile : LogFile zawierający metadane zapisanego pliku.

moduł testowyZakończony

public final void testModuleEnded ()

Zgłasza koniec działania modułu.

Uruchomiono moduł testowy

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 wykorzystuje moduły: biegacze bazujący na pakiecie.

Parametry
moduleContext IInvocationContext : IInvocationContext modułu.

testRunZakończony

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

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

Parametry
elapsedTime long : urządzenie zgłosiło czas, który upłynął, w milisekundach

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

testRun nie powiódł się

public final void testRunFailed (FailureDescription failure)

Raportuje, że przebieg testu nie został ukończony z powodu błędu opisanego w FailureDescription .

Parametry
failure FailureDescription : FailureDescription opisujący awarię i jej kontekst.

testRun nie powiódł się

public final void testRunFailed (String errorMessage)

Raportuje, że przebieg testu nie został ukończony z powodu błędu krytycznego.

Parametry
errorMessage String : String opisujący przyczynę niepowodzenia uruchomienia.

Uruchomiono testRun

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

Zgłasza rozpoczęcie przebiegu testowego.

Parametry
runName String : nazwa przebiegu testowego

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 przez 0 i powinna zwiększać się za każdym razem, gdy nastąpi nowe uruchomienie. np. test jest szczegółowo powtarzany 3 razy, powinien mieć w sumie 4 przebiegi pod tą samą nazwą uruchomienia, a numer próby wynosi od 0 do 3.

Uruchomiono testRun

public final void testRunStarted (String runName, 
                int testCount)

Przetestuj wywołania zwrotne

Parametry
runName String : nazwa przebiegu testowego

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

Uruchomiono testRun

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

Zgłasza rozpoczęcie przebiegu testowego.

Parametry
runName String : nazwa przebiegu testowego

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 przez 0 i powinna zwiększać się za każdym razem, gdy nastąpi nowe uruchomienie. np. test jest szczegółowo powtarzany 3 razy, powinien mieć w sumie 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ą System.currentTimeMillis()

testRunZatrzymany

public final void testRunStopped (long elapsedTime)

Raportuje, że uruchomienie testowe zostało zatrzymane przed zakończeniem z powodu żądania użytkownika.

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

Parametry
elapsedTime long : urządzenie zgłosiło czas, który upłynął, w milisekundach

test rozpoczęty

public final void testStarted (TestDescription test, 
                long startTime)

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

Parametry
test TestDescription : identyfikuje test

startTime long : czas rozpoczęcia testu mierzony za pomocą System.currentTimeMillis()

test rozpoczę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

getRunName

protected String getRunName ()

Zwroty
String