Processore post-base
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
java.lang.Object | |
🎞 | com.android.tradefed.postprocessor.BasePostProcessor |
Il valore IPostProcessor
di base che ogni implementazione dovrebbe estendere. Assicurati che il post
vengono 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)
Report che la chiamata è stata terminata, correttamente o a causa di un errore . |
final
void
|
invocationFailed(FailureDescription failure)
Segnala una chiamata incompleta a causa di alcune condizioni di errore. |
final
void
|
invocationFailed(Throwable cause)
Segnala una chiamata incompleta a causa di alcune condizioni di errore. |
void
|
invocationSkipped(SkipReason reason)
Segnala una chiamata come saltata |
final
void
|
invocationStarted(IInvocationContext context)
Listener di chiamata per l'inoltro |
final
boolean
|
isDisabled()
Restituisce True se l'intero oggetto è disabilitato (saltano configurazione ed eliminazione). |
final
void
|
logAssociation(String dataName, LogFile logFile)
In alcuni casi, il log deve essere fortemente associato a uno scenario di test, ma la possibilità di farlo
quindi sulla diretta Aggiorna l'associazione da log a 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 dalle metriche esistenti e logaritmi. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Implementa questo metodo per caricare metriche e log del processo di ogni test. |
final
void
|
setLogSaver(ILogSaver logSaver)
Imposta |
void
|
setUp()
Esegui l'override di questo metodo nei post-processori secondari per inizializzarlo prima dell'esecuzione del test. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Richiamato quando un test atomico segnala che assume una condizione falsa |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Richiamato quando un test atomico segnala che assume 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'errore di un singolo scenario di test. |
final
void
|
testFailed(TestDescription test, String trace)
Segnala l'errore di un singolo scenario di test. |
final
void
|
testIgnored(TestDescription test)
Richiamato quando non verrà eseguito un test, in genere perché un metodo di test è annotato con org.junit.Ignora. |
final
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
Utilizza questo metodo per registrare un file dall'implementazione PostProcessor. |
final
void
|
testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Richiamato quando il log di test viene salvato. |
final
void
|
testModuleEnded()
Segnala la fine dell'esecuzione di un modulo. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
Segnala l'inizio di un modulo in esecuzione. |
final
void
|
testRunEnded(long elapsedTime,
Fine dell'esecuzione del test nei report. |
final
void
|
testRunFailed(FailureDescription failure)
L'esecuzione del test dei report non è riuscita a causa di un errore descritto da |
final
void
|
testRunFailed(String errorMessage)
L'esecuzione del test dei report non è riuscita a causa di un errore irreversibile. |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Segnala l'inizio di un'esecuzione di test. |
final
void
|
testRunStarted(String runName, int testCount)
Callback esecuzione di test |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Segnala l'inizio di un'esecuzione di test. |
final
void
|
testRunStopped(long elapsedTime)
Esecuzione di test dei report interrotta prima del completamento a causa di una richiesta dell'utente. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Richiamato quando un test viene ignorato e non è stato eseguito per un motivo solitamente non previsto. |
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()
Se necessario, sostituisci questo metodo per modificare il tipo di metrica. |
String
|
getRunName()
|
Costruttori pubblici
Processore post-base
public BasePostProcessor ()
Metodi pubblici
Inizia
public final ITestInvocationListener init (ITestInvocationListener listener)
Passaggio di inizializzazione del post-processore. Assicurati di essere chiamato prima di qualsiasi test i callback.
Parametri | |
---|---|
listener |
ITestInvocationListener |
Ritorni | |
---|---|
ITestInvocationListener |
chiamata terminata
public final void invocationEnded (long elapsedTime)
Report che la chiamata è stata terminata, correttamente o a causa di un errore .
Verrà chiamato automaticamente dal framework TradeFederation.
Parametri | |
---|---|
elapsedTime |
long : il tempo trascorso della chiamata in ms |
chiamata non riuscita
public final void invocationFailed (FailureDescription failure)
Segnala una chiamata incompleta a causa di alcune condizioni di errore.
Verrà chiamato automaticamente dal framework TradeFederation.
Parametri | |
---|---|
failure |
FailureDescription : il valore FailureDescription che descrive la causa dell'errore |
chiamata non riuscita
public final void invocationFailed (Throwable cause)
Segnala una chiamata incompleta a causa di alcune condizioni di errore.
Verrà chiamato automaticamente dal framework TradeFederation.
Parametri | |
---|---|
cause |
Throwable : la causa Throwable dell'errore |
chiamataIgnorata
public void invocationSkipped (SkipReason reason)
Segnala una chiamata come saltata
Parametri | |
---|---|
reason |
SkipReason |
chiamataIniziata
public final void invocationStarted (IInvocationContext context)
Listener di chiamata per l'inoltro
Parametri | |
---|---|
context |
IInvocationContext : informazioni sulla chiamata |
non è disabilitato
public final boolean isDisabled ()
Restituisce True se l'intero oggetto è disabilitato (saltano configurazione ed 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 la possibilità di farlo
quindi sulla diretta 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
in modo esplicito.
Aggiorna l'associazione da log a test. Se questo metodo viene chiamato durante un test, il log appartiene al test; in caso contrario sarà un log di esecuzione.
Parametri | |
---|---|
dataName |
String : il nome dei dati |
logFile |
LogFile : il valore LogFile registrato in precedenza e che deve essere associato al
caso di test. |
processiAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Implementa questo metodo per aggregare metriche e log in tutti i test. Le metriche in uscita questo metodo sarà indicato come reporter come metriche eseguite. Solo le metriche appena generate devono essere e con un nome di chiave univoco (non sono consentite collisioni con chiavi esistenti).
Parametri | |
---|---|
allTestMetrics |
ListMultimap : una mappa HashMultimap che memorizza le metriche di ogni test raggruppate per metrica
i nomi degli utenti. |
allTestLogs |
: una mappa in cui è archiviata la mappa di ogni test dei file di log, digitata in base ai nomi dei dati.
usando 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 dalle metriche esistenti e logaritmi. Devono essere restituite solo le metriche appena generate e con un nome chiave univoco (nessuna sono consentite le collisioni con chiavi esistenti).
Parametri | |
---|---|
rawMetrics |
: l'insieme di metriche non elaborate disponibili per l'esecuzione. |
runLogs |
: il set di file di log per l'esecuzione del test. |
Ritorni | |
---|---|
|
L'insieme di metriche appena generate dalle metriche di esecuzione. |
processiTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Implementa questo metodo per caricare metriche e log del processo di ogni test. Solo i nuovi le metriche generate devono essere restituite con un nome chiave univoco (nessuna collisione con sono consentite).
Parametri | |
---|---|
testDescription |
TestDescription : l'oggetto TestDescription che descrive il test. |
testMetrics |
: l'insieme di metriche del test. |
testLogs |
: l'insieme di file registrati durante il test. |
Ritorni | |
---|---|
|
L'insieme 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 : ILogSaver |
impostazione
public void setUp ()
Esegui l'override di questo metodo nei post-processori secondari per inizializzarlo prima dell'esecuzione del test.
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Richiamato quando un test atomico segnala che assume una condizione falsa
Parametri | |
---|---|
test |
TestDescription : identifica il test |
trace |
String : analisi dello stack degli errori |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Richiamato quando un test atomico segnala che assume una condizione falsa
Parametri | |
---|---|
test |
TestDescription : identifica il test |
failure |
FailureDescription : FailureDescription che descrive l'errore e il relativo contesto. |
testTerminato
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
in cui è possibile specificare l'ora di fine
strato Add. Combinalo 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 |
: una percentuale pari a ERROR(/Map) delle metriche emesse |
testTerminato
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 qualsiasi coppia chiave-valore
metriche emesse durante l'esecuzione dello scenario di test.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
testMetrics |
: una percentuale pari a ERROR(/Map) delle metriche emesse |
testNon riuscito
public final void testFailed (TestDescription test, FailureDescription failure)
Segnala l'errore di un singolo scenario 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. |
testNon riuscito
public final void testFailed (TestDescription test, String trace)
Segnala l'errore di un singolo scenario di test.
Verrà chiamato tra testStarted e testEnded.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
trace |
String : analisi dello stack degli errori |
testIgnorato
public final void testIgnored (TestDescription test)
Richiamato quando non verrà eseguito un test, in genere perché un metodo di test è annotato con org.junit.Ignora.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
Diariotest
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Utilizza questo metodo per registrare un file dall'implementazione PostProcessor.
Parametri | |
---|---|
dataName |
String : un nome descrittivo String dei dati. ad es. "device_logcat". Nota
dataName non può essere univoco per ogni chiamata. ovvero gli implementer devono essere in grado di
più chiamate con lo stesso dataName |
dataType |
LogDataType : il LogDataType dei dati |
dataStream |
InputStreamSource : il InputStreamSource dei dati. Gli addetti all'implementazione devono chiamare
createInputStream per iniziare a leggere i dati e assicurarsi di chiudere
InputStream al termine. I chiamanti devono garantire che l'origine dei dati rimanga
e accessibile fino al completamento del metodo testLog. |
TestLogSalvato
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Richiamato quando il log di test viene salvato.
Da utilizzare al posto di ITestInvocationListener#testLog(String, LogDataType,
InputStreamSource)
.
Parametri | |
---|---|
dataName |
String : un nome descrittivo String dei dati. ad es. "device_logcat". Nota
dataName non può essere univoco per ogni chiamata. ovvero gli implementer devono essere in grado di
più chiamate con lo stesso dataName |
dataType |
LogDataType : il LogDataType dei dati |
dataStream |
InputStreamSource : il InputStreamSource dei dati. Gli addetti all'implementazione devono chiamare
createInputStream per iniziare a leggere i dati e assicurarsi di chiudere
InputStream al termine. |
logFile |
LogFile : il valore LogFile contenente i metadati del file salvato. |
testModuloTerminato
public final void testModuleEnded ()
Segnala la fine dell'esecuzione di un modulo.
testModuloIniziato
public final void testModuleStarted (IInvocationContext moduleContext)
Segnala l'inizio di un modulo in esecuzione. Questo callback è associato a testModuleEnded()
ed è facoltativo nella sequenza. Viene usato solo durante una corsa che usa
moduli: runner basati su suite.
Parametri | |
---|---|
moduleContext |
IInvocationContext : il IInvocationContext del modulo. |
testRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
Fine dell'esecuzione del test nei report. FIXME: Non possiamo avere due mappe<> si interfaccia con tipi diversi, dobbiamo usare HashMap qui.
Parametri | |
---|---|
elapsedTime |
long : tempo trascorso sul dispositivo segnalato, in millisecondi |
runMetrics |
: coppie chiave-valore segnalate al termine di un'esecuzione di test con Metric . |
testRunNon riuscito
public final void testRunFailed (FailureDescription failure)
L'esecuzione del test dei report non è riuscita a causa di un errore descritto da FailureDescription
.
Parametri | |
---|---|
failure |
FailureDescription : FailureDescription che descrive l'errore e il relativo contesto. |
testRunNon riuscito
public final void testRunFailed (String errorMessage)
L'esecuzione del test dei report non è riuscita a causa di un errore irreversibile.
Parametri | |
---|---|
errorMessage |
String : String che descrive il motivo dell'errore dell'esecuzione. |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber)
Segnala l'inizio di un'esecuzione di test.
Parametri | |
---|---|
runName |
String : nome dell'esecuzione del test |
testCount |
int : numero totale di test nell'esecuzione del test |
attemptNumber |
int : numero d'ordine che identifica i diversi tentativi dello stesso runName
che vengono eseguite più volte. Il numero tentato è indicizzato a 0 e deve aumentare ogni volta
quando si verifica una nuova esecuzione. ad es. Un test viene ripetuto tre volte in modo granulare e dovrebbe avere in totale 4
viene eseguito con lo stesso runName e il numero di tentativi è compreso tra 0 e 3. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
Callback esecuzione di test
Parametri | |
---|---|
runName |
String : nome dell'esecuzione del test |
testCount |
int : numero totale di test nell'esecuzione del test |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
Segnala l'inizio di un'esecuzione di test.
Parametri | |
---|---|
runName |
String : nome dell'esecuzione del test |
testCount |
int : numero totale di test nell'esecuzione del test |
attemptNumber |
int : numero d'ordine che identifica i diversi tentativi dello stesso runName
che vengono eseguite più volte. Il numero di tentativi è indicizzato a 0 e deve aumentare ogni volta che
una nuova esecuzione. ad es. Un test viene ripetuto tre volte in modo granulare e dovrebbe avere in totale 4 esecuzioni.
sotto lo stesso runName e il numero tentato è compreso tra 0 e 3. |
startTime |
long : l'ora di inizio della corsa, misurata tramite System.currentTimeMillis() |
testRunArrestato
public final void testRunStopped (long elapsedTime)
Esecuzione di test dei report interrotta prima del completamento a causa di una richiesta dell'utente.
DA FARE: attualmente inutilizzato, valuta la possibilità di rimuoverlo
Parametri | |
---|---|
elapsedTime |
long : tempo trascorso sul dispositivo segnalato, in millisecondi |
testIgnorato
public final void testSkipped (TestDescription test, SkipReason reason)
Richiamato quando un test viene ignorato e non è stato eseguito per un motivo solitamente non previsto. Si cercherà di ritentare questi test per ottenere un'esecuzione corretta.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
reason |
SkipReason : SkipReason |
testIniziato
public final void testStarted (TestDescription test, long startTime)
Alternativa a testStarted(com.android.tradefed.result.TestDescription)
, dove specifichiamo anche quando il test è stato
iniziare, combinato con ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
per una misurazione accurata.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
startTime |
long : l'ora in cui è iniziato il test, misurata tramite System.currentTimeMillis() |
testIniziato
public final void testStarted (TestDescription test)
Callback degli scenari di test
Parametri | |
---|---|
test |
TestDescription : identifica il test |
Metodi protetti
pulizia
protected void cleanUp ()
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Se necessario, sostituisci questo metodo per modificare il tipo di metrica. Per impostazione predefinita, la metrica è impostata su tipo elaborato.
Ritorni | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Ritorni | |
---|---|
String |