BasePostProcessor
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
| java.lang.Object | |
| ↳ | com.android.tradefed.postprocessor.BasePostProcessor |
La base IPostProcessor che ogni implementazione deve estendere. Assicurati che i metodi di post-elaborazione vengano chiamati prima dei reporter dei risultati finali.
Riepilogo
Costruttori pubblici | |
|---|---|
BasePostProcessor()
|
|
Metodi pubblici | |
|---|---|
final
ITestInvocationListener
|
init(ITestInvocationListener listener)
Passaggio di inizializzazione del post-processore. |
final
void
|
invocationEnded(long elapsedTime)
Segnala che l'invocazione è terminata, correttamente o a causa di una condizione di errore. |
final
void
|
invocationFailed(FailureDescription failure)
Segnala una chiamata incompleta a causa di una condizione di errore. |
final
void
|
invocationFailed(Throwable cause)
Segnala una chiamata incompleta a causa di una condizione di errore. |
void
|
invocationSkipped(SkipReason reason)
Segnala un'invocazione come ignorata |
final
void
|
invocationStarted(IInvocationContext context)
Listener di chiamata per l'inoltro |
final
boolean
|
isDisabled()
Restituisce True se l'intero oggetto è disattivato (vengono ignorati sia la configurazione che l'eliminazione). |
final
void
|
logAssociation(String dataName, LogFile logFile)
In alcuni casi, il log deve essere fortemente associato a uno scenario di test, ma l'opportunità di farlo
nel callback diretto Aggiorna l'associazione log-test. |
|
processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,
Implementa questo metodo per aggregare metriche e log in tutti i test. |
abstract
|
processRunMetricsAndLogs(
Implementa questo metodo per generare un insieme di nuove metriche dai log e dalle metriche esistenti. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Implementa questo metodo per post-elaborare metriche e log di ogni test. |
final
void
|
setLogSaver(ILogSaver logSaver)
Imposta |
void
|
setUp()
Esegui l'override di questo metodo nei post-processor secondari per l'inizializzazione prima dell'esecuzione del test. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Chiamato quando un test atomico segnala che presuppone una condizione falsa |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Chiamato quando un test atomico segnala che presuppone una condizione falsa |
final
void
|
testEnded(TestDescription test, long endTime,
Alternativa a |
final
void
|
testEnded(TestDescription test,
Segnala la fine dell'esecuzione di un singolo scenario di test. |
final
void
|
testFailed(TestDescription test, FailureDescription failure)
Segnala l'esito negativo di un singolo caso di test. |
final
void
|
testFailed(TestDescription test, String trace)
Segnala l'esito negativo di un singolo caso di test. |
final
void
|
testIgnored(TestDescription test)
Chiamato quando un test non verrà eseguito, in genere perché un metodo di test è annotato con org.junit.Ignore. |
final
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
Utilizza questo metodo per registrare un file dall'implementazione di PostProcessor. |
final
void
|
testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Chiamato quando viene salvato il log di test. |
final
void
|
testModuleEnded()
Segnala la fine dell'esecuzione di un modulo. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
Indica l'inizio dell'esecuzione di un modulo. |
final
void
|
testRunEnded(long elapsedTime,
Segnala la fine dell'esecuzione del test. |
final
void
|
testRunFailed(FailureDescription failure)
L'esecuzione di test dei report non è stata completata a causa di un errore descritto da |
final
void
|
testRunFailed(String errorMessage)
L'esecuzione del test dei report non è stata completata a causa di un errore irreversibile. |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Segnala l'inizio di un'esecuzione del test. |
final
void
|
testRunStarted(String runName, int testCount)
Test run callbacks |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Segnala l'inizio di un'esecuzione del test. |
final
void
|
testRunStopped(long elapsedTime)
L'esecuzione di prova dei report è stata interrotta prima del completamento a causa di una richiesta dell'utente. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Chiamato quando un test viene ignorato e non eseguito per un motivo insolito. |
final
void
|
testStarted(TestDescription test, long startTime)
Alternativa a |
final
void
|
testStarted(TestDescription test)
Callback degli scenari di test |
Metodi protetti | |
|---|---|
void
|
cleanUp()
|
MetricMeasurement.DataType
|
getMetricType()
Esegui l'override di questo metodo per modificare il tipo di metrica, se necessario. |
String
|
getRunName()
|
Costruttori pubblici
BasePostProcessor
public BasePostProcessor ()
Metodi pubblici
init
public final ITestInvocationListener init (ITestInvocationListener listener)
Passaggio di inizializzazione del post-processore. Assicurati di chiamare prima di qualsiasi callback dei test.
| Parametri | |
|---|---|
listener |
ITestInvocationListener |
| Ritorni | |
|---|---|
ITestInvocationListener |
|
invocationEnded
public final void invocationEnded (long elapsedTime)
Segnala che l'invocazione è terminata, correttamente o a causa di una condizione di errore.
Verrà chiamato automaticamente dal framework TradeFederation.
| Parametri | |
|---|---|
elapsedTime |
long: il tempo trascorso dell'invocazione in ms |
invocationFailed
public final void invocationFailed (FailureDescription failure)
Segnala una chiamata incompleta a causa di una condizione di errore.
Verrà chiamato automaticamente dal framework TradeFederation.
| Parametri | |
|---|---|
failure |
FailureDescription: il FailureDescription che descrive la causa dell'errore |
invocationFailed
public final void invocationFailed (Throwable cause)
Segnala una chiamata incompleta a causa di una condizione di errore.
Verrà chiamato automaticamente dal framework TradeFederation.
| Parametri | |
|---|---|
cause |
Throwable: la causa Throwable dell'errore |
invocationSkipped
public void invocationSkipped (SkipReason reason)
Segnala un'invocazione come ignorata
| Parametri | |
|---|---|
reason |
SkipReason |
invocationStarted
public final void invocationStarted (IInvocationContext context)
Listener di chiamata per l'inoltro
| Parametri | |
|---|---|
context |
IInvocationContext: informazioni sulla chiamata |
isDisabled
public final boolean isDisabled ()
Restituisce True se l'intero oggetto è disattivato (vengono ignorati sia la configurazione che l'eliminazione). Falso negli altri casi.
| Ritorni | |
|---|---|
boolean |
|
logAssociation
public final void logAssociation (String dataName,
LogFile logFile)In alcuni casi, il log deve essere fortemente associato a uno scenario di test, ma l'opportunità di farlo
nel callback diretto testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
non è possibile. Pertanto, questo callback consente di fornire un'associazione forte
in modo esplicito.
Aggiorna l'associazione log-test. Se questo metodo viene chiamato durante un test, il log appartiene al test; altrimenti sarà un log di esecuzione.
| Parametri | |
|---|---|
dataName |
String: il nome dei dati |
logFile |
LogFile: il LogFile registrato in precedenza e che deve essere associato allo scenario di test. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Implementa questo metodo per aggregare metriche e log in tutti i test. Le metriche risultanti da questo metodo verranno segnalate come metriche di esecuzione. Devono essere restituite solo le metriche appena generate e con un nome di chiave univoco (non sono consentite collisioni con le chiavi esistenti).
| Parametri | |
|---|---|
allTestMetrics |
ListMultimap: Un HashMultimap che memorizza le metriche di ogni test raggruppate per nome della metrica. |
allTestLogs |
: una mappa che memorizza la mappa dei file di log di ogni test in base ai nomi dei dati,
utilizzando TestDescription di ogni test come chiavi. |
| Ritorni | |
|---|---|
|
L'insieme di metriche appena generate da tutte le metriche di test. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Implementa questo metodo per generare un insieme di nuove metriche dai log e dalle metriche esistenti. Devono essere restituite solo le metriche appena generate e con un nome di chiave univoco (non sono consentite collisioni con le chiavi esistenti).
| Parametri | |
|---|---|
rawMetrics |
: Il set di metriche non elaborate disponibili per l'esecuzione. |
runLogs |
: Il set di file di log per l'esecuzione del test. |
| Ritorni | |
|---|---|
|
Il set di metriche appena generate dalle metriche della corsa. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Implementa questo metodo per post-elaborare metriche e log di ogni test. Devono essere restituite solo le metriche generate di recente e con un nome di chiave univoco (non sono consentite collisioni con chiavi esistenti).
| Parametri | |
|---|---|
testDescription |
TestDescription: l'oggetto TestDescription che descrive il test. |
testMetrics |
: Il set di metriche del test. |
testLogs |
: L'insieme di file registrati durante il test. |
| Ritorni | |
|---|---|
|
Il set di metriche appena generate dalle metriche di test. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Imposta ILogSaver per consentire all'implementatore di salvare i file.
| Parametri | |
|---|---|
logSaver |
ILogSaver: il ILogSaver |
setUp
public void setUp ()
Esegui l'override di questo metodo nei post-processor secondari per l'inizializzazione prima dell'esecuzione del test.
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Chiamato quando un test atomico segnala che presuppone una condizione falsa
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
trace |
String: analisi dello stack dell'errore |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Chiamato quando un test atomico segnala che presuppone una condizione falsa
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
failure |
FailureDescription: FailureDescription che descrive l'errore e il relativo contesto. |
testEnded
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) in cui possiamo specificare direttamente l'ora di fine. Combina con testStarted(com.android.tradefed.result.TestDescription, long) per una misurazione accurata.
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
endTime |
long: l'ora in cui è terminato il test, misurata tramite System.currentTimeMillis() |
testMetrics |
: un ERROR(/Map) delle metriche emesse |
testEnded
public final void testEnded (TestDescription test,testMetrics)
Segnala la fine dell'esecuzione di un singolo scenario di test.
Se testFailed(TestDescription, FailureDescription) non è stato richiamato, questo test è stato superato. Restituisce anche eventuali metriche chiave/valore
che potrebbero essere state emesse durante l'esecuzione dello scenario di test.
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
testMetrics |
: un ERROR(/Map) delle metriche emesse |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
Segnala l'esito negativo di un singolo caso di test.
Verrà chiamato tra testStarted e testEnded.
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
failure |
FailureDescription: FailureDescription che descrive l'errore e il relativo contesto. |
testFailed
public final void testFailed (TestDescription test, String trace)
Segnala l'esito negativo di un singolo caso di test.
Verrà chiamato tra testStarted e testEnded.
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
trace |
String: analisi dello stack dell'errore |
testIgnored
public final void testIgnored (TestDescription test)
Chiamato quando un test non verrà eseguito, in genere perché un metodo di test è annotato con org.junit.Ignore.
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
testLog
public final void testLog (String dataName,
LogDataType dataType,
InputStreamSource dataStream)Utilizza questo metodo per registrare un file dall'implementazione di PostProcessor.
| Parametri | |
|---|---|
dataName |
String: un nome descrittivo String dei dati, ad es. "device_logcat". Nota
dataName potrebbe non essere univoco per invocazione. Ciò significa che gli implementatori devono essere in grado di gestire
più chiamate con lo stesso dataName |
dataType |
LogDataType: il LogDataType dei dati |
dataStream |
InputStreamSource: il InputStreamSource dei dati. Gli implementatori devono chiamare
createInputStream per iniziare a leggere i dati e assicurarsi di chiudere l'InputStream risultante al termine dell'operazione. I chiamanti devono assicurarsi che l'origine dei dati rimanga
presente e accessibile fino al completamento del metodo testLog. |
testLogSaved
public final void testLogSaved (String dataName,
LogDataType dataType,
InputStreamSource dataStream,
LogFile logFile)Chiamato quando viene salvato il log di test.
Deve essere utilizzato al posto di ITestInvocationListener.testLog(String, LogDataType,
InputStreamSource).
| Parametri | |
|---|---|
dataName |
String: un nome descrittivo String dei dati, ad es. "device_logcat". Nota
dataName potrebbe non essere univoco per invocazione. Ciò significa che gli implementatori devono essere in grado di gestire
più chiamate con lo stesso dataName |
dataType |
LogDataType: il LogDataType dei dati |
dataStream |
InputStreamSource: il InputStreamSource dei dati. Gli implementatori devono chiamare
createInputStream per iniziare a leggere i dati e assicurarsi di chiudere l'InputStream risultante al termine dell'operazione. |
logFile |
LogFile: il LogFile contenente i metadati del file salvato. |
testModuleEnded
public final void testModuleEnded ()
Segnala la fine dell'esecuzione di un modulo.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Indica l'inizio dell'esecuzione di un modulo. Questo callback è associato a testModuleEnded() ed è facoltativo nella sequenza. Viene utilizzato solo durante un'esecuzione che utilizza
moduli: runner basati su suite.
| Parametri | |
|---|---|
moduleContext |
IInvocationContext: il IInvocationContext del modulo. |
testRunEnded
public final void testRunEnded (long elapsedTime,
runMetrics) Segnala la fine dell'esecuzione del test.
| Parametri | |
|---|---|
elapsedTime |
long: tempo trascorso segnalato dal dispositivo, in millisecondi |
runMetrics |
: coppie chiave-valore segnalate alla fine di un'esecuzione del test |
testRunFailed
public final void testRunFailed (FailureDescription failure)
L'esecuzione di test dei report non è stata completata a causa di un errore descritto da FailureDescription.
| Parametri | |
|---|---|
failure |
FailureDescription: FailureDescription che descrive l'errore e il relativo contesto. |
testRunFailed
public final void testRunFailed (String errorMessage)
L'esecuzione del test dei report non è stata completata a causa di un errore irreversibile.
| Parametri | |
|---|---|
errorMessage |
String: String che descrive il motivo dell'errore di esecuzione. |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber)Segnala l'inizio di un'esecuzione del test.
| Parametri | |
|---|---|
runName |
String: il nome dell'esecuzione di test |
testCount |
int: numero totale di test nell'esecuzione di test |
attemptNumber |
int: numero d'ordine, che identifica i diversi tentativi dello stesso runName
eseguiti più volte. attemptNumber è indicizzato a 0 e deve aumentare ogni volta
che viene eseguita una nuova esecuzione. Ad esempio, un test viene riprovato in modo granulare 3 volte, deve avere 4 esecuzioni
totali con lo stesso runName e attemptNumber va da 0 a 3. |
testRunStarted
public final void testRunStarted (String runName,
int testCount)Test run callbacks
| Parametri | |
|---|---|
runName |
String: il nome dell'esecuzione di test |
testCount |
int: numero totale di test nell'esecuzione di test |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber,
long startTime)Segnala l'inizio di un'esecuzione del test.
| Parametri | |
|---|---|
runName |
String: il nome dell'esecuzione di test |
testCount |
int: numero totale di test nell'esecuzione di test |
attemptNumber |
int: numero d'ordine, che identifica i diversi tentativi dello stesso runName
eseguiti più volte. attemptNumber è indicizzato a 0 e deve aumentare ogni volta che
viene eseguita una nuova esecuzione. Ad esempio, un test viene ritentato in modo granulare 3 volte, deve avere 4 esecuzioni totali
con lo stesso runName e attemptNumber va da 0 a 3. |
startTime |
long: l'ora in cui è iniziata la corsa, misurata tramite System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
L'esecuzione di prova dei report è stata interrotta prima del completamento a causa di una richiesta dell'utente.
TODO: attualmente non utilizzato, valuta la possibilità di rimuoverlo
| Parametri | |
|---|---|
elapsedTime |
long: tempo trascorso segnalato dal dispositivo, in millisecondi |
testSkipped
public final void testSkipped (TestDescription test, SkipReason reason)
Chiamato quando un test viene ignorato e non eseguito per un motivo insolito. Verrà effettuato un nuovo tentativo di esecuzione di questi test.
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
reason |
SkipReason: SkipReason |
testStarted
public final void testStarted (TestDescription test, long startTime)
Alternativa a testStarted(com.android.tradefed.result.TestDescription), in cui specifichiamo anche quando è iniziato il test, combinata con ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) per una misurazione accurata.
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
startTime |
long: l'ora di inizio del test, misurata tramite System.currentTimeMillis() |
testStarted
public final void testStarted (TestDescription test)
Callback degli scenari di test
| Parametri | |
|---|---|
test |
TestDescription: identifica il test |
Metodi protetti
cleanUp
protected void cleanUp ()
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Esegui l'override di questo metodo per modificare il tipo di metrica, se necessario. Per impostazione predefinita, la metrica è impostata sul tipo elaborato.
| Ritorni | |
|---|---|
MetricMeasurement.DataType |
|
getRunName
protected String getRunName ()
| Ritorni | |
|---|---|
String |
|