SubprocessResultsReporter

public class SubprocessResultsReporter
extends Object implements AutoCloseable, ILogSaverListener, ISupportGranularResults, ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.SubprocessResultsReporter

Znane bezpośrednie podklasy LegacySubprocessResultsReporter LegacySubprocessResultsReporter Zamrożona implementacja narzędzia do raportowania wyników podprocesu, która powinna pozostać zgodna z wcześniejszymi wersjami TF/CTS (np. 8+), pomimo zmian w jej klasie nadrzędnej.

---

Implementuje ITestInvocationListener, aby określić go jako result_reporter i przekazywać z podprocesu wyniki testów, przebiegów testów i wywołań testów.

Podsumowanie

Konstruktory publiczne
SubprocessResultsReporter()

Metody publiczne
void	close()
TestSummary	getSummary() Umożliwia interfejsowi InvocationListener zwracanie podsumowania.
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.
void	invocationFailed(FailureDescription failure) Zgłasza niekompletne wywołanie z powodu błędu.
void	invocationFailed(Throwable cause) Zgłasza niekompletne wywołanie z powodu błędu.
void	invocationStarted(IInvocationContext context) Zgłasza rozpoczęcie wywołania testu.
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).
void	printEvent(String key, Object event) Funkcja pomocnicza do drukowania klucza zdarzenia, a następnie obiektu JSON.
void	setOutputTestLog(boolean outputTestLog) Określa, czy test powinien być rejestrowany.
boolean	supportGranularResults() Zwraca wartość „True”, jeśli narzędzie do raportowania obsługuje szczegółowe wyniki, w przeciwnym razie zwraca wartość „False”.
void	testAssumptionFailure(TestDescription testId, String trace) Wywoływana, gdy test atomowy zgłasza, że zakłada warunek, który jest fałszywy
void	testAssumptionFailure(TestDescription testId, FailureDescription failure) Wywoływana, gdy test atomowy zgłasza, że zakłada warunek, który jest fałszywy
void	testEnded(TestDescription testId, long endTime, HashMap<String, MetricMeasurement.Metric> metrics) Alternatywa dla testEnded(TestDescription,Map), w której możemy bezpośrednio określić czas zakończenia.
void	testEnded(TestDescription testId, HashMap<String, MetricMeasurement.Metric> metrics) Zgłasza zakończenie wykonania pojedynczego elementu testowania.
void	testFailed(TestDescription testId, FailureDescription failure) Zgłasza niepowodzenie pojedynczego elementu testowania.
void	testFailed(TestDescription testId, String reason) Zgłasza niepowodzenie pojedynczego elementu testowania.
void	testIgnored(TestDescription testId) Wywoływana, gdy test nie zostanie uruchomiony, zwykle dlatego, że metoda testowa jest oznaczona adnotacją org.junit.Ignore.
void	testLog(String dataName, LogDataType dataType, InputStreamSource dataStream) Zawiera powiązane dane dziennika lub dane debugowania z wywołania testu.
void	testModuleEnded() Zgłasza zakończenie działania modułu.
void	testModuleStarted(IInvocationContext moduleContext) Zgłasza rozpoczęcie działania modułu.
void	testRunEnded(long time, HashMap<String, MetricMeasurement.Metric> runMetrics) Zgłasza zakończenie sesji testowej.
void	testRunFailed(FailureDescription failure) Zgłasza, że nie udało się ukończyć sesji testowej z powodu błędu opisanego przez FailureDescription.
void	testRunFailed(String reason) Zgłasza, że nie udało się ukończyć sesji testowej z powodu błędu krytycznego.
void	testRunStarted(String runName, int testCount, int attemptNumber) Zgłasza rozpoczęcie sesji testowej.
void	testRunStarted(String runName, int testCount) Zgłasza rozpoczęcie sesji testowej.
void	testRunStarted(String runName, int testCount, int attemptNumber, long startTime) Zgłasza rozpoczęcie sesji testowej.
void	testRunStopped(long arg0) Zgłasza zatrzymanie sesji testowej przed zakończeniem na prośbę użytkownika.
void	testSkipped(TestDescription testId, SkipReason reason) Wywoływana, gdy test jest pomijany i nie jest wykonywany z przyczyny, która zwykle nie jest oczekiwana.
void	testStarted(TestDescription testId, 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.
void	testStarted(TestDescription testId) Zgłasza rozpoczęcie pojedynczego elementu testowania.

Konstruktory publiczne

SubprocessResultsReporter

public SubprocessResultsReporter ()

Metody publiczne

zamknij

public void close ()

getSummary

public TestSummary getSummary ()

Umożliwia interfejsowi InvocationListener zwracanie podsumowania.

Zwraca
TestSummary	TestSummary podsumowująca bieg lub wartość null.

invocationEnded

public 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 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 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

invocationStarted

public void invocationStarted (IInvocationContext context)

Zgłasza rozpoczęcie wywołania testu.

Zostanie automatycznie wywołana przez platformę TradeFederation. Aby obsługiwać raportowanie z wielu urządzeń, reporterzy muszą zastąpić tę metodę.

Parametry
context	IInvocationContext: informacje o wywołaniu,

logAssociation

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

Parametry
dataName	String: nazwa danych
logFile	LogFile: LogFile, który został zarejestrowany wcześniej i powinien być powiązany z elementem testowania.

printEvent

public void printEvent (String key, 
                Object event)

Funkcja pomocnicza do drukowania klucza zdarzenia, a następnie obiektu JSON.

Parametry
key	String
event	Object

setOutputTestLog

public void setOutputTestLog (boolean outputTestLog)

Określa, czy test powinien być rejestrowany.

Parametry
outputTestLog	boolean

supportGranularResults

public boolean supportGranularResults ()

Zwraca wartość „True”, jeśli narzędzie do raportowania obsługuje szczegółowe wyniki, w przeciwnym razie zwraca wartość „False”.

Zwraca
boolean

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                String trace)

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

