BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Oggetto
com.android.tradefed.postprocessor.BasePostProcessor


L' IPostProcessor di base che deve essere esteso da ogni implementazione. Assicurarsi che i metodi di post-elaborazione vengano richiamati prima dei reporter del risultato finale.

Riepilogo

Costruttori pubblici

BasePostProcessor ()

Metodi pubblici

final ITestInvocationListener init ( ITestInvocationListener listener)

Fase di inizializzazione del post processore.

final void invocationEnded (long elapsedTime)

Segnala che la chiamata è stata terminata, con successo oa causa di qualche 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.

final void invocationStarted ( IInvocationContext context)

Invocazione Listener per l'inoltro

final boolean isDisabled ()

Restituisce True se l'intero oggetto è disabilitato (salta sia l'installazione che lo smontaggio).

final void logAssociation (String dataName, LogFile logFile)

In alcuni casi, log deve essere fortemente associato a un test case, ma l'opportunità di farlo direttamente testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) la richiamata non è possibile.

Aggiorna l'associazione log-to-test.

processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)

Implementa questo metodo per aggregare metriche e log in tutti i test.

abstract processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs)

Implementa questo metodo per generare un set di nuove metriche dalle metriche e dai log esistenti.

processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs)

Implementa questo metodo per pubblicare metriche e log di ogni test.

final void setLogSaver ( ILogSaver logSaver)

Impostare ILogSaver per consentire all'implementatore di salvare i file.

void setUp ()

Eseguire l'override di questo metodo nei post processori figlio 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, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics)

Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) dove possiamo specificare direttamente l'ora di fine.

final void testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics)

Riporta la fine dell'esecuzione di un singolo test case.

final void testFailed ( TestDescription test, FailureDescription failure)

Segnala il fallimento di un singolo test case.

final void testFailed ( TestDescription test, String trace)

Segnala il fallimento di un singolo test case.

final void testIgnored ( TestDescription test)

Chiamato quando un test non verrà eseguito, generalmente perché un metodo di test è annotato con org.junit.Ignore.

final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)

Utilizzare questo metodo per registrare un file dall'implementazione PostProcessor.

final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

Chiamato 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, runMetrics) testRunEnded (long elapsedTime, runMetrics)

Segnala la fine dell'esecuzione del test.

final void testRunFailed ( FailureDescription failure)

L'esecuzione del test dei report non è riuscita a essere completata a causa di un errore descritto da FailureDescription .

final void testRunFailed (String errorMessage)

L'esecuzione del test dei rapporti non è riuscita a essere completata a causa di un errore irreversibile.

final void testRunStarted (String runName, int testCount, int attemptNumber)

Segnala l'inizio di un'esecuzione di prova.

final void testRunStarted (String runName, int testCount)

Callback di esecuzione di test

final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)

Segnala l'inizio di un'esecuzione di prova.

final void testRunStopped (long elapsedTime)

Segnala l'interruzione dell'esecuzione del test prima del completamento a causa di una richiesta dell'utente.

final void testStarted ( TestDescription test, long startTime)

Alternativa a testStarted(com.android.tradefed.result.TestDescription) dove specifichiamo anche quando il test è stato avviato, combinato con ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) per una misura accurata .

final void testStarted ( TestDescription test)

Callback dei casi di test

Metodi protetti

MetricMeasurement.DataType getMetricType ()

Eseguire l'override di questo metodo per modificare il tipo di metrica, se necessario.

String getRunName ()

Costruttori pubblici

BasePostProcessor

public BasePostProcessor ()

Metodi pubblici

dentro

public final ITestInvocationListener init (ITestInvocationListener listener)

Fase di inizializzazione del post processore. Assicurati di essere chiamato prima di qualsiasi callback dei test.

Parametri
listener ITestInvocationListener

ritorna
ITestInvocationListener

invocazioneEnded

public final void invocationEnded (long elapsedTime)

Segnala che la chiamata è stata terminata, con successo oa causa di qualche condizione di errore.

Verrà richiamato automaticamente dal framework TradeFederation.

Parametri
elapsedTime long : il tempo trascorso dell'invocazione in ms

invocazione non riuscita

public final void invocationFailed (FailureDescription failure)

Segnala una chiamata incompleta a causa di una condizione di errore.

Verrà richiamato automaticamente dal framework TradeFederation.

Parametri
failure FailureDescription : la FailureDescription che descrive la causa dell'errore

invocazione non riuscita

public final void invocationFailed (Throwable cause)

Segnala una chiamata incompleta a causa di una condizione di errore.

Verrà richiamato automaticamente dal framework TradeFederation.

Parametri
cause Throwable : la causa ERROR(/Throwable) dell'errore

invocazioneAvviato

public final void invocationStarted (IInvocationContext context)

Invocazione Listener per l'inoltro

Parametri
context IInvocationContext : informazioni sulla chiamata

è disabilitato

public final boolean isDisabled ()

Restituisce True se l'intero oggetto è disabilitato (salta sia l'installazione che lo smontaggio). Falso altrimenti.

ritorna
boolean

logAssociazione

public final void logAssociation (String dataName, 
                LogFile logFile)

In alcuni casi, log deve essere fortemente associato a un test case, ma l'opportunità di farlo direttamente testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) la richiamata non è possibile. Pertanto, questo callback consente di fornire esplicitamente un'associazione forte.

Aggiorna l'associazione log-to-test. Se questo metodo viene chiamato durante un test, il registro appartiene al test; altrimenti sarà un registro di esecuzione.

Parametri
dataName String : il nome dei dati

logFile LogFile : il LogFile che è stato registrato in precedenza e deve essere associato al test case.

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

Implementa questo metodo per aggregare metriche e log in tutti i test. Le metriche che escono da questo metodo saranno riportate come metriche di esecuzione. Devono essere restituite solo le metriche appena generate e con un nome di chiave univoco (non sono consentite collisioni con chiavi esistenti).

Parametri
allTestMetrics ListMultimap : una HashMultimap che memorizza le metriche di ogni test raggruppate per nomi di metriche.

allTestLogs : una mappa che memorizza la mappa dei file di registro di ogni test con chiave in base ai nomi dei dati, utilizzando la TestDescription di ogni test come chiavi.

ritorna
L'insieme di metriche appena generate da tutte le metriche di test.

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

Implementa questo metodo per generare un set di nuove metriche dalle metriche e dai log esistenti. Devono essere restituite solo le metriche appena generate e con un nome di chiave univoco (non sono consentite collisioni con chiavi esistenti).

Parametri
rawMetrics : il set di metriche non elaborate disponibili per l'esecuzione.

runLogs : il set di file di registro per l'esecuzione del test.

ritorna
Il set di metriche appena generate dalle metriche di esecuzione.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

Implementa questo metodo per pubblicare metriche e log di ogni test. Devono essere restituite solo le metriche appena generate 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 : l'insieme di metriche del test.

testLogs : l'insieme di file registrati durante il test.

ritorna
L'insieme di metriche appena generate dalle metriche di test.

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

Impostare ILogSaver per consentire all'implementatore di salvare i file.

Parametri
logSaver ILogSaver : ILogSaver

impostare

public void setUp ()

Eseguire l'override di questo metodo nei post processori figlio 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 : traccia 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.

testTerminato

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) dove 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 il test è terminato, misurato tramite ERROR(/System#currentTimeMillis())

testMetrics : un ERROR(/Map) delle metriche emesse

testTerminato

public final void testEnded (TestDescription test, 
                 testMetrics)

Riporta la fine dell'esecuzione di un singolo test case.

Se testFailed(TestDescription, FailureDescription) non è stato richiamato, questo test ha avuto esito positivo. Restituisce anche qualsiasi metrica chiave/valore che potrebbe essere stata emessa durante l'esecuzione del caso 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 il fallimento di un singolo test case.

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 il fallimento di un singolo test case.

Verrà chiamato tra testStarted e testEnded.

Parametri
test TestDescription : identifica il test

trace String : traccia dello stack dell'errore

testIgnorato

public final void testIgnored (TestDescription test)

Chiamato quando un test non verrà eseguito, generalmente 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)

Utilizzare questo metodo per registrare un file dall'implementazione PostProcessor.

Parametri
dataName String : un ERROR(/String) nome descrittivo dei dati. ad esempio "device_logcat". Nota dataName potrebbe non essere univoco per chiamata. cioè gli implementatori devono essere in grado di gestire più chiamate con lo stesso dataName

dataType LogDataType : il LogDataType dei dati

dataStream InputStreamSource : InputStreamSource dei dati. Gli implementatori dovrebbero chiamare createInputStream per iniziare a leggere i dati e assicurarsi di chiudere l'InputStream risultante al termine. I chiamanti devono assicurarsi che l'origine dei dati rimanga presente e accessibile fino al completamento del metodo testLog.

testLogSalvato

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

Chiamato quando il log di test viene salvato.

Deve essere utilizzato al posto di ITestInvocationListener#testLog(String, LogDataType, InputStreamSource) .

Parametri
dataName String : un ERROR(/String) nome descrittivo dei dati. ad esempio "device_logcat". Nota dataName potrebbe non essere univoco per chiamata. cioè gli implementatori devono essere in grado di gestire più chiamate con lo stesso dataName

dataType LogDataType : il LogDataType dei dati

dataStream InputStreamSource : InputStreamSource dei dati. Gli implementatori dovrebbero chiamare createInputStream per iniziare a leggere i dati e assicurarsi di chiudere l'InputStream risultante al termine.

logFile LogFile : il LogFile contenente i metadati del file salvato.

testModuleEnded

public final void testModuleEnded ()

Segnala la fine dell'esecuzione di un modulo.

testModuleAvviato

public final void testModuleStarted (IInvocationContext moduleContext)

Segnala l'inizio di un modulo in esecuzione. Questo callback è associato a testModuleEnded() ed è facoltativo nella sequenza. Viene utilizzato solo durante una corsa che utilizza moduli: corridori basati su suite.

Parametri
moduleContext IInvocationContext : IInvocationContext del modulo.

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

Segnala la fine dell'esecuzione del test. FIXME: non possiamo avere due interfacce Map<> con tipo diverso, quindi dobbiamo usare HashMap qui.

Parametri
elapsedTime long : tempo trascorso segnalato dal dispositivo, in millisecondi

runMetrics : coppie chiave-valore riportate al termine di un'esecuzione di test con Metric .

testRunFailed

public final void testRunFailed (FailureDescription failure)

L'esecuzione del test dei report non è riuscita a essere 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 rapporti non è riuscita a essere completata a causa di un errore irreversibile.

Parametri
errorMessage String : ERROR(/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 di prova.

Parametri
runName String : il 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 eseguiti più volte. Il tryNumber è indicizzato a 0 e dovrebbe incrementare ogni volta che si verifica una nuova esecuzione. ad esempio, un test viene ritentato in modo granulare 3 volte, dovrebbe avere 4 esecuzioni totali con lo stesso runName e il numero di tentativi è compreso tra 0 e 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Callback di esecuzione di test

Parametri
runName String : il 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 : il 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 eseguiti più volte. Il tryNumber è indicizzato a 0 e dovrebbe incrementare ogni volta che si verifica una nuova esecuzione. ad esempio, un test viene ritentato in modo granulare 3 volte, dovrebbe avere 4 esecuzioni totali con lo stesso runName e il numero di tentativi è compreso tra 0 e 3.

startTime long : l'ora in cui è iniziata la corsa, misurata tramite ERROR(/System#currentTimeMillis())

testRunStopped

public final void testRunStopped (long elapsedTime)

Segnala l'interruzione dell'esecuzione del test prima del completamento a causa di una richiesta dell'utente.

TODO: attualmente inutilizzato, prendere in considerazione la rimozione

Parametri
elapsedTime long : tempo trascorso segnalato dal dispositivo, in millisecondi

testAvviato

public final void testStarted (TestDescription test, 
                long startTime)

Alternativa a testStarted(com.android.tradefed.result.TestDescription) dove specifichiamo anche quando il test è stato avviato, combinato con ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) per una misura accurata .

Parametri
test TestDescription : identifica il test

startTime long : l'ora di inizio del test, misurata tramite ERROR(/System#currentTimeMillis())

testAvviato

public final void testStarted (TestDescription test)

Callback dei casi di test

Parametri
test TestDescription : identifica il test

Metodi protetti

getMetricType

protected MetricMeasurement.DataType getMetricType ()

Eseguire l'override di questo metodo per modificare il tipo di metrica, se necessario. Per impostazione predefinita, la metrica è impostata sul tipo elaborato.

ritorna
MetricMeasurement.DataType

getRunName

protected String getRunName ()

ritorna
String