BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IConfigurationReceiver, 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 ostatecznymi reporterami wyników.

Podsumowanie

Konstruktory publiczne

BasePostProcessor()

Metody publiczne

IConfiguration getConfiguration()
final ITestInvocationListener init(ITestInvocationListener listener)

Krok inicjowania procesora końcowego.

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ść True, jeśli cały obiekt jest wyłączony (pomija zarówno konfigurację, jak i zamykanie).

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,LogDataType,InputStreamSource,LogFile).

Aktualizuje powiązanie logu z testem.

Map<String, MetricMeasurement.Metric.Builder> processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, Map<TestDescription, Map<String, LogFile>> allTestLogs)

Zaimplementuj tę metodę, aby agregować dane i logi ze wszystkich testów.

abstract Map<String, MetricMeasurement.Metric.Builder> processRunMetricsAndLogs(HashMap<String, MetricMeasurement.Metric> rawMetrics, Map<String, LogFile> runLogs)

Zaimplementuj tę metodę, aby wygenerować zestaw nowych rodzajów danych na podstawie dotychczasowych rodzajów danych i logów.

Map<String, MetricMeasurement.Metric.Builder> processTestMetricsAndLogs(TestDescription testDescription, HashMap<String, MetricMeasurement.Metric> testMetrics, Map<String, LogFile> testLogs)

Zaimplementuj tę metodę, aby przetwarzać dane i dzienniki z każdego testu.

void setConfiguration(IConfiguration configuration)

Wstawia używaną wartość IConfiguration.

final void setLogSaver(ILogSaver logSaver)

Ustaw ILogSaver, aby umożliwić osobie wdrażającej zapisywanie plików.

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łasza, że zakłada warunek, który jest fałszywy

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

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

final void testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics)

Alternatywa dla testEnded(TestDescription,Map), w której możemy bezpośrednio określić czas zakończenia.

final void testEnded(TestDescription test, Map<String, String> testMetrics)

Zgłasza zakończenie wykonania pojedynczego elementu testowania.

final void testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> testMetrics)

Zgłasza zakończenie wykonania pojedynczego elementu testowania.

final void testEnded(TestDescription test, long endTime, Map<String, String> testMetrics)

Alternatywa dla testEnded(TestDescription,Map), w której możemy bezpośrednio określić czas zakończenia.

final void testFailed(TestDescription test, FailureDescription failure)

Zgłasza niepowodzenie pojedynczego elementu testowania.

final void testFailed(TestDescription test, String trace)

Zgłasza niepowodzenie pojedynczego elementu testowania.

final void testIgnored(TestDescription test)

Wywoływana, gdy test nie zostanie uruchomiony, zwykle 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 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, HashMap<String, MetricMeasurement.Metric> runMetrics)

Zgłasza zakończenie sesji testowej.

final void testRunEnded(long elapsedTime, Map<String, String> runMetrics)

Zgłasza zakończenie sesji testowej.

final void testRunFailed(FailureDescription failure)

Zgłasza, że nie udało się ukończyć sesji testowej z powodu błędu opisanego przez FailureDescription.

final void testRunFailed(String errorMessage)

Zgłasza, że nie udało się ukończyć sesji testowej z powodu błędu krytycznego.

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

Zgłasza rozpoczęcie sesji testowej.

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 sesji testowej.

final void testRunStopped(long elapsedTime)

Zgłasza zatrzymanie sesji testowej 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 testStarted(TestDescription), w której podajemy też datę rozpoczęcia testu, w połączeniu z testEnded(TestDescription,long,Map), aby uzyskać dokładny pomiar.

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()
final String getStackTrace()
final boolean isTestFailed()

Konstruktory publiczne

BasePostProcessor

public BasePostProcessor ()

Metody publiczne

getConfiguration

public IConfiguration getConfiguration ()

Zwraca
IConfiguration

init

public final ITestInvocationListener init (ITestInvocationListener listener)

Krok inicjowania procesora końcowego. Wywoływana przed wszystkimi wywołaniami zwrotnymi testów.

Parametry
listener ITestInvocationListener

Zwraca
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ąca 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ść True, jeśli cały obiekt jest wyłączony (pomija zarówno konfigurację, jak i zamykanie). W przeciwnym razie ma wartość Fałsz.

Zwraca
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,LogDataType,InputStreamSource,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 zostanie wywołana podczas testu, dziennik będzie należeć 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 elementem testowania.

processAllTestMetricsAndLogs