Parametry
testId	TestDescription: identyfikuje test
trace	String: zrzut stosu błędu

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                FailureDescription failure)

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

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

testEnded

public void testEnded (TestDescription testId, 
                long endTime, 
                HashMap<String, MetricMeasurement.Metric> metrics)

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
testId	TestDescription: identyfikuje test
endTime	long: czas zakończenia testu mierzony za pomocą System.currentTimeMillis()
metrics	HashMap: Map danych wygenerowanych

testEnded

public void testEnded (TestDescription testId, 
                HashMap<String, MetricMeasurement.Metric> metrics)

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
testId	TestDescription: identyfikuje test
metrics	HashMap: Map danych wygenerowanych

testFailed

public void testFailed (TestDescription testId, 
                FailureDescription failure)

Zgłasza niepowodzenie pojedynczego elementu testowania.

Wywoływana między testStarted a testEnded.

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

testFailed

public void testFailed (TestDescription testId, 
                String reason)

Zgłasza niepowodzenie pojedynczego elementu testowania.

Wywoływana między testStarted a testEnded.

Parametry
testId	TestDescription: identyfikuje test
reason	String: zrzut stosu błędu

testIgnored

public void testIgnored (TestDescription testId)

Wywoływana, gdy test nie zostanie uruchomiony, zwykle dlatego, że metoda testowa jest oznaczona adnotacją org.junit.Ignore.

Parametry
testId	TestDescription: identyfikuje test

testLog

public void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

Zawiera powiązane dane dziennika lub dane debugowania z wywołania testu.

Musi być wywołana przed ERROR(ITestInvocationListener.invocationFailed(Throwable)/ITestInvocationListener#invocationFailed(java.lang.Throwable) ITestInvocationListener.invocationFailed(Throwable)) lub ERROR(/ITestInvocationListener#invocationEnded(long))

Platforma TradeFederation automatycznie wywoła tę metodę, podając dziennik hosta i w razie potrzeby dziennik logcat urządzenia.

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.

testModuleEnded

public void testModuleEnded ()

Zgłasza zakończenie działania modułu.

testModuleStarted

public 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 void testRunEnded (long time, 
                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
time	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.

testRunFailed

public 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 void testRunFailed (String reason)

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

Parametry
reason	String: String opisuje przyczynę niepowodzenia uruchomienia.

testRunStarted

public 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 void testRunStarted (String runName, 
                int testCount)

Zgłasza rozpoczęcie sesji testowej.

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

testRunStarted

public 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 void testRunStopped (long arg0)

Zgłasza zatrzymanie sesji testowej przed zakończeniem na prośbę użytkownika.

TODO: obecnie nieużywane, rozważ usunięcie

Parametry
arg0	long: czas, który upłynął od ostatniego zgłoszenia przez urządzenie (w milisekundach)

testSkipped

public void testSkipped (TestDescription testId, 
                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
testId	TestDescription: identyfikuje test
reason	SkipReason: SkipReason

testStarted

public void testStarted (TestDescription testId, 
                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
testId	TestDescription: identyfikuje test
startTime	long: czas rozpoczęcia testu mierzony za pomocą System.currentTimeMillis()

testStarted

public void testStarted (TestDescription testId)

Zgłasza rozpoczęcie pojedynczego elementu testowania. Jest to starszy interfejs; o ile to możliwe, używaj testStarted(TestDescription).

Parametry
testId	TestDescription: identyfikuje test