ProtoResultReporter
public abstract class ProtoResultReporter
extends Object
implements ITestInvocationListener , ILogSaverListener , ISupportGranularResults
java.lang.Obiekt | |
↳ | com.android.tradefed.result.proto.ProtoResultReporter |
Reporter wyników tworzy protobuf TestRecord
ze wszystkimi wynikami w środku. Powinien zostać rozszerzony, aby obsłużyć, co zrobić z końcowym proto w processFinalProto(com.android.tradefed.result.proto.TestRecordProto.TestRecord)
.
Streszczenie
Konstruktory publiczne | |
---|---|
ProtoResultReporter () |
Metody publiczne | |
---|---|
final void | invocationEnded (long elapsedTime) Zgłasza, że wywołanie zakończyło się pomyślnie lub 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. |
final void | invocationStarted ( IInvocationContext context) Zgłasza początek wywołania testowego. |
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 |
void | processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs) Użyj rekordu wywołania, aby wysłać jeden po drugim wszystkie końcowe dzienniki wywołania. |
void | processFinalProto (TestRecordProto.TestRecord finalRecord) Obsługa ostatecznego proto ze wszystkimi wynikami. |
void | processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext) Wystąpiła obsługa proto rekordu testu częściowego wywołania po |
void | processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord) Obsługa sfinalizowanego rekordu przypadku testowego po wystąpieniu |
void | processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord) Obsługa proto rekordu częściowego przypadku testowego po wystąpieniu |
void | processTestModuleEnd (TestRecordProto.TestRecord moduleRecord) Obsługa sfinalizowanego proto rekordu modułu po wystąpieniu |
void | processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord) Obsługa proto częściowego rekordu modułu po wystąpieniu |
void | processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress) Obsługa sfinalizowanego proto rekordu przebiegu po wystąpieniu |
void | processTestRunStarted (TestRecordProto.TestRecord runStartedRecord) Obsługa proto częściowego rekordu przebiegu testu po wystąpieniu |
void | setGranularResults (boolean granularResults) |
void | setInlineRecordOfChildren (boolean inline) |
boolean | supportGranularResults () Zwraca True, jeśli reporter obsługuje szczegółowe wyniki, w przeciwnym razie zwraca false. |
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 |
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 | testModuleEnded () Zgłasza koniec uruchomienia modułu. |
final void | testModuleStarted ( IInvocationContext moduleContext) Zgłasza początek uruchomionego modułu. |
final void | testRunEnded (long elapsedTimeMillis, runMetrics) testRunEnded (long elapsedTimeMillis, 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 |
final void | testRunFailed (String errorMessage) Testowanie raportów nie zostało ukończone z powodu błędu krytycznego. |
void | testRunStarted (String runName, int testCount, int attemptNumber) Zgłasza początek przebiegu testowego. |
final void | testRunStarted (String runName, int testCount) Zgłasza początek przebiegu testowego. |
void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Zgłasza początek przebiegu testowego. |
final void | testStarted ( TestDescription test, long startTime) Alternatywa dla |
final void | testStarted ( TestDescription test) Raportuje początek pojedynczego przypadku testowego. |
Metody chronione | |
---|---|
TestRecordProto.ChildReference | createModuleChildReference (TestRecordProto.TestRecord record) Tworzy odwołanie podrzędne dla modułu. |
Konstruktory publiczne
ProtoResultReporter
public ProtoResultReporter ()
Metody publiczne
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 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 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 Throwable |
wywołanie rozpoczęte
public final void invocationStarted (IInvocationContext context)
Zgłasza początek wywołania testowego.
Zostanie automatycznie wywołany przez platformę TradeFederation. Reporterzy muszą zastąpić tę metodę, aby obsługiwać raportowanie wielu urządzeń.
Parametry | |
---|---|
context | IInvocationContext : informacje o wywołaniu |
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.
Parametry | |
---|---|
dataName | String : Nazwa danych |
logFile | LogFile : LogFile , który był wcześniej rejestrowany i powinien być powiązany z przypadkiem testowym. |
processFinalInvocationLogs
public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)
Użyj rekordu wywołania, aby wysłać jeden po drugim wszystkie końcowe dzienniki wywołania.
Parametry | |
---|---|
invocationLogs | TestRecordProto.TestRecord : sfinalizowane proto reprezentujące wywołanie. |
procesFinalProto
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
Obsługa ostatecznego proto ze wszystkimi wynikami.
Parametry | |
---|---|
finalRecord | TestRecordProto.TestRecord : sfinalizowane proto ze wszystkimi wynikami wywołania. |
ProcessStartInwokacja
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
Wystąpiła obsługa proto rekordu testu częściowego wywołania po invocationStarted(com.android.tradefed.invoker.IInvocationContext)
.
Parametry | |
---|---|
invocationStartRecord | TestRecordProto.TestRecord : Częściowe proto wypełnione po invocationStart. |
invocationContext | IInvocationContext : Wywołanie IInvocationContext . |
processTestCaseEnded
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
Obsługa sfinalizowanego rekordu przypadku testowego po wystąpieniu ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))
.
Parametry | |
---|---|
testCaseRecord | TestRecordProto.TestRecord : sfinalizowane proto reprezentujące przypadek testowy. |
procesTestCaseRozpoczęty
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
Obsługa proto rekordu częściowego przypadku testowego po wystąpieniu testStarted(com.android.tradefed.result.TestDescription, long)
.
Parametry | |
---|---|
testCaseStartedRecord | TestRecordProto.TestRecord : Częściowe proto reprezentujące przypadek testowy. |
ProcessTestModuleEnd
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
Obsługa sfinalizowanego proto rekordu modułu po wystąpieniu testModuleEnded()
.
Parametry | |
---|---|
moduleRecord | TestRecordProto.TestRecord : sfinalizowane proto reprezentujące moduł. |
ProcessTestModuleUruchomiono
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
Obsługa proto częściowego rekordu modułu po wystąpieniu testModuleStarted(com.android.tradefed.invoker.IInvocationContext)
.
Parametry | |
---|---|
moduleStartRecord | TestRecordProto.TestRecord : Częściowe proto reprezentujące moduł. |
procesTestRunEnded
public void processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
Obsługa sfinalizowanego proto rekordu przebiegu po wystąpieniu ERROR(/#testRunEnded(long,HashMap))
.
Parametry | |
---|---|
runRecord | TestRecordProto.TestRecord : sfinalizowane proto reprezentujące przebieg. |
moduleInProgress | boolean : czy moduł jest w toku. |
procesTestUruchomionyRozpoczęty
public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)
Obsługa proto częściowego rekordu przebiegu testu po wystąpieniu testRunStarted(String, int)
.
Parametry | |
---|---|
runStartedRecord | TestRecordProto.TestRecord : Częściowe proto reprezentujące przebieg. |
ustaw szczegółowe wyniki
public void setGranularResults (boolean granularResults)
Parametry | |
---|---|
granularResults | boolean |
setInlineRecordOfChildren
public void setInlineRecordOfChildren (boolean inline)
Parametry | |
---|---|
inline | boolean |
wsparcieSzczegółoweWyniki
public boolean supportGranularResults ()
Zwraca True, jeśli reporter obsługuje szczegółowe wyniki, w przeciwnym razie zwraca false.
Zwroty | |
---|---|
boolean |
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ą System.currentTimeMillis() |
testMetrics | ERROR(/Map) emitowanych metryk |
test zakończony
public 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 |
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 elapsedTimeMillis,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 | |
---|---|
elapsedTimeMillis | long : czas, który upłynął od urządzenia, w milisekundach |
runMetrics | 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 : String opisujący przyczynę niepowodzenia uruchomienia. |
testRunStarted
public 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)
Zgłasza początek przebiegu testowego.
Parametry | |
---|---|
runName | String : nazwa uruchomienia testu |
testCount | int : całkowita liczba testów w przebiegu testu |
testRunStarted
public 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 przez System.currentTimeMillis() |
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ą System.currentTimeMillis() |
testRozpoczęty
public final void testStarted (TestDescription test)
Raportuje początek pojedynczego przypadku testowego. Starszy interfejs powinien używać testStarted(com.android.tradefed.result.TestDescription)
gdy tylko jest to możliwe.
Parametry | |
---|---|
test | TestDescription : identyfikuje test |
Metody chronione
utwórzModuleChildReference
protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)
Tworzy odwołanie podrzędne dla modułu.
Parametry | |
---|---|
record | TestRecordProto.TestRecord |
Zwroty | |
---|---|
TestRecordProto.ChildReference |