public Map<String, MetricMeasurement.Metric.Builder> processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                Map<TestDescription, Map<String, LogFile>> allTestLogs)

Zaimplementuj tę metodę, aby agregować dane i logi ze wszystkich testów. Dane pochodzące z tej metody będą raportowane jako dane o wykonaniu. Zwracane powinny być tylko nowo wygenerowane wskaźniki z unikalną nazwą klucza (nie są dozwolone kolizje z istniejącymi kluczami).

Parametry
allTestMetrics ListMultimap: HashMultimap przechowujący dane z każdego testu pogrupowane według nazw danych.
allTestLogs Map: mapa przechowująca mapę plików dziennika każdego testu, której klucze stanowią nazwy danych, a klucze poszczególnych testów to TestDescription.
Zwraca
Map<String, MetricMeasurement.Metric.Builder> Zbiór nowo wygenerowanych wskaźników ze wszystkich wskaźników testu.

processRunMetricsAndLogs

public abstract Map<String, MetricMeasurement.Metric.Builder> processRunMetricsAndLogs (HashMap<String, MetricMeasurement.Metric> rawMetrics, 
                Map<String, LogFile> runLogs)

Zaimplementuj tę metodę, aby wygenerować zestaw nowych rodzajów danych na podstawie dotychczasowych rodzajów danych i logów. Należy zwracać tylko nowo wygenerowane wskaźniki z unikalną nazwą klucza (nie są dozwolone kolizje z istniejącymi kluczami).

Parametry
rawMetrics HashMap: Zestaw surowych danych dostępnych w przypadku danego uruchomienia.
runLogs Map: Zestaw plików dziennika dla sesji testowej.
Zwraca
Map<String, MetricMeasurement.Metric.Builder> Zestaw nowo wygenerowanych danych na podstawie danych z biegu.

processTestMetricsAndLogs

public Map<String, MetricMeasurement.Metric.Builder> processTestMetricsAndLogs (TestDescription testDescription, 
                HashMap<String, MetricMeasurement.Metric> testMetrics, 
                Map<String, LogFile> testLogs)

Zaimplementuj tę metodę, aby przetwarzać dane i dzienniki z każdego testu. Należy zwracać tylko nowo wygenerowane wskaźniki z unikalną nazwą klucza (nie są dozwolone kolizje z istniejącymi kluczami).

Parametry
testDescription TestDescription: obiekt TestDescription opisujący test.
testMetrics HashMap: zestaw danych z testu.
testLogs Map: Zestaw plików zarejestrowanych podczas testu.
Zwraca
Map<String, MetricMeasurement.Metric.Builder> Zbiór nowo wygenerowanych danych z danych testowych.

setConfiguration

public void setConfiguration (IConfiguration configuration)

Wstawia używaną wartość IConfiguration.

Parametry
configuration IConfiguration

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łasza, ż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łasza, że zakłada warunek, który jest fałszywy

Parametry
test TestDescription: identyfikuje test
failure FailureDescription: FailureDescription opisuje błąd i jego kontekst.

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

Alternatywa dla testEnded(TestDescription,Map), w której możemy bezpośrednio określić czas zakończenia. Łącz z testStarted(TestDescription,long), aby uzyskać dokładne pomiary.

Parametry
test TestDescription: identyfikuje test
endTime long: czas zakończenia testu mierzony za pomocą System.currentTimeMillis()
testMetrics HashMap: Map danych wygenerowanych

testEnded

public final void testEnded (TestDescription test, 
                Map<String, String> testMetrics)

Zgłasza zakończenie wykonania pojedynczego elementu testowania.

Jeśli funkcja testFailed(TestDescription, FailureDescription) nie została wywołana, test uznaje się za zaliczony. Zwraca też wszystkie dane klucz/wartość, które mogły zostać wyemitowane podczas wykonywania elementu testowania.

Parametry
test TestDescription: identyfikuje test
testMetrics Map: Map danych wygenerowanych

testEnded

public final void testEnded (TestDescription test, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

Zgłasza zakończenie wykonania pojedynczego elementu testowania.

Jeśli funkcja testFailed(TestDescription, FailureDescription) nie została wywołana, test uznaje się za zaliczony. Zwraca też wszystkie dane klucz/wartość, które mogły zostać wyemitowane podczas wykonywania elementu testowania.

Parametry
test TestDescription: identyfikuje test
testMetrics HashMap: Map danych wygenerowanych

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                Map<String, String> testMetrics)

Alternatywa dla testEnded(TestDescription,Map), w której możemy bezpośrednio określić czas zakończenia. Łącz z testStarted(TestDescription,long), aby uzyskać dokładne pomiary.

Parametry
test TestDescription: identyfikuje test
endTime long: czas zakończenia testu mierzony za pomocą System.currentTimeMillis()
testMetrics Map: Map danych wygenerowanych

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

Zgłasza niepowodzenie pojedynczego elementu testowania.

Wywoływana między testStarted a testEnded.

Parametry
test TestDescription: identyfikuje test
failure FailureDescription: FailureDescription opisuje błąd i jego kontekst.

testFailed

public final void testFailed (TestDescription test, 
                String trace)

Zgłasza niepowodzenie pojedynczego elementu testowania.

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 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 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 tą samą nazwą 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: dataName może nie być unikalne w przypadku każdego wywołania. Oznacza to, że osoby wdrażające muszą być w stanie obsłużyć wiele wywołań z tą samą wartością dataName.
dataType LogDataType: LogDataType danych
dataStream InputStreamSource: InputStreamSource danych. Wdrażający powinni 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. Ten wywołanie zwrotne jest powiązane z elementem testModuleEnded() i jest opcjonalne w sekwencji. Jest używany tylko podczas uruchamiania modułów: narzędzi uruchamiających opartych na pakietach.

Parametry
moduleContext IInvocationContext: IInvocationContext modułu.

testRunEnded

public final void testRunEnded (long elapsedTime, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

Zgłasza zakończenie sesji testowej. FIXME: Nie możemy mieć dwóch interfejsów Map<> z różnymi typami, więc musimy tutaj użyć HashMap.

Parametry
elapsedTime long: czas, który upłynął od ostatniego zgłoszenia przez urządzenie (w milisekundach)
runMetrics HashMap: pary klucz/wartość zgłaszane na zakończenie sesji testowej z parametrem Metric.

testRunEnded

public final void testRunEnded (long elapsedTime, 
                Map<String, String> runMetrics)

Zgłasza zakończenie sesji testowej.

Parametry
elapsedTime long: czas, który upłynął od ostatniego zgłoszenia przez urządzenie (w milisekundach)
runMetrics Map: pary klucz/wartość zgłaszane na zakończenie sesji testowej

testRunFailed

public final void testRunFailed (FailureDescription failure)

Zgłasza, że nie udało się ukończyć sesji testowej z powodu błędu opisanego przez FailureDescription.

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

testRunFailed

public final void testRunFailed (String errorMessage)

Zgłasza, że nie udało się ukończyć sesji testowej z powodu błędu krytycznego.

Parametry
errorMessage String: String opisuje przyczynę niepowodzenia uruchomienia.

testRunStarted

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

Zgłasza rozpoczęcie sesji testowej.

Parametry
runName String: nazwa sesji testowej
testCount int: łączna liczba testów podczas sesji testowej
attemptNumber int: numer zamówienia, który identyfikuje różne próby tego samego uruchomienia runName wykonywanego wielokrotnie. Numer próby jest indeksowany od 0 i powinien zwiększać się za każdym razem, gdy następuje nowe uruchomienie. Przykład: test jest ponownie uruchamiany 3 razy, więc powinien mieć łącznie 4 uruchomienia pod tą samą nazwą uruchomienia, a numer próby powinien wynosić od 0 do 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Wywołania zwrotne testu

Parametry
runName String: nazwa sesji testowej
testCount int: łączna liczba testów podczas sesji testowej

testRunStarted

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

Zgłasza rozpoczęcie sesji testowej.

Parametry
runName String: nazwa sesji testowej
testCount int: łączna liczba testów podczas sesji testowej
attemptNumber int: numer zamówienia, który identyfikuje różne próby tego samego uruchomienia runName wykonywanego wielokrotnie. Wartość attemptNumber jest indeksowana od zera i powinna 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ą runName, a wartość attemptNumber powinna wynosić od 0 do 3.
startTime long: czas rozpoczęcia uruchomienia mierzony za pomocą System.currentTimeMillis()

testRunStopped

public final void testRunStopped (long elapsedTime)

Zgłasza zatrzymanie sesji testowej 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(TestDescription), w której podajemy też datę rozpoczęcia testu, w połączeniu z testEnded(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 typ danych to typ przetworzony.

Zwraca
MetricMeasurement.DataType

getRunName

protected String getRunName ()

Zwraca
String

getStackTrace

protected final String getStackTrace ()

Zwraca
String

isTestFailed

protected final boolean isTestFailed ()

Zwraca
boolean