ProtoResultReporter
public
abstract
class
ProtoResultReporter
extends Object
implements
ILogSaverListener,
ISupportGranularResults,
ITestInvocationListener
java.lang.Object | |
↳ | com.android.tradefed.result.proto.ProtoResultReporter |
Raport z wyników tworzy plik TestRecord
protobuf ze wszystkimi wynikami. Należy rozszerzyć, aby określić, co zrobić z protokołem końcowym w processFinalProto(com.android.tradefed.result.proto.TestRecordProto.TestRecord)
.
Podsumowanie
Konstruktory publiczne | |
---|---|
ProtoResultReporter()
|
Metody publiczne | |
---|---|
final
void
|
invocationEnded(long elapsedTime)
Informuje, że wywołanie zostało zakończone (z powodu błędu lub prawidłowo). |
void
|
invocationFailed(FailureDescription failure)
zgłasza niepełne wywołanie z powodu błędu. |
void
|
invocationFailed(Throwable cause)
zgłasza niepełne wywołanie z powodu błędu. |
void
|
invocationSkipped(SkipReason reason)
zgłasza wywołanie jako pominięte; |
void
|
invocationStarted(IInvocationContext context)
Raportuje rozpoczęcie wywołania testu. |
final
void
|
logAssociation(String dataName, LogFile logFile)
W niektórych przypadkach log musi być silnie powiązany z przypadkami testowymi, ale nie można tego zrobić bezpośrednio w wywołaniu |
void
|
processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs)
Użyj rekordu wywołania, aby wysłać pojedynczo wszystkie logi wywołania. |
void
|
processFinalProto(TestRecordProto.TestRecord finalRecord)
Obsługa ostatecznego protokołu ze wszystkimi wynikami. |
void
|
processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
Obsługa protokołu rekordu testu częściowego wywołania po wystąpieniu |
void
|
processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord)
Obsługa zakończonego rekordu testu proto po wystąpieniu |
void
|
processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord)
Obsługa protokołu rekordu częściowego przypadku testowego po wystąpieniu |
void
|
processTestModuleEnd(TestRecordProto.TestRecord moduleRecord)
Obsługa protokołu rekordu sfinalizowanego modułu po |
void
|
processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord)
Obsługa protokołu rekordu częściowego modułu po wystąpieniu |
void
|
processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
Obsługa protokołu rekordu uruchomienia po zakończeniu |
void
|
processTestRunStarted(TestRecordProto.TestRecord runStartedRecord)
Obsługa rekordu proto częściowego testu po wystąpieniu błędu |
void
|
setGranularResults(boolean granularResults)
|
void
|
setInlineRecordOfChildren(boolean inline)
|
boolean
|
supportGranularResults()
Zwraca wartość „True” (Prawda), jeśli raportujący obsługuje szczegółowe wyniki, w przeciwnym razie zwraca wartość „False” (Fałsz). |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Wywoływany, gdy test atomowy sygnalizuje, że zakłada warunek, który jest fałszywy. |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Wywoływany, gdy test atomowy sygnalizuje, że zakłada warunek, który jest fałszywy. |
final
void
|
testEnded(TestDescription test, long endTime,
Alternatywa dla |
void
|
testEnded(TestDescription test,
Raportuje zakończenie wykonywania pojedynczego przypadku testu. |
final
void
|
testFailed(TestDescription test, FailureDescription failure)
Raportuje niepowodzenie pojedynczego przypadku testowego. |
final
void
|
testFailed(TestDescription test, String trace)
Raportuje niepowodzenie pojedynczego przypadku testowego. |
final
void
|
testIgnored(TestDescription test)
Wywoływany, gdy test nie zostanie uruchomiony, zwykle dlatego, że metoda testu jest oznaczona adnotacją org.junit.Ignore. |
final
void
|
testModuleEnded()
Raportuje koniec wykonania modułu. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
zgłasza rozpoczęcie działania modułu. |
final
void
|
testRunEnded(long elapsedTimeMillis,
Raportuje zakończenie testu. |
final
void
|
testRunFailed(FailureDescription failure)
Nie udało się przeprowadzić testu raportów z powodu błędu opisanego w |
final
void
|
testRunFailed(String errorMessage)
Nie udało się przeprowadzić testu raportów z powodu krytycznego błędu. |
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Raportuje rozpoczęcie testu. |
final
void
|
testRunStarted(String runName, int testCount)
Raportuje rozpoczęcie testu. |
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Raportuje rozpoczęcie testu. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Wywoływany, gdy test jest pomijany i nie jest wykonywany z nieoczekiwanego powodu. |
final
void
|
testStarted(TestDescription test, long startTime)
Alternatywa dla |
final
void
|
testStarted(TestDescription test)
Raportuje rozpoczęcie indywidualnego przypadku testowego. |
Chronione metody | |
---|---|
void
|
afterModuleEnd()
|
void
|
beforeModuleStart()
|
TestRecordProto.ChildReference
|
createModuleChildReference(TestRecordProto.TestRecord record)
Tworzy odwołanie podrzędne do modułu. |
Konstruktory publiczne
ProtoResultReporter
public ProtoResultReporter ()
Metody publiczne
invocationEnded
public final void invocationEnded (long elapsedTime)
Informuje, że wywołanie zostało zakończone (z powodu błędu lub prawidłowo).
Będzie wywoływany automatycznie przez platformę TradeFederation.
Parametry | |
---|---|
elapsedTime |
long : upłynął czas wywołania w ms |
invocationFailed
public void invocationFailed (FailureDescription failure)
zgłasza niepełne wywołanie z powodu błędu.
Będzie wywoływany automatycznie przez platformę TradeFederation.
Parametry | |
---|---|
failure |
FailureDescription : FailureDescription opisujący przyczynę niepowodzenia |
invocationFailed
public void invocationFailed (Throwable cause)
zgłasza niepełne wywołanie z powodu błędu.
Będzie wywoływany automatycznie przez platformę TradeFederation.
Parametry | |
---|---|
cause |
Throwable : przyczyna niepowodzenia Throwable |
invocationSkipped
public void invocationSkipped (SkipReason reason)
zgłasza wywołanie jako pominięte;
Parametry | |
---|---|
reason |
SkipReason |
invocationStarted
public void invocationStarted (IInvocationContext context)
Raportuje rozpoczęcie wywołania testu.
Będzie wywoływany automatycznie przez platformę TradeFederation. Aby umożliwić raportowanie z kilku urządzeń, autorzy raportów muszą zastąpić tę metodę.
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 nie można tego zrobić bezpośrednio w wywołaniu testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
. Dzięki temu wywołaniu zwrotnemu można wyraźnie powiązać dane.
Parametry | |
---|---|
dataName |
String : nazwa danych |
logFile |
LogFile : LogFile , który został wcześniej zarejestrowany i powinien być powiązany z przypadkiem testowym. |
processFinalInvocationLogs
public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)
Użyj rekordu wywołania, aby wysłać pojedynczo wszystkie logi wywołania.
Parametry | |
---|---|
invocationLogs |
TestRecordProto.TestRecord : sfinalizowany prototyp reprezentujący wywołanie. |
processFinalProto
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
Obsługa ostatecznego protokołu ze wszystkimi wynikami.
Parametry | |
---|---|
finalRecord |
TestRecordProto.TestRecord : sfinalizowany prototyp ze wszystkimi wynikami wywołania. |
processStartInvocation
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
Obsługa protokołu rekordu testu częściowego wywołania po wystąpieniu invocationStarted(com.android.tradefed.invoker.IInvocationContext)
.
Parametry | |
---|---|
invocationStartRecord |
TestRecordProto.TestRecord : częściowy proto wypełniony po wywołaniu invocationStart. |
invocationContext |
IInvocationContext : wywołanie IInvocationContext . |
processTestCaseEnded
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
Obsługa zakończonego rekordu testu proto po wystąpieniu ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,HashMap))
.
Parametry | |
---|---|
testCaseRecord |
TestRecordProto.TestRecord : sfinalizowany prototyp reprezentujący element testowania. |
processTestCaseStarted
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
Obsługa protokołu rekordu częściowego przypadku testowego po wystąpieniu testStarted(com.android.tradefed.result.TestDescription, long)
.
Parametry | |
---|---|
testCaseStartedRecord |
TestRecordProto.TestRecord : częściowy proto reprezentujący element testowania. |
processTestModuleEnd
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
Obsługa protokołu rekordu sfinalizowanego modułu po testModuleEnded()
.
Parametry | |
---|---|
moduleRecord |
TestRecordProto.TestRecord : gotowy prototyp reprezentujący moduł. |
processTestModuleStarted
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
Obsługa protokołu rekordu częściowego modułu po wystąpieniu testModuleStarted(com.android.tradefed.invoker.IInvocationContext)
.
Parametry | |
---|---|
moduleStartRecord |
TestRecordProto.TestRecord : częściowy proto reprezentujący moduł. |
processTestRunEnded
public void processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
Obsługa protokołu rekordu uruchomienia po zakończeniu ERROR(/#testRunEnded(long,HashMap))
.
Parametry | |
---|---|
runRecord |
TestRecordProto.TestRecord : sfinalizowany prototyp reprezentujący uruchomienie. |
moduleInProgress |
boolean : czy moduł jest w toku. |
processTestRunStarted
public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)
Obsługa rekordu proto częściowego testu po wystąpieniu błędu testRunStarted(String, int)
.
Parametry | |
---|---|
runStartedRecord |
TestRecordProto.TestRecord : częściowy prototyp reprezentujący uruchomienie. |
setGranularResults
public void setGranularResults (boolean granularResults)
Parametry | |
---|---|
granularResults |
boolean |
setInlineRecordOfChildren
public void setInlineRecordOfChildren (boolean inline)
Parametry | |
---|---|
inline |
boolean |
supportGranularResults
public boolean supportGranularResults ()
Zwraca wartość „True” (Prawda), jeśli raportujący obsługuje szczegółowe wyniki, w przeciwnym razie zwraca wartość „False” (Fałsz).
Zwroty | |
---|---|
boolean |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Wywoływany, gdy test atomowy sygnalizuje, ż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ływany, gdy test atomowy sygnalizuje, że zakłada warunek, który jest fałszywy.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
failure |
FailureDescription : FailureDescription opisujący błąd i jego kontekst. |
testEnded
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternatywa dla ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
, w której możemy bezpośrednio określić czas zakończenia. Aby uzyskać dokładne pomiary, połącz je z elementem testStarted(com.android.tradefed.result.TestDescription, long)
.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
endTime |
long : czas zakończenia testu mierzony za pomocą funkcji System.currentTimeMillis() |
testMetrics |
: ERROR(/Map) danych wyemitowanych |
testEnded
public void testEnded (TestDescription test,testMetrics)
Raportuje zakończenie wykonywania pojedynczego przypadku testu.
Jeśli funkcja testFailed(TestDescription, FailureDescription)
nie została wywołana, test się powiedzie. Zwraca też wszystkie dane klucz-wartość, które mogły zostać wyemitowane podczas wykonywania testu.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
testMetrics |
: ERROR(/Map) danych wyemitowanych |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
Raportuje niepowodzenie pojedynczego przypadku testowego.
Jest wywoływany między testStarted i testEnded.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
failure |
FailureDescription : FailureDescription opisujący błąd i jego kontekst. |
testFailed
public final void testFailed (TestDescription test, String trace)
Raportuje niepowodzenie pojedynczego przypadku testowego.
Jest wywoływany między testStarted i testEnded.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
trace |
String : zrzut stosu błędu |
testIgnored
public final void testIgnored (TestDescription test)
Wywoływany, gdy test nie zostanie uruchomiony, zwykle dlatego, że metoda testu jest oznaczona adnotacją org.junit.Ignore.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
testModuleEnded
public final void testModuleEnded ()
Raportuje koniec wykonania modułu.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
zgłasza rozpoczęcie działania modułu. To wywołanie zwrotne jest powiązane z testModuleEnded()
i jest opcjonalne w sekwencji. Jest używany tylko podczas wykonywania testu, który korzysta z modułów: modułów opartych na zestawach.
Parametry | |
---|---|
moduleContext |
IInvocationContext : IInvocationContext modułu. |
testRunEnded
public final void testRunEnded (long elapsedTimeMillis,runMetrics)
Raportuje zakończenie testu.
Parametry | |
---|---|
elapsedTimeMillis |
long : czas upłynął, milisekundy zgłoszone przez urządzenie |
runMetrics |
: pary klucz-wartość zgłoszone na końcu wykonania testu |
testRunFailed
public final void testRunFailed (FailureDescription failure)
Nie udało się przeprowadzić testu raportów z powodu błędu opisanego w FailureDescription
.
Parametry | |
---|---|
failure |
FailureDescription : FailureDescription opisujący błąd i jego kontekst. |
testRunFailed
public final void testRunFailed (String errorMessage)
Nie udało się przeprowadzić testu raportów z powodu krytycznego błędu.
Parametry | |
---|---|
errorMessage |
String : String opisujący przyczynę niepowodzenia wykonania. |
testRunStarted
public void testRunStarted (String runName, int testCount, int attemptNumber)
Raportuje rozpoczęcie testu.
Parametry | |
---|---|
runName |
String : nazwa testu; |
testCount |
int : łączna liczba testów w sesji testowej |
attemptNumber |
int : numer zamówienia, który identyfikuje różne próby tego samego runName, które są wykonywane wielokrotnie. attemptNumber ma indeks 0 i powinien zwiększać się za każdym razem, gdy następuje nowe wykonanie. Przykład: test jest szczegółowo powtarzany 3 razy, więc powinien mieć łącznie 4 wykonania pod tym samym runName, a attemptNumber powinien mieć wartość od 0 do 3. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
Raportuje rozpoczęcie testu.
Parametry | |
---|---|
runName |
String : nazwa testu; |
testCount |
int : łączna liczba testów w sesji testowej |
testRunStarted
public void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
Raportuje rozpoczęcie testu.
Parametry | |
---|---|
runName |
String : nazwa testu; |
testCount |
int : łączna liczba testów w sesji testowej |
attemptNumber |
int : numer zamówienia, który identyfikuje różne próby tego samego runName, które są wykonywane wielokrotnie. attemptNumber ma indeks 0 i powinien zwiększać się za każdym razem, gdy następuje nowe uruchomienie. Przykład: test jest szczegółowo powtarzany 3 razy, więc powinien mieć łącznie 4 uruchomienia pod tym samym runName, a attemptNumber powinien mieć wartości od 0 do 3. |
startTime |
long : czas rozpoczęcia wykonywania zadania, mierzony za pomocą System.currentTimeMillis() |
testSkipped
public final void testSkipped (TestDescription test, SkipReason reason)
Wywoływany, gdy test jest pomijany i nie jest wykonywany z nieoczekiwanego powodu. Te testy zostaną powtórzone, aby sprawdzić, czy tym razem zostaną wykonane prawidłowo.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
reason |
SkipReason : SkipReason |
testStarted
public final void testStarted (TestDescription test, long startTime)
Alternatywa dla testStarted(com.android.tradefed.result.TestDescription)
, w której określamy też, kiedy test się rozpoczął, w połączeniu z ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
, aby uzyskać dokładne wyniki.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
startTime |
long : czas rozpoczęcia testu mierzony za pomocą funkcji System.currentTimeMillis() |
testStarted
public final void testStarted (TestDescription test)
Raportuje rozpoczęcie pojedynczego testu. Starszy interfejs, którego należy używać w miarę możliwości w przypadku testStarted(com.android.tradefed.result.TestDescription)
.
Parametry | |
---|---|
test |
TestDescription : identyfikuje test |
Chronione metody
afterModuleEnd
protected void afterModuleEnd ()
beforeModuleStart
protected void beforeModuleStart ()
createModuleChildReference
protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)
Tworzy odwołanie podrzędne do modułu.
Parametry | |
---|---|
record |
TestRecordProto.TestRecord |
Zwroty | |
---|---|
TestRecordProto.ChildReference |