ProtoResultReporter
public
abstract
class
ProtoResultReporter
extends Object
implements
ILogSaverListener,
ISupportGranularResults,
ITestInvocationListener
| java.lang.Object | |
| ↳ | com.android.tradefed.result.proto.ProtoResultReporter |
Moduł raportujący wyniki tworzy TestRecord protobuf zawierający wszystkie wyniki. Należy rozszerzyć tę funkcję, aby określała, co zrobić z ostatecznym protokołem w processFinalProto(TestRecord).
Podsumowanie
Konstruktory publiczne | |
|---|---|
ProtoResultReporter()
|
|
Metody publiczne | |
|---|---|
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. |
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
|
invocationSkipped(SkipReason reason)
Zgłasza wywołanie jako pominięte |
void
|
invocationStarted(IInvocationContext context)
Zgłasza rozpoczęcie wywołania testu. |
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 |
void
|
processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs)
Użyj rekordu wywołania, aby wysłać po kolei wszystkie końcowe logi wywołania. |
void
|
processFinalProto(TestRecordProto.TestRecord finalRecord)
Obsługa końcowego protokołu ze wszystkimi wynikami. |
void
|
processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
Obsługa częściowego rekordu testowego wywołania po wystąpieniu błędu |
void
|
processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord)
Obsługa ostatecznego rekordu protokołu elementu testowania po wystąpieniu zdarzenia |
void
|
processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord)
Obsługa częściowego rekordu protokołu testu po wystąpieniu |
void
|
processTestModuleEnd(TestRecordProto.TestRecord moduleRecord)
Obsługa sfinalizowanego protokołu rekordu modułu po wystąpieniu |
void
|
processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord)
Obsługa częściowego rekordu modułu po wystąpieniu zdarzenia |
void
|
processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
Obsługa ostatecznego rekordu uruchomienia po wystąpieniu zdarzenia |
void
|
processTestRunStarted(TestRecordProto.TestRecord runStartedRecord)
Obsługa częściowego rekordu proto przebiegu testu po wystąpieniu znaku |
void
|
setGranularResults(boolean granularResults)
|
void
|
setInlineRecordOfChildren(boolean inline)
|
boolean
|
supportGranularResults()
Zwraca wartość „True”, jeśli narzędzie do raportowania obsługuje szczegółowe wyniki, w przeciwnym razie zwraca wartość „False”. |
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 |
void
|
testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> testMetrics)
Zgłasza zakończenie wykonania pojedynczego elementu testowania. |
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
|
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 elapsedTimeMillis, HashMap<String, MetricMeasurement.Metric> 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 |
final
void
|
testRunFailed(String errorMessage)
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. |
final
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. |
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 |
final
void
|
testStarted(TestDescription test)
Zgłasza rozpoczęcie pojedynczego elementu testowania. |
Metody chronione | |
|---|---|
void
|
afterModuleEnd()
|
void
|
beforeModuleStart()
|
TestRecordProto.ChildReference
|
createModuleChildReference(TestRecordProto.TestRecord record)
Tworzy odwołanie do elementu podrzędnego modułu. |
Konstruktory publiczne
ProtoResultReporter
public ProtoResultReporter ()
Metody publiczne
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 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 |
invocationSkipped
public void invocationSkipped (SkipReason reason)
Zgłasza wywołanie jako pominięte
| Parametry | |
|---|---|
reason |
SkipReason |
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 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.
| Parametry | |
|---|---|
dataName |
String: nazwa danych |
logFile |
LogFile: LogFile, który został zarejestrowany wcześniej i powinien być powiązany z elementem testowania. |
processFinalInvocationLogs
public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)
Użyj rekordu wywołania, aby wysłać po kolei wszystkie końcowe logi wywołania.
| Parametry | |
|---|---|
invocationLogs |
TestRecordProto.TestRecord: sfinalizowany protokół reprezentujący wywołanie. |
processFinalProto
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
Obsługa końcowego protokołu ze wszystkimi wynikami.
| Parametry | |
|---|---|
finalRecord |
TestRecordProto.TestRecord: ostateczny protokół ze wszystkimi wynikami wywołania. |
processStartInvocation
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord,
IInvocationContext invocationContext)Obsługa częściowego rekordu testowego wywołania po wystąpieniu błędu invocationStarted(IInvocationContext).
| Parametry | |
|---|---|
invocationStartRecord |
TestRecordProto.TestRecord: Częściowy protokół wypełniony po wywołaniu invocationStart. |
invocationContext |
IInvocationContext: wywołanie IInvocationContext. |
processTestCaseEnded
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
Obsługa ostatecznego rekordu protokołu elementu testowania po wystąpieniu zdarzenia testEnded(TestDescription,long,HashMap).
| Parametry | |
|---|---|
testCaseRecord |
TestRecordProto.TestRecord: Sfinalizowany protokół reprezentujący element testowania. |
processTestCaseStarted
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
Obsługa częściowego rekordu protokołu testu po wystąpieniu testStarted(TestDescription,long).
| Parametry | |
|---|---|
testCaseStartedRecord |
TestRecordProto.TestRecord: Częściowy protokół reprezentujący element testowania. |
processTestModuleEnd
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
Obsługa sfinalizowanego protokołu rekordu modułu po wystąpieniu testModuleEnded().
| Parametry | |
|---|---|
moduleRecord |
TestRecordProto.TestRecord: ostateczny protokół reprezentujący moduł. |
processTestModuleStarted
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
Obsługa częściowego rekordu modułu po wystąpieniu zdarzenia testModuleStarted(IInvocationContext).
| Parametry | |
|---|---|
moduleStartRecord |
TestRecordProto.TestRecord: częściowy protokół reprezentujący moduł. |
processTestRunEnded
public void processTestRunEnded (TestRecordProto.TestRecord runRecord,
boolean moduleInProgress)Obsługa ostatecznego rekordu uruchomienia po wystąpieniu zdarzenia testRunEnded(long,HashMap).
| Parametry | |
|---|---|
runRecord |
TestRecordProto.TestRecord: sfinalizowany protokół reprezentujący uruchomienie. |
moduleInProgress |
boolean: czy moduł jest w toku. |
processTestRunStarted
public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)
Obsługa częściowego rekordu proto przebiegu testu po wystąpieniu znaku testRunStarted(String,int).
| Parametry | |
|---|---|
runStartedRecord |
TestRecordProto.TestRecord: częściowy protokół 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”, jeśli narzędzie do raportowania obsługuje szczegółowe wyniki, w przeciwnym razie zwraca wartość „False”.
| Zwraca | |
|---|---|
boolean |
|
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 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 |
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 |
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 elapsedTimeMillis,
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 | |
|---|---|
elapsedTimeMillis |
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 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 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)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() |
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)
Zgłasza rozpoczęcie pojedynczego elementu testowania. Jest to starszy interfejs; o ile to możliwe, używaj testStarted(TestDescription).
| Parametry | |
|---|---|
test |
TestDescription: identyfikuje test |
Metody chronione
afterModuleEnd
protected void afterModuleEnd ()
beforeModuleStart
protected void beforeModuleStart ()
createModuleChildReference
protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)
Tworzy odwołanie do elementu podrzędnego modułu.
| Parametry | |
|---|---|
record |
TestRecordProto.TestRecord |
| Zwraca | |
|---|---|
TestRecordProto.ChildReference |
